DataStore API¶
List Stores¶
List all DataStores within a given experience.
USAGE:
rbxcloud datastore list-stores [OPTIONS] --universe-id <UNIVERSE_ID> --api-key <API_KEY>
OPTIONS:
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-c, --cursor <CURSOR> Cursor for the next set of data
-h, --help Print help information
-l, --limit <LIMIT> Maximum number of items to return
-p, --prefix <PREFIX> Return only DataStores with this prefix
-u, --universe-id <UNIVERSE_ID> Universe ID of the experience
List Keys¶
List all keys within a given DataStore.
USAGE:
rbxcloud datastore list [OPTIONS] --datastore-name <DATASTORE_NAME> --universe-id <UNIVERSE_ID> --api-key <API_KEY>
OPTIONS:
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-c, --cursor <CURSOR> Cursor for the next set of data
-d, --datastore-name <DATASTORE_NAME> DataStore name
-h, --help Print help information
-l, --limit <LIMIT> Maximum number of items to return
-o, --all-scopes If true, return keys from all scopes
-p, --prefix <PREFIX> Return only DataStores with this prefix
-s, --scope <SCOPE> DataStore scope
-u, --universe-id <UNIVERSE_ID> Universe ID of the experience
List Key Versions¶
List all versions of the specified key.
USAGE:
rbxcloud datastore list-versions [OPTIONS] --datastore-name <DATASTORE_NAME> --key <KEY> --sort-order <SORT_ORDER> --limit <LIMIT> --universe-id <UNIVERSE_ID> --api-key <API_KEY>
OPTIONS:
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-c, --cursor <CURSOR> Cursor for the next set of data
-d, --datastore-name <DATASTORE_NAME> DataStore name
-e, --end-time <END_TIME> End time constraint (ISO UTC Datetime)
-h, --help Print help information
-k, --key <KEY> The key of the entry
-l, --limit <LIMIT> Maximum number of items to return
-o, --sort-order <SORT_ORDER> Sort order [possible values: ascending, descending]
-s, --scope <SCOPE> DataStore scope
-t, --start-time <START_TIME> Start time constraint (ISO UTC Datetime)
-u, --universe-id <UNIVERSE_ID> Universe ID of the experience
Get Key¶
Get the entry value of a specific key.
USAGE:
rbxcloud datastore get [OPTIONS] --datastore-name <DATASTORE_NAME> --key <KEY> --universe-id <UNIVERSE_ID> --api-key <API_KEY>
OPTIONS:
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-d, --datastore-name <DATASTORE_NAME> DataStore name
-h, --help Print help information
-k, --key <KEY> The key of the entry
-s, --scope <SCOPE> DataStore scope
-u, --universe-id <UNIVERSE_ID> Universe ID of the experience
Set Key¶
Set (or create) the entry value of a specific key.
USAGE:
rbxcloud datastore set [OPTIONS] --datastore-name <DATASTORE_NAME> --key <KEY> --data <DATA> --universe-id <UNIVERSE_ID> --api-key <API_KEY>
OPTIONS:
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-d, --datastore-name <DATASTORE_NAME> DataStore name
-D, --data <DATA> JSON-stringified data (up to 4MB)
-e, --exclusive-create Only create the entry if it does not exist
-h, --help Print help information
-i, --match-version <MATCH_VERSION> Only update if the current version matches this
-k, --key <KEY> The key of the entry
-s, --scope <SCOPE> DataStore scope
-t, --attributes <ATTRIBUTES> JSON-stringified attributes data
-u, --universe-id <UNIVERSE_ID> Universe ID of the experience
-U, --user-ids <USER_IDS> Comma-separated list of Roblox user IDs
Increment Key¶
Increment (or create) the entry value of a specific key.
USAGE:
rbxcloud datastore increment [OPTIONS] --datastore-name <DATASTORE_NAME> --key <KEY> --increment-by <INCREMENT_BY> --universe-id <UNIVERSE_ID> --api-key <API_KEY>
OPTIONS:
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-d, --datastore-name <DATASTORE_NAME> DataStore name
-h, --help Print help information
-i, --increment-by <INCREMENT_BY> The amount by which the entry should be incremented
-k, --key <KEY> The key of the entry
-s, --scope <SCOPE> DataStore scope
-t, --attributes <ATTRIBUTES> JSON-stringified attributes data
-u, --universe-id <UNIVERSE_ID> Universe ID of the experience
-U, --user-ids <USER_IDS> Comma-separated list of Roblox user IDs
Delete Key¶
Delete the value of a specific key. Per Roblox's documentation, this creates a "tombstone" version for 30 days before being completely deleted.
USAGE:
rbxcloud datastore delete [OPTIONS] --datastore-name <DATASTORE_NAME> --key <KEY> --universe-id <UNIVERSE_ID> --api-key <API_KEY>
OPTIONS:
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-d, --datastore-name <DATASTORE_NAME> DataStore name
-h, --help Print help information
-k, --key <KEY> The key of the entry
-s, --scope <SCOPE> DataStore scope
-u, --universe-id <UNIVERSE_ID> Universe ID of the experience
Get Key Version¶
Get a specific entry of a key given the version.
USAGE:
rbxcloud datastore get-version [OPTIONS] --datastore-name <DATASTORE_NAME> --key <KEY> --version-id <VERSION_ID> --universe-id <UNIVERSE_ID> --api-key <API_KEY>
OPTIONS:
-a, --api-key <API_KEY> Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
-d, --datastore-name <DATASTORE_NAME> DataStore name
-h, --help Print help information
-i, --version-id <VERSION_ID> The version of the key
-k, --key <KEY> The key of the entry
-s, --scope <SCOPE> DataStore scope
-u, --universe-id <UNIVERSE_ID> Universe ID of the experience