OCP App SDK / KVStore

KVStore

The base interface all key-value stores implement

Hierarchy

• BaseKVStore<KVHash, KVHash>.KVStore

Index

Methods

• addNumber
• addNumberMulti
• addString
• addStringMulti
• append
• appendMulti
• delete
• exists
• get
• hasNumber
• hasNumberMulti
• hasString
• hasStringMulti
• increment
• incrementMulti
• patch
• peek
• peekMulti
• put
• removeNumber
• removeNumberMulti
• removeString
• removeStringMulti
• shift
• shiftMulti
• unshift
• unshiftMulti

Methods

addNumber()

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.

Signature

addNumber(key: string, field: string, value: number): Promise<boolean>;

Parameters

Returns

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:240

addNumberMulti()

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.

Signature

addNumberMulti(key: string, fieldValues: MultiValue<number[]>): Promise<MultiValue<NumberSet>>;

Parameters

Returns

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:251

addString()

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.

Signature

addString(key: string, field: string, value: string): Promise<boolean>;

Parameters

Returns

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:305

addStringMulti()

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.

Signature

addStringMulti(key: string, fieldValues: MultiValue<string[]>): Promise<MultiValue<StringSet>>;

Parameters

Returns

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:316

append()

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.

Async

Signature

append<T>(key: string, field: string, value: T): Promise<void>;

Type parameters

• T extends Value

Parameters

Returns

Promise<void>

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

appendMulti()

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.

Async

Signature

appendMulti<T>(key: string, fieldValues: MultiValue<T[]>): Promise<void>;

Type parameters

• T extends Value

Parameters

Returns

Promise<void>

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

delete()

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

Async

Signature

delete<T>(key: string, fields?: string[]): Promise<T>;

Type parameters

• T extends KVHash

Parameters

Returns

Promise<T>

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

Overrides: BaseKVStore.delete

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

exists()

Check if an object exists at a given key.

Async

Signature

exists(key: string): Promise<boolean>;

Parameters

Returns

Promise<boolean>

true if the object exists

Overrides: BaseKVStore.exists

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

get()

Retrieve an object from the store given a key.

Async

Signature

get<T>(key: string, fields?: string[]): Promise<T>;

Type parameters

• T extends KVHash

Parameters

Returns

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.

Overrides: BaseKVStore.get

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

hasNumber()

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.

Signature

hasNumber(key: string, field: string, value: number): Promise<boolean>;

Parameters

Returns

Promise<boolean>

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

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

hasNumberMulti()

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.

Signature

hasNumberMulti(key: string, fieldValues: MultiValue<number[]>): Promise<MultiValue<NumberSet>>;

Parameters

Returns

Promise<MultiValue<NumberSet>>

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

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

hasString()

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.

Signature

hasString(key: string, field: string, value: string): Promise<boolean>;

Parameters

Returns

Promise<boolean>

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

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

hasStringMulti()

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.

Signature

hasStringMulti(key: string, fieldValues: MultiValue<string[]>): Promise<MultiValue<StringSet>>;

Parameters

Returns

Promise<MultiValue<StringSet>>

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

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

increment()

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.

Async

Signature

increment(
  key: string,
  field: string,
  amount?: number,
  options?: KVRowOptions): Promise<number>;

Parameters

Returns

Promise<number>

the value of the field after incrementing

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

incrementMulti()

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.

Async

Signature

incrementMulti(key: string, fieldAmounts: MultiValue<number>, options?: KVRowOptions): Promise<MultiValue<number>>;

Parameters

Returns

Promise<MultiValue<number>>

hash of fields to values after incrementing

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

patch()

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

Async

Signature

patch<T>(key: string, value: T, options?: KVRowOptions): Promise<T>;

Type parameters

• T extends KVHash

Parameters

Returns

Promise<T>

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

Overrides: BaseKVStore.patch

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

Update a stored object using a callback to make changes.

Async

Signature

patch<T>(key: string, updater: KVPatchUpdater<T>, options?: KVRowOptions): Promise<T>;

Type parameters

• T extends KVHash

Parameters

Returns

Promise<T>

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

Overrides: BaseKVStore.patch

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

peek()

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.

Async

Signature

peek<T>(key: string, field: string): Promise<undefined | T>;

Type parameters

• T extends Value

Parameters

Returns

Promise<undefined | T>

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

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

peekMulti()

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.

Async

Signature

peekMulti<T>(key: string, fieldCounts: MultiValue<number>): Promise<MultiValue<T[]>>;

Type parameters

• T extends Value

Parameters

Returns

Promise<MultiValue<T[]>>

hash of fields to array of list elements

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

put()

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

Async

Signature

put<T>(key: string, value: T, options?: KVRowOptions): Promise<T>;

Type parameters

• T extends KVHash

Parameters

Returns

Promise<T>

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

Overrides: BaseKVStore.put

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

removeNumber()

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.

Signature

removeNumber(key: string, field: string, value: number): Promise<boolean>;

Parameters

Returns

Promise<boolean>

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

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

removeNumberMulti()

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.

Signature

removeNumberMulti(key: string, fieldValues: MultiValue<number[]>): Promise<MultiValue<NumberSet>>;

Parameters

Returns

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:272

removeString()

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.

Signature

removeString(key: string, field: string, value: string): Promise<boolean>;

Parameters

Returns

Promise<boolean>

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

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

removeStringMulti()

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.

Signature

removeStringMulti(key: string, fieldValues: MultiValue<string[]>): Promise<MultiValue<StringSet>>;

Parameters

Returns

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:337

shift()

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.

Async

Signature

shift<T>(key: string, field: string): Promise<undefined | T>;

Type parameters

• T extends Value

Parameters

Returns

Promise<undefined | T>

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

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

shiftMulti()

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.

Async

Signature

shiftMulti<T>(key: string, fieldCounts: MultiValue<number>): Promise<MultiValue<T[]>>;

Type parameters

• T extends Value

Parameters

Returns

Promise<MultiValue<T[]>>

hash of fields to array of list elements

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

unshift()

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.

Async

Signature

unshift<T>(key: string, field: string, value: T): Promise<void>;

Type parameters

• T extends Value

Parameters

Returns

Promise<void>

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

unshiftMulti()

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.

Async

Signature

unshiftMulti<T>(key: string, fieldValues: MultiValue<T[]>): Promise<void>;

Type parameters

• T extends Value

Parameters

Returns

Promise<void>

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