Skip to content

DataStoreOptions

DataStore 获取存储集合的额外选项,在 GetDataStore / GetOrderedDataStore 时传入,可通过 DataStoreOptions.New() 构造。

概览

DataStoreOptions 是获取 DataStore 或 OrderedDataStore 句柄时传入的实例级默认选项,后续读写方法未传入自己的 options 时会使用这些默认值。

可通过 DataStoreOptions.New() 构造

代码示例

构造选项

lua
-- @runtime client
local opts = DataStoreOptions.New()

属性

名称类型默认值说明
AllScopesBoolfalse控制数据存储操作是否跨范围(Scope)处理数据。
WithKeyInfoBoolfalse控制数据存储操作是否同时返回包含版本号、创建和修改日期、用户标识及元数据的 DataStoreKeyInfo 信息。
KeepOldMetasBooltrue控制更新数据条目时是否保留旧有元数据。
ExcludeDeletedBoolfalse控制查询或列表操作是否排除已标记为删除的条目。
UseCacheBoolfalse控制数据存储操作是否使用缓存。
PermanentlyRemoveBoolfalse控制删除操作是永久删除还是软删除。
UpdateTimeAscBooltrue控制在按更新时间排序的结果中是否使用升序排列。