com.influxdb.client.reactive.QueryReactiveApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of influxdb-client-reactive Show documentation
The reference reactive Java client for InfluxDB 2.x. The client provide supports for asynchronous stream processing with backpressure as is defined by the Reactive Streams.
There is a newer version: 7.2.0
Show newest version
/*
 * The MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.influxdb.client.reactive;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.influxdb.client.InfluxDBClientOptions;
import com.influxdb.client.domain.Dialect;
import com.influxdb.query.FluxRecord;

import io.reactivex.Flowable;
import org.reactivestreams.Publisher;

/**
 * The client that allow perform Flux query against theInfluxDB 2.0by a reactive way.
 *
 * @author Jakub Bednar (bednar@github) (21/11/2018 07:19)
 */
public interface QueryReactiveApi {

    /**
     * Returns {@link Flowable} emitting {@link FluxRecord}s which are matched the query.
     * If none found than return {@link Flowable#empty()}.
     *
     * The {@link InfluxDBClientOptions#getOrg()} will be used as source organization.
     *
     * @param query the Flux query to execute
     * @return {@link Flowable} of {@link FluxRecord}s
     */
    @Nonnull
    Flowable query(@Nonnull final String query);

    /**
     * Returns {@link Flowable} emitting {@link FluxRecord}s which are matched the query.
     * If none found than return {@link Flowable#empty()}.
     *
     * @param query the Flux query to execute
     * @param org specifies the source organization
     * @return {@link Flowable} of {@link FluxRecord}s
     */
    @Nonnull
    Flowable query(@Nonnull final String query, @Nonnull final String org);

    /**
     * Execute a Flux against the Flux service.
     *
     * The {@link InfluxDBClientOptions#getOrg()} will be used as source organization.
     *
     * @param query           the flux query to execute
     * @param measurementType the class type used to which will be result mapped
     * @param              the type of the measurement (POJO)
     * @return {@link Flowable} emitting a POJO mapped to {@code measurementType} which are matched
     * the query or {@link Flowable#empty()} if none found.
     */
     Flowable query(@Nonnull final String query,
                          @Nonnull final Class measurementType);

    /**
     * Execute a Flux against the Flux service.
     *
     * @param query           the flux query to execute
     * @param org           specifies the source organization
     * @param measurementType the class type used to which will be result mapped
     * @param              the type of the measurement (POJO)
     * @return {@link Flowable} emitting a POJO mapped to {@code measurementType} which are matched
     * the query or {@link Flowable#empty()} if none found.
     */
     Flowable query(@Nonnull final String query,
                          @Nonnull final String org,
                          @Nonnull final Class measurementType);

    /**
     * Returns {@link Flowable} emitting {@link FluxRecord}s which are matched the query.
     * If none found than return {@link Flowable#empty()}.
     *
     * The {@link InfluxDBClientOptions#getOrg()} will be used as source organization.
     *
     * @param queryStream the Flux query publisher
     * @return {@link Flowable} of {@link FluxRecord}s
     */
    @Nonnull
    Flowable query(@Nonnull final Publisher queryStream);

    /**
     * Returns {@link Flowable} emitting {@link FluxRecord}s which are matched the query.
     * If none found than return {@link Flowable#empty()}.
     *
     * @param queryStream the Flux query publisher
     * @param org       specifies the source organization
     * @return {@link Flowable} of {@link FluxRecord}s
     */
    @Nonnull
    Flowable query(@Nonnull final Publisher queryStream, @Nonnull final String org);

    /**
     * Returns the {@link Flowable} emitting POJO stream.
     * 
     * If none found than return {@link Flowable#empty()}.
     *
     * 
The {@link InfluxDBClientOptions#getOrg()} will be used as source organization.
     *
     * @param measurementType the measurement class (POJO)
     * @param              the type of the measurement (POJO)
     * @param queryStream     the Flux query publisher
     * @return {@link Flowable} of {@link FluxRecord}s
     */
    @Nonnull
     Flowable query(@Nonnull final Publisher queryStream,
                          @Nonnull final Class measurementType);

