InfluxDB (influxdb java bindings 2.7 API)

All Known Implementing Classes:

InfluxDBImpl
```
public interface InfluxDB
```
Interface with all available methods to access a InfluxDB database. A full list of currently available interfaces is implemented in: https://github.com/ influxdb/influxdb/blob/master/src/api/http/api.go

Author:

stefan.majer [at] gmail.com

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`InfluxDB.ConsistencyLevel` ConsistencyLevel for write Operations.
`static class`	`InfluxDB.LogLevel` Controls the level of logging of the REST layer.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` close thread for asynchronous batch write and UDP socket to release resources if need.
`void`	`createDatabase(String name)` Create a new Database.
`boolean`	`databaseExists(String name)` Check if a database exists.
`void`	`deleteDatabase(String name)` Delete a database.
`List<String>`	`describeDatabases()` Describe all available databases.
`void`	`disableBatch()` Disable Batching.
`InfluxDB`	`disableGzip()` Disable Gzip compress for http request body.
`InfluxDB`	`enableBatch(int actions, int flushDuration, TimeUnit flushDurationTimeUnit)` Enable batching of single Point writes as `enableBatch(int, int, TimeUnit, ThreadFactory)`} using default thread factory.
`InfluxDB`	`enableBatch(int actions, int flushDuration, TimeUnit flushDurationTimeUnit, ThreadFactory threadFactory)` Enable batching of single Point writes as `enableBatch(int, int, TimeUnit, ThreadFactory, BiConsumer)` using with a exceptionHandler that does nothing.
`InfluxDB`	`enableBatch(int actions, int flushDuration, TimeUnit flushDurationTimeUnit, ThreadFactory threadFactory, BiConsumer<Iterable<Point>,Throwable> exceptionHandler)` Enable batching of single Point writes to speed up writes significant.
`InfluxDB`	`enableGzip()` Enable Gzip compress for http request body.
`void`	`flush()` Send any buffered points to InfluxDB.
`boolean`	`isBatchEnabled()` Returns whether Batching is enabled.
`boolean`	`isGzipEnabled()` Returns whether Gzip compress for http request body is enabled.
`Pong`	`ping()` Ping this influxDB.
`QueryResult`	`query(Query query)` Execute a query against a database.
`void`	`query(Query query, int chunkSize, Consumer<QueryResult> consumer)` Execute a streaming query against a database.
`QueryResult`	`query(Query query, TimeUnit timeUnit)` Execute a query against a database.
`InfluxDB`	`setConsistency(InfluxDB.ConsistencyLevel consistency)` Set the consistency level which is used for writing points.
`InfluxDB`	`setDatabase(String database)` Set the database which is used for writing points.
`InfluxDB`	`setLogLevel(InfluxDB.LogLevel logLevel)` Set the loglevel which is used for REST related actions.
`InfluxDB`	`setRetentionPolicy(String retentionPolicy)` Set the retention policy which is used for writing points.
`String`	`version()` Return the version of the connected influxDB Server.
`void`	`write(BatchPoints batchPoints)` Write a set of Points to the influxdb database with the new (>= 0.9.0rc32) lineprotocol.
`void`	`write(int udpPort, List<String> records)` Write a set of Points to the influxdb database with the list of string records through UDP.
`void`	`write(int udpPort, Point point)` Write a single Point to the database through UDP.
`void`	`write(int udpPort, String records)` Write a set of Points to the influxdb database with the string records through UDP.
`void`	`write(List<String> records)` Write a set of Points to the default database with the list of string records.
`void`	`write(Point point)` Write a single Point to the default database.
`void`	`write(String records)` Write a set of Points to the default database with the string records.
`void`	`write(String database, String retentionPolicy, InfluxDB.ConsistencyLevel consistency, List<String> records)` Write a set of Points to the influxdb database with the list of string records.
`void`	`write(String database, String retentionPolicy, InfluxDB.ConsistencyLevel consistency, String records)` Write a set of Points to the influxdb database with the string records.
`void`	`write(String database, String retentionPolicy, Point point)` Write a single Point to the database.

- Method Detail
  - setLogLevel
```
InfluxDB setLogLevel(InfluxDB.LogLevel logLevel)
```
    Set the loglevel which is used for REST related actions.
    
    Parameters:
    
    logLevel - the loglevel to set.
    
    Returns:
    
    the InfluxDB instance to be able to use it in a fluent manner.
  - enableGzip
```
InfluxDB enableGzip()
```
    Enable Gzip compress for http request body.
    
    Returns:
    
    the InfluxDB instance to be able to use it in a fluent manner.
  - disableGzip
```
InfluxDB disableGzip()
```
    Disable Gzip compress for http request body.
    
    Returns:
    
    the InfluxDB instance to be able to use it in a fluent manner.
  - isGzipEnabled
```
boolean isGzipEnabled()
```
    Returns whether Gzip compress for http request body is enabled.
    
    Returns:
    
    true if gzip is enabled.
  - enableBatch
```
InfluxDB enableBatch(int actions,
                     int flushDuration,
                     TimeUnit flushDurationTimeUnit)
