API:Class/DataStoreService

Server only:This service is server-side only! You should use a Script instead of a LocalScript when using it.
Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Service: This class is a service. It is a top-level singleton which can be obtained with the GetService method.
Uncreatable: This object cannot be created with Instance.new.

ExplorerImageIndex69.pngDataStoreService : Object Icon.pngInstance

The DataStoreService is a service that stores data across multiple user created places. More can be read about Data Stores in the DataStore manual.

Properties

PropertiesmemberhiddenProperties [toggle]

boolAutomaticRetry [LocalUserSecurity]

Sets whether DataStore functions will automatically retry or not.

|RMD member="API:Class/DataStoreService/AutomaticRetry"|Sets whether DataStore functions will automatically retry or not.|/RMD|
boolLegacyNamingScheme [LocalUserSecurity] [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/DataStoreService/LegacyNamingScheme"|Deprecated. Do not use.|/RMD|
AutomaticRetry [LocalUserSecurity]
Sets whether DataStore functions will automatically retry or not.
LegacyNamingScheme [LocalUserSecurity] [deprecated]
Deprecated. Do not use.

Functions

Functions [toggle]

GlobalDataStoreGetDataStore ( string name, string scope = "global" )

Returns a data store with the given name and scope.

|RMD member="API:Class/DataStoreService/GetDataStore"|Returns a data store with the given name and scope.|/RMD|
GlobalDataStoreGetGlobalDataStore ( )

Returns the default data store.

|RMD member="API:Class/DataStoreService/GetGlobalDataStore"|Returns the default data store.|/RMD|
OrderedDataStoreGetOrderedDataStore ( string name, string scope = "global" )

Returns an ordered data store with the given name and scope.

|RMD member="API:Class/DataStoreService/GetOrderedDataStore"|Returns an ordered data store with the given name and scope.|/RMD|
intGetRequestBudgetForRequestType ( DataStoreRequestType requestType )

Returns the number of requests that can be made by the given request type.

|RMD member="API:Class/DataStoreService/GetRequestBudgetForRequestType"|Returns the number of requests that can be made by the given request type.|/RMD|
GetDataStore ( string name, string scope = "global" )
Returns a data store with the given name and scope.
Returns the default data store.
GetOrderedDataStore ( string name, string scope = "global" )
Returns an ordered data store with the given name and scope.
Returns the number of requests that can be made by the given request type.


|RMD member="API:Class/DataStoreService"|The DataStoreService is a service that stores data across multiple user created places. More can be read about Data Stores in the DataStore manual. |/RMD|