OCP App SDK

OCP App SDK / KVStore

Defined in: src/store/KVStore.ts:46

The base interface all key-value stores implement

Defined in: src/store/KVStore.ts:240

Atomically adds a value to a NumberSet. If the object or field does not exist, it will be created with a NumberSet containing the given element. If the field exists but is not a NumberSet, this will result in an error.

string

of the stored object

string

that holds the NumberSet

number

to add

Promise<boolean>

true if the value was newly added, false if it was already a member of the set

Defined in: src/store/KVStore.ts:251

Atomically adds the given arrays of values to the given NumberSet fields. If the object or fields do not exist, they will be created from the given arrays. If any field exists but is not a NumberSet, this will result in an error.

string

of the stored object

MultiValue<number[]>

hash of fields to array of values to add

Promise<MultiValue<NumberSet>>

hash of fields to NumberSet containing only the values that were newly added (any values that already existed in the target NumberSet will not exist in the return value)

Defined in: src/store/KVStore.ts:305

Atomically adds a value to a StringSet. If the object or field does not exist, it will be created with a StringSet containing the given element. If the field exists but is not a StringSet, this will result in an error.

string

of the stored object

string

that holds the StringSet

string

to add

Promise<boolean>

true if the value was newly added, false if it was already a member of the set

Defined in: src/store/KVStore.ts:316

Atomically adds the given arrays of values to the given StringSet fields. If the object or fields do not exist, they will be created from the given arrays. If any field exists but is not a StringSet, this will result in an error.

string

of the stored object

MultiValue<string[]>

hash of fields to array of values to add

Promise<MultiValue<StringSet>>

hash of fields to StringSet containing only the values that were newly added (any values that already existed in the target StringSet will not exist in the return value)

Defined in: src/store/KVStore.ts:216

Atomically append an element to the end of a list. If the object or field does not exist, it will be created with a list consisting of the given element. If the field exists but is not a list, this will result in an error.

T extends Value

string

of the stored object

string

that holds the list

T

to append

Promise<void>

Defined in: src/store/KVStore.ts:226

Atomically append the given arrays of elements to the end of the given lists. If the object or fields do not exist, they will be created from the given arrays. If any field exists but is not a list, this will result in an error.

T extends Value

string

of the stored object

MultiValue<T[]>

hash of fields to array of values to append

Promise<void>

Defined in: src/store/KVStore.ts:102

Delete an object or a single field from the store at a given key. If fields is undefined, the entire object will be deleted.

T extends KVHash

string

of the stored object

string[]

to delete or undefined to delete all fields

Promise<T>

the deleted value if successful, or an empty object if it did not exist.

BaseKVStore.delete

Defined in: src/store/KVStore.ts:110

Check if an object exists at a given key.

string

of the stored object

Promise<boolean>

true if the object exists

BaseKVStore.exists

Defined in: src/store/KVStore.ts:59

Retrieve an object from the store given a key.

T extends KVHash

string

of the stored object

string[]

to retrieve from the stored object, or undefined to retrieve the full object

Promise<T>

hash of the complete object or only the specified fields, if supplied. An empty object is returned if the object, or all specified fields, does not exist.

BaseKVStore.get

Defined in: src/store/KVStore.ts:282

Checks if a value exists in a NumberSet. Calling this method on a non-existent object will not cause it to be created. If the field exists but is not a NumberSet, this will result in an error.

string

of the stored object

string

that holds the NumberSet

number

to check

Promise<boolean>

true if the value is a member of the set, false if it is not

Defined in: src/store/KVStore.ts:291

Checks if the given arrays of values exist in the given NumberSet fields. Calling this method on a non-existent object will not cause it to be created. If any field exists but is not a NumberSet, this will result in an error.

string

of the stored object

MultiValue<number[]>

hash of fields to array of values to check

Promise<MultiValue<NumberSet>>

hash of fields to NumberSet containing only the values that exist in the target NumberSet

Defined in: src/store/KVStore.ts:347

Checks if a value exists in a StringSet. Calling this method on a non-existent object will not cause it to be created. If the field exists but is not a StringSet, this will result in an error.

string

of the stored object

string

that holds the StringSet

string

to check

Promise<boolean>

true if the value is a member of the set, false if it is not

Defined in: src/store/KVStore.ts:356

Checks if the given arrays of values exist in the given StringSet fields. Calling this method on a non-existent object will not cause it to be created. If any field exists but is not a StringSet, this will result in an error.

string

of the stored object

MultiValue<string[]>

hash of fields to array of values to check

Promise<MultiValue<StringSet>>

hash of fields to StringSet containing only the values that exist in the target StringSet

Defined in: src/store/KVStore.ts:127

Atomically increment the value of a numeric field. If the object or field did not previously exist, the resulting field will be set to the given amount. If the field does already exist but is not a number, this will result in an error.

string

of the stored object

string

to increment

number

by which to increment (can be negative, defaults to 1)

KVRowOptions

optionally set a TTL for this row

Promise<number>

the value of the field after incrementing

Defined in: src/store/KVStore.ts:139

