DataStoreService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This class is a service. It is a singleton that may be acquired with GetService.

This item is not replicated. Its interface does not cross the network boundary.

Memory Category	Instances

Tags: [NotCreatable, Service, NotReplicated]

Inherits (1)

Instance

Member index (7)

Type	Member	History
bool	AutomaticRetry	306
bool	LegacyNamingScheme	155 292 469
GlobalDataStore	GetDataStore (string name, string scope = global, Instance options = nil)	137 453 453 452 452 463 483
GlobalDataStore	GetGlobalDataStore ()	483
OrderedDataStore	GetOrderedDataStore (string name, string scope = global)	138 483
int	GetRequestBudgetForRequestType (DataStoreRequestType requestType)	288
DataStoreListingPages	ListDataStoresAsync (string prefix = , int pageSize = 0, string cursor = )	453 452 463 483 489 548
57 members inherited from Instance

Removed member index (1)

Type		Member	History
Variant		GetDataFromEmptyScopeDataStoreAsyncTemporary (string name, string key)	452 478

548 Change Parameters of DataStoreService.ListDataStoresAsync from (string prefix = , int pageSize = 0) to (string prefix = , int pageSize = 0, string cursor = )
489 Change ReturnType of DataStoreService.ListDataStoresAsync from DataStoreEnumerationPages to DataStoreListingPages
483 Change ReturnType of DataStoreService.GetDataStore from Instance to GlobalDataStore
483 Change ReturnType of DataStoreService.GetGlobalDataStore from Instance to GlobalDataStore
483 Change ReturnType of DataStoreService.GetOrderedDataStore from Instance to OrderedDataStore
483 Change ReturnType of DataStoreService.ListDataStoresAsync from Instance to DataStoreEnumerationPages
478 Remove DataStoreService.GetDataFromEmptyScopeDataStoreAsyncTemporary
469 Change Tags of DataStoreService.LegacyNamingScheme from [Deprecated] to [Hidden, Deprecated]
463 Change Parameters of DataStoreService.GetDataStore from (string name, string scope = global) to (string name, string scope = global, Instance options = nil)
463 Add DataStoreService.ListDataStoresAsync
452 Add DataStoreService.GetDataFromEmptyScopeDataStoreAsyncTemporary
452 Change Parameters of DataStoreService.GetDataStore from (string name, Variant scope, Instance options = nil) to (string name, string scope = global)
452 Change Tags of DataStoreService.GetDataStore from [Yields] to []
452 Remove DataStoreService.ListDataStoresAsync
453 Change Parameters of DataStoreService.GetDataStore from (string name, string scope = global) to (string name, Variant scope, Instance options = nil)
453 Change Tags of DataStoreService.GetDataStore from [] to [Yields]
453 Add DataStoreService.ListDataStoresAsync
306 Add DataStoreService.AutomaticRetry
292 Change Tags of DataStoreService.LegacyNamingScheme from [] to [Deprecated]
288 Add DataStoreService.GetRequestBudgetForRequestType
155 Add DataStoreService.LegacyNamingScheme
138 Add DataStoreService.GetOrderedDataStore
137 Add DataStoreService.GetDataStore
132 Add DataStoreService

Members

AutomaticRetry On DevHub

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Security	LocalUserSecurity
Category	Behavior
Can Load	true
Can Save	true

History

306 Add DataStoreService.AutomaticRetry

Tags: [NotReplicated]

GetDataStore On DevHub

Parameters	3

Name	Type	Default
name	string	none
scope	string	global
options	Instance	nil

Return Type	GlobalDataStore

History

483 Change ReturnType of DataStoreService.GetDataStore from Instance to GlobalDataStore
463 Change Parameters of DataStoreService.GetDataStore from (string name, string scope = global) to (string name, string scope = global, Instance options = nil)
452 Change Parameters of DataStoreService.GetDataStore from (string name, Variant scope, Instance options = nil) to (string name, string scope = global)
452 Change Tags of DataStoreService.GetDataStore from [Yields] to []
453 Change Parameters of DataStoreService.GetDataStore from (string name, string scope = global) to (string name, Variant scope, Instance options = nil)
453 Change Tags of DataStoreService.GetDataStore from [] to [Yields]
137 Add DataStoreService.GetDataStore

GetGlobalDataStore On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	GlobalDataStore

History

483 Change ReturnType of DataStoreService.GetGlobalDataStore from Instance to GlobalDataStore

GetOrderedDataStore On DevHub

Parameters	2

Name	Type	Default
name	string	none
scope	string	global

Return Type	OrderedDataStore

History

483 Change ReturnType of DataStoreService.GetOrderedDataStore from Instance to OrderedDataStore
138 Add DataStoreService.GetOrderedDataStore

GetRequestBudgetForRequestType On DevHub

Parameters	1

Name	Type	Default
requestType	DataStoreRequestType	none

Return Type	int

History

288 Add DataStoreService.GetRequestBudgetForRequestType

LegacyNamingScheme On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	bool
Security	LocalUserSecurity
Category	Behavior
Can Load	true
Can Save	true

History

469 Change Tags of DataStoreService.LegacyNamingScheme from [Deprecated] to [Hidden, Deprecated]
292 Change Tags of DataStoreService.LegacyNamingScheme from [] to [Deprecated]
155 Add DataStoreService.LegacyNamingScheme

Tags: [Hidden, Deprecated]

ListDataStoresAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	3

Name	Type	Default
prefix	string
pageSize	int	0
cursor	string

Return Type	DataStoreListingPages

History

548 Change Parameters of DataStoreService.ListDataStoresAsync from (string prefix = , int pageSize = 0) to (string prefix = , int pageSize = 0, string cursor = )
489 Change ReturnType of DataStoreService.ListDataStoresAsync from DataStoreEnumerationPages to DataStoreListingPages
483 Change ReturnType of DataStoreService.ListDataStoresAsync from Instance to DataStoreEnumerationPages
463 Add DataStoreService.ListDataStoresAsync
452 Remove DataStoreService.ListDataStoresAsync
453 Add DataStoreService.ListDataStoresAsync

Tags: [Yields]

Removed members

GetDataFromEmptyScopeDataStoreAsyncTemporary

This function yields. It will block the calling thread until completion.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
name	string	none
key	string	none

Return Type	Variant

Roblox API Reference

DataStoreService On DevHub

Summary

Inherits (1)

Member index (7)

Removed member index (1)

History

Members

AutomaticRetry On DevHub

History

GetDataStore On DevHub

History

GetGlobalDataStore On DevHub

History

GetOrderedDataStore On DevHub

History

GetRequestBudgetForRequestType On DevHub

History

LegacyNamingScheme On DevHub

History

ListDataStoresAsync On DevHub

History

Removed members

GetDataFromEmptyScopeDataStoreAsyncTemporary

History

Relevant classes (4)

Relevant enums (1)