Constructors
constructor
- new RedisStore(client, config?): RedisStore
Methods
batch
- batch(ops): Promise<any[]>
Returns Promise<any[]>
close
- close(): Promise<void>
Returns Promise<void>
delete
- delete(namespace, key): Promise<void>
Parameters
- namespace: string[]
- key: string
Returns Promise<void>
get
- get(namespace, key, options?): Promise<null | Item>
Parameters
- namespace: string[]
- key: string
Optional options: {
refreshTTL?: boolean;
}Optional refreshTTL?: boolean
Returns Promise<null | Item>
getStatistics
- getStatistics(): Promise<{
indexInfo?: Record<string, any>;
namespaceCount: number;
totalDocuments: number;
vectorDocuments?: number;
}> Returns Promise<{
indexInfo?: Record<string, any>;
namespaceCount: number;
totalDocuments: number;
vectorDocuments?: number;
}>
listNamespaces
- listNamespaces(options?): Promise<string[][]>
Parameters
Optional options: {
limit?: number;
maxDepth?: number;
offset?: number;
prefix?: string[];
suffix?: string[];
}Optional limit?: number
Optional maxDepth?: number
Optional offset?: number
Optional prefix?: string[]
Optional suffix?: string[]
Returns Promise<string[][]>
put
- put(namespace, key, value, options?): Promise<void>
Parameters
- namespace: string[]
- key: string
- value: any
Optional options: {
index?: boolean | string[];
ttl?: number;
}Optional index?: boolean | string[]
Optional ttl?: number
Returns Promise<void>
search
- search(namespacePrefix, options?): Promise<SearchItem[]>
Parameters
- namespacePrefix: string[]
Optional options: {
filter?: Filter;
limit?: number;
offset?: number;
query?: string;
refreshTTL?: boolean;
similarityThreshold?: number;
}Optional filter?: Filter
Optional limit?: number
Optional offset?: number
Optional query?: string
Optional refreshTTL?: boolean
Optional similarityThreshold?: number
setup
- setup(): Promise<void>
Returns Promise<void>
Static fromCluster
- fromCluster(rootNodes, config?): Promise<RedisStore>
Parameters
- rootNodes: {
url: string;
}[] Optional config: StoreConfig
Static fromConnString
- fromConnString(connString, config?): Promise<RedisStore>
Get statistics about the store. Returns document counts and other metrics.