    /**
     * Returns the {@link Flowable} emitting POJO stream.
     * 
     * If none found than return {@link Flowable#empty()}.
     *
     * @param measurementType the measurement class (POJO)
     * @param org           specifies the source organization
     * @param              the type of the measurement (POJO)
     * @param queryStream     the Flux query publisher
     * @return {@link Flowable} of {@link FluxRecord}s
     */
    @Nonnull
     Flowable query(@Nonnull final Publisher queryStream,
                          @Nonnull final String org,
                          @Nonnull final Class measurementType);

    /**
     * Returns {@link Flowable} emitting raw response fromInfluxDB 2.0server line by line.
     *
     * 
The {@link InfluxDBClientOptions#getOrg()} will be used as source organization.
     *
     * @param query the Flux query to execute
     * @return {@link Flowable} of response lines
     */
    @Nonnull
    Flowable queryRaw(@Nonnull final String query);

    /**
     * Returns {@link Flowable} emitting raw response fromInfluxDB 2.0server line by line.
     *
     * @param query the Flux query to execute
     * @param org specifies the source organization
     * @return {@link Flowable} of response lines
     */
    @Nonnull
    Flowable queryRaw(@Nonnull final String query, @Nonnull final String org);

    /**
     * Returns {@link Flowable} emitting queryRaw response from InfluxDB server line by line.
     *
     * The {@link InfluxDBClientOptions#getOrg()} will be used as source organization.
     *
     * @param queryStream the Flux query publisher
     * @return {@link Flowable} of response lines
     */
    @Nonnull
    Flowable queryRaw(@Nonnull final Publisher queryStream);

    /**
     * Returns {@link Flowable} emitting queryRaw response from InfluxDB server line by line.
     *
     * @param queryStream the Flux query publisher
     * @param org       specifies the source organization
     * @return {@link Flowable} of response lines
     */
    @Nonnull
    Flowable queryRaw(@Nonnull final Publisher queryStream, @Nonnull final String org);

    /**
     * Returns {@link Flowable} emitting queryRaw response fromInfluxDB 2.0server line by line.
     *
     * The {@link InfluxDBClientOptions#getOrg()} will be used as source organization.
     *
     * @param dialect Dialect is an object defining the options to use when encoding the response.
     *                See dialect SPEC..
     * @param query   the Flux query to execute
     * @return {@link Flowable} of response lines
     */
    @Nonnull
    Flowable queryRaw(@Nonnull final String query,
                              @Nullable final Dialect dialect);

    /**
     * Returns {@link Flowable} emitting queryRaw response fromInfluxDB 2.0server line by line.
     *
     * @param dialect Dialect is an object defining the options to use when encoding the response.
     *                See dialect SPEC..
     * @param query   the Flux query to execute
     * @param org   specifies the source organization
     * @return {@link Flowable} of response lines
     */
    @Nonnull
    Flowable queryRaw(@Nonnull final String query,
                              @Nullable final Dialect dialect,
                              @Nonnull final String org);

    /**
     * Returns {@link Flowable} emitting queryRaw response fromInfluxDB 2.0server line by line.
     *
     * The {@link InfluxDBClientOptions#getOrg()} will be used as source organization.
     *
     * @param dialect     Dialect is an object defining the options to use when encoding the response.
     *                    See dialect SPEC..
     * @param queryStream the Flux query publisher
     * @return {@link Flowable} of response lines
     */
    @Nonnull
    Flowable queryRaw(@Nonnull final Publisher queryStream,
                              @Nullable final Dialect dialect);

    /**
     * Returns {@link Flowable} emitting queryRaw response fromInfluxDB 2.0server line by line.
     *
     * @param dialect     Dialect is an object defining the options to use when encoding the response.
     *                    See dialect SPEC..
     * @param queryStream the Flux query publisher
     * @param org       specifies the source organization
     * @return {@link Flowable} of response lines
     */
    @Nonnull
    Flowable queryRaw(@Nonnull final Publisher queryStream,
                              @Nullable final Dialect dialect,
                              @Nonnull final String org);
}