Interface QueryKotlinApi

  • All Implemented Interfaces:

    
    public interface QueryKotlinApi
    
                        

    The client that allows perform Flux queries against the InfluxDB /api/v2/query endpoint.

    For parametrized queries use Query object, see com.influxdb.client.QueryApi in Java module for more details.

    Author:

    Jakub Bednar (bednar@github) (29/10/2018 10:45)

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Channel<FluxRecord> query(String query) Executes the Flux query against the InfluxDB and asynchronously stream com.influxdb.query.FluxRecords to kotlinx.coroutines.channels.Channel.
      abstract Channel<FluxRecord> query(String query, String org) Executes the Flux query against the InfluxDB and asynchronously stream com.influxdb.query.FluxRecords to kotlinx.coroutines.channels.Channel.
      abstract Channel<FluxRecord> query(Query query) Executes the Flux query against the InfluxDB and asynchronously stream com.influxdb.query.FluxRecords to kotlinx.coroutines.channels.Channel.
      abstract Channel<FluxRecord> query(Query query, String org) Executes the Flux query against the InfluxDB and asynchronously stream com.influxdb.query.FluxRecords to kotlinx.coroutines.channels.Channel.
      abstract <M extends Any> Channel<M> query(String query, Class<M> measurementType) Executes the Flux query against the InfluxDB and asynchronously stream measurements to kotlinx.coroutines.channels.Channel.
      abstract <M extends Any> Channel<M> query(String query, String org, Class<M> measurementType) Executes the Flux query against the InfluxDB and asynchronously stream measurements to kotlinx.coroutines.channels.Channel.
      abstract <M extends Any> Channel<M> query(Query query, Class<M> measurementType) Executes the Flux query against the InfluxDB and asynchronously stream measurements to kotlinx.coroutines.channels.Channel.
      abstract <M extends Any> Channel<M> query(Query query, String org, Class<M> measurementType) Executes the Flux query against the InfluxDB and asynchronously stream measurements to kotlinx.coroutines.channels.Channel.
      abstract Channel<String> queryRaw(String query) Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.
      abstract Channel<String> queryRaw(String query, String org) Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.
      abstract Channel<String> queryRaw(String query, Dialect dialect) Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.
      abstract Channel<String> queryRaw(String query, Dialect dialect, String org) Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.
      abstract Channel<String> queryRaw(Query query) Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.
      abstract Channel<String> queryRaw(Query query, String org) Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • query

         abstract Channel<FluxRecord> query(String query)

        Executes the Flux query against the InfluxDB and asynchronously stream com.influxdb.query.FluxRecords to kotlinx.coroutines.channels.Channel.

        The com.influxdb.client.InfluxDBClientOptions.getOrg will be used as source organization.

        Parameters:
        query - the flux query to execute
        Returns:

        the stream of com.influxdb.query.FluxRecords

      • query

         abstract Channel<FluxRecord> query(String query, String org)

        Executes the Flux query against the InfluxDB and asynchronously stream com.influxdb.query.FluxRecords to kotlinx.coroutines.channels.Channel.

        Parameters:
        query - the flux query to execute
        org - specifies the source organization
        Returns:

        the stream of com.influxdb.query.FluxRecords

      • query

         abstract Channel<FluxRecord> query(Query query)

        Executes the Flux query against the InfluxDB and asynchronously stream com.influxdb.query.FluxRecords to kotlinx.coroutines.channels.Channel.

        The com.influxdb.client.InfluxDBClientOptions.getOrg will be used as source organization.

        Parameters:
        query - the flux query to execute
        Returns:

        the stream of com.influxdb.query.FluxRecords

      • query

         abstract Channel<FluxRecord> query(Query query, String org)

        Executes the Flux query against the InfluxDB and asynchronously stream com.influxdb.query.FluxRecords to kotlinx.coroutines.channels.Channel.

        Parameters:
        query - the flux query to execute
        org - specifies the source organization
        Returns:

        the stream of com.influxdb.query.FluxRecords

      • query

         abstract <M extends Any> Channel<M> query(String query, Class<M> measurementType)

        Executes the Flux query against the InfluxDB and asynchronously stream measurements to kotlinx.coroutines.channels.Channel.

        The com.influxdb.client.InfluxDBClientOptions.getOrg will be used as source organization.

        Parameters:
        query - the flux query to execute
        Returns:

        the stream of measurements

      • query

         abstract <M extends Any> Channel<M> query(String query, String org, Class<M> measurementType)

        Executes the Flux query against the InfluxDB and asynchronously stream measurements to kotlinx.coroutines.channels.Channel.

        Parameters:
        query - the flux query to execute
        org - specifies the source organization
        Returns:

        the stream of measurements

      • query

         abstract <M extends Any> Channel<M> query(Query query, Class<M> measurementType)

        Executes the Flux query against the InfluxDB and asynchronously stream measurements to kotlinx.coroutines.channels.Channel.

        The com.influxdb.client.InfluxDBClientOptions.getOrg will be used as source organization.

        Parameters:
        query - the flux query to execute
        Returns:

        the stream of measurements

      • query

         abstract <M extends Any> Channel<M> query(Query query, String org, Class<M> measurementType)

        Executes the Flux query against the InfluxDB and asynchronously stream measurements to kotlinx.coroutines.channels.Channel.

        Parameters:
        query - the flux query to execute
        org - specifies the source organization
        Returns:

        the stream of measurements

      • queryRaw

         abstract Channel<String> queryRaw(String query)

        Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.

        The com.influxdb.client.InfluxDBClientOptions.getOrg will be used as source organization.

        Parameters:
        query - the flux query to execute
        Returns:

        the response stream

      • queryRaw

         abstract Channel<String> queryRaw(String query, String org)

        Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.

        Parameters:
        query - the flux query to execute
        org - specifies the source organization
        Returns:

        the response stream

      • queryRaw

         abstract Channel<String> queryRaw(String query, Dialect dialect)

        Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.

        The com.influxdb.client.InfluxDBClientOptions.getOrg will be used as source organization.

        Parameters:
        query - the flux query to execute
        dialect - Dialect is an object defining the options to use when encoding the response.
        Returns:

        the response stream

      • queryRaw

         abstract Channel<String> queryRaw(String query, Dialect dialect, String org)

        Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.

        Parameters:
        query - the flux query to execute
        dialect - Dialect is an object defining the options to use when encoding the response.
        org - specifies the source organization
        Returns:

        the response stream

      • queryRaw

         abstract Channel<String> queryRaw(Query query)

        Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.

        The com.influxdb.client.InfluxDBClientOptions.getOrg will be used as source organization.

        Parameters:
        query - the flux query to execute
        Returns:

        the response stream

      • queryRaw

         abstract Channel<String> queryRaw(Query query, String org)

        Executes the Flux query against the InfluxDB and asynchronously stream response to kotlinx.coroutines.channels.Channel.

        Parameters:
        query - the flux query to execute
        org - specifies the source organization
        Returns:

        the response stream