org.influxdb.impl

Class InfluxDBImpl

java.lang.Object

org.influxdb.impl.InfluxDBImpl

All Implemented Interfaces:

InfluxDB

public class InfluxDBImpl
extends Object
implements InfluxDB

Implementation of a InluxDB API.

Author:

stefan.majer [at] gmail.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.influxdb.InfluxDB

InfluxDB.ConsistencyLevel, InfluxDB.LogLevel

Constructor Summary

Constructors

Constructor and Description
InfluxDBImpl(String url, String username, String password, okhttp3.OkHttpClient.Builder client)
InfluxDBImpl(String url, String username, String password, okhttp3.OkHttpClient.Builder client, String database, String retentionPolicy, InfluxDB.ConsistencyLevel consistency)

Method Summary

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.
void	createRetentionPolicy(String rpName, String database, String duration, int replicationFactor, boolean isDefault) Creates a retentionPolicy.
void	createRetentionPolicy(String rpName, String database, String duration, String shardDuration, int replicationFactor) Creates a retentionPolicy.
void	createRetentionPolicy(String rpName, String database, String duration, String shardDuration, int replicationFactor, boolean isDefault) Creates a retentionPolicy.
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.
void	dropRetentionPolicy(String rpName, String database) Drops a retentionPolicy in a database.
InfluxDB	enableBatch(int actions, int flushDuration, TimeUnit flushDurationTimeUnit) Enable batching of single Point writes as InfluxDB.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 InfluxDB.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, Consumer<QueryResult> onSuccess, Consumer<Throwable> onFailure) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InfluxDBImpl

public InfluxDBImpl(String url,
                    String username,
                    String password,
                    okhttp3.OkHttpClient.Builder client)

InfluxDBImpl

public InfluxDBImpl(String url,
                    String username,
                    String password,
                    okhttp3.OkHttpClient.Builder client,
                    String database,
                    String retentionPolicy,
                    InfluxDB.ConsistencyLevel consistency)

Method Detail

setLogLevel

public InfluxDB setLogLevel(InfluxDB.LogLevel logLevel)

Description copied from interface: InfluxDB

Set the loglevel which is used for REST related actions.

Specified by:

setLogLevel in interface InfluxDB

Parameters:

logLevel - the loglevel to set.

Returns:

the InfluxDB instance to be able to use it in a fluent manner.

enableGzip

public InfluxDB enableGzip()

Enable Gzip compress for http request body.

Specified by:

enableGzip in interface InfluxDB

Returns:

the InfluxDB instance to be able to use it in a fluent manner.

disableGzip

public InfluxDB disableGzip()

Disable Gzip compress for http request body.

Specified by:

disableGzip in interface InfluxDB

Returns:

the InfluxDB instance to be able to use it in a fluent manner.

isGzipEnabled

public boolean isGzipEnabled()

Returns whether Gzip compress for http request body is enabled.

Specified by:

isGzipEnabled in interface InfluxDB

Returns:

true if gzip is enabled.

enableBatch

public InfluxDB enableBatch(int actions,
                            int flushDuration,
                            TimeUnit flushDurationTimeUnit)

Description copied from interface: InfluxDB

Enable batching of single Point writes as InfluxDB.enableBatch(int, int, TimeUnit, ThreadFactory)} using default thread factory.

Specified by:

enableBatch in interface InfluxDB

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:

InfluxDB.enableBatch(int, int, TimeUnit, ThreadFactory)

enableBatch

public InfluxDB enableBatch(int actions,
                            int flushDuration,
                            TimeUnit flushDurationTimeUnit,
                            ThreadFactory threadFactory)

Description copied from interface: InfluxDB

Enable batching of single Point writes as InfluxDB.enableBatch(int, int, TimeUnit, ThreadFactory, BiConsumer) using with a exceptionHandler that does nothing.

Specified by:

enableBatch in interface InfluxDB

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:

InfluxDB.enableBatch(int, int, TimeUnit, ThreadFactory, BiConsumer)

enableBatch

public InfluxDB enableBatch(int actions,
                            int flushDuration,
                            TimeUnit flushDurationTimeUnit,
                            ThreadFactory threadFactory,
                            BiConsumer<Iterable<Point>,Throwable> exceptionHandler)

Description copied from interface: InfluxDB

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().

Specified by:

enableBatch in interface InfluxDB

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

public void disableBatch()

Description copied from interface: InfluxDB

Disable Batching.

Specified by:

disableBatch in interface InfluxDB

isBatchEnabled

public boolean isBatchEnabled()

Description copied from interface: InfluxDB

Returns whether Batching is enabled.

Specified by:

isBatchEnabled in interface InfluxDB

Returns:

true if batch is enabled.

ping

public Pong ping()

Description copied from interface: InfluxDB

Ping this influxDB.

Specified by:

ping in interface InfluxDB

Returns:

the response of the ping execution.

version

public String version()

Description copied from interface: InfluxDB

Return the version of the connected influxDB Server.

Specified by:

version in interface InfluxDB

Returns:

the version String, otherwise unknown.

write

public void write(Point point)

Description copied from interface: InfluxDB

Write a single Point to the default database.

Specified by:

write in interface InfluxDB

Parameters:

point - The point to write

write

public void write(String records)

Description copied from interface: InfluxDB

Write a set of Points to the default database with the string records.

Specified by:

write in interface InfluxDB

Parameters:

records - the points in the correct lineprotocol.

write

public void write(List<String> records)

Description copied from interface: InfluxDB

Write a set of Points to the default database with the list of string records.

Specified by:

write in interface InfluxDB

Parameters:

records - the List of points in the correct lineprotocol.

write

public void write(String database,
                  String retentionPolicy,
                  Point point)

Description copied from interface: InfluxDB

Write a single Point to the database.

Specified by:

write in interface InfluxDB

Parameters:

database - the database to write to.

retentionPolicy - the retentionPolicy to use.

point - The point to write

write

public void write(int udpPort,
                  Point point)

Write a single Point to the database through UDP.

Specified by:

write in interface InfluxDB

Parameters:

udpPort - the udpPort to write to.

point - The point to write.

write

public void write(BatchPoints batchPoints)

Description copied from interface: InfluxDB

Write a set of Points to the influxdb database with the new (>= 0.9.0rc32) lineprotocol.

Specified by:

write in interface InfluxDB

Parameters:

batchPoints - the points to write in BatchPoints.

See Also:

2696

write

public void write(String database,
                  String retentionPolicy,
                  InfluxDB.ConsistencyLevel consistency,
                  String records)

Description copied from interface: InfluxDB

Write a set of Points to the influxdb database with the string records.

Specified by:

write in interface InfluxDB

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

public void write(String database,
                  String retentionPolicy,
                  InfluxDB.ConsistencyLevel consistency,
                  List<String> records)

Description copied from interface: InfluxDB

Write a set of Points to the influxdb database with the list of string records.

Specified by:

write in interface InfluxDB

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

public void write(int udpPort,
                  String records)

Write a set of Points to the influxdb database with the string records through UDP.

Specified by:

write in interface InfluxDB

Parameters:

udpPort - the udpPort where influxdb is listening

records - the content will be encoded by UTF-8 before sent.

write

public void write(int udpPort,
                  List<String> records)

Write a set of Points to the influxdb database with the list of string records through UDP.

Specified by:

write in interface InfluxDB

Parameters:

udpPort - the udpPort where influxdb is listening

records - list of record, the content will be encoded by UTF-8 before sent.

query

public QueryResult query(Query query)

Execute a query against a database.

Specified by:

query in interface InfluxDB

Parameters:

query - the query to execute.

Returns:

a List of Series which matched the query.

query

public void query(Query query,
                  Consumer<QueryResult> onSuccess,
                  Consumer<Throwable> onFailure)

Execute a query against a database. One of the consumers will be executed.

Specified by:

query in interface InfluxDB

Parameters:

query - the query to execute.

onSuccess - the consumer to invoke when result is received

onFailure - the consumer to invoke when error is thrown

query

public void query(Query query,
                  int chunkSize,
                  Consumer<QueryResult> consumer)

Execute a streaming query against a database.

Specified by:

query in interface InfluxDB

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

public QueryResult query(Query query,
                         TimeUnit timeUnit)

Execute a query against a database.

Specified by:

query in interface InfluxDB

Parameters:

query - the query to execute.

timeUnit - the time unit of the results.

Returns:

a List of Series which matched the query.

createDatabase

public void createDatabase(String name)

Create a new Database.

Specified by:

createDatabase in interface InfluxDB

Parameters:

name - the name of the new database.

deleteDatabase

public void deleteDatabase(String name)

Delete a database.

Specified by:

deleteDatabase in interface InfluxDB

Parameters:

name - the name of the database to delete.

describeDatabases

public List<String> describeDatabases()

Describe all available databases.

Specified by:

describeDatabases in interface InfluxDB

Returns:

a List of all Database names.

databaseExists

public boolean databaseExists(String name)

Check if a database exists.

Specified by:

databaseExists in interface InfluxDB

Parameters:

name - the name of the database to search.

Returns:

true if the database exists or false if it doesn't exist

flush

public void flush()

Send any buffered points to InfluxDB. This method is synchronous and will block while all pending points are written.

Specified by:

flush in interface InfluxDB

close

public void close()

close thread for asynchronous batch write and UDP socket to release resources if need.

Specified by:

close in interface InfluxDB

setConsistency

public InfluxDB setConsistency(InfluxDB.ConsistencyLevel consistency)

Description copied from interface: InfluxDB

Set the consistency level which is used for writing points.

Specified by:

setConsistency in interface InfluxDB

Parameters:

consistency - the consistency level to set.

Returns:

the InfluxDB instance to be able to use it in a fluent manner.

setDatabase

public InfluxDB setDatabase(String database)

Description copied from interface: InfluxDB

Set the database which is used for writing points.

Specified by:

setDatabase in interface InfluxDB

Parameters:

database - the database to set.

Returns:

the InfluxDB instance to be able to use it in a fluent manner.

setRetentionPolicy

public InfluxDB setRetentionPolicy(String retentionPolicy)

Description copied from interface: InfluxDB

Set the retention policy which is used for writing points.

Specified by:

setRetentionPolicy in interface InfluxDB

Parameters:

retentionPolicy - the retention policy to set.

Returns:

the InfluxDB instance to be able to use it in a fluent manner.

createRetentionPolicy

public void createRetentionPolicy(String rpName,
                                  String database,
                                  String duration,
                                  String shardDuration,
                                  int replicationFactor,
                                  boolean isDefault)

Creates a retentionPolicy.

Specified by:

createRetentionPolicy in interface InfluxDB

Parameters:

rpName - the name of the retentionPolicy(rp)

database - the name of the database

duration - the duration of the rp

shardDuration - the shardDuration

replicationFactor - the replicationFactor of the rp

isDefault - if the rp is the default rp for the database or not

createRetentionPolicy

public void createRetentionPolicy(String rpName,
                                  String database,
                                  String duration,
                                  int replicationFactor,
                                  boolean isDefault)

Creates a retentionPolicy. (optional shardDuration)

Specified by:

createRetentionPolicy in interface InfluxDB

Parameters:

rpName - the name of the retentionPolicy(rp)

database - the name of the database

duration - the duration of the rp

replicationFactor - the replicationFactor of the rp

isDefault - if the rp is the default rp for the database or not

createRetentionPolicy

public void createRetentionPolicy(String rpName,
                                  String database,
                                  String duration,
                                  String shardDuration,
                                  int replicationFactor)

Creates a retentionPolicy. (optional shardDuration and isDefault)

Specified by:

createRetentionPolicy in interface InfluxDB

Parameters:

rpName - the name of the retentionPolicy(rp)

database - the name of the database

duration - the duration of the rp

shardDuration - the shardDuration

replicationFactor - the replicationFactor of the rp

dropRetentionPolicy

public void dropRetentionPolicy(String rpName,
                                String database)

Drops a retentionPolicy in a database.

Specified by:

dropRetentionPolicy in interface InfluxDB

Parameters:

rpName - the name of the retentionPolicy

database - the name of the database