org.influxdb

Interface InfluxDB

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

Modifier and Type	Method and Description
void	createDatabase(String name) Create a new Database.
void	deleteDatabase(String name) Delete a database.
List<String>	describeDatabases() Describe all available databases.
void	disableBatch() Disable Batching.
InfluxDB	enableBatch(int actions, int flushDuration, TimeUnit flushDurationTimeUnit) Enable Batching of single Point writes to speed up writes significant.
Pong	ping() Ping this influxDB-
QueryResult	query(Query query) Execute a query agains a database.
QueryResult	query(Query query, TimeUnit timeUnit) Execute a query agains a database.
InfluxDB	setLogLevel(InfluxDB.LogLevel logLevel) Set the loglevel which is used for REST related actions.
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(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.

enableBatch

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

Enable Batching of single Point writes to speed up writes significant. If either actions or flushDurations is reached first, a batchwrite is issued.

Parameters:

actions - the number of actions to collect

flushDuration - the time to wait at most.

flushDurationTimeUnit -

Returns:

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

disableBatch

void disableBatch()

Disable Batching.

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(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(BatchPoints batchPoints)

Write a set of Points to the influxdb database with the new (>= 0.9.0rc32) lineprotocol. "https://github.com/influxdb/influxdb/pull/2696"

Parameters:

batchPoints -

query

QueryResult query(Query query)

Execute a query agains a database.

Parameters:

query - the query to execute.

Returns:

a List of Series which matched the query.

query

QueryResult query(Query query,
                  TimeUnit timeUnit)

Execute a query agains 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.