DataStore

显示已弃用

*此内容使用人工智能(Beta)翻译,可能包含错误。若要查看英文页面,请点按 此处

无法创建
未复制

请参阅数据存储

概要

方法

继承自GlobalDataStore方法

属性

方法

GetVersionAsync

暂停

此函数还会检索一个 DataStoreKeyInfo 实例,其版本识别器可以通过 DataStore:ListVersionsAsync() 或 alternatively是返回 GlobalDataStore:SetAsync() 的返回。

参数

key: string

版本信息所需的钥匙名称。如果 DataStoreOptions.AllScopes 设置为 true 使用 DataStoreService:GetDataStore() 访问数据存储时,此钥匙名必须与原始范围一起使用,如在 "范围/键" 中。

version: string

版本信息所需的钥匙的版本号。


返回

在指定版本的钥匙的值和一个 DataStoreKeyInfo 实例,包括版本号、日期和时间版本创建,以及恢复UserIds和元数据的功能。

ListKeysAsync

暂停

此函数返回一个 DataStoreKeyPages 对象,用于通过数据存储商店的钥匙列表进行枚列。它接受一个可选的 prefix 参数,用于仅找到始于指定前缀的钥匙。

如果 DataStoreOptions.AllScopes 设置为 true 使用 DataStoreService:GetDataStore() 访问数据存储时,钥匙将以所有范围作为前缀返回。

参数

prefix: string

(可选) 用于找到钥匙的前缀。

默认值:""
pageSize: number

(可选) 最多可以返回的物品数量。

默认值:0
cursor: string

(可选) 鼠标指针来继续循环。

默认值:""
excludeDeleted: bool

(可选) 排除已删除的钥匙从返回。

启用时,ListKeys 可检查到 512 个钥匙。如果所有检查的钥匙都被删除,它将返回一个空列表,用户名称继续循环。

默认值:false

返回

一个 DataStoreKeyPages 实例,该实例列出为 DataStoreKey 实例。

ListVersionsAsync

暂停

此函数可以在 Enum.SortDirection 参数指定的上升或下降顺序列出指定的钥匙的版本。它可以选择最小和最大时戳来过滤返回的版本。

参数

key: string

列出版本的钥匙名。如果 DataStoreOptions.AllScopes 设置为 true 使用 DataStoreService:GetDataStore() 访问数据存储时,此钥匙名必须与原始范围一起使用,如果在 "范围/键" 中使用 " scope/key" 。

sortDirection: Enum.SortDirection

列表的排序顺序可以指定为上升或下降。

默认值:"Ascending"
minDate: number

在毫秒后的 UNIX 时戳后,版本应该列出。

默认值:0
maxDate: number

在毫秒内以 Unix 时戳开始列出版本。

默认值:0
pageSize: number

每个页面将返回的物品数量。

默认值:0

返回

一个 DataStoreVersionPages 实例,该实例列出所有版本的钥匙为 DataStoreObjectVersionInfo 实例。

代码示例

Retrieving DataStore Versions With A Date Filter

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
end

RemoveVersionAsync

void
暂停

此功能永久删除指定版本的键匙。版本识别器可以通过 DataStore:ListVersionsAsync() 找到。

GlobalDataStore:RemoveAsync() 不同,此函数不会创建新的“墓石”版本,且删除的值不能在后续恢复。

参数

key: string

版本号称为要移除的版本。如果 DataStoreOptions.AllScopes 设置为 true 使用 DataStoreService:GetDataStore() 访问数据存储时,此键名必须与原始范围一起使用,因为在 "范围/键" 中,它的前头必须是 "范围" 。

version: string

移除钥匙的版本号。


返回

void

活动