Atomically increment the values of multiple numeric fields. If the object or fields did not previously exist, the resulting fields will be set to their respective given amount. If any of the fields does already exist but is not a number, this will result in an error.

string

of the stored object

MultiValue<number>

hash of fields to amounts by which to increment (can be negative)

KVRowOptions

optionally set a TTL for this row

Promise<MultiValue<number>>

hash of fields to values after incrementing

Defined in: src/store/KVStore.ts:80

Write a set of fields to an object in the store at a given key. Does not overwrite the entire object.

T extends KVHash

string

of the stored object

T

hash of fields and values to update the object with. Leaves all other fields untouched.

KVRowOptions

optionally set a TTL for this row

Promise<T>

the complete object from before the update An empty object is returned if the object previously did not exist.

BaseKVStore.patch

Defined in: src/store/KVStore.ts:92

Update a stored object using a callback to make changes.

T extends KVHash

string

of the stored object

KVPatchUpdater<T>

function to manipulate the existing object (may be called multiple times to ensure an atomic change)

KVRowOptions

optionally set a TTL for this row

Promise<T>

the complete object from before the update An empty object is returned if the object previously did not exist.

BaseKVStore.patch

Defined in: src/store/KVStore.ts:196

Retrieve (without removing) the first element from a list. If the object or field does not exist, is empty, or is not a list, the result will be undefined.

T extends Value

string

of the stored object

string

that holds the list

Promise<undefined | T>

the first element of the list, if available, otherwise undefined

Defined in: src/store/KVStore.ts:206

Retrieve (without removing) up to the given number of elements from the front of the given lists. If the object or fields do not exist, are empty, or are not lists, the result of each missing field will be an empty array.

T extends Value

string

of the stored object

MultiValue<number>

hash of fields to number of elements to retrieve

Promise<MultiValue<T[]>>

hash of fields to array of list elements

Defined in: src/store/KVStore.ts:69

Write an object to the store at a given key. Overwrites the entire object.

T extends KVHash

string

of the stored object

T

complete hash to write

KVRowOptions

optionally set a TTL for this row

Promise<T>

the previous value found at the key if successful. Otherwise throws an error.

BaseKVStore.put

Defined in: src/store/KVStore.ts:261

Atomically removes a value from a NumberSet. Calling this method on a non-existent object will not cause it to be created. If the field exists but is not a NumberSet, this will result in an error.

string

of the stored object

string

that holds the NumberSet

number

to remove

Promise<boolean>

true if the value was removed, false if it was not a member of the set

Defined in: src/store/KVStore.ts:272

Atomically removes the given arrays of values from the given NumberSet fields. Calling this method on a non-existent object will not cause it to be created. If any field exists but is not a NumberSet, this will result in an error.

string

of the stored object

MultiValue<number[]>

hash of fields to array of values to remove

Promise<MultiValue<NumberSet>>

hash of fields to NumberSet containing only the values that were removed (any values that did not exist in the target NumberSet will not exist in the return value)

Defined in: src/store/KVStore.ts:326

Atomically removes a value from a StringSet. Calling this method on a non-existent object will not cause it to be created. If the field exists but is not a StringSet, this will result in an error.

string

of the stored object

string

that holds the StringSet

string

to remove

Promise<boolean>

true if the value was removed, false if it was not a member of the set

Defined in: src/store/KVStore.ts:337

Atomically removes the given arrays of values from the given StringSet fields. Calling this method on a non-existent object will not cause it to be created. If any field exists but is not a StringSet, this will result in an error.

string

of the stored object

MultiValue<string[]>

hash of fields to array of values to remove

Promise<MultiValue<StringSet>>

hash of fields to StringSet containing only the values that were removed (any values that did not exist in the target StringSet will not exist in the return value)

Defined in: src/store/KVStore.ts:154

Atomically retrieve and remove the first element from a list. If the object or field does not exist or is empty, the result will be undefined. Calling this method on a non-existent object will not cause it to be created. If the field exists but is not a list, this will result in an error.

T extends Value

string

of the stored object

string

that holds the list

Promise<undefined | T>

the first element of the list, if available, otherwise undefined

Defined in: src/store/KVStore.ts:166

Atomically retrieve and remove up to the given number of elements from the front of the given lists. If the object or fields do not exist or are empty, the result of each missing field will be an empty array. Calling this method on a non-existent object will not cause it to be created. If any field exists but is not a list, this will result in an error.

T extends Value

string

of the stored object

MultiValue<number>

hash of fields to number of elements to retrieve and remove

Promise<MultiValue<T[]>>

hash of fields to array of list elements

Defined in: src/store/KVStore.ts:176

Atomically insert an element at the front of a list. If the object or field does not exist, it will be created with a list consisting of the given element. If the field exists but is not a list, this will result in an error.

T extends Value

string

of the stored object

string

that holds the list

T

to insert

Promise<void>

Defined in: src/store/KVStore.ts:186

Atomically insert the given arrays of elements at the front of the given lists. If the object or fields do not exist, they will be created from the given arrays. If any field exists but is not a list, this will result in an error.

T extends Value

string

of the stored object

MultiValue<T[]>

hash of fields to array of values to insert

Promise<void>