C# Class AdysTech.InfluxDB.Client.Net.InfluxDBClient

Provides asynchronous interaction channel with InfluxDB engine
Inheritance: IInfluxDBClient, IDisposable
Afficher le fichier Open project: AdysTech/InfluxDB.Client.Net Class Usage Examples

Méthodes publiques

Méthode Description
CreateContinuousQueryAsync ( IInfluxContinuousQuery cq ) : Task

Creates a Continuous Queries
CreateDatabaseAsync ( string dbName ) : Task

Creates the specified database
CreateRetentionPolicyAsync ( IInfluxRetentionPolicy policy ) : Task

Creates a retention policy
Dispose ( ) : void
DropContinuousQueryAsync ( IInfluxContinuousQuery cq ) : Task
GetContinuousQueriesAsync ( ) : Task>

Gets the list of Continuous Queries currently in efect
GetInfluxDBNamesAsync ( ) : Task>

Queries and Gets list of all existing databases in the Influx server instance
GetInfluxDBStructureAsync ( string dbName ) : Task

Gets the whole DB structure for the given databse in Influx.
GetRetentionPoliciesAsync ( string dbName ) : Task>

Gets the list of retention policies present in a DB
GetServerVersionAsync ( ) : Task

InfluxDB engine version
InfluxDBClient ( string InfluxUrl ) : System

Creates the InfluxDB Client
InfluxDBClient ( string InfluxUrl, string UserName, string Password ) : System

Creates the InfluxDB Client
PostPointAsync ( string dbName, IInfluxDatapoint point ) : Task

Posts an InfluxDataPoint to given measurement
PostPointsAsync ( string dbName, IEnumerable Points ) : Task

Posts series of InfluxDataPoints to given measurement, in batches of 255
PostRawValueAsync ( string dbName, TimePrecision precision, string content ) : Task

Posts raw write request to Influx.
QueryMultiSeriesAsync ( string dbName, string measurementQuery, TimePrecision precision = TimePrecision.Nanoseconds ) : Task>

Queries Influx DB and gets a time series data back. Ideal for fetching measurement values. The return list is of InfluxSeries, and each element in there will have properties named after columns in series

Méthodes protégées

Méthode Description
Dispose ( bool disposing ) : void

Private Methods

Méthode Description
GetAsync ( string>.Dictionary Query ) : Task
PostAsync ( string>.Dictionary EndPoint, ByteArrayContent requestContent ) : Task
PostPointsAsync ( string dbName, TimePrecision precision, string retention, IEnumerable points ) : Task
QueryDBAsync ( string dbName, string measurementQuery ) : Task>

Method Details

CreateContinuousQueryAsync() public méthode

Creates a Continuous Queries
public CreateContinuousQueryAsync ( IInfluxContinuousQuery cq ) : Task
cq IInfluxContinuousQuery An instance of the Continuous Query, DBName, Name, Query must be set
Résultat Task

CreateDatabaseAsync() public méthode

Creates the specified database
When Influx needs authentication, and no user name password is supplied or auth fails all other HTTP exceptions
public CreateDatabaseAsync ( string dbName ) : Task
dbName string
Résultat Task

CreateRetentionPolicyAsync() public méthode

Creates a retention policy
public CreateRetentionPolicyAsync ( IInfluxRetentionPolicy policy ) : Task
policy IInfluxRetentionPolicy An instance of the Retention Policy, DBName, Name and Duration must be set
Résultat Task

Dispose() public méthode

public Dispose ( ) : void
Résultat void

Dispose() protected méthode

protected Dispose ( bool disposing ) : void
disposing bool
Résultat void

DropContinuousQueryAsync() public méthode

public DropContinuousQueryAsync ( IInfluxContinuousQuery cq ) : Task
cq IInfluxContinuousQuery
Résultat Task

GetContinuousQueriesAsync() public méthode

Gets the list of Continuous Queries currently in efect
public GetContinuousQueriesAsync ( ) : Task>
Résultat Task>

GetInfluxDBNamesAsync() public méthode

Queries and Gets list of all existing databases in the Influx server instance
When Influx needs authentication, and no user name password is supplied or auth fails all other HTTP exceptions InfluxDB service is not available on the port mentioned
public GetInfluxDBNamesAsync ( ) : Task>
Résultat Task>

GetInfluxDBStructureAsync() public méthode

Gets the whole DB structure for the given databse in Influx.
When Influx needs authentication, and no user name password is supplied or auth fails all other HTTP exceptions
public GetInfluxDBStructureAsync ( string dbName ) : Task
dbName string Name of the database
Résultat Task

GetRetentionPoliciesAsync() public méthode

Gets the list of retention policies present in a DB
public GetRetentionPoliciesAsync ( string dbName ) : Task>
dbName string Name of the database
Résultat Task>

GetServerVersionAsync() public méthode

InfluxDB engine version
public GetServerVersionAsync ( ) : Task
Résultat Task

InfluxDBClient() public méthode

Creates the InfluxDB Client
public InfluxDBClient ( string InfluxUrl ) : System
InfluxUrl string Url for the Inflex Server, e.g. localhost:8086
Résultat System

InfluxDBClient() public méthode

Creates the InfluxDB Client
public InfluxDBClient ( string InfluxUrl, string UserName, string Password ) : System
InfluxUrl string Url for the Inflex Server, e.g. http://localhost:8086
UserName string User name to authenticate InflexDB
Password string password
Résultat System

PostPointAsync() public méthode

Posts an InfluxDataPoint to given measurement
When Influx needs authentication, and no user name password is supplied or auth fails all other HTTP exceptions
public PostPointAsync ( string dbName, IInfluxDatapoint point ) : Task
dbName string InfluxDB database name
point IInfluxDatapoint Influx data point to be written
Résultat Task

PostPointsAsync() public méthode

Posts series of InfluxDataPoints to given measurement, in batches of 255
When Influx needs authentication, and no user name password is supplied or auth fails all other HTTP exceptions
public PostPointsAsync ( string dbName, IEnumerable Points ) : Task
dbName string InfluxDB database name
Points IEnumerable Collection of Influx data points to be written
Résultat Task

PostRawValueAsync() public méthode

Posts raw write request to Influx.
public PostRawValueAsync ( string dbName, TimePrecision precision, string content ) : Task
dbName string Name of the Database
precision TimePrecision Unit of the timestamp, Hour->nanosecond
content string Raw request, as per Line Protocol
Résultat Task

QueryMultiSeriesAsync() public méthode

Queries Influx DB and gets a time series data back. Ideal for fetching measurement values. The return list is of InfluxSeries, and each element in there will have properties named after columns in series
public QueryMultiSeriesAsync ( string dbName, string measurementQuery, TimePrecision precision = TimePrecision.Nanoseconds ) : Task>
dbName string Name of the database
measurementQuery string Query text, Only results with single series are supported for now
precision TimePrecision epoch precision of the data set
Résultat Task>