langchain.js
    Preparing search index...

    Class UpstashRedisStore

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

    const store = new UpstashRedisStore({
      client: new Redis({
        url: "your-upstash-redis-url",
        token: "your-upstash-redis-token",
      }),
    });
    await store.mset([
      ["message:id:0", "encoded-ai-message"],
      ["message:id:1", "encoded-human-message"],
    ]);
    const retrievedMessages = await store.mget(["message:id:0", "message:id:1"]);
    const yieldedKeys = [];
    for await (const key of store.yieldKeys("message:id")) {
      yieldedKeys.push(key);
    }
    await store.mdelete(yieldedKeys);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client lc_namespace namespace? yieldKeysScanBatchSize

    Methods

    _getDeprefixedKey _getPrefixedKey mdelete mget mset yieldKeys

    Constructors

    Properties

    client: Redis
    lc_namespace: string[] = ...
    namespace?: string
    yieldKeysScanBatchSize: number = 1000

    Methods

    _getDeprefixedKey

    • _getDeprefixedKey(key: string): string

      Parameters

      • key: string

      Returns string

    _getPrefixedKey

    • _getPrefixedKey(key: string): string

      Parameters

      • key: string

      Returns string

    • Deletes multiple keys from the Upstash Redis database.

      Parameters

      • keys: string[]

        Array of keys to be deleted.

      Returns Promise<void>

      Promise that resolves when all keys have been deleted.

    • Gets multiple keys from the Upstash Redis database.

      Parameters

      • keys: string[]

        Array of keys to be retrieved.

      Returns Promise<(undefined | Uint8Array<ArrayBuffer>)[]>

      An array of retrieved values.

    • Sets multiple keys in the Upstash Redis database.

      Parameters

      • keyValuePairs: [string, Uint8Array<ArrayBufferLike>][]

        Array of key-value pairs to be set.

      Returns Promise<void>

      Promise that resolves when all keys have been set.

    • Yields keys from the Upstash Redis database.

      Parameters

      • Optionalprefix: string

        Optional prefix to filter the keys. A wildcard (*) is always appended to the end.

      Returns AsyncGenerator<string>

      An AsyncGenerator that yields keys from the Upstash Redis database.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods