DataStore
See Data Stores.
概要
方法
- イールド
Retrieves the specified key version.
- ListKeysAsync(prefix : string,pageSize : number,cursor : string,excludeDeleted : bool):DataStoreKeyPagesイールド
Returns a DataStoreKeyPages object for enumerating through keys of a data store.
- ListVersionsAsync(key : string,sortDirection : Enum.SortDirection,minDate : number,maxDate : number,pageSize : number):DataStoreVersionPagesイールド
Enumerates all versions of a key.
- イールド
Permanently deletes the specified version of a key.
- イールド
Returns the value of a key in a specified data store and a DataStoreKeyInfo instance.
- IncrementAsync(key : string,delta : number,userIds : Array,options : DataStoreIncrementOptions):Variantイールド
Increments the value of a key by the provided amount (both must be integers).
- イールド
Removes the specified key while also retaining an accessible version.
- イールド
Sets the value of the data store for the given key.
- イールド
Updates a key's value with a new value from the specified callback function.
プロパティ
方法
GetVersionAsync
This function retrieves the specified key version as well as a DataStoreKeyInfo instance. A version identifier can be found through DataStore:ListVersionsAsync() or alternatively be the identifier returned by GlobalDataStore:SetAsync().
パラメータ
Key name for which the version info is requested. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in "scope/key".
Version number of the key for which the version info is requested.
戻り値
The value of the key at the specified version and a DataStoreKeyInfo instance that includes the version number, date and time the version was created, and functions to retrieve UserIds and metadata.
ListKeysAsync
This function returns a DataStoreKeyPages object for enumerating through keys of a data store. It accepts an optional prefix parameter to only locate keys whose names start with the provided prefix.
If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), keys will be returned with all scopes as prefixes.
パラメータ
(Optional) Prefix to use for locating keys.
(Optional) Maximum possible number of items that can be returned. The default is 50.
(Optional) Cursor to continue iteration.
(Optional) Exclude deleted keys from being returned.
When enabled ListKeys will check up to 512 keys. If all checked keys are deleted then it will return an empty list with a cursor to continue iteration.
戻り値
A DataStoreKeyPages instance that enumerates the keys as DataStoreKey instances.
ListVersionsAsync
This function enumerates versions of the specified key in either ascending or descending order specified by a Enum.SortDirection parameter. It can optionally filter the returned versions by minimum and maximum timestamp.
パラメータ
Key name for the versions to list. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in "scope/key".
Enum specifying ascending or descending sort order.
Date after which the versions should be listed.
Date up to which the versions should be listed.
Number of items to be returned in each page. By default is 1024.
戻り値
A DataStoreVersionPages instance that enumerates all the versions of the key as DataStoreObjectVersionInfo instances.
コードサンプル
local DataStoreService = game:GetService("DataStoreService")
local experienceStore = DataStoreService:GetDataStore("PlayerExperience")
local time = DateTime.fromUniversalTime(2020, 10, 09, 01, 42)
local listSuccess, pages = pcall(function()
return experienceStore:ListVersionsAsync("User_1234", nil, time.UnixTimestampMillis)
end)
if listSuccess then
local items = pages:GetCurrentPage()
for key, info in pairs(items) do
print("Key:", key, "; Version:", info.Version, "; Created:", info.CreatedTime, "; Deleted:", info.IsDeleted)
end
endRemoveVersionAsync
This function permanently deletes the specified version of a key. Version identifiers can be found through DataStore:ListVersionsAsync().
Unlike GlobalDataStore:RemoveAsync(), this function does not create a new "tombstone" version and the removed value cannot be retrieved later.
パラメータ
Key name for which a version is to be removed. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in "scope/key".
Version number of the key to remove.