diff --git a/src/content/docs/durable-objects/api/alarms.mdx b/src/content/docs/durable-objects/api/alarms.mdx index ba809bf79a288fb..c789b441efb0ba0 100644 --- a/src/content/docs/durable-objects/api/alarms.mdx +++ b/src/content/docs/durable-objects/api/alarms.mdx @@ -39,11 +39,7 @@ Alarms can be used to build distributed primitives, like queues or batching of w ### `setAlarm` -- - {" "} - setAlarm(scheduledTimeMs ) - - : +- setAlarm(scheduledTimeMs ) : - Set the time for the alarm to run. Specify the time as the number of milliseconds elapsed since the UNIX epoch. - If you call `setAlarm` when there is already one scheduled, it will override the existing alarm. @@ -66,11 +62,7 @@ This is due to the fact that, if the Durable Object wakes up after being inactiv ### `alarm` -- - alarm(`alarmInfo` - ) - - : +- alarm(alarmInfo ): - Called by the system when a scheduled alarm time is reached. diff --git a/src/content/docs/durable-objects/api/storage-api.mdx b/src/content/docs/durable-objects/api/storage-api.mdx index d95c0105af8c17e..737156b069864ee 100644 --- a/src/content/docs/durable-objects/api/storage-api.mdx +++ b/src/content/docs/durable-objects/api/storage-api.mdx @@ -113,10 +113,7 @@ export class MyDurableObject extends DurableObject { ### `exec` - - exec(query: , ...bindings: ) - -: +exec(query: , ...bindings: ): #### Parameters @@ -199,19 +196,13 @@ The PITR API represents points in time using 'bookmarks'. A bookmark is a mostly ### `getBookmarkForTime` - - ctx.storage.getBookmarkForTime(timestamp: ) - -: +ctx.storage.getBookmarkForTime(timestamp: ): - Returns a bookmark representing approximately the given point in time, which must be within the last 30 days. If the timestamp is represented as a number, it is converted to a date as if using `new Date(timestamp)`. ### `onNextSessionRestoreBookmark` - - ctx.storage.onNextSessionRestoreBookmark(bookmark: ) - -: +ctx.storage.onNextSessionRestoreBookmark(bookmark: ): - Configures the Durable Object so that the next time it restarts, it should restore its storage to exactly match what the storage contained at the given bookmark. After calling this, the application should typically invoke `ctx.abort()` to restart the Durable Object, thus completing the point-in-time recovery. @@ -228,25 +219,11 @@ ctx.storage.onNextSessionRestoreBookmark(bookmark); ### `get` -- - get(key , options {" "} - ) - - : - Retrieves the value associated with the given - key. The type of the returned value will be whatever was previously written - for the key, or undefined if the key does not exist. - -- - get(keys , options {" "} - ) - - : - Retrieves the values associated - with each of the provided keys. The type of each returned value in the - [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) - will be whatever was previously written for the corresponding key. Results in - the `Map` will be sorted in increasing order of their UTF-8 encodings, with - any requested keys that do not exist being omitted. Supports up to 128 keys at - a time. +- ctx.storage.get(key , options {" "}): + - Retrieves the value associated with the given key. The type of the returned value will be whatever was previously written for the key, or undefined if the key does not exist. + +- ctx.storage.get(keys , options ): + - Retrieves the values associated with each of the provided keys. The type of each returned value in the [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) will be whatever was previously written for the corresponding key. Results in the `Map` will be sorted in increasing order of their UTF-8 encodings, with any requested keys that do not exist being omitted. Supports up to 128 keys at a time. #### Supported options @@ -258,50 +235,27 @@ ctx.storage.onNextSessionRestoreBookmark(bookmark); ### `put` -- - put(key , value , options{" "} - ) - - : - Stores the value and associates it with the given - key. The value can be any type supported by the [structured clone - algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), - which is true of most types. - - The size of keys and values have different limits depending on the Durable Object storage backend you are using. Refer to either: - - [SQLite-backed Durable Object limits](/durable-objects/platform/limits/#sqlite-backed-durable-objects-general-limits) - - [KV-backed Durable Object limits](/durable-objects/platform/limits/#key-value-backed-durable-objects-general-limits).

