|
1 | 1 | --- |
2 | 2 | productName: Durable Objects |
3 | 3 | entries: |
4 | | -- term: "Durable Objects" |
5 | | - general_definition: |- |
6 | | - The product name, or the collective noun referring to more than one Durable Object instance. |
| 4 | + - term: "Durable Objects" |
| 5 | + general_definition: |- |
| 6 | + The product name, or the collective noun referring to more than one Durable Object instance. |
7 | 7 |
|
8 | | -- term: "Namespace" |
9 | | - general_definition: |- |
10 | | - A container for a collection of Durable Objects that all share the same Durable Object (class) definition. A single Namespace can have (tens of) millions of Durable Objects. Metrics are scoped per Namespace. |
| 8 | + - term: "Namespace" |
| 9 | + general_definition: |- |
| 10 | + A container for a collection of Durable Objects that all share the same Durable Object (class) definition. A single Namespace can have (tens of) millions of Durable Objects. Metrics are scoped per Namespace. |
11 | 11 |
|
12 | | -- term: "Durable Object" |
13 | | - general_definition: |- |
14 | | - An individual Durable Object. A Durable Object is globally unique (referenced by ID), provides a global point of coordination for all methods/requests sent to it, and has private, persistent storage that is not shared with other Durable Objects within a Namespace. |
| 12 | + - term: "Durable Object" |
| 13 | + general_definition: |- |
| 14 | + An individual Durable Object. A Durable Object is globally unique (referenced by ID), provides a global point of coordination for all methods/requests sent to it, and has private, persistent storage that is not shared with other Durable Objects within a Namespace. |
15 | 15 |
|
16 | | -- term: "Stub" |
17 | | - general_definition: |- |
18 | | - An object that refers to a unique Durable Object within a Namespace and allows you to call into that Durable Object via RPC methods or the `fetch` API. For example, `let stub = env.MY_DURABLE_OBJECT.get(id)` |
| 16 | + - term: "Stub" |
| 17 | + general_definition: |- |
| 18 | + An object that refers to a unique Durable Object within a Namespace and allows you to call into that Durable Object via RPC methods or the `fetch` API. For example, `let stub = env.MY_DURABLE_OBJECT.get(id)` |
19 | 19 |
|
20 | | -- term: "actor" |
21 | | - general_definition: |- |
22 | | - A term referring to a unique Durable Object. |
| 20 | + - term: "actor" |
| 21 | + general_definition: |- |
| 22 | + A term referring to a unique Durable Object. |
23 | 23 |
|
24 | | -- term: "instance" |
25 | | - general_definition: |- |
26 | | - See 'actor'. |
| 24 | + - term: "instance" |
| 25 | + general_definition: |- |
| 26 | + See 'actor'. |
27 | 27 |
|
28 | | -- term: "Durable Object class" |
29 | | - general_definition: |- |
30 | | - The JavaScript class that defines the methods (RPC) and handlers (`fetch`, `alarm`) as part of your Durable Object, and/or an optional `constructor`. All Durable Objects within a single Namespace share the same class definition. |
| 28 | + - term: "Durable Object class" |
| 29 | + general_definition: |- |
| 30 | + The JavaScript class that defines the methods (RPC) and handlers (`fetch`, `alarm`) as part of your Durable Object, and/or an optional `constructor`. All Durable Objects within a single Namespace share the same class definition. |
31 | 31 |
|
32 | | -- term: "Storage Backend" |
33 | | - general_definition: |- |
34 | | - By default, a Durable Object class can use Storage API that leverages a key-value storage backend. New Durable Object classes can opt-in to using a [SQLite storage backend](/durable-objects/best-practices/access-durable-objects-storage/#sqlite-storage-backend). |
| 32 | + - term: "Storage Backend" |
| 33 | + general_definition: |- |
| 34 | + By default, a Durable Object class can use Storage API that leverages a key-value storage backend. New Durable Object classes can opt-in to using a [SQLite storage backend](/durable-objects/best-practices/access-durable-objects-storage/#sqlite-storage-backend). |
35 | 35 |
|
36 | | -- term: "Storage API" |
37 | | - general_definition: |- |
38 | | - The transactional and strongly consistent (serializable) [Storage API](/durable-objects/api/storage-api/) for persisting data within each Durable Object instance. State stored within a unique DO instance is "private" to that Durable Object, and not accessible from other Durable Objects. |
| 36 | + - term: "Storage API" |
| 37 | + general_definition: |- |
| 38 | + The transactional and strongly consistent (serializable) [Storage API](/durable-objects/api/storage-api/) for persisting data within each Durable Object instance. State stored within a unique DO instance is "private" to that Durable Object, and not accessible from other Durable Objects. |
39 | 39 |
|
40 | | - Storage API includes key-value (KV) API, SQL API, and point-in-time-recovery (PITR) API. |
| 40 | + Storage API includes key-value (KV) API, SQL API, and point-in-time-recovery (PITR) API. |
41 | 41 |
|
42 | | - - Durable Object classes with the key-value storage backend can use KV API. |
43 | | - - Durable Object classes with the SQLite storage backend can use KV API, SQL API, and PITR API. |
| 42 | + - Durable Object classes with the key-value storage backend can use KV API. |
| 43 | + - Durable Object classes with the SQLite storage backend can use KV API, SQL API, and PITR API. |
44 | 44 |
|
45 | | -- term: "KV API" |
46 | | - general_definition: |- |
47 | | - API methods part of Storage API that support persisting key-value data. |
| 45 | + - term: "KV API" |
| 46 | + general_definition: |- |
| 47 | + API methods part of Storage API that support persisting key-value data. |
48 | 48 |
|
49 | | -- term: "SQL API" |
50 | | - general_definition: |- |
51 | | - API methods part of Storage API that support SQL querying. |
| 49 | + - term: "SQL API" |
| 50 | + general_definition: |- |
| 51 | + API methods part of Storage API that support SQL querying. |
52 | 52 |
|
53 | | -- term: Migration |
54 | | - general_definition: |- |
55 | | - A Durable Object migration is a mapping process from a class name to a runtime state. |
56 | | - Initiate a Durable Object migration when you need to: |
| 53 | + - term: Migration |
| 54 | + general_definition: |- |
| 55 | + A Durable Object migration is a mapping process from a class name to a runtime state. |
| 56 | + Initiate a Durable Object migration when you need to: |
57 | 57 |
|
58 | | - - Create a new Durable Object class. |
59 | | - - Rename a Durable Object class. |
60 | | - - Delete a Durable Object class. |
61 | | - - Transfer an existing Durable Objects class. |
| 58 | + - Create a new Durable Object class. |
| 59 | + - Rename a Durable Object class. |
| 60 | + - Delete a Durable Object class. |
| 61 | + - Transfer an existing Durable Objects class. |
62 | 62 |
|
63 | | -- term: Alarm |
64 | | - general_definition: |- |
65 | | - A Durable Object alarm is a mechanism that allows you to schedule the Durable Object to be woken up at a time in the future. |
| 63 | + - term: Alarm |
| 64 | + general_definition: |- |
| 65 | + A Durable Object alarm is a mechanism that allows you to schedule the Durable Object to be woken up at a time in the future. |
0 commit comments