Engine

OrderedDataStore

Show Deprecated
not creatable
not replicated

A OrderedDataStore is essentially a GlobalDataStore with the exception that stored values must be positive integers. It exposes a method GetSortedAsync() which allows inspection of the entries in sorted order using a DataStorePages object.

See Data Stores for an overview on using ordered data stores.

Code Samples

OrderedDataStore Basics

local DataStoreService = game:GetService("DataStoreService")
local pointsStore = DataStoreService:GetOrderedDataStore("Points")
local function printTopTenPlayers()
local isAscending = false
local pageSize = 10
local pages = pointsStore:GetSortedAsync(isAscending, pageSize)
local topTen = pages:GetCurrentPage()
-- The data in 'topTen' is stored with the index being the index on the page
-- For each item, 'data.key' is the key in the OrderedDataStore and 'data.value' is the value
for rank, data in ipairs(topTen) do
local name = data.key
local points = data.value
print(name .. " is ranked #" .. rank .. " with " .. points .. "points")
end
-- Potentially load the next page...
--pages:AdvanceToNextPageAsync()
end
-- Create some data
pointsStore:SetAsync("Alex", 55)
pointsStore:SetAsync("Charley", 32)
pointsStore:SetAsync("Sydney", 68)
-- Display the top ten players
printTopTenPlayers()

Summary

Methods

Methods inherited from GlobalDataStore

Properties

Methods

GetSortedAsync

yields

Returns a DataStorePages object. The sort order is determined by ascending, the length of each page by pageSize, and minValue/maxValue are optional parameters which filter the results.

See Data Stores for request limits and descriptions of the error codes.

Parameters

ascending: bool

A boolean indicating whether the returned data pages are in ascending order.

pagesize: number

The length of each page. By default is 50. The max allowed value is 100.

minValue: Variant

Optional parameter. If set, data pages with a value less than than minValue will be excluded.

maxValue: Variant

Optional parameter. If set, data pages with a value greater than maxValue will be excluded.


Returns

A sorted DataStorePages object based on the provided arguments.

Events