langchain.js
    Preparing search index...

    Type Alias ConvexKVStoreConfig<DataModel, TableName, IndexName, KeyFieldName, ValueFieldName, UpsertMutation, LookupQuery, DeleteManyMutation>

    Type that defines the config required to initialize the ConvexKVStore class. It includes the table name, index name, field name.

    type ConvexKVStoreConfig<
        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 },
            >,
    > = {
        ctx: GenericActionCtx<DataModel>;
        deleteMany?: DeleteManyMutation;
        index?: IndexName;
        keyField?: KeyFieldName;
        lookup?: LookupQuery;
        table?: TableName;
        upsert?: UpsertMutation;
        valueField?: ValueFieldName;
    }

    Type Parameters

    • 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 },
      >
    Index

    Properties

    ctx deleteMany? index? keyField? lookup? table? upsert? valueField?

    Properties

    ctx: GenericActionCtx<DataModel>
    deleteMany?: DeleteManyMutation

    Defaults to internal.langchain.db.deleteMany

    index?: IndexName

    Defaults to "byKey"

    keyField?: KeyFieldName

    Defaults to "key"

    lookup?: LookupQuery

    Defaults to internal.langchain.db.lookup

    table?: TableName

    Defaults to "cache"

    upsert?: UpsertMutation

    Defaults to internal.langchain.db.upsert

    valueField?: ValueFieldName

    Defaults to "value"

    Settings

    Member Visibility

    On This Page

    Properties