Interface AdapterContext

Runtime context providing introspection into the current adapter.

This interface provides a high-level API for querying adapter capabilities, connection state, and performance without requiring manual capability flag checking.

Example

const context = adapter.context;

// Simple boolean checks
if (context.supportsBatch) {
  await adapter.batch(operations);
}

// Get detailed status
const status = context.getStatus();
console.log(`Healthy: ${status.healthy}, Queries: ${status.totalQueries}`);

// Get limitations
const limits = context.getLimitations();
console.log(`Max batch size: ${limits.maxBatchSize}`);
interface AdapterContext {
    adapter: StorageAdapter;
    kind: AdapterKind;
    capabilities: ReadonlySet<StorageCapability>;
    isOpen: boolean;
    supportsSync: boolean;
    supportsTransactions: boolean;
    supportsBatch: boolean;
    supportsPrepared: boolean;
    supportsStreaming: boolean;
    supportsWAL: boolean;
    supportsJSON: boolean;
    supportsArrays: boolean;
    supportsConcurrent: boolean;
    supportsPersistence: boolean;
    connectionInfo: ConnectionInfo;
    hasCapability(capability: StorageCapability): boolean;
    requiresCapability(capability: StorageCapability): void;
    getLimitations(): AdapterLimitations;
    getStatus(): AdapterStatus;
}

Properties

adapter kind capabilities isOpen supportsSync supportsTransactions supportsBatch supportsPrepared supportsStreaming supportsWAL supportsJSON supportsArrays supportsConcurrent supportsPersistence connectionInfo

Methods

hasCapability requiresCapability getLimitations getStatus

Properties

Readonlyadapter

adapter: StorageAdapter

Reference to the underlying adapter

Readonlykind

kind: AdapterKind

Adapter kind identifier

Readonlycapabilities

capabilities: ReadonlySet<StorageCapability>

Set of capabilities supported by this adapter

ReadonlyisOpen

isOpen: boolean

Whether the adapter is currently open/connected

ReadonlysupportsSync

supportsSync: boolean

Whether the adapter supports synchronous operations

ReadonlysupportsTransactions

supportsTransactions: boolean

Whether the adapter supports ACID transactions

ReadonlysupportsBatch

supportsBatch: boolean

Whether the adapter supports batch operations

ReadonlysupportsPrepared

supportsPrepared: boolean

Whether the adapter supports prepared statements

ReadonlysupportsStreaming

supportsStreaming: boolean

Whether the adapter supports streaming results

ReadonlysupportsWAL

supportsWAL: boolean

Whether the adapter supports Write-Ahead Logging

ReadonlysupportsJSON

supportsJSON: boolean

Whether the adapter supports native JSON operations

ReadonlysupportsArrays

supportsArrays: boolean

Whether the adapter supports array data types

ReadonlysupportsConcurrent

supportsConcurrent: boolean

Whether the adapter supports concurrent connections

ReadonlysupportsPersistence

supportsPersistence: boolean

Whether the adapter persists data across restarts

ReadonlyconnectionInfo

connectionInfo: ConnectionInfo

Information about the current connection

Methods

hasCapability

  • hasCapability(capability): boolean

  • Check if a specific capability is supported.

    Parameters

    Returns boolean

    True if the capability is supported

    Example

    if (context.hasCapability('streaming')) {
      // Use streaming API
    }

requiresCapability

  • requiresCapability(capability): void

  • Require a specific capability, throwing an error if not supported.

    Parameters

    Returns void

    Throws

    If the capability is not supported

    Example

    context.requiresCapability('transactions');
    // Safe to use transactions now
    await adapter.transaction(async (trx) => { ... });

getLimitations

getStatus

Settings

Member Visibility

On This Page

Properties
Methods