prorm API Reference
    Preparing search index...

    Interface Neo4jStoreOptions

    Connection options for Neo4jStore.

    Accepts either a pre-built AuthToken (e.g. from neo4j.auth.kerberos()/ neo4j.auth.bearer()) or a plain username/password pair, which is turned into a basic auth token. Any other neo4j-driver Config fields (maxConnectionPoolSize, connectionTimeout, encrypted, etc) are passed straight through via config.

    interface Neo4jStoreOptions {
        uri: string;
        username?: string;
        password?: string;
        auth?: AuthToken;
        database?: string;
        config?: Config;
    }
    Index
    uri username? password? auth? database? config?
    uri: string

    Bolt/neo4j connection URI, e.g. 'neo4j://localhost:7687' or 'bolt://localhost:7687'.

    username?: string

    Basic-auth username. Ignored if auth is provided.

    password?: string

    Basic-auth password. Ignored if auth is provided.

    auth?: AuthToken

    A pre-built auth token (neo4j.auth.basic/kerberos/bearer/custom). Overrides username/password.

    database?: string

    Default database to run sessions/queries against (Neo4j 4.0+ multi-database).

    config?: Config

    Any other neo4j-driver Config fields, passed straight through to neo4j.driver().

    Settings
    Member Visibility

    On This Page
    Properties