Skip to content

Commit 5b3ad45

Browse files
update Open Source Docs from Roblox internal teams
1 parent a3d8b6e commit 5b3ad45

File tree

5 files changed

+109
-99
lines changed

5 files changed

+109
-99
lines changed

content/common/navigation/cloud/guides.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ navigation:
66
- title: Overview
77
path: /cloud/guides/
88
- heading: Open Cloud v2 Guides
9+
- title: Data stores
10+
path: /cloud/guides/data-stores
911
- title: User inventories
1012
path: /cloud/guides/inventory
1113
- title: Engine instances

content/common/navigation/cloud/reference.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ navigation:
4747
path: /cloud/features/chats
4848
- title: Creator Store
4949
path: /cloud/features/creator-store
50+
- title: Data and memory stores
51+
path: /cloud/features/storage
5052
- title: Developer products
5153
path: /cloud/features/developer-products
5254
- title: Friends
@@ -73,8 +75,6 @@ navigation:
7375
path: /cloud/features/private-servers
7476
- title: Sponsored campaigns
7577
path: /cloud/features/sponsored-campaigns
76-
- title: Storage
77-
path: /cloud/features/storage
7878
- title: Team Create
7979
path: /cloud/features/team-create
8080
- title: Thumbnails
Lines changed: 2 additions & 2 deletions
Loading

content/en-us/cloud/guides/data-store-api-handling.md

Lines changed: 1 addition & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -11,101 +11,7 @@ Like all Open Cloud APIs, data store endpoints require all requests to include t
1111

1212
## Throttling
1313

14-
All endpoints have two types of universe level throttling: **request-per-minute throttling** and **throughput throttling**. With every experience, **request-per-minute throttling** allows you to send a certain number of requests per minute, and **throughput throttling** allows you to send a certain amount of data per minute, regardless of the number of API keys.
15-
16-
Unlike the Luau API, these limits currently do not scale based on user counts. Exceeding these limits causes the endpoint to return `429 Too Many Requests`.
17-
18-
### Standard data stores throttling limits
19-
20-
<table>
21-
<thead>
22-
<tr>
23-
<th>Request type</th>
24-
<th>Method</th>
25-
<th>Throttle limits</th>
26-
</tr>
27-
<tr>
28-
<td>Write</td>
29-
<td>
30-
<ul>
31-
<li>Set Entry</li>
32-
<li>Increment Entry</li>
33-
<li>Delete Entry</li>
34-
</ul>
35-
</td>
36-
<td>
37-
<ul>
38-
<li>10 MB/min/universe write throughput</li>
39-
<li>300 reqs/min/universe</li>
40-
</ul>
41-
</td>
42-
</tr>
43-
<tr>
44-
<td>Read</td>
45-
<td>
46-
<ul>
47-
<li>List Data Stores</li>
48-
<li>List Entries</li>
49-
<li>Get Entry</li>
50-
<li>List Entry Versions</li>
51-
<li>Get Entry Version</li>
52-
</ul>
53-
</td>
54-
<td>
55-
<ul>
56-
<li>20 MB/min/universe write throughput</li>
57-
<li>300 reqs/min/universe</li>
58-
</ul>
59-
</td>
60-
</tr>
61-
</thead>
62-
<tbody>
63-
</tbody>
64-
</table>
65-
66-
### Ordered data stores throttling limits
67-
68-
<table>
69-
<thead>
70-
<tr>
71-
<th>Request type</th>
72-
<th>Method</th>
73-
<th>Throttle limits</th>
74-
</tr>
75-
<tr>
76-
<td>Write</td>
77-
<td>
78-
<ul>
79-
<li>Create</li>
80-
<li>Increment</li>
81-
<li>Update</li>
82-
<li>Delete</li>
83-
</ul>
84-
</td>
85-
<td>
86-
<ul>
87-
<li>300 reqs/min/universe</li>
88-
</ul>
89-
</td>
90-
</tr>
91-
<tr>
92-
<td>Read</td>
93-
<td>
94-
<ul>
95-
<li>List</li>
96-
<li>Get</li>
97-
</ul>
98-
</td>
99-
<td>
100-
<ul>
101-
<li>300 reqs/min/universe</li>
102-
</ul>
103-
</td>
104-
</tr>
105-
</thead>
106-
<tbody>
107-
</tbody>
108-
</table>
14+
Rate limits for the Open Cloud v1 Data Stores API are identical to [the v2 limits](./data-stores.md#throttling).
10915

11016
## Input validation
11117

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
title: Data stores
3+
description: Covers usage and rate limits for the Open Cloud v2 Data Stores API.
4+
---
5+
6+
## Throttling
7+
8+
The [Data Stores API](/cloud/reference/DataStore) enforces two types of throttling: **requests per minute** and **throughput**. Each experience allows a certain number of requests per minute and a certain amount of data per minute. These limits are enforced for the universe regardless of the number of API keys used.
9+
10+
Unlike the Engine API, these limits do **not** scale based on user count. Exceeding either one causes the endpoint to return `429 Too Many Requests`.
11+
12+
### Standard data stores throttling limits
13+
14+
<table>
15+
<thead>
16+
<tr>
17+
<th>Request type</th>
18+
<th>Method</th>
19+
<th>Throttle limits</th>
20+
</tr>
21+
</thead>
22+
<tbody>
23+
<tr>
24+
<td>Write</td>
25+
<td>
26+
<ul>
27+
<li>Create Data Store Entry</li>
28+
<li>Delete Data Store Entry</li>
29+
<li>Update Data Store Entry</li>
30+
<li>Increment Data Store Entry</li>
31+
</ul>
32+
</td>
33+
<td>
34+
<ul>
35+
<li>10 MB/minute/universe write throughput</li>
36+
<li>300 requests/minute/universe</li>
37+
</ul>
38+
</td>
39+
</tr>
40+
<tr>
41+
<td>Read</td>
42+
<td>
43+
<ul>
44+
<li>List Data Stores</li>
45+
<li>List Data Store Entries</li>
46+
<li>Get Data Store Entry</li>
47+
<li>List Data Store Entry Revisions</li>
48+
</ul>
49+
</td>
50+
<td>
51+
<ul>
52+
<li>20 MB/minute/universe read throughput</li>
53+
<li>300 requests/minute/universe</li>
54+
</ul>
55+
</td>
56+
</tr>
57+
</tbody>
58+
</table>
59+
60+
### Ordered data stores throttling limits
61+
62+
<table>
63+
<thead>
64+
<tr>
65+
<th>Request type</th>
66+
<th>Method</th>
67+
<th>Throttle limits</th>
68+
</tr>
69+
</thead>
70+
<tbody>
71+
<tr>
72+
<td>Write</td>
73+
<td>
74+
<ul>
75+
<li>Create Ordered Data Store Entry</li>
76+
<li>Delete Ordered Data Store Entry</li>
77+
<li>Update Ordered Data Store Entry</li>
78+
<li>Increment Ordered Data Store Entry</li>
79+
</ul>
80+
</td>
81+
<td>
82+
<ul>
83+
<li>300 requests/minute/universe</li>
84+
</ul>
85+
</td>
86+
</tr>
87+
<tr>
88+
<td>Read</td>
89+
<td>
90+
<ul>
91+
<li>List Ordered Data Store Entries</li>
92+
<li>Get Ordered Data Store Entry</li>
93+
</ul>
94+
</td>
95+
<td>
96+
<ul>
97+
<li>300 requests/minute/universe</li>
98+
</ul>
99+
</td>
100+
</tr>
101+
</tbody>
102+
</table>

0 commit comments

Comments
 (0)