DataStoreService

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.

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.

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.

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.

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.

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#