Interface default

Asynchronous API that queries data from a database.

interface default {
    close(): Promise<void>;
    query(
        query: string,
        database: string,
        options: QueryOptions,
    ): AsyncGenerator<Record<string, any>, void, void>;
    queryPoints(
        query: string,
        database: string,
        options: QueryOptions,
    ): AsyncGenerator<PointValues, void, void>;
}

Implemented by

Methods

close query queryPoints

Methods

close

query

  • query(
        query: string,
        database: string,
        options: QueryOptions,
    ): AsyncGenerator<Record<string, any>, void, void>

  • Execute a query and return the results as an async generator.

    Parameters

    • query: string

      The query string.

    • database: string

      The name of the database to query.

    • options: QueryOptions

      options applied to the query (default: { type: 'sql'}).

    Returns AsyncGenerator<Record<string, any>, void, void>

    An async generator that yields maps of string keys to any values.

queryPoints

  • queryPoints(
        query: string,
        database: string,
        options: QueryOptions,
    ): AsyncGenerator<PointValues, void, void>

  • Execute a query and return the results as an async generator.

    Parameters

    • query: string

      The query string.

    • database: string

      The name of the database to query.

    • options: QueryOptions

      Options for the query (default: {type: 'sql'}).

    Returns AsyncGenerator<PointValues, void, void>

    An async generator that yields PointValues object.

Settings

Member Visibility

On This Page

Methods