```
    Enable batching of single Point writes as enableBatch(int, int, TimeUnit, ThreadFactory)} using default thread factory.
    
    Parameters:
    
    actions - the number of actions to collect
    
    flushDuration - the time to wait at most.
    
    flushDurationTimeUnit - the TimeUnit for the given flushDuration.
    
    Returns:
    
    the InfluxDB instance to be able to use it in a fluent manner.
    
    See Also:
    
    enableBatch(int, int, TimeUnit, ThreadFactory)
  - enableBatch
```
InfluxDB enableBatch(int actions,
                     int flushDuration,
                     TimeUnit flushDurationTimeUnit,
                     ThreadFactory threadFactory)
```
    Enable batching of single Point writes as enableBatch(int, int, TimeUnit, ThreadFactory, BiConsumer) using with a exceptionHandler that does nothing.
    
    Parameters:
    
    actions - the number of actions to collect
    
    flushDuration - the time to wait at most.
    
    flushDurationTimeUnit - the TimeUnit for the given flushDuration.
    
    threadFactory - a ThreadFactory instance to be used.
    
    Returns:
    
    the InfluxDB instance to be able to use it in a fluent manner.
    
    See Also:
    
    enableBatch(int, int, TimeUnit, ThreadFactory, BiConsumer)
  - enableBatch
```
InfluxDB enableBatch(int actions,
                     int flushDuration,
                     TimeUnit flushDurationTimeUnit,
                     ThreadFactory threadFactory,
                     BiConsumer<Iterable<Point>,Throwable> exceptionHandler)
```
    Enable batching of single Point writes to speed up writes significant. If either actions or flushDurations is reached first, a batch write is issued. Note that batch processing needs to be explicitly stopped before the application is shutdown. To do so call disableBatch().
    
    Parameters:
    
    actions - the number of actions to collect
    
    flushDuration - the time to wait at most.
    
    flushDurationTimeUnit - the TimeUnit for the given flushDuration.
    
    threadFactory - a ThreadFactory instance to be used.
    
    exceptionHandler - a consumer function to handle asynchronous errors
    
    Returns:
    
    the InfluxDB instance to be able to use it in a fluent manner.
  - disableBatch
```
void disableBatch()
```
    Disable Batching.
  - isBatchEnabled
```
boolean isBatchEnabled()
```
    Returns whether Batching is enabled.
    
    Returns:
    
    true if batch is enabled.
  - ping
```
Pong ping()
```
    Ping this influxDB.
    
    Returns:
    
    the response of the ping execution.
  - version
```
String version()
```
    Return the version of the connected influxDB Server.
    
    Returns:
    
    the version String, otherwise unknown.
  - write
```
void write(Point point)
```
    Write a single Point to the default database.
    
    Parameters:
    
    point - The point to write
  - write
```
void write(String records)
```
    Write a set of Points to the default database with the string records.
    
    Parameters:
    
    records - the points in the correct lineprotocol.
  - write
```
void write(List<String> records)
```
    Write a set of Points to the default database with the list of string records.
    
    Parameters:
    
    records - the List of points in the correct lineprotocol.
  - write
```
void write(String database,
           String retentionPolicy,
           Point point)
```
    Write a single Point to the database.
    
    Parameters:
    
    database - the database to write to.
    
    retentionPolicy - the retentionPolicy to use.
    
    point - The point to write
  - write
```
void write(int udpPort,
           Point point)
```
    Write a single Point to the database through UDP.
    
    Parameters:
    
    udpPort - the udpPort to write to.
    
    point - The point to write.
  - write
```
void write(BatchPoints batchPoints)
```
    Write a set of Points to the influxdb database with the new (>= 0.9.0rc32) lineprotocol.
    
    Parameters:
    
    batchPoints - the points to write in BatchPoints.
    
    See Also:
    
    2696
  - write
```
void write(String database,
           String retentionPolicy,
           InfluxDB.ConsistencyLevel consistency,
           String records)
```
    Write a set of Points to the influxdb database with the string records.
    
    Parameters:
    
    database - the name of the database to write
    
    retentionPolicy - the retentionPolicy to use
    
    consistency - the ConsistencyLevel to use
    
    records - the points in the correct lineprotocol.
    
    See Also:
    
    2696
  - write
```
void write(String database,
           String retentionPolicy,
           InfluxDB.ConsistencyLevel consistency,
           List<String> records)
```
    Write a set of Points to the influxdb database with the list of string records.
    
    Parameters:
    
    database - the name of the database to write
    
    retentionPolicy - the retentionPolicy to use
    
    consistency - the ConsistencyLevel to use
    
    records - the List of points in the correct lineprotocol.
    
    See Also:
    
    2696
  - write
```
void write(int udpPort,
           String records)
```
    Write a set of Points to the influxdb database with the string records through UDP.
    
    Parameters:
    
    udpPort - the udpPort where influxdb is listening
    
    records - the content will be encoded by UTF-8 before sent.
  - write
```
void write(int udpPort,
           List<String> records)
```
    Write a set of Points to the influxdb database with the list of string records through UDP.
    
    Parameters:
    
    udpPort - the udpPort where influxdb is listening
    
    records - list of record, the content will be encoded by UTF-8 before sent.
  - query
```
QueryResult query(Query query)
```
    Execute a query against a database.
    
    Parameters:
    
    query - the query to execute.
    
    Returns:
    
    a List of Series which matched the query.
  - query
```
void query(Query query,
           int chunkSize,
           Consumer<QueryResult> consumer)
```
    Execute a streaming query against a database.
    
    Parameters:
    
    query - the query to execute.
    
    chunkSize - the number of QueryResults to process in one chunk.
    
    consumer - the consumer to invoke for each received QueryResult
  - query
```
QueryResult query(Query query,
                  TimeUnit timeUnit)
```
    Execute a query against a database.
    
    Parameters:
    
    query - the query to execute.
    
    timeUnit - the time unit of the results.
    
    Returns:
    
    a List of Series which matched the query.
  - createDatabase
```
void createDatabase(String name)
```
    Create a new Database.
    
    Parameters:
    
    name - the name of the new database.
  - deleteDatabase
```
void deleteDatabase(String name)
```
    Delete a database.
    
    Parameters:
    
    name - the name of the database to delete.
  - describeDatabases
```
List<String> describeDatabases()
```
    Describe all available databases.
    
    Returns:
    
    a List of all Database names.
  - databaseExists
```
boolean databaseExists(String name)
```
    Check if a database exists.
    
    Parameters:
    
    name - the name of the database to search.
    
    Returns:
    
    true if the database exists or false if it doesn't exist
  - flush
```
void flush()
```
    Send any buffered points to InfluxDB. This method is synchronous and will block while all pending points are written.
    
    Throws:
    
    IllegalStateException - if batching is not enabled.
  - close
```
void close()
```
    close thread for asynchronous batch write and UDP socket to release resources if need.
  - setConsistency
```
InfluxDB setConsistency(InfluxDB.ConsistencyLevel consistency)
```
    Set the consistency level which is used for writing points.
    
    Parameters:
    
    consistency - the consistency level to set.
    
    Returns:
    
    the InfluxDB instance to be able to use it in a fluent manner.
  - setDatabase
```
InfluxDB setDatabase(String database)
```
    Set the database which is used for writing points.
    
    Parameters:
    
    database - the database to set.
    
    Returns:
    
    the InfluxDB instance to be able to use it in a fluent manner.
  - setRetentionPolicy
```
InfluxDB setRetentionPolicy(String retentionPolicy)
```
    Set the retention policy which is used for writing points.
    
    Parameters:
    
    retentionPolicy - the retention policy to set.
    
    Returns:
    
    the InfluxDB instance to be able to use it in a fluent manner.

Interface InfluxDB

Nested Class Summary

Method Summary

Method Detail

setLogLevel

enableGzip

disableGzip

isGzipEnabled

enableBatch

enableBatch

enableBatch

disableBatch

isBatchEnabled

ping

version

write

write

write

write

write

write

write

write

write

write

query

query

query

createDatabase

deleteDatabase

describeDatabases

databaseExists

flush

close

setConsistency

setDatabase

setRetentionPolicy