prorm API Reference
    Preparing search index...

    Interface InfluxDBStoreOptions

    Connection options for InfluxDBStore.

    url, token, and org are required - InfluxDB 2.x/Cloud auth is token-based and every write/query is scoped to an organization. bucket is optional here and is only used as the default bucket for convenience methods that don't take an explicit bucket override.

    interface InfluxDBStoreOptions {
        url: string;
        token: string;
        org: string;
        bucket?: string;
        precision?: WritePrecisionType;
        timeout?: number;
        headers?: Record<string, string>;
        writeOptions?: Partial<WriteOptions>;
    }
    Index
    url token org bucket? precision? timeout? headers? writeOptions?
    url: string

    Base URL of the InfluxDB server/cloud instance, e.g. http://localhost:8086.

    token: string

    API token used for both writes and queries.

    org: string

    Organization (name or ID) that writes/queries are scoped to.

    bucket?: string

    Default bucket used by convenience methods when no bucket override is given.

    precision?: WritePrecisionType

    Default timestamp precision for the write API. Defaults to 'ns'.

    timeout?: number

    Socket timeout in milliseconds. Defaults to the client's own default (10000).

    headers?: Record<string, string>

    Extra HTTP headers sent with every request.

    writeOptions?: Partial<WriteOptions>

    Overrides for the write API's batching/retry behavior (batchSize, flushInterval, maxRetries, ...).

    Settings
    Member Visibility

    On This Page
    Properties