diff --git a/README.md b/README.md index 7a3b673..2d1feed 100644 --- a/README.md +++ b/README.md @@ -120,7 +120,8 @@ This proposal was inspired by Dapr's [State API] [State API](https://docs.dapr.io/developing-applications/building-blocks/state-management/) ### Change log - +- 2025-03-29: + - Modified `atomics` interface signature - 2024-03-29: - Simplified interfaces to 3 key pieces of functionality: store, atomics, and batch. Also removed the use of streams to simplify the starting point of the API diff --git a/imports.md b/imports.md index ca31a78..28536b7 100644 --- a/imports.md +++ b/imports.md @@ -9,13 +9,13 @@ Components targeting this world will be able to do:

-

Import interface wasi:keyvalue/store@0.2.0-draft2

+

Import interface wasi:keyvalue/store@0.2.0-draft3

A keyvalue interface that provides eventually consistent key-value operations.

Each of these operations acts on a single key-value pair.

The value in the key-value pair is defined as a u8 byte array and the intention is that it is @@ -178,7 +178,7 @@ for more information.

-

Import interface wasi:keyvalue/atomics@0.2.0-draft2

+

Import interface wasi:keyvalue/atomics@0.2.0-draft3

A keyvalue interface that provides atomic operations.

Atomic operations are single, indivisible operations. When a fault causes an atomic operation to fail, it will appear to the invoker of the atomic operation that the action either completed @@ -226,16 +226,17 @@ latest version or transaction.

-

[method]cas.current: func

-

Get the current value of the key (if it exists). This allows for avoiding reads if all -that is needed to ensure the atomicity of the operation

+

[static]cas.new_with_read: func

+

Construct a new CAS operation returning the current value. Implementors can map the underlying functionality +(transactions, versions, etc) as desired.

Params
Return values

increment: func

Atomically increment the value associated with the key in the store by the given delta. It @@ -265,7 +266,7 @@ the CAS operation failed.

-

Import interface wasi:keyvalue/batch@0.2.0-draft2

+

Import interface wasi:keyvalue/batch@0.2.0-draft3

A keyvalue interface that provides batch operations.

A batch operation is an operation that operates on multiple keys at once.

Batch operations are useful for reducing network round-trip time. For example, if you want to diff --git a/watch-service.md b/watch-service.md index a65115a..c144319 100644 --- a/watch-service.md +++ b/watch-service.md @@ -2,18 +2,18 @@

-

Import interface wasi:keyvalue/store@0.2.0-draft2

+

Import interface wasi:keyvalue/store@0.2.0-draft3

A keyvalue interface that provides eventually consistent key-value operations.

Each of these operations acts on a single key-value pair.

The value in the key-value pair is defined as a u8 byte array and the intention is that it is @@ -176,7 +176,7 @@ for more information.

-

Import interface wasi:keyvalue/atomics@0.2.0-draft2

+

Import interface wasi:keyvalue/atomics@0.2.0-draft3

A keyvalue interface that provides atomic operations.

Atomic operations are single, indivisible operations. When a fault causes an atomic operation to fail, it will appear to the invoker of the atomic operation that the action either completed @@ -224,16 +224,17 @@ latest version or transaction.

-

[method]cas.current: func

-

Get the current value of the key (if it exists). This allows for avoiding reads if all -that is needed to ensure the atomicity of the operation

+

[static]cas.new_with_read: func

+

Construct a new CAS operation returning the current value. Implementors can map the underlying functionality +(transactions, versions, etc) as desired.

Params
Return values

increment: func

Atomically increment the value associated with the key in the store by the given delta. It @@ -263,7 +264,7 @@ the CAS operation failed.

-

Import interface wasi:keyvalue/batch@0.2.0-draft2

+

Import interface wasi:keyvalue/batch@0.2.0-draft3

A keyvalue interface that provides batch operations.

A batch operation is an operation that operates on multiple keys at once.

Batch operations are useful for reducing network round-trip time. For example, if you want to @@ -342,7 +343,7 @@ fail.

-

Export interface wasi:keyvalue/watcher@0.2.0-draft2

+

Export interface wasi:keyvalue/watcher@0.2.0-draft3

Types

type bucket

diff --git a/wit/atomic.wit b/wit/atomic.wit index 87d562a..10289b4 100644 --- a/wit/atomic.wit +++ b/wit/atomic.wit @@ -16,19 +16,30 @@ interface atomics { /// A store error occurred when performing the operation store-error(error), /// The CAS operation failed because the value was too old. This returns a new CAS handle - /// for easy retries. Implementors MUST return a CAS handle that has been updated to the + /// for easy retries, as well as the current value for comparison. Implementors MUST return a CAS handle that has been updated to the /// latest version or transaction. - cas-failed(cas), + cas-failed(tuple>>), } /// A handle to a CAS (compare-and-swap) operation. resource cas { - /// Construct a new CAS operation. Implementors can map the underlying functionality - /// (transactions, versions, etc) as desired. + /// Construct a new CAS handle for `key`. + /// + /// This handle should guarantee that a subsequent `swap` operation will operate on data that has + /// not been modified since this call. If that condition is not met, `swap` should return `error`. + /// + /// Note that this handle does not necessarily guarantee that no other operations occur on the key + /// after the handle is created, only that `error` is returned when calling `swap` if other operations did occur. new: static func(bucket: borrow, key: string) -> result; - /// Get the current value of the key (if it exists). This allows for avoiding reads if all - /// that is needed to ensure the atomicity of the operation - current: func() -> result>, error>; + + /// Construct a new CAS handle returning the current value of `key`. + /// + /// This handle should guarantee that a subsequent `swap` operation will operate on data that has + /// not been modified since this call. If that condition is not met, `swap` should return `error`. + /// + /// Note that this handle does not necessarily guarantee that no other operations occur on the key + /// after the handle is created, only that `error` is returned when calling `swap` if other operations did occur. + new-with-read: static func(bucket: borrow, key: string) -> result>>, error>; } /// Atomically increment the value associated with the key in the store by the given delta. It diff --git a/wit/world.wit b/wit/world.wit index fa26226..951baf9 100644 --- a/wit/world.wit +++ b/wit/world.wit @@ -1,4 +1,4 @@ -package wasi:keyvalue@0.2.0-draft2; +package wasi:keyvalue@0.2.0-draft3; /// The `wasi:keyvalue/imports` world provides common APIs for interacting with key-value stores. /// Components targeting this world will be able to do: