ListVersionsAsync

Yields

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

DataStore

Description:

This function enumerates versions of the specified key in either ascending or descending order specified by a Enum/SortDirection parameter. It can optionally filter the returned versions by minimum and maximum timestamp.

Parameters

Name	Type	Default	Description
Name key	Type string	Default	Summary Key name for the versions to list. If `DataStoreOptions/AllScopes` was set to true when accessing the data store through `DataStoreService/GetDataStore`, this key name must be prepended with the original scope as in “scope/key”.
Name sortDirection	Type SortDirection	Default Ascending	Summary Enum specifying ascending or descending sort order.
Name minDate	Type int64	Default 0	Summary Date after which the versions should be listed.
Name maxDate	Type int64	Default 0	Summary Date up to which the versions should be listed.
Name pageSize	Type int	Default 0	Summary Number of items to be returned in each page.

Returns

Return Type	Summary
Return Type DataStoreVersionPages	Summary A `DataStoreVersionPages` instance that enumerates all the versions of the key as `DataStoreObjectVersionInfo` instances.

Code Samples

Retrieving DataStore Versions With A Date Filter

The following code sample retrieves all versions after a specified starting time, sorted in ascending order.

			
				Retrieving DataStore Versions With A Date Filter

				Expected Output
			
				Expand
				
			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
		
				Copy Code
			
				Light Theme

ListVersionsAsync

See Also

Parameters

key

sortDirection

minDate

maxDate

pageSize

Returns

DataStoreVersionPages

Code Samples

Retrieving DataStore Versions With A Date Filter