Class ConvexKVStore<T, DataModel, TableName, IndexName, KeyFieldName, ValueFieldName, UpsertMutation, LookupQuery, DeleteManyMutation>

Class that extends the BaseStore class to interact with a Convex database. It provides methods for getting, setting, and deleting key value pairs, as well as yielding keys from the database.

Type Parameters

  • T extends Value
  • DataModel extends GenericDataModel
  • TableName extends TableNamesInDataModel<DataModel>
  • IndexName extends VectorIndexNames<NamedTableInfo<DataModel, TableName>>
  • KeyFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>>
  • ValueFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>>
  • UpsertMutation extends FunctionReference<"mutation", "internal", {
        document: object;
        table: string;
    }>
  • LookupQuery extends FunctionReference<"query", "internal", {
        index: string;
        key: string;
        keyField: string;
        table: string;
    }, object[]>
  • DeleteManyMutation extends FunctionReference<"mutation", "internal", {
        index: string;
        key: string;
        keyField: string;
        table: string;
    }>

Hierarchy

  • BaseStore<string, T>
    • ConvexKVStore

Constructors

constructor

Methods

mdelete mget mset toJSON toJSONNotImplemented yieldKeys

Constructors

constructor

Methods

mdelete

  • mdelete(keys): Promise<void>

  • Deletes multiple keys from the Convex database.

    Parameters

    • keys: string[]

      Array of keys to be deleted.

    Returns Promise<void>

    Promise that resolves when all keys have been deleted.

mget

  • mget(keys): Promise<(undefined | T)[]>

  • Gets multiple keys from the Convex database.

    Parameters

    • keys: string[]

      Array of keys to be retrieved.

    Returns Promise<(undefined | T)[]>

    An array of retrieved values.

mset

  • mset(keyValuePairs): Promise<void>

  • Sets multiple keys in the Convex database.

    Parameters

    • keyValuePairs: [string, T][]

      Array of key-value pairs to be set.

    Returns Promise<void>

    Promise that resolves when all keys have been set.

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

yieldKeys

  • yieldKeys(_prefix?): AsyncGenerator<string, any, unknown>

  • Yields keys from the Convex database.

    Parameters

    • Optional_prefix: string

    Returns AsyncGenerator<string, any, unknown>

    An AsyncGenerator that yields keys from the Convex database.

Settings

Member Visibility

On This Page

Constructors
Methods