- -- - put(entries , options {" "} - ) - - : - Takes an Object and stores each of its keys and - values to storage. - Each value can be any type supported by the [structured - clone - algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), - which is true of most types. - Supports up to 128 key-value pairs at a time. - The size of keys and values have different limits depending on the flavor of - Durable Object you are using. Refer to either: - [SQLite-backed Durable Object - limits](/durable-objects/platform/limits/#sqlite-backed-durable-objects-general-limits) - - [KV-backed Durable Object - limits](/durable-objects/platform/limits/#key-value-backed-durable-objects-general-limits) +- put(key , value , options ): + - Stores the value and associates it with the given key. The value can be any type supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), which is true of most types. + + The size of keys and values have different limits depending on the Durable Object storage backend you are using. Refer to either: + - [SQLite-backed Durable Object limits](/durable-objects/platform/limits/#sqlite-backed-durable-objects-general-limits) + - [KV-backed Durable Object limits](/durable-objects/platform/limits/#key-value-backed-durable-objects-general-limits).

+ +- put(entries , options ): + - Takes an Object and stores each of its keys and values to storage. + - Each value can be any type supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), which is true of most types. + - Supports up to 128 key-value pairs at a time. The size of keys and values have different limits depending on the flavor of Durable Object you are using. Refer to either: + - [SQLite-backed Durable Object limits](/durable-objects/platform/limits/#sqlite-backed-durable-objects-general-limits) + - [KV-backed Durable Object limits](/durable-objects/platform/limits/#key-value-backed-durable-objects-general-limits) ### `delete` -- - delete(key , options {" "} - ) - - : - Deletes the key and associated value. - Returns `true` if the key existed or `false` if it did not. - -- - delete(keys , options {" "} - ) - - : - Deletes the provided keys and their - associated values. Supports up to 128 keys at a time. Returns a count of the - number of key-value pairs deleted. +- delete(key , options ): + - Deletes the key and associated value. Returns `true` if the key existed or `false` if it did not. + +- delete(keys , options ): + - Deletes the provided keys and their associated values. Supports up to 128 keys at a time. Returns a count of the number of key-value pairs deleted. #### Supported options @@ -335,12 +289,8 @@ The `put()` method returns a `Promise`, but most applications can discard this p ### `list` -- - list(options ) - - : - Returns all keys and values - associated with the current Durable Object in ascending sorted order based on - the keys' UTF-8 encodings. +- list(options ): + - Returns all keys and values associated with the current Durable Object in ascending sorted order based on the keys' UTF-8 encodings. - The type of each returned value in the [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) will be whatever was previously written for the corresponding key. - Be aware of how much data may be stored in your Durable Object before calling this version of `list` without options because all the data will be loaded into the Durable Object's memory, potentially hitting its [limit](/durable-objects/platform/limits/). If that is a concern, pass options to `list` as documented below. @@ -376,13 +326,8 @@ The `put()` method returns a `Promise`, but most applications can discard this p ### `getAlarm` -- - getAlarm(options ) - - : - Retrieves the current alarm time (if - set) as integer milliseconds since epoch. The alarm is considered to be set if - it has not started, or if it has failed and any retry has not begun. If no - alarm is set, `getAlarm()` returns `null`. +- getAlarm(options ): + - Retrieves the current alarm time (if set) as integer milliseconds since epoch. The alarm is considered to be set if it has not started, or if it has failed and any retry has not begun. If no alarm is set, `getAlarm()` returns `null`. #### Supported options @@ -390,22 +335,15 @@ The `put()` method returns a `Promise`, but most applications can discard this p ### `setAlarm` -- - setAlarm(scheduledTime , options{" "} - ) - - : - Sets the current alarm time, accepting either a - JavaScript `Date`, or integer milliseconds since epoch. +- setAlarm(scheduledTime , options ): + - Sets the current alarm time, accepting either a JavaScript `Date`, or integer milliseconds since epoch. If `setAlarm()` is called with a time equal to or before `Date.now()`, the alarm will be scheduled for asynchronous execution in the immediate future. If the alarm handler is currently executing in this case, it will not be canceled. Alarms can be set to millisecond granularity and will usually execute within a few milliseconds after the set time, but can be delayed by up to a minute due to maintenance or failures while failover takes place. ### `deleteAlarm` -- - deleteAlarm(options ) - - : - Deletes the alarm if one exists. Does not cancel - the alarm handler if it is currently executing. +- deleteAlarm(options ): + - Deletes the alarm if one exists. Does not cancel the alarm handler if it is currently executing. #### Supported options @@ -415,23 +353,10 @@ The `put()` method returns a `Promise`, but most applications can discard this p ### `deleteAll` -- - deleteAll(options ) - - : - Deletes all stored data, effectively deallocating - all storage used by the Durable Object. For Durable Objects with a key-value - storage backend, `deleteAll()` removes all keys and associated values for an - individual Durable Object. For Durable Objects with a [SQLite storage - backend](/durable-objects/best-practices/access-durable-objects-storage/#create-sqlite-backed-durable-object-class), - `deleteAll()` removes the entire contents of a Durable Object's private SQLite - database, including both SQL data and key-value data. - For Durable Objects - with a key-value storage backend, an in-progress `deleteAll()` operation can - fail, which may leave a subset of data undeleted. Durable Objects with a - SQLite storage backend do not have a partial `deleteAll()` issue because - `deleteAll()` operations are atomic (all or nothing). - `deleteAll()` does not - proactively delete [alarms](/durable-objects/api/alarms/). Use - [`deleteAlarm()`](/durable-objects/api/alarms/#deletealarm) to delete an - alarm. +- deleteAll(options ): + - Deletes all stored data, effectively deallocating all storage used by the Durable Object. For Durable Objects with a key-value storage backend, `deleteAll()` removes all keys and associated values for an individual Durable Object. For Durable Objects with a [SQLite storage backend](/durable-objects/best-practices/access-durable-objects-storage/#create-sqlite-backed-durable-object-class), `deleteAll()` removes the entire contents of a Durable Object's private SQLite database, including both SQL data and key-value data. + - For Durable Objects with a key-value storage backend, an in-progress `deleteAll()` operation can fail, which may leave a subset of data undeleted. Durable Objects with a SQLite storage backend do not have a partial `deleteAll()` issue because `deleteAll()` operations are atomic (all or nothing). + - `deleteAll()` does not proactively delete [alarms](/durable-objects/api/alarms/). Use [`deleteAlarm()`](/durable-objects/api/alarms/#deletealarm) to delete an alarm. ### `transactionSync` @@ -470,6 +395,6 @@ The `put()` method returns a `Promise`, but most applications can discard this p ## Related resources -- [Durable Objects: Easy, Fast, Correct – Choose Three](https://blog.cloudflare.com/durable-objects-easy-fast-correct-choose-three/) +- [Durable Objects: Easy, Fast, Correct Choose Three](https://blog.cloudflare.com/durable-objects-easy-fast-correct-choose-three/) - [Zero-latency SQLite storage in every Durable Object blog](https://blog.cloudflare.com/sqlite-in-durable-objects/) - [WebSockets API](/durable-objects/best-practices/websockets/)