@influxdata/influxdb3-client
    Preparing search index...

    Interface ClientOptions

    Options used by InfluxDBClient .

    interface ClientOptions {
        authScheme?: string;
        database?: string;
        grpcOptions?: Record<string, any>;
        headers?: Record<string, string>;
        host: string;
        proxyUrl?: string;
        queryOptions?: Partial<QueryOptions>;
        queryTimeout?: number;
        timeout?: number;
        token?: string;
        transport?: Transport;
        transportOptions?: { [key: string]: any };
        writeOptions?: Partial<WriteOptions>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authScheme? database? grpcOptions? headers? host proxyUrl? queryOptions? queryTimeout? timeout? token? transport? transportOptions? writeOptions?

    Properties

    authScheme?: string

    token authentication scheme. Not set for Cloud access, set to 'Bearer' for Edge.

    database?: string

    default database for write query if not present as argument.

    grpcOptions?: Record<string, any>

    Grpc options to be passed when instantiating query transport. See supported channel options in @grpc/grpc-js/README.md.

    headers?: Record<string, string>

    Default HTTP headers to send with every request.

    host: string

    base host URL

    proxyUrl?: string

    Full HTTP web proxy URL including schema, for example http://your-proxy:8080.

    queryOptions?: Partial<QueryOptions>

    supplies query options to be use with each and every query.

    queryTimeout?: number

    stream timeout for query (grpc timeout). The gRPC doesn't apply the socket timeout to operations as is defined above. To successfully close a call to the gRPC endpoint, the queryTimeout must be specified. Without this timeout, a gRPC call might end up in an infinite wait state.

    60000
    timeout?: number

    socket timeout. 10000 milliseconds by default in node.js. Not applicable in browser (option is ignored).

    10000
    token?: string

    authentication token

    transport?: Transport

    specifies custom transport

    transportOptions?: { [key: string]: any }

    TransportOptions supply extra options for the transport layer, they differ between node.js and browser/deno. Node.js transport accepts options specified in http.request or https.request. For example, an agent property can be set to setup HTTP/HTTPS proxy, rejectUnauthorized property can disable TLS server certificate verification. Additionally, follow-redirects property can be also specified in order to follow redirects in node.js. fetch is used under the hood in browser/deno. For example, redirect property can be set to 'error' to abort request if a redirect occurs.

    writeOptions?: Partial<WriteOptions>

    supplies and overrides default writing options.

    Settings

    Member Visibility

    On This Page

    Properties