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.LogLevel Controls the level of logging of the REST layer.

Method Summary

Methods

Modifier and Type	Method and Description
void	alterDatabasePrivilege(String database, String name, boolean isAdmin, String... permissions) Alter the admin privilege of a given database user.
void	authenticateDatabaseUser(String database, String username, String password) Authenticate with the given credentials against the database.
void	createClusterAdmin(String name, String password) Create a new cluster admin.
void	createDatabase(DatabaseConfiguration config) Create a new Database from a DatabaseConfiguration.
void	createDatabase(String name) Create a new Database.
void	createDatabaseUser(String database, String name, String password, String... permissions) Create a new regular database user.
void	createShard(Shard shard) Deprecated. this functionality is gone with 0.8.0, will be removed in the next version.
void	createShardSpace(String database, ShardSpace shardSpace) Create a ShardSpace in a Database.
void	deleteClusterAdmin(String name) Delete a cluster admin.
void	deleteContinuousQuery(String database, int id) Delete a continous query.
void	deleteDatabase(String name) Delete a database.
void	deleteDatabaseUser(String database, String name) Delete a database user.
void	deleteSeries(String database, String serieName) Delete a serie.
List<User>	describeClusterAdmins() Describe all cluster admins.
List<ContinuousQuery>	describeContinuousQueries(String database) Describe all contious queries in a database.
List<Database>	describeDatabases() Describe all available databases.
List<User>	describeDatabaseUsers(String database) Describe all database users allowed to acces the given database.
void	dropShard(Shard shard) Deprecated. this functionality is gone with 0.8.0, will be removed in the next version.
void	dropShardSpace(String database, String name) Drop a existing ShardSpace from a Database.
void	forceRaftCompaction() Force Database compaction.
Shards	getShards() Deprecated. this functionality is gone with 0.8.0, will be removed in the next version.
List<ShardSpace>	getShardSpaces() Describe all existing shardspaces.
List<String>	interfaces() List all interfaces influxDB is listening.
List<Server>	listServers() List all servers which are member of the cluster.
Pong	ping() Ping this influxDB-
List<Serie>	query(String database, String query, TimeUnit precision) Execute a query agains a database.
void	removeServers(int id) Remove the given Server from the cluster.
InfluxDB	setLogLevel(InfluxDB.LogLevel logLevel) Set the loglevel which is used for REST related actions.
Boolean	sync() Sync the database to the filesystem.
void	updateClusterAdmin(String name, String password) Update the password of the given admin.
void	updateDatabaseUser(String database, String name, String password, String... permissions) Update the password and/or the permissions of a database user.
String	version() Return the version of the connected influxDB Server.
void	write(String database, TimeUnit precision, Serie... series) Write a Series to the given database.
void	writeUdp(int port, TimeUnit precision, Serie... series) Write a Series to the given 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.

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,
         TimeUnit precision,
         Serie... series)

Write a Series to the given database.

Parameters:

database - the name of the database to write to.

precision - the precision used for the values.

series - a Array of Series to write.

writeUdp

void writeUdp(int port,
            TimeUnit precision,
            Serie... series)

Write a Series to the given database.

Parameters:

port - the port where to reach the influxdb udp service. The database is configured per port in the influxdb configuration.

precision - the precision used for the values.

series - a Array of Series to write.

query

List<Serie> query(String database,
                String query,
                TimeUnit precision)

Execute a query agains a database.

Parameters:

database - the name of the database.

query - the query to execute, for language specification please see http://influxdb.org/docs/query_language

precision - the precision used for the values.

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.

createDatabase

void createDatabase(DatabaseConfiguration config)

Create a new Database from a DatabaseConfiguration. This is the way to create a db with shards specified.

Parameters:

config - the configuration for the database to create..

deleteDatabase

void deleteDatabase(String name)

Delete a database.

Parameters:

name - the name of the database to delete.

describeDatabases

List<Database> describeDatabases()

Describe all available databases.

Returns:

a List of all Databases.

createClusterAdmin

void createClusterAdmin(String name,
                      String password)

Create a new cluster admin.

Parameters:

name - the name of the new admin.

password - the password for the new admin.

deleteClusterAdmin

void deleteClusterAdmin(String name)

Delete a cluster admin.

Parameters:

name - the name of the admin to delete.

describeClusterAdmins

List<User> describeClusterAdmins()

Describe all cluster admins.

