Class BaseStorageAdapter`Abstract`

Abstract base class for SQL storage adapters.

Implements common functionality shared by all adapters:

State management (open/close tracking)
Parameter validation
Error handling and wrapping
Performance metrics with configurable tiers
Query result caching (tier-dependent)
Lifecycle hooks for RAG and analytics
Logging and diagnostics

Implements

StorageAdapter

Constructors

constructor

new BaseStorageAdapter(options?): BaseStorageAdapter

Creates a new adapter instance.

Parameters

options: BaseAdapterOptions = {}
Configuration options for the adapter

Returns BaseStorageAdapter

Example: Default balanced tier

const adapter = new MyAdapter();

Example: Fast tier for development

const adapter = new MyAdapter({
  performance: { tier: 'fast' },
  verbose: true
});

Example: With RAG hooks

const adapter = new MyAdapter({
  hooks: {
    onBeforeWrite: async (ctx) => {
      ctx.metadata = { embedding: await embed(ctx.parameters) };
      return ctx;
    }
  }
});

Properties

`Abstract` `Readonly`kind

kind: string

Identifier for logging/diagnostics (e.g., 'better-sqlite3', 'postgres').

`Abstract` `Readonly`capabilities

capabilities: ReadonlySet<StorageCapability>

Capability flags indicating supported features.

`Protected` `Readonly`options

options: BaseAdapterOptions

`Protected` `Readonly`performanceSettings

performanceSettings: PerformanceSettings

`Protected` `Readonly`hooks

hooks: StorageHooks

Methods

open

open(options?): Promise<void>
Opens the adapter connection. Handles state management and delegates to subclass implementation.
Parameters
- Optionaloptions: StorageOpenOptions
Returns Promise<void>
Implementation of StorageAdapter.open
- Defined in src/adapters/baseStorageAdapter.ts:284

run

run(statement, parameters?): Promise<StorageRunResult>
Executes a mutation statement (INSERT, UPDATE, DELETE).

Invokes onBeforeWrite and onAfterWrite hooks if configured. Supports retry on transient errors based on performance tier.
Parameters
- statement: string
- Optionalparameters: StorageParameters
Returns Promise<StorageRunResult>
Implementation of StorageAdapter.run
- Defined in src/adapters/baseStorageAdapter.ts:314

get

get<T>(statement, parameters?): Promise<null | T>
Retrieves a single row.

Supports caching based on performance tier and invokes query hooks.
Type Parameters
- T = unknown
Parameters
- statement: string
- Optionalparameters: StorageParameters
Returns Promise<null | T>
Implementation of StorageAdapter.get
- Defined in src/adapters/baseStorageAdapter.ts:390

all

all<T>(statement, parameters?): Promise<T[]>
Retrieves all rows.

Supports caching based on performance tier and invokes query hooks.
Type Parameters
- T = unknown
Parameters
- statement: string
- Optionalparameters: StorageParameters
Returns Promise<T[]>
Implementation of StorageAdapter.all
- Defined in src/adapters/baseStorageAdapter.ts:475

exec

exec(script): Promise<void>
Executes a SQL script.
Parameters
- script: string
Returns Promise<void>
Implementation of StorageAdapter.exec
- Defined in src/adapters/baseStorageAdapter.ts:558

transaction

transaction<T>(fn): Promise<T>
Executes a transaction.

Invokes transaction hooks and invalidates cache on completion.
Type Parameters
- T
Parameters
- fn: ((trx: StorageAdapter) => Promise<T>)
  - - (trx): Promise<T>
    - Parameters
      trx: StorageAdapter
      Returns Promise<T>
Returns Promise<T>
Implementation of StorageAdapter.transaction
- Defined in src/adapters/baseStorageAdapter.ts:583

close

close(): Promise<void>
Closes the adapter connection.

Returns Promise<void>
Implementation of StorageAdapter.close
- Defined in src/adapters/baseStorageAdapter.ts:650

batch

batch(operations): Promise<BatchResult>
Executes a batch of operations (optional).
Parameters
- operations: BatchOperation[]
Returns Promise<BatchResult>
Implementation of StorageAdapter.batch
- Defined in src/adapters/baseStorageAdapter.ts:675

prepare

prepare<T>(statement): PreparedStatement<T>
Creates a prepared statement (optional).
Type Parameters
- T = unknown
Parameters
- statement: string
Returns PreparedStatement<T>
Implementation of StorageAdapter.prepare
- Defined in src/adapters/baseStorageAdapter.ts:708

`Protected` `Abstract`performOpen

performOpen(options?): Promise<void>
Adapter-specific open logic. Called by base class after state validation.
Parameters
- Optionaloptions: StorageOpenOptions
Returns Promise<void>
- Defined in src/adapters/baseStorageAdapter.ts:731

`Protected` `Abstract`performRun

performRun(statement, parameters?): Promise<StorageRunResult>
Adapter-specific mutation logic.
Parameters
- statement: string
- Optionalparameters: StorageParameters
Returns Promise<StorageRunResult>
- Defined in src/adapters/baseStorageAdapter.ts:736

`Protected` `Abstract`performGet

performGet<T>(statement, parameters?): Promise<null | T>
Adapter-specific single-row query logic.
Type Parameters
- T
Parameters
- statement: string
- Optionalparameters: StorageParameters
Returns Promise<null | T>
- Defined in src/adapters/baseStorageAdapter.ts:741

`Protected` `Abstract`performAll

performAll<T>(statement, parameters?): Promise<T[]>
Adapter-specific multi-row query logic.
Type Parameters
- T
Parameters
- statement: string
- Optionalparameters: StorageParameters
Returns Promise<T[]>
- Defined in src/adapters/baseStorageAdapter.ts:746

`Protected` `Abstract`performExec

performExec(script): Promise<void>
Adapter-specific script execution logic.
Parameters
- script: string
Returns Promise<void>
- Defined in src/adapters/baseStorageAdapter.ts:751

`Protected` `Abstract`performTransaction

performTransaction<T>(fn): Promise<T>
Adapter-specific transaction logic.
Type Parameters
- T
Parameters
- fn: ((trx: StorageAdapter) => Promise<T>)
  - - (trx): Promise<T>
    - Parameters
      trx: StorageAdapter
      Returns Promise<T>
Returns Promise<T>
- Defined in src/adapters/baseStorageAdapter.ts:756

`Protected` `Abstract`performClose

performClose(): Promise<void>
Adapter-specific close logic.

Returns Promise<void>
- Defined in src/adapters/baseStorageAdapter.ts:761

`Protected` `Optional`performBatch

performBatch(operations): Promise<BatchResult>
Adapter-specific batch logic (optional). Only called if adapter declares 'batch' capability.
Parameters
- operations: BatchOperation[]
Returns Promise<BatchResult>
- Defined in src/adapters/baseStorageAdapter.ts:767

`Protected` `Optional`performPrepare

performPrepare<T>(statement): PreparedStatement<T>
Adapter-specific prepared statement logic (optional). Only called if adapter declares 'prepared' capability.
Type Parameters
- T
Parameters
- statement: string
Returns PreparedStatement<T>
- Defined in src/adapters/baseStorageAdapter.ts:773

`Protected`assertOpen

assertOpen(): void
Asserts that adapter is in open state.

Returns void
Throws
If adapter is not open
- Defined in src/adapters/baseStorageAdapter.ts:783

`Protected`validateStatement

validateStatement(statement): void
Validates SQL statement.
Parameters
- statement: string
Returns void
Throws
If statement is invalid
- Defined in src/adapters/baseStorageAdapter.ts:793

`Protected`wrapError

wrapError(message, error): Error
Wraps an error with adapter context.
Parameters
- message: string
- error: unknown
Returns Error
- Defined in src/adapters/baseStorageAdapter.ts:1042

`Protected`log

log(message): void
Logs a message if verbose mode is enabled.
Parameters
- message: string
Returns void
- Defined in src/adapters/baseStorageAdapter.ts:1057

`Protected`logWarn

logWarn(message): void
Logs a warning message (always outputs regardless of verbose).
Parameters
- message: string
Returns void
- Defined in src/adapters/baseStorageAdapter.ts:1066

getState

getState(): string
Gets current adapter state.

Returns string
- Defined in src/adapters/baseStorageAdapter.ts:1097

getMetrics

getMetrics(): Readonly<AdapterMetrics>
Gets performance metrics.

Returns Readonly<AdapterMetrics>
- Defined in src/adapters/baseStorageAdapter.ts:1104

getCacheStats

getCacheStats(): null | Readonly<CacheStats>
Gets cache statistics.

Returns null | Readonly<CacheStats>
- Defined in src/adapters/baseStorageAdapter.ts:1114

getPerformanceSettings

getPerformanceSettings(): Readonly<PerformanceSettings>
Gets current performance settings.

Returns Readonly<PerformanceSettings>
- Defined in src/adapters/baseStorageAdapter.ts:1124

isOpen

isOpen(): boolean
Checks if adapter is open.

Returns boolean
- Defined in src/adapters/baseStorageAdapter.ts:1131

isClosed

isClosed(): boolean
Checks if adapter is closed.

Returns boolean
- Defined in src/adapters/baseStorageAdapter.ts:1138

getUptime

getUptime(): number
Gets uptime in milliseconds.

Returns number
- Defined in src/adapters/baseStorageAdapter.ts:1145

Class BaseStorageAdapterAbstract

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseStorageAdapter

Example: Default balanced tier

Example: Fast tier for development

Example: With RAG hooks

Properties

Abstract Readonlykind

Abstract Readonlycapabilities

Protected Readonlyoptions

Protected ReadonlyperformanceSettings

Protected Readonlyhooks

Methods

open

Parameters

Returns Promise<void>

run

Parameters

Returns Promise<StorageRunResult>

get

Type Parameters

Parameters

Returns Promise<null | T>

all

Type Parameters

Parameters

Returns Promise<T[]>

exec

Parameters

Returns Promise<void>

transaction

Type Parameters

Parameters

Parameters

Returns Promise<T>

Returns Promise<T>

close

Returns Promise<void>

batch

Parameters

Returns Promise<BatchResult>

prepare

Type Parameters

Parameters

Returns PreparedStatement<T>

Protected AbstractperformOpen

Parameters

Returns Promise<void>

Protected AbstractperformRun

Parameters

Returns Promise<StorageRunResult>

Protected AbstractperformGet

Type Parameters

Parameters

Returns Promise<null | T>

Protected AbstractperformAll

Type Parameters

Parameters

Returns Promise<T[]>

Protected AbstractperformExec

Parameters

Returns Promise<void>

Protected AbstractperformTransaction

Type Parameters

Parameters

Parameters

Returns Promise<T>

Returns Promise<T>

Protected AbstractperformClose

Returns Promise<void>

Protected OptionalperformBatch

Parameters

Returns Promise<BatchResult>

Class BaseStorageAdapter`Abstract`

`Abstract` `Readonly`kind

`Abstract` `Readonly`capabilities

`Protected` `Readonly`options

`Protected` `Readonly`performanceSettings

`Protected` `Readonly`hooks

`Protected` `Abstract`performOpen

`Protected` `Abstract`performRun

`Protected` `Abstract`performGet

`Protected` `Abstract`performAll

`Protected` `Abstract`performExec

`Protected` `Abstract`performTransaction

`Protected` `Abstract`performClose

`Protected` `Optional`performBatch

`Protected` `Optional`performPrepare

`Protected`assertOpen

`Protected`validateStatement

`Protected`wrapError

`Protected`log

`Protected`logWarn