DataStore
*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.
Veja Armazenamentos de Dados.
Resumo
Métodos
Recupera a versão de chave especificada.
Recupera a versão de chave que estava ativa em um determinado momento.
- ListKeysAsync(prefix : string,pageSize : number,cursor : string,excludeDeleted : boolean):DataStoreKeyPages
Retorna um objeto DataStoreKeyPages para enumerar através de chaves de um lojade dados.
- ListVersionsAsync(key : string,sortDirection : Enum.SortDirection,minDate : number,maxDate : number,pageSize : number):DataStoreVersionPages
Enumera todas as versões de uma chave.
Exclui permanentemente a versão especificada de uma chave.
Retorna o valor de uma chave em um armazenamento de dados especificado e uma instância DataStoreKeyInfo .
- IncrementAsync(key : string,delta : number,userIds : Array,options : DataStoreIncrementOptions):Variant
Aumenta o valor de uma chave pelo valor fornecido (ambos devem ser inteiros).
Remove a chave especificada enquanto também mantém uma versão acessível.
Define o valor do armazenamento de dados para a chave dada.
Atualiza o valor de uma chave com um novo valor da função de chamada especificada.
Propriedades
Métodos
GetVersionAsync
Essa função recupera a versão de chave especificada, bem como uma instância DataStoreKeyInfo .Um identificador de versão pode ser encontrado através de DataStore:ListVersionsAsync() ou, alternativamente, ser o identificador retornado por GlobalDataStore:SetAsync().
Parâmetros
Nome da chave para a qual a informação de versão é solicitada.Se DataStoreOptions.AllScopes for definido como verdadeiro ao acessar o armazenamento de dados através de DataStoreService:GetDataStore(), este nome de chave deve ser precedido pelo escopo original como em "scope/key".
Número de versão da chave para a qual a informação de versão é solicitada.
Devolução
O valor da chave na versão especificada e uma instância DataStoreKeyInfo que inclui o número de versão, data e hora em que a versão foi criada e funções para recuperar UserIds e metadados.
GetVersionAtTimeAsync
Essa função recupera a versão de chave que estava ativa em um determinado momento, bem como uma instância DataStoreKeyInfo .
Parâmetros
Nome da chave para a qual a informação de versão é solicitada.Se DataStoreOptions.AllScopes for definido como verdadeiro ao acessar o armazenamento de dados através de DataStoreService:GetDataStore(), este nome de chave deve ser precedido pelo escopo original como em "scope/key".
timestamp do Unix em milisegundos para o qual a versão solicitada estava atual.Deve ser maior que zero.Não deve ser mais de dez minutos no futuro.
Devolução
O valor da chave que estava ativo no momento especificado e uma instância DataStoreKeyInfo que inclui o número de versão, data e hora em que a versão foi criada e funções para recuperar UserIds e metadados.nil se nenhuma versão disponível estiver ativa no momento solicitado.
Amostras de código
The following code sample retrieves data store key versions using timestamps.
local DataStoreService = game:GetService("DataStoreService")
local dataStore = DataStoreService:GetDataStore("DataStore")
local key = "key-123"
function setData(data)
local success, result = pcall(function()
dataStore:SetAsync(key, data)
end)
if not success then
warn(result)
end
end
function getVersionAtTime(timestamp)
local success, result, keyInfo = pcall(function()
return dataStore:GetVersionAtTimeAsync(key, timestamp.UnixTimestampMillis)
end)
if success then
if result == nil then
print("No version found at time")
else
print(result, keyInfo.Version)
end
else
warn(result)
end
end
-- Previously ran at 2024/12/02 6:00 UTC
setData("version 1")
-- Previously ran at 2024/12/02 9:00 UTC
setData("version 2")
-- Prints "No version found at time"
local time1 = DateTime.fromUniversalTime(2024, 12, 02, 05, 00)
getVersionAtTime(time1)
-- Prints "version 1 <version>"
local time2 = DateTime.fromUniversalTime(2024, 12, 02, 07, 00)
getVersionAtTime(time2)
-- Prints "version 2 <version>"
local time3 = DateTime.fromUniversalTime(2024, 12, 02, 10, 00)
getVersionAtTime(time3)ListKeysAsync
Essa função retorna um objeto DataStoreKeyPages para enumerar através de chaves de um lojade dados.Ele aceita um parâmetro opcional prefix opcional para localizar apenas chaves cujos nomes começam com o prefixo fornecido.
Se DataStoreOptions.AllScopes for definido como verdadeiro ao acessar o armazenamento de dados através de DataStoreService:GetDataStore(), as chaves serão retornadas com todos os escopos como prefixos.
Parâmetros
(Opcional) Prefixo para usar para localizar chaves.
(Opcional) Número de itens a serem retornados em cada página.Se nenhum valor for dado, o motor envia um valor padrão de 0 para o serviço de armazenamento de dados na web, que, por sua vez, padrãoiza 50 itens por página.
(Opcional) Cursor para continuar a iteração.
(Opcional) Excluir chaves excluídas de serem retornadas.
Quando ativado, os ListKeys verificarão até 512 chaves.Se todas as chaves selecionadas forem excluídas, então retornará uma lista vazia com um cursor para continuar a iteração.
Devolução
Uma instância DataStoreKeyPages que enumera as chaves como DataStoreKey instâncias.
ListVersionsAsync
Essa função lista versões da chave especificada em ordem ascendente ou descendente especificada por um parâmetro Enum.SortDirection.Pode opcionalmente filtrar as versões retornadas por data de registro mínima e máxima.
Parâmetros
Nome da chave para as versões a listar.Se DataStoreOptions.AllScopes for definido como verdadeiro ao acessar o armazenamento de dados através de DataStoreService:GetDataStore(), este nome de chave deve ser precedido pelo escopo original como em "scope/key".
(Opcional) Enum especificando ordem de classificação ascendente ou descendente.
(Opcional) Unix timestamp em milisegundos após o qual as versões devem ser listadas.
(Opcional) Unix timestamp em milisegundos até o qual as versões devem ser listadas.
(Opcional) Número de itens a serem retornados em cada página.Se nenhum valor for dado, o motor envia um valor padrão de 0 para o serviço de armazenamento de dados na web, que, por sua vez, padrãoiza para 1024 itens por página.
Devolução
Uma instância DataStoreVersionPages que enumera todas as versões da chave como DataStoreObjectVersionInfo instâncias.
Amostras de código
The following code sample retrieves all versions after a specified starting time, sorted in ascending order.
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
Essa função exclui permanentemente a versão especificada de uma chave. Os identificadores de versão podem ser encontrados através de DataStore:ListVersionsAsync() .
Ao contrário de GlobalDataStore:RemoveAsync(), esta função não cria uma nova versão de "lápide" e o valor removido não pode ser recuperado mais tarde.
Parâmetros
Nome da chave para a qual uma versão deve ser removida.Se DataStoreOptions.AllScopes for definido como verdadeiro ao acessar o armazenamento de dados através de DataStoreService:GetDataStore(), este nome de chave deve ser precedido pelo escopo original como em "scope/key".
Número de versão da chave para remover.