FileStorageAdapter

File-based storage adapter for persisting embeddings to local disk.

Constructor

constructor(config?: FileStorageConfig)

FileStorageConfig

interface FileStorageConfig {
  cacheDir?: string;
  namespace?: string;
  fileName?: string;
}

Option	Type	Default	Description
`cacheDir`	`string`	`'./.cache/vectoriadb'`	Cache directory
`namespace`	`string`	`'default'`	Namespace for isolation
`fileName`	`string`	`'embeddings.json'`	Cache file name

Example

import { VectoriaDB, FileStorageAdapter } from 'vectoriadb';

const db = new VectoriaDB({
  storageAdapter: new FileStorageAdapter({
    cacheDir: './.cache/vectoriadb',
    namespace: 'my-index',
  }),
});

File Structure

.cache/vectoriadb/
└── my-index/              # namespace
    └── embeddings.json    # cache file

Methods

All storage adapters implement the BaseStorageAdapter interface:

Method	Description
`initialize()`	Create cache directory
`load()`	Load embeddings from file
`save(data)`	Save embeddings to file
`hasValidCache(metadata)`	Check if valid cache exists
`clear()`	Delete cache file
`close()`	Cleanup (no-op for file adapter)

Security

The adapter includes path traversal protection:

Namespace is sanitized to prevent directory escape
Resolved path is validated to stay within cacheDir

RedisStorageAdapter

Redis storage

MemoryStorageAdapter

Memory storage

Storage Guide

File adapter guide

Overview

VectoriaDB

TFIDFVectoria

Storage Adapters

Interfaces

Errors

Constructor

FileStorageConfig

Example

File Structure

Methods

Security

RedisStorageAdapter

MemoryStorageAdapter

Storage Guide

​Constructor

​FileStorageConfig

​Example

​File Structure

​Methods

​Security

​Related

RedisStorageAdapter

MemoryStorageAdapter

Storage Guide

Constructor

FileStorageConfig

Example

File Structure

Methods

Security

Related