Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.agentfront.dev/llms.txt

Use this file to discover all available pages before exploring further.

Redis-based storage adapter for distributed caching.

​
Constructor

constructor(config: RedisStorageConfig)

​
RedisStorageConfig

interface RedisStorageConfig {
  client: RedisClient;
  namespace?: string;
  ttl?: number;
  keyPrefix?: string;
}
OptionTypeDefaultDescription
clientRedisClientrequiredRedis client instance
namespacestring'default'Namespace for isolation
ttlnumber86400TTL in seconds (24 hours)
keyPrefixstring'vectoriadb'Redis key prefix

​
RedisClient Interface

interface RedisClient {
  get(key: string): Promise<string | null>;
  set(key: string, value: string): Promise<void | string>;
  setex(key: string, seconds: number, value: string): Promise<void | string>;
  del(key: string): Promise<number>;
  ping(): Promise<string>;
  quit(): Promise<void>;
}
Compatible with ioredis, node-redis, and similar clients.

​
Example

import { VectoriaDB, RedisStorageAdapter } from 'vectoriadb';
import Redis from 'ioredis';

const redisClient = new Redis();

const db = new VectoriaDB({
  storageAdapter: new RedisStorageAdapter({
    client: redisClient,
    namespace: 'my-index',
    ttl: 86400,
  }),
});

​
Key Structure

Redis key format: {keyPrefix}:{namespace} Example: vectoriadb:my-index

​
Methods

MethodDescription
initialize()Test Redis connection
load()Load embeddings from Redis
save(data)Save embeddings with TTL
hasValidCache(metadata)Check if valid cache exists
clear()Delete Redis key
close()No-op (client lifecycle is external)

​
Security

The adapter includes command injection protection:
  • Namespace is sanitized to remove control characters
  • Key prefix is sanitized similarly

FileStorageAdapter

File storage

MemoryStorageAdapter

Memory storage

Storage Guide

Redis adapter guide