prorm API Reference
    Preparing search index...

    Interface NoSqlStore

    Base interface for NoSQL stores.

    NoSQL engines (document stores, key-value caches, partition-key stores) do not share the SQL-shaped Dialect interface (no query(sql), no identifier escaping, no DDL). NoSqlStore is intentionally minimal: connection lifecycle plus a raw escape hatch. Each store's real API surface (find/insert/update for Mongo, hash/list/set ops for Redis, item CRUD for DynamoDB) lives on its own class, not on this interface, because forcing them into one shared query shape would misrepresent what each engine can actually do.

    interface NoSqlStore {
        name: string;
        library: string;
        connect(): Promise<void>;
        disconnect(): Promise<void>;
        isConnected(): boolean;
        getClient(): unknown;
    }

    Implemented by

    Index
    name library
    connect disconnect isConnected getClient
    name: string

    The name of the store (e.g. 'mongodb', 'redis', 'dynamodb')

    library: string

    The client library being used

    • Access the underlying native client for operations not wrapped here

      Returns unknown

    Settings
    Member Visibility

    On This Page
    Properties
    Methods