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 (view full)

Toolkit<string, T>
- ConvexKVStore

Index

Constructors

constructor

Methods

mdelete mget mset yieldKeys

Constructors

constructor

new ConvexKVStore<T, DataModel, TableName, IndexName, KeyFieldName, ValueFieldName, UpsertMutation, LookupQuery, DeleteManyMutation>(config): ConvexKVStore<T, DataModel, TableName, IndexName, KeyFieldName, ValueFieldName, UpsertMutation, LookupQuery, DeleteManyMutation>
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>
Overrides BaseStore<string, T>.constructor
- Defined in libs/langchain-community/src/storage/convex.ts:122

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.
- Defined in libs/langchain-community/src/storage/convex.ts:201

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.
- Defined in libs/langchain-community/src/storage/convex.ts:157

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.
- Defined in libs/langchain-community/src/storage/convex.ts:177

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.
- Defined in libs/langchain-community/src/storage/convex.ts:221

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

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 (view full)

Index

Constructors

Methods

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>

Methods

mdelete

Parameters

keys: string[]

Returns Promise<void>

mget

Parameters

keys: string[]

Returns Promise<(undefined | T)[]>

mset

Parameters

keyValuePairs: [string, T][]

Returns Promise<void>

yieldKeys

Parameters

Optional _prefix: string

Returns AsyncGenerator<string, any, unknown>

Settings

Member Visibility

Theme

On This Page

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

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

`Optional` _prefix: string