Skip to content

DataStoreKeyBriefInfo

概览

字段
KindData · 数据 Data
Realmserver

DataStoreKeyBriefInfo 是 DataStore:ListKeysAsync 返回的 key 摘要条目,包含 Scope、Key 和 IsDeleted。

适用场景

在服务端分页巡检某个 DataStore 的 key 时,快速读取 key 名、所属 scope 和删除状态。

使用要点

先通过 DataStoreService:GetDataStore 获取 DataStore,再调用 dataStore:ListKeysAsync 获得 DataStoreKeyBriefInfoPages;从 pages:GetCurrentPage() 返回的数组中读取条目。

注意事项

该对象不可直接构造,必须通过数据存储的列表操作获得。IsDeleted 属性仅表示键是否被标记为删除,不代表数据已物理清除。

代码示例

读取 key 摘要条目

lua
-- @runtime server
local DataStoreService = game:GetService('DataStoreService')
local Task = game:GetService('Task')
local dataStore = DataStoreService:GetDataStore('PlayerData', 'global')

Task:Spawn(function()
    local pages = dataStore:ListKeysAsync('player_', 10)
    for _, briefInfo in ipairs(pages:GetCurrentPage()) do
        print(briefInfo.Scope, briefInfo.Key, briefInfo.IsDeleted)
    end
end)

属性 (3)

Name类型默认值说明
ScopeString""该键所属的作用域。
KeyString""数据存储中该键的名称。
IsDeletedBoolfalse表示该键是否已被标记为删除。