Interface QueryApi

Query InfluxDB. Provides methods that notify about result lines of the executed query. See https://docs.influxdata.com/influxdb/latest/api/#operation/PostQuery

interface QueryApi {
    collectLines(query: string | ParameterizedQuery): Promise<string[]>;
    collectRows<T>(
        query: string | ParameterizedQuery,
        rowMapper?: (
            values: string[],
            tableMeta: FluxTableMetaData,
        ) => undefined | T,
    ): Promise<T[]>;
    iterateLines(query: string | ParameterizedQuery): AsyncIterable<string>;
    iterateRows(query: string | ParameterizedQuery): AsyncIterable<Row>;
    lines(query: string | ParameterizedQuery): Observable<string>;
    queryLines(
        query: string | ParameterizedQuery,
        consumer: CommunicationObserver<string>,
    ): void;
    queryRaw(query: string | ParameterizedQuery): Promise<string>;
    queryRows(
        query: string | ParameterizedQuery,
        consumer: FluxResultObserver<string[]>,
    ): void;
    response(query: string | ParameterizedQuery): AnnotatedCSVResponse;
    rows(query: string | ParameterizedQuery): Observable<Row>;
    with(options: Partial<QueryOptions>): QueryApi;
}

Index

Methods

collectLines collectRows iterateLines iterateRows lines queryLines queryRaw queryRows response rows with

Methods

collectLines

collectLines(query: string | ParameterizedQuery): Promise<string[]>
CollectLines executes the query and collects all result lines in the returned Promise. This method is suitable to collect simple results. Use with caution, a possibly huge stream of lines is copied to memory.
Parameters
- query: string | ParameterizedQuery
  query
Returns Promise<string[]>
Promise of returned csv lines
- Defined in packages/core/src/QueryApi.ts:153

collectRows

collectRows<T>(
    query: string | ParameterizedQuery,
    rowMapper?: (
        values: string[],
        tableMeta: FluxTableMetaData,
    ) => undefined | T,
): Promise<T[]>
CollectRows executes the query and collects all the results in the returned Promise. This method is suitable to collect simple results. Use with caution, a possibly huge stream of results is copied to memory.
Type Parameters
- T
Parameters
- query: string | ParameterizedQuery
  query
- OptionalrowMapper: (values: string[], tableMeta: FluxTableMetaData) => undefined | T
  maps the supplied row to an item that is then collected, undefined return values are not collected. If no rowMapper is supplied, row => tableMeta.toObject(row.values) is used.
Returns Promise<T[]>
Promise of mapped results
- Defined in packages/core/src/QueryApi.ts:137

iterateLines

iterateLines(query: string | ParameterizedQuery): AsyncIterable<string>
IterateLines executes the supplied query and returns results in an async iterable of annotated CSV lines. Async iterables are best consumed by for-await loop.
Parameters
- query: string | ParameterizedQuery
  query
Returns AsyncIterable<string>
async iterable of CSV result lines
- Defined in packages/core/src/QueryApi.ts:66

iterateRows

iterateRows(query: string | ParameterizedQuery): AsyncIterable<Row>
IterateRows executes the supplied query and returns results in an async iterable of row data and table metadata pairs. Async iterables are best consumed by for-await loop.
Parameters
- query: string | ParameterizedQuery
  query
Returns AsyncIterable<Row>
async iterable of CSV result lines
- Defined in packages/core/src/QueryApi.ts:76

lines

lines(query: string | ParameterizedQuery): Observable<string>
Creates a cold observable of the lines returned by the given query.
Parameters
- query: string | ParameterizedQuery
  query
Returns Observable<string>
observable of CSV result lines
- Defined in packages/core/src/QueryApi.ts:84

queryLines

queryLines(
query: string | ParameterizedQuery,
consumer: CommunicationObserver<string>,
): void
Executes the query and receives result lines (including empty and annotation lines) through the supplied consumer. See annotated-csv.
Parameters
- query: string | ParameterizedQuery
  query
- consumer: CommunicationObserver<string>
  csv result lines and error consumer
Returns void
- Defined in packages/core/src/QueryApi.ts:101

queryRaw

queryRaw(query: string | ParameterizedQuery): Promise<string>
QueryRaw executes a query and returns the full response as a string. Use with caution, a possibly huge stream is copied to memory.
Parameters
- query: string | ParameterizedQuery
  query
Returns Promise<string>
Promise of response text
- Defined in packages/core/src/QueryApi.ts:124

queryRows

queryRows(
query: string | ParameterizedQuery,
consumer: FluxResultObserver<string[]>,
): void
Executes the query and receives table metadata and rows through the supplied consumer.
Parameters
- query: string | ParameterizedQuery
  query
- consumer: FluxResultObserver<string[]>
  result rows and error consumer
Returns void
- Defined in packages/core/src/QueryApi.ts:112

response

response(query: string | ParameterizedQuery): AnnotatedCSVResponse
Response returns an AnnotatedCSVResponse instance that executes the query when asked for data.
Parameters
- query: string | ParameterizedQuery
  query
Returns AnnotatedCSVResponse
response with various methods to process data from the returned annotated CSV response data stream
- Defined in packages/core/src/QueryApi.ts:56

rows

rows(query: string | ParameterizedQuery): Observable<Row>
Creates a cold observable of the rows returned by the given query.
Parameters
- query: string | ParameterizedQuery
  query
Returns Observable<Row>
observable of result rows
- Defined in packages/core/src/QueryApi.ts:92

with

with(options: Partial<QueryOptions>): QueryApi
Returns a new query API with extra options applied.
Parameters
- options: Partial<QueryOptions>
  query options to use
Returns QueryApi
queryApi instance with the supplied options
- Defined in packages/core/src/QueryApi.ts:46

Interface QueryApi

Index

Methods

Methods

collectLines

Parameters

Returns Promise<string[]>

collectRows

Type Parameters

Parameters

Returns Promise<T[]>

iterateLines

Parameters

Returns AsyncIterable<string>

iterateRows

Parameters

Returns AsyncIterable<Row>

lines

Parameters

Returns Observable<string>

queryLines

Parameters

Returns void

queryRaw

Parameters

Returns Promise<string>

queryRows

Parameters

Returns void

response

Parameters

Returns AnnotatedCSVResponse

rows

Parameters

Returns Observable<Row>

with

Parameters

Returns QueryApi

Settings

On This Page