Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
DataStoreService
Inherits from: Instance → Object
DataStoreService exposes methods for getting GlobalDataStore and OrderedDataStore objects. Data stores can only be accessed by game servers, so you can only use DataStoreService within a Script or a ModuleScript that is used by a Script.
See Data stores for an in-depth guide on data structure, management, error handling, limits, and more.
Inherits from: Instance
Memory category: Instances
Tags: NotCreatable, Service, NotReplicated
Code samples: View on Creator Hub (DataStore-Budget).
Methods
| Name | Type / Returns | Description |
|---|---|---|
| DataStoreService:GetDataStore | DataStore | Creates a DataStore instance with the provided name and scope. |
| DataStoreService:GetGlobalDataStore | DataStore | Returns the default data store. |
| DataStoreService:GetOrderedDataStore | OrderedDataStore | Get an OrderedDataStore given a name and optional scope. |
| DataStoreService:GetRequestBudgetForRequestType | int | Returns the number of requests that can be made by the given request type. |
| DataStoreService:ListDataStoresAsync | DataStoreListingPages | Returns a DataStoreListingPages object for enumerating through all of the experience's data stores. |
| DataStoreService:SetRateLimitForRequestType | () | Sets the rate limit for a given request type per minute. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
DataStoreService:GetDataStore
This function creates a DataStore instance with the provided name and scope. Subsequent calls to this method with the same name/scope will return the same object.
Using the scope parameter will restrict operations to that scope by automatically prepending the scope to keys in all operations done on the data store. This function also accepts an optional DataStoreOptions instance which includes options for enabling AllScopes. See Versioning, listing, and caching for details on scope.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | Name of the data store. | |
| scope | string | global | (Optional) A string specifying the scope. |
| options | Instance | nil | (Optional) A DataStoreOptions instance to enable experimental features and v2 API features. |
Returns
| Type | Description |
|---|---|
| DataStore | A DataStore instance with provided name and optional scope. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["DataStore"] |
DataStoreService:GetGlobalDataStore
This function returns the default GlobalDataStore. If you want to access a specific named data store instead, you should use the GetDataStore() function.
Note that the DataStore returned by this function always uses the scope u. See Data stores for details on scope.
Returns
| Type | Description |
|---|---|
| DataStore | The default GlobalDataStore instance. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["DataStore"] |
Code samples: View on Creator Hub (get-a-globaldatastore-instance).
DataStoreService:GetOrderedDataStore
This method returns an OrderedDataStore, similar to the way GetDataStore() does with GlobalDataStores. Subsequent calls to this method with the same name/scope will return the same object.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | Name of the ordered data store. | |
| scope | string | global | (Optional) A string specifying the scope. Default is "global". |
Returns
| Type | Description |
|---|---|
| OrderedDataStore | An OrderedDataStore instance with the provided name and scope. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["DataStore"] |
Code samples: View on Creator Hub (OrderedDataStore-Basics).
DataStoreService:GetRequestBudgetForRequestType
This function returns the number of data store requests that the current place can make based on the given DataStoreRequestType. Any requests made that exceed this budget are subject to throttling. Monitoring and adjusting the frequency of data store requests using this function is recommended.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| requestType | DataStoreRequestType | The DataStoreRequestType to check the budget for. |
Returns
| Type | Description |
|---|---|
| int | The number of data store requests that can currently be made for the specified request type. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["DataStore"] |
Code samples: View on Creator Hub (DataStoreService-GetRequestBudgetForRequestType1).
DataStoreService:ListDataStoresAsync
Returns a DataStoreListingPages object for enumerating through all of the experience's data stores. It accepts an optional prefix parameter to only locate data stores whose names start with the provided prefix.
Only data stores containing at least one object will be listed via this function.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| prefix | string | (Optional) Prefix to enumerate data stores that start with the given prefix. | |
| pageSize | int | 0 | (Optional) Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 32 items per page. |
| cursor | string | (Optional) Cursor to continue iteration. |
Returns
| Type | Description |
|---|---|
| DataStoreListingPages | DataStoreListingPages instance containing DataStoreInfo instances that provide details such as name, creation time, and time last updated. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["DataStore"] |
DataStoreService:SetRateLimitForRequestType
Sets the per-server rate limit (requests per minute) for a given Data Store request type. The configured limit overrides the default rate limit for that request type on the current server. The rate limit is calculated as rateLimit = baseLimit + (perPlayerLimit * numPlayers), where numPlayers is the current number of active players on the server. DataStoreRequestType.OnUpdate and DataStoreRequestType.UpdateAsync cannot be configured with this function. Calling this API with those request types will result in an error.
You should call this API once per request type during server initialization. We don't recommend calling this API during active experience logic. If called multiple times, the new limit definitions will immediately overwrite the previous ones.
The baseLimit and perPlayerLimit have different constraints depending on the request type. See the table below for more information.
Constraints by Request Type
| Request Type | baseLimit constraints | perPlayerLimit constraints |
|---|---|---|
| GetAsync | [0, 60] | [0, 40] |
| SetIncrementAsync | [0, 60] | [0, 40] |
| UpdateAsync | N/A | N/A |
| GetSortedAsync | [0, 5] | [0, 2] |
| SetIncrementSortedAsync | [0, 30] | [0, 5] |
| OnUpdate | N/A | N/A |
| ListAsync | [0, 5] | [0, 2] |
| GetVersionAsync | [0, 5] | [0, 2] |
| RemoveVersionAsync | [0, 5] | [0, 2] |
| StandardRead | [0, 10000] | [0, 200] |
| StandardWrite | [0, 10000] | [0, 200] |
| StandardList | [0, 10000] | [0, 200] |
| StandardRemove | [0, 10000] | [0, 200] |
| OrderedRead | [0, 10000] | [0, 200] |
| OrderedWrite | [0, 10000] | [0, 200] |
| OrderedList | [0, 10000] | [0, 200] |
| OrderedRemove | [0, 10000] | [0, 200] |
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| requestType | DataStoreRequestType | The DataStoreRequestType to configure the rate limit for. | |
| baseLimit | int | The base number of requests allowed per minute regardless of player count. | |
| perPlayerLimit | int | The additional number of requests per minute granted for each connected player. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["DataStore"] |
Code samples: View on Creator Hub (DataStoreService-SetRateLimitForRequestType1).
Properties
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |