Interface WriteContext

Context for write operations (run, batch).

Example

const hooks: StorageHooks = {
  onBeforeWrite: async (context) => {
    // Add timestamp to all inserts
    if (context.statement.toUpperCase().startsWith('INSERT')) {
      context.metadata = { ...context.metadata, insertedAt: Date.now() };
    }
    return context;
  }
};
interface WriteContext {
    operationId: string;
    startTime: number;
    adapterKind: string;
    metadata?: Record<string, unknown>;
    operation: "run" | "batch";
    statement: string;
    parameters?: StorageParameters;
    affectedTables?: string[];
    inTransaction?: boolean;
}

Hierarchy (view full)

Properties

operationId startTime adapterKind metadata? operation statement parameters? affectedTables? inTransaction?

Properties

ReadonlyoperationId

operationId: string

Unique identifier for this operation (UUID v4).

Use for correlation in logs and traces.

ReadonlystartTime

startTime: number

Timestamp when operation started (ms since epoch).

ReadonlyadapterKind

adapterKind: string

Adapter kind (e.g., 'better-sqlite3', 'indexeddb', 'postgres').

Optionalmetadata

metadata?: Record<string, unknown>

Custom metadata attached to this operation.

Hooks can read and modify this to pass data between hooks or to the calling code.

Example: Marking a query for special handling

const results = await db.all(
  'SELECT * FROM users WHERE id = ?',
  [userId],
  { metadata: { skipCache: true, auditLevel: 'high' } }
);

Readonlyoperation

operation: "run" | "batch"

Operation type (write operations only).

statement

statement: string

SQL statement being executed.

Hooks can modify this to transform mutations.

Optionalparameters

parameters?: StorageParameters

Parameters for parameterized statements.

Hooks can modify this to transform parameters.

OptionalaffectedTables

affectedTables?: string[]

Tables being modified by this write.

Used for cache invalidation and tracking.

Optional ReadonlyinTransaction

inTransaction?: boolean

Whether this write is part of a transaction.

Settings

Member Visibility

On This Page

Properties