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

Constructors

constructor

Properties

lc_kwargs lc_namespace lc_serializable

Accessors

lc_aliases lc_attributes lc_id lc_secrets

Methods

mdelete mget mset toJSON toJSONNotImplemented yieldKeys lc_name

Constructors

constructor

  • Type Parameters

    • T extends Value

    • DataModel extends GenericDataModel

    • TableName extends string

    • IndexName extends string | number | symbol

    • KeyFieldName extends string

    • ValueFieldName extends string

    • 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;
      }>

    Parameters

    • config: ConvexKVStoreConfig<DataModel, TableName, IndexName, KeyFieldName, ValueFieldName, UpsertMutation, LookupQuery, DeleteManyMutation>

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

Properties

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable

lc_serializable: boolean = false

Accessors

lc_aliases

  • get lc_aliases(): undefined | {
        [key: string]: string;
    }

  • A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

    Returns undefined | {
        [key: string]: string;
    }

lc_attributes

  • get lc_attributes(): undefined | SerializedFields

  • A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

    Returns undefined | SerializedFields

lc_id

lc_secrets

  • get lc_secrets(): undefined | {
        [key: string]: string;
    }

  • A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

    Returns undefined | {
        [key: string]: string;
    }

Methods

mdelete

  • 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

  • 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

  • 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

toJSONNotImplemented

yieldKeys

  • Yields keys from the Convex database.

    Parameters

    • Optional _prefix: string

    Returns AsyncGenerator<string, any, unknown>

    An AsyncGenerator that yields keys from the Convex database.

Static lc_name

  • The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

    Implemented as a static method to support loading logic.

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc