Class VercelKVStore

Class that extends the BaseStore class to interact with a Vercel KV database. It provides methods for getting, setting, and deleting data, as well as yielding keys from the database.

Hierarchy

BaseStore<string, Uint8Array>
- VercelKVStore

Index

Constructors

constructor

new VercelKVStore(fields?): VercelKVStore
Parameters
- Optional fields: {
      client?: VercelKV;
      namespace?: string;
      ttl?: number;
      yieldKeysScanBatchSize?: number;
  }
  - Optional client?: VercelKV
  - Optional namespace?: string
  - Optional ttl?: number
  - Optional yieldKeysScanBatchSize?: number
Returns VercelKVStore
Overrides BaseStore.constructor
- Defined in langchain/src/storage/vercel_kv.ts:21

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

`Protected` client

client: VercelKV

`Protected` yieldKeysScanBatchSize

yieldKeysScanBatchSize: number = 1000

`Protected` `Optional` namespace

namespace?: string

`Protected` `Optional` ttl

ttl?: number

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;
}
Inherited from BaseStore.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

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
Inherited from BaseStore.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from BaseStore.lc_id
- Defined in langchain/src/load/serializable.ts:100

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;
}
Inherited from BaseStore.lc_secrets
- Defined in langchain/src/load/serializable.ts:112

Methods

_getDeprefixedKey

_getDeprefixedKey(key): string
Parameters
- key: string
Returns string
- Defined in langchain/src/storage/vercel_kv.ts:43

_getPrefixedKey

_getPrefixedKey(key): string
Parameters
- key: string
Returns string
- Defined in langchain/src/storage/vercel_kv.ts:35

mdelete

mdelete(keys): Promise<void>
Deletes multiple keys from the Redis database.
Parameters
- keys: string[]
  
  Array of keys to be deleted.
Returns Promise<void>
Promise that resolves when all keys have been deleted.
Overrides BaseStore.mdelete
- Defined in langchain/src/storage/vercel_kv.ts:100

mget

mget(keys): Promise<(undefined | Uint8Array)[]>
Gets multiple keys from the Redis database.
Parameters
- keys: string[]
  
  Array of keys to be retrieved.
Returns Promise<(undefined | Uint8Array)[]>
An array of retrieved values.
Overrides BaseStore.mget
- Defined in langchain/src/storage/vercel_kv.ts:56

mset

mset(keyValuePairs): Promise<void>
Sets multiple keys in the Redis database.
Parameters
- keyValuePairs: [string, Uint8Array][]
  
  Array of key-value pairs to be set.
Returns Promise<void>
Promise that resolves when all keys have been set.
Overrides BaseStore.mset
- Defined in langchain/src/storage/vercel_kv.ts:78

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseStore.toJSON
- Defined in langchain/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseStore.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:214

yieldKeys

yieldKeys(prefix?): AsyncGenerator<string, any, unknown>
Yields keys from the Redis database.
Parameters
- Optional prefix: string
  
  Optional prefix to filter the keys.
Returns AsyncGenerator<string, any, unknown>
An AsyncGenerator that yields keys from the Redis database.
Overrides BaseStore.yieldKeys
- Defined in langchain/src/storage/vercel_kv.ts:109

`Static` lc_name

lc_name(): string
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
Inherited from BaseStore.lc_name
- Defined in langchain/src/load/serializable.ts:93

Class VercelKVStore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional fields: { client?: VercelKV; namespace?: string; ttl?: number; yieldKeysScanBatchSize?: number; }

Optional client?: VercelKV

Optional namespace?: string

Optional ttl?: number

Optional yieldKeysScanBatchSize?: number

Returns VercelKVStore

Properties

lc_kwargs

lc_namespace

lc_serializable

Protected client

Protected yieldKeysScanBatchSize

Protected Optional namespace

Protected Optional ttl

Accessors

lc_aliases

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

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

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

Methods

_getDeprefixedKey

Parameters

key: string

Returns string

_getPrefixedKey

Parameters

key: string

Returns string

mdelete

Parameters

keys: string[]

Returns Promise<void>

mget

Parameters

keys: string[]

Returns Promise<(undefined | Uint8Array)[]>

mset

Parameters

keyValuePairs: [string, Uint8Array][]

Returns Promise<void>

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

yieldKeys

Parameters

Optional prefix: string

Returns AsyncGenerator<string, any, unknown>

Static lc_name

Returns string

Settings

Member Visibility

Theme

On This Page

`Optional` fields: {
client?: VercelKV;
namespace?: string;
ttl?: number;
yieldKeysScanBatchSize?: number;
}

`Optional` client?: VercelKV

`Optional` namespace?: string

`Optional` ttl?: number

`Optional` yieldKeysScanBatchSize?: number

`Protected` client

`Protected` yieldKeysScanBatchSize

`Protected` `Optional` namespace

`Protected` `Optional` ttl

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

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

`Optional` prefix: string

`Static` lc_name