請參閱 資料儲存 。
概要
方法
取回指定的鑰匙版本。
- ListKeysAsync(prefix : string,pageSize : number,cursor : string,excludeDeleted : bool):DataStoreKeyPages
返回 DataStoreKeyPages 個對象,以鍵匙列表通過資料存取商商店 商家的鍵匙進行列索。
- ListVersionsAsync(key : string,sortDirection : Enum.SortDirection,minDate : number,maxDate : number,pageSize : number):DataStoreVersionPages
列出所有鑰鍵的所有版本。
永久刪除鑰鍵的指定版本。
返回指定資料存取中的鑰匙值,並且是 DataStoreKeyInfo 個實個體、實例。
- IncrementAsync(key : string,delta : number,userIds : Array,options : DataStoreIncrementOptions):Variant
增加鑰匙的值提供的數量(必須是整數)。
保留可用版本,同時移除指定的鑰匙。
設定資料存取對應的鑰鍵的數據存取值。
更新鑰鍵的值,以從指定的回撥函數中的新值。
屬性
方法
GetVersionAsync
此功能會擷取指定的鑰匙版本以及一個 DataStoreKeyInfo 實個體、實例。版本標識器可以通過 DataStore:ListVersionsAsync() 或 alternatively是由 GlobalDataStore:SetAsync() 返回的。
參數
要求版本資訊的鑰匙名稱。如果 DataStoreOptions.AllScopes 設為 true 在使用資料存取服務過程中通過 DataStoreService:GetDataStore() ,此鑰匙名稱必須與原始範圍相同。
版本資訊的鑰匙的版本號。
返回
值在指定版本和含有版本號、日期和時間、版本創建時間和功能的 DataStoreKeyInfo 實例。
ListKeysAsync
此功能返回一个 DataStoreKeyPages 對象,用於瀏覽數商店 商家存取的鑰匙。它接受一個可選的 prefix 參數,用於僅限於擁有指定樣式的名稱開始。
如果 DataStoreOptions.AllScopes 設為 true 時,鍵將在使用 DataStoreService:GetDataStore() 存取資料存儲時返回。
參數
(可選) 預設值用於查找鑰匙。
(可選) 最大可以返回的項目數量。
(可選) 滑鼠指針以繼續執行。
(可選) 排除已刪除的鑰匙。
啟用時,ListKeys 可檢查高達 512 個鑰匙。如果所有鑰匙都被刪除,它將返回一個空清單,並且以符號返回以繼續執行。
返回
一個 DataStoreKeyPages 實例,其中列出為 DataStoreKey 個實例。
ListVersionsAsync
此功能以 Enum.SortDirection 參數指定的上升或下降順序列出指定鑰匙的版本。它可以選擇最小和最大時間皆準的版本。
參數
版本列表的鑰匙名稱。如果 DataStoreOptions.AllScopes 設為 true 從存取資料存取店過程中使用 Class.DataStoreService:GetDataStore() ,此鑰匙名稱必須與原始範圍相同。如果在 "鑰匙/鑰匙" 中使用 ,鑰匙名稱將以原始範圍的前置字串來設定。
枚列指定排序順序。
在毫秒後的 UNIX 標準時間後,版本應該被列出。
升級到毫秒後的 UNIX 時間戳,以便列出版本。
每個頁面將返回的物品數量。
返回
一個 DataStoreVersionPages 實例,其中列出所有版本的鑰匙為 DataStoreObjectVersionInfo 實例。
範例程式碼
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
此功能永久刪除指定版本的鑰鍵。版本標識可以通過 DataStore:ListVersionsAsync() 找到。
與 GlobalDataStore:RemoveAsync() 不同,此功能不會創建新的 "tombstone" 版本,且已移除的值無法在後期取回。
參數
版本中要移除的鑰匙名稱。如果 DataStoreOptions.AllScopes 設置為 true 在使用資料存取服務過程中通過 DataStoreService:GetDataStore() 時,此鑰匙名稱必須與原始範圍相同。如果 Class.DataStoreOptions.AllScopes 設置為 false ,此鑰匙名稱必須以原始範圍的樣式來命名
鑰匙的版本數來移除。