Skip to content

Create README.md #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sammster10 merged 1 commit into from
Nov 30, 2024
Merged

Create README.md #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Why does this exist
`static-data` exists for use in distributed Minecraft servers, where additional latency on read operations cannot be afforded.

## Data wrappers
A data wrapper is meant to be a field in a `UniqueData` object. Currently, the following data wrappers have been implemented:
- `PersistentValue`: This value is stored in the database. It is referenced via the `@Table` annotation on the parent data class, and by it's column which is explicitly defined.
- `ForeignPersistentValue`: This is similar to `PersistentValue`, however it does not use the `@Table` annotation. Instead, the table must be explicitly defined. Furthermore, it references a column in a different data object, hence the name foreign.
- `CachedValue`: This is a value stored in Redis. It will fallback to its default value if the value is not present in redis.
- `PersistentCollection`: This is a collection of values that is stored in the database. The current implementation is a list based implementation.