Skip to content

Commit 9398830

Browse files
committed
Consolidating "Get started" into one file, which
assumes SQLite is used by default. Fixing links, setting up redirect.
1 parent 5178ca7 commit 9398830

18 files changed

+28
-345
lines changed

public/_redirects

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,8 @@
426426
/durable-objects/platform/changelog/ /durable-objects/release-notes/ 301
427427
/durable-objects/changelog/ /durable-objects/release-notes/ 301
428428
/durable-objects/glossary/ /durable-objects/reference/glossary/ 301
429-
/durable-objects/get-started/walkthrough/ /durable-objects/get-started/tutorial/ 301
429+
/durable-objects/get-started/walkthrough/ /durable-objects/get-started/ 301
430+
/durable-objects/get-started/tutorial-with-sql-api/ /durable-objects/get-started/ 301
430431
/durable-objects/get-started/video-series/intro/ /durable-objects/video-tutorials/ 301
431432
/durable-objects/get-started/video-series/app-frontend/ /durable-objects/video-tutorials/ 301
432433
/durable-objects/get-started/video-series/deploy-app/ /durable-objects/video-tutorials/ 301

src/content/docs/durable-objects/examples/alarms-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export class Batcher extends DurableObject {
7373

7474
The `alarm()` handler will be called once every 10 seconds. If an unexpected error terminates the Durable Object, the `alarm()` handler will be re-instantiated on another machine. Following a short delay, the `alarm()` handler will run from the beginning on the other machine.
7575

76-
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/tutorial/#5-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
76+
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/#4-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
7777

7878
<WranglerConfig>
7979

src/content/docs/durable-objects/examples/build-a-counter.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ export class Counter extends DurableObject {
165165

166166
</TabItem> </Tabs>
167167

168-
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/tutorial/#5-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
168+
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/#5-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
169169

170170
<WranglerConfig>
171171

src/content/docs/durable-objects/examples/build-a-rate-limiter.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ export class RateLimiter extends DurableObject {
277277
</TabItem>
278278
</Tabs>
279279

280-
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/tutorial/#5-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
280+
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/#4-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
281281

282282
<WranglerConfig>
283283

src/content/docs/durable-objects/examples/durable-object-in-memory-state.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ New Location: ${request.cf.city}`);
6767
}
6868
```
6969

70-
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/tutorial/#5-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
70+
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/#4-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
7171

7272
<WranglerConfig>
7373

src/content/docs/durable-objects/examples/durable-object-ttl.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export default {
9696

9797
</TabItem> </Tabs>
9898

99-
To test and deploy this example, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/tutorial/#5-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
99+
To test and deploy this example, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/#4-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
100100

101101
<WranglerConfig>
102102

src/content/docs/durable-objects/examples/websocket-hibernation-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ export class WebSocketHibernationServer extends DurableObject {
188188

189189
</TabItem> </Tabs>
190190

191-
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/tutorial/#5-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
191+
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/#4-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the namespace and class name chosen previously.
192192

193193
<WranglerConfig>
194194

src/content/docs/durable-objects/examples/websocket-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ export class WebSocketServer extends DurableObject {
192192

193193
</TabItem> </Tabs>
194194

195-
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/tutorial/#5-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the <GlossaryTooltip term="namespace">namespace</GlossaryTooltip> and class name chosen previously.
195+
Finally, configure your Wrangler file to include a Durable Object [binding](/durable-objects/get-started/#4-configure-durable-object-bindings) and [migration](/durable-objects/reference/durable-objects-migrations/) based on the <GlossaryTooltip term="namespace">namespace</GlossaryTooltip> and class name chosen previously.
196196

197197
<WranglerConfig>
198198

src/content/docs/durable-objects/features/access-durable-objects-storage.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A Durable Object's [in-memory state](/durable-objects/reference/in-memory-state/
1414

1515
## Access storage
1616

17-
By default, a <GlossaryTooltip term="Durable Object class">Durable Object class</GlossaryTooltip> leverages a key-value storage backend. New Durable Object classes can opt-in to using a [SQLite storage backend](/durable-objects/features/access-durable-objects-storage/#sqlite-storage-backend).
17+
By default, a <GlossaryTooltip term="Durable Object class">Durable Object class</GlossaryTooltip> leverages a SQLite storage backend.
1818

1919
[Storage API methods](/durable-objects/api/storage-api/#methods) are available on `ctx.storage` parameter passed to the Durable Object constructor. Storage API has key-value APIs and SQL APIs. Only Durable Object classes with a SQLite storage backend can access SQL API.
2020

@@ -50,11 +50,7 @@ However if you ever write using [Storage API](/durable-objects/api/storage-api/)
5050

5151
## SQLite storage backend
5252

53-
:::note[SQLite in Durable Objects Beta]
54-
55-
The new beta version of Durable Objects is available where each Durable Object has a private, embedded SQLite database. When deploying a new Durable Object class, users can opt-in to a SQLite storage backend in order to access new [SQL API](/durable-objects/api/sql-storage/#exec). Otherwise, a Durable Object class has a key-value storage backend.
56-
57-
:::
53+
By default, Durable Objects use SQLite storage backend.
5854

5955
To allow a new Durable Object class to use SQLite storage backend, use `new_sqlite_classes` on the migration in your Worker's Wrangler file:
6056

src/content/docs/durable-objects/features/access-kv-storage.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ sidebar:
77

88
import { Tabs, TabItem, GlossaryTooltip, Type } from "~/components";
99

10+
[Storage API methods](/durable-objects/api/storage-api/#methods) are available on `ctx.storage` parameter passed to the Durable Object constructor. Storage API has key-value APIs and SQL APIs. Only Durable Object classes with a SQLite storage backend can access SQL API.
11+
12+
To use Durable Objects with KV-storage, TBC

0 commit comments

Comments
 (0)