langchain.js
    Preparing search index...

    Class RedisByteStore

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

    const store = new RedisByteStore({ client: new Redis({}) });
    await store.mset([
      [
        "message:id:0",
        new TextEncoder().encode(JSON.stringify(new AIMessage("ai stuff..."))),
      ],
      [
        "message:id:1",
        new TextEncoder().encode(
          JSON.stringify(new HumanMessage("human stuff...")),
        ),
      ],
    ]);
    const retrievedMessages = await store.mget(["message:id:0", "message:id:1"]);
    console.log(retrievedMessages.map((v) => new TextDecoder().decode(v)));
    const yieldedKeys = [];
    for await (const key of store.yieldKeys("message:id:")) {
      yieldedKeys.push(key);
    }
    console.log(yieldedKeys);
    await store.mdelete(yieldedKeys);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client lc_namespace namespace? ttl? yieldKeysScanBatchSize

    Methods

    _getDeprefixedKey _getPrefixedKey mdelete mget mset yieldKeys

    Constructors

    • Parameters

      • fields: {
            client: Redis;
            namespace?: string;
            ttl?: number;
            yieldKeysScanBatchSize?: number;
        }

      Returns RedisByteStore

    Properties

    client: Redis
    lc_namespace: string[] = ...
    namespace?: string
    ttl?: number
    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 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 Redis database.

      Parameters

      • keys: string[]

        Array of keys to be retrieved.

      Returns Promise<(undefined | Buffer<ArrayBufferLike>)[]>

      An array of retrieved values.

    • Sets multiple keys in the 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 Redis database.

      Parameters

      • Optionalprefix: string

        Optional prefix to filter the keys.

      Returns AsyncGenerator<string>

      An AsyncGenerator that yields keys from the Redis database.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods