Skip to content

Update GlobalDataStore.yaml #1069

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
merged 4 commits into from Apr 9, 2025
Merged

Update GlobalDataStore.yaml #1069

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
298c078
Update GlobalDataStore.yaml
Apr 6, 2025
6df8b77
Update GlobalDataStore.yaml
IgnisRBX Apr 8, 2025
c493d3d
Merge branch 'main' into patch-2
IgnisRBX Apr 8, 2025
96c696a
Merge branch 'main' into patch-2
IgnisRBX Apr 9, 2025
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
31 changes: 13 additions & 18 deletions content/en-us/reference/engine/classes/GlobalDataStore.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,10 @@ methods:
This function increments the value of a key by the provided amount (both
must be integers).

`Class.OrderedDataStore` does not support versioning, so calling this
method on an `Class.OrderedDataStore` key will overwrite the current value
Values in `Class.GlobalDataStore|GlobalDataStores` are **versioned** as outlined
in [versioning](../../../cloud-services/data-stores/versioning-listing-and-caching.md#versioning).
`Class.OrderedDataStore|OrderedDataStores` do not support versioning, so calling this
method on an ordered data store key will overwrite the current value
with the incremented value and make previous versions inaccessible.
code_samples:
parameters:
Expand Down Expand Up @@ -221,14 +223,10 @@ methods:
This function sets the latest value, `Class.Player.UserId|UserIds`, and
metadata for the given key.

Values in data stores are versioned, meaning
`Class.GlobalDataStore:SetAsync()` will create a new version every time it
is called. Prior versions can be accessed through
`Class.DataStore:ListVersionsAsync()`/`Class.DataStore:GetVersionAsync()`
for up to 30 days at which point they are permanently deleted.

`Class.OrderedDataStore` does not support versioning, so calling this
method on an `Class.OrderedDataStore` key will overwrite the current value
Values in `Class.GlobalDataStore|GlobalDataStores` are **versioned** as outlined
in [versioning](../../../cloud-services/data-stores/versioning-listing-and-caching.md#versioning).
`Class.OrderedDataStore|OrderedDataStores` do not support versioning, so calling this
method on an ordered data store key will overwrite the current value
and make previous versions inaccessible.

Metadata definitions must always be updated with a value, even if there
Expand Down Expand Up @@ -302,14 +300,11 @@ methods:
specified through the second parameter. If the callback returns `nil`, the
write operation is cancelled and the value remains unchanged.

If the update succeeds, a new version of the value will be created and
prior versions will remain accessible through
`Class.DataStore:ListVersionsAsync()` and
`Class.DataStore:GetVersionAsync()`.

`Class.OrderedDataStore` does not support versioning, so calling this
function on an `Class.OrderedDataStore` key will overwrite the current
value and make previous versions inaccessible.
Values in `Class.GlobalDataStore|GlobalDataStores` are **versioned** as outlined
in [versioning](../../../cloud-services/data-stores/versioning-listing-and-caching.md#versioning).
`Class.OrderedDataStore|OrderedDataStores` do not support versioning, so calling this
method on an ordered data store key will overwrite the current value
and make previous versions inaccessible.

In cases where another game server updated the key in the short timespan
between retrieving the key's current value and setting the key's value,
Expand Down