org.springframework.data.influxdb

Class InfluxDBTemplate<T>

java.lang.Object

org.springframework.data.influxdb.InfluxDBAccessor

org.springframework.data.influxdb.InfluxDBTemplate<T>

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, InfluxDBOperations<T>

Direct Known Subclasses:

DefaultInfluxDBTemplate

public class InfluxDBTemplate<T>
extends InfluxDBAccessor
implements InfluxDBOperations<T>

Field Summary

Fields inherited from class org.springframework.data.influxdb.InfluxDBAccessor

logger

Constructor Summary

Constructors

Constructor and Description
InfluxDBTemplate()
InfluxDBTemplate(InfluxDBConnectionFactory connectionFactory, PointCollectionConverter<T> converter)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	createDatabase() Ensures that the configured database exists.
org.influxdb.dto.Pong	ping() Ping the database.
org.influxdb.dto.QueryResult	query(org.influxdb.dto.Query query) Executes a query against the database.
void	query(org.influxdb.dto.Query query, int chunkSize, Consumer<org.influxdb.dto.QueryResult> consumer) Execute a streaming query against the database.
org.influxdb.dto.QueryResult	query(org.influxdb.dto.Query query, TimeUnit timeUnit) Executes a query against the database.
void	setConverter(PointCollectionConverter<T> converter)
String	version() Return the version of the connected database.
void	write(List<T> payload) Write a set of measurements to the database.
void	write(T... payload) Write a single measurement to the database.

Methods inherited from class org.springframework.data.influxdb.InfluxDBAccessor

getConnection, getConnectionFactory, getDatabase, getRetentionPolicy, setConnectionFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

InfluxDBTemplate

public InfluxDBTemplate()

InfluxDBTemplate

public InfluxDBTemplate(InfluxDBConnectionFactory connectionFactory,
                        PointCollectionConverter<T> converter)

Method Detail

setConverter

public void setConverter(PointCollectionConverter<T> converter)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class InfluxDBAccessor

createDatabase

public void createDatabase()

Description copied from interface: InfluxDBOperations

Ensures that the configured database exists.

Specified by:

createDatabase in interface InfluxDBOperations<T>

write

public void write(T... payload)

Description copied from interface: InfluxDBOperations

Write a single measurement to the database.

Specified by:

write in interface InfluxDBOperations<T>

Parameters:

payload - the measurement to write to

write

public void write(List<T> payload)

Description copied from interface: InfluxDBOperations

Write a set of measurements to the database.

Specified by:

write in interface InfluxDBOperations<T>

Parameters:

payload - the values to write to

query

public org.influxdb.dto.QueryResult query(org.influxdb.dto.Query query)

Description copied from interface: InfluxDBOperations

Executes a query against the database.

Specified by:

query in interface InfluxDBOperations<T>

Parameters:

query - the query to execute

Returns:

a List of time series data matching the query

query

public org.influxdb.dto.QueryResult query(org.influxdb.dto.Query query,
                                          TimeUnit timeUnit)

Description copied from interface: InfluxDBOperations

Executes a query against the database.

Specified by:

query in interface InfluxDBOperations<T>

Parameters:

query - the query to execute

timeUnit - the time unit to be used for the query

Returns:

a List of time series data matching the query

query

public void query(org.influxdb.dto.Query query,
                  int chunkSize,
                  Consumer<org.influxdb.dto.QueryResult> consumer)

Description copied from interface: InfluxDBOperations

Execute a streaming query against the database.

Specified by:

query in interface InfluxDBOperations<T>

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

ping

public org.influxdb.dto.Pong ping()

Description copied from interface: InfluxDBOperations

Ping the database.

Specified by:

ping in interface InfluxDBOperations<T>

Returns:

the response of the ping execution

version

public String version()

Description copied from interface: InfluxDBOperations

Return the version of the connected database.

Specified by:

version in interface InfluxDBOperations<T>

Returns:

the version String, otherwise unknown