Returns:

a list of all admins.

updateClusterAdmin

void updateClusterAdmin(String name,
                      String password)

Update the password of the given admin.

Parameters:

name - the name of the admin for which the password should be updated.

password - the new password for the given admin.

createDatabaseUser

void createDatabaseUser(String database,
                      String name,
                      String password,
                      String... permissions)

Create a new regular database user. Without any given permissions the new user is allowed to read and write to the database. The permission must be specified in regex which will match for the series. You have to specify either no permissions or both (readFrom and writeTo) permissions.

Parameters:

database - the name of the database where this user is allowed.

name - the name of the new database user.

password - the password for this user.

permissions - a array of readFrom and writeTo permissions (in this order) and given in regex form.

deleteDatabaseUser

void deleteDatabaseUser(String database,
                      String name)

Delete a database user.

Parameters:

database - the name of the database the given user should be removed from.

name - the name of the user to remove.

describeDatabaseUsers

List<User> describeDatabaseUsers(String database)

Describe all database users allowed to acces the given database.

Parameters:

database - the name of the database for which all users should be described.

Returns:

a list of all users.

updateDatabaseUser

void updateDatabaseUser(String database,
                      String name,
                      String password,
                      String... permissions)

Update the password and/or the permissions of a database user.

Parameters:

database - the name of the database where this user is allowed.

name - the name of the existing database user.

password - the password for this user.

permissions - a array of readFrom and writeTo permissions (in this order) and given in regex form.

alterDatabasePrivilege

void alterDatabasePrivilege(String database,
                          String name,
                          boolean isAdmin,
                          String... permissions)

Alter the admin privilege of a given database user.

Parameters:

database - the name of the database where this user is allowed.

name - the name of the existing database user.

isAdmin - if set to true this user is a database admin, otherwise it isnt.

permissions - a array of readFrom and writeTo permissions (in this order) and given in regex form.

authenticateDatabaseUser

void authenticateDatabaseUser(String database,
                            String username,
                            String password)

Authenticate with the given credentials against the database.

Parameters:

database - the name of the database where this user is allowed.

username - the name of the existing database user.

password - the password for this user.

describeContinuousQueries

List<ContinuousQuery> describeContinuousQueries(String database)

Describe all contious queries in a database.

Parameters:

database - the name of the database for which all continous queries should be described.

Returns:

a list of all contious queries.

deleteContinuousQuery

void deleteContinuousQuery(String database,
                         int id)

Delete a continous query.

Parameters:

database - the name of the database for which this query should be deleted.

id - the id of the query.

deleteSeries

void deleteSeries(String database,
                String serieName)

Delete a serie.

Parameters:

database - the database in which the given serie should be deleted.

serieName - the name of the serie.

forceRaftCompaction

void forceRaftCompaction()

Force Database compaction.

interfaces

List<String> interfaces()

List all interfaces influxDB is listening.

Returns:

a List of interface names.

sync

Boolean sync()

Sync the database to the filesystem.

Returns:

true|false if successful.

listServers

List<Server> listServers()

List all servers which are member of the cluster.

Returns:

a List of all influxdb servers.

removeServers

void removeServers(int id)

Remove the given Server from the cluster.

Parameters:

id - the id of the server to remove.

createShard

@Deprecated
void createShard(Shard shard)

Deprecated. this functionality is gone with 0.8.0, will be removed in the next version.

Create a new Shard.

Parameters:

shard - the new shard to create.

getShards

@Deprecated
Shards getShards()

Deprecated. this functionality is gone with 0.8.0, will be removed in the next version.

Describe all existing shards.

Returns:

a List of all Shards.

dropShard

@Deprecated
void dropShard(Shard shard)

Deprecated. this functionality is gone with 0.8.0, will be removed in the next version.

Drop the given shard.

Parameters:

shard - the shard to delete.

getShardSpaces

List<ShardSpace> getShardSpaces()

Describe all existing shardspaces.

Returns:

a List of all ShardSpaces.

dropShardSpace

void dropShardSpace(String database,
                  String name)

Drop a existing ShardSpace from a Database.

Parameters:

database - the name of the database.

name - the name of the ShardSpace to delete.

createShardSpace

void createShardSpace(String database,
                    ShardSpace shardSpace)

Create a ShardSpace in a Database.

Parameters:

database - the name of the database.

shardSpace - the shardSpace to create in this database