DataStoreService

DataStoreService
Not creatableThis class cannot be instantiated. ServiceThis class is a service. Not replicatedThis class is not replicated.
Icon
Added in	132 (December 2013)
Memory category	Instances
Inheritance
Object Instance DataStoreService

Responsible for storing data across multiple user created places. This class cannot be instantiated. It was added on December 12, 2013.

Properties

AutomaticRetry: bool

• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:DataStoreService/AutomaticRetry.

• Category: Behavior.
• Read security: LocalUserSecurity.
• Write security: LocalUserSecurity.
• Serialization: can save and load.
• Thread safety: read safe

LegacyNamingScheme: bool

• HiddenThis property is not shown in the object browser and properties window.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:DataStoreService/LegacyNamingScheme.

• Category: Behavior.
• Read security: LocalUserSecurity.
• Write security: LocalUserSecurity.
• Serialization: can save and load.
• Thread safety: read safe

Methods

GetDataStore(name: string, scope: string = global, options: Instance = nil): DataStore

Parameters

Name	Type	Default
name	string
scope	string	global
options	Instance	nil

• Thread safety: unsafe

GetGlobalDataStore(): DataStore

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:DataStoreService/GetGlobalDataStore.

• Thread safety: unsafe

GetOrderedDataStore(name: string, scope: string = global): OrderedDataStore

Parameters

Name	Type	Default
name	string
scope	string	global

• Thread safety: unsafe

GetRequestBudgetForRequestType(requestType: DataStoreRequestType): int

Parameters

Name	Type
requestType	DataStoreRequestType

• Thread safety: unsafe

ListDataStoresAsync(prefix: string = , pageSize: int = 0, cursor: string = ): DataStoreListingPages

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
prefix	string
pageSize	int	0
cursor	string

• Thread safety: unsafe

Removed members

Methods

• GetDataFromEmptyScopeDataStoreAsyncTemporary

External links

• DataStoreService in the Roblox Creator Documentation
• DataStoreService in the Roblox API Reference