prorm API Reference
    Preparing search index...

    Interface GraphConnectionOptions

    Connection options accepted by every graph dialect. Superset of the SQL DialectOptions (host/port/database/username/password) plus a graph endpoint url and an escape hatch for injecting a pre-built driver/client (used by tests and connection reuse, mirroring the NoSQL stores).

    interface GraphConnectionOptions {
        url?: string;
        host?: string;
        port?: number;
        database?: string;
        username?: string;
        password?: string;
        driverOptions?: Record<string, unknown>;
        client?: unknown;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    url? host? port? database? username? password? driverOptions? client?
    url?: string

    Full endpoint URL, e.g. bolt://localhost:7687, ws://host:8182/gremlin, http://localhost:8080.

    host?: string
    port?: number
    database?: string
    username?: string
    password?: string
    driverOptions?: Record<string, unknown>

    Extra driver-specific options passed straight through.

    client?: unknown

    Pre-built native client/driver to use instead of constructing one.

    Settings
    Member Visibility

    On This Page
    Properties