prorm API Reference
    Preparing search index...

    Interface TigerGraphStoreOptions

    Connection options for TigerGraphStore.

    TigerGraph traditionally splits traffic across two ports: the REST++ data-plane API (vertex/edge CRUD, installed queries - historically port 9000) and the GSQL server (schema/DDL, ad-hoc "interpreted" queries - historically port 14240). TigerGraph 4.1+ unifies external traffic behind port 14240 with /restpp/... and /gsql/... path prefixes and makes 9000 internal-only; this store defaults to the classic two-port layout (confirmed against documented pre-4.1 REST++ endpoint shapes - see README) but every port/prefix is configurable so it can be pointed at a 4.1+ unified deployment too.

    interface TigerGraphStoreOptions {
        host: string;
        restPort?: number;
        gsqlPort?: number;
        restPathPrefix?: string;
        graph: string;
        secret?: string;
        token?: string;
        tokenLifetime?: number;
        username?: string;
        password?: string;
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
    }
    Index
    host restPort? gsqlPort? restPathPrefix? graph secret? token? tokenLifetime? username? password? fetch?
    host: string

    Protocol + hostname, e.g. 'http://localhost' or 'https://my-cluster.i.tgcloud.io'. No trailing slash, no port.

    restPort?: number

    REST++ port (vertex/edge/query endpoints). Default 9000.

    gsqlPort?: number

    GSQL server port (interpreted queries, schema introspection). Default 14240.

    restPathPrefix?: string

    Path prefix in front of REST++ routes, e.g. '/restpp' on a 4.1+ unified deployment. Default ''.

    graph: string

    Default graph name used when a call doesn't override it.

    secret?: string

    GSQL secret used to mint a token via POST /requesttoken (see README - confirmed pre-4.1 shape). Provide this, or a pre-minted token, to authenticate REST++ (vertex/edge/query) calls.

    token?: string

    A pre-minted REST++ auth token. Skips the /requesttoken round trip in connect().

    tokenLifetime?: number

    Requested token lifetime in seconds, passed to /requesttoken.

    username?: string

    Username/password used for HTTP Basic auth against GSQL-server endpoints (interpreted queries, schema introspection). TigerGraph's documented example for the interpreted-query endpoint uses Basic auth rather than the REST++ bearer token; the same credentials are reused here for schema introspection since both are GSQL-server routes.

    password?: string
    fetch?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Injectable fetch implementation, primarily for tests. Defaults to globalThis.fetch.

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    Settings
    Member Visibility

    On This Page
    Properties