orangeqs.juice.client.influxdb2#

Utilities to interact with OrangeQS Juice InfluxDB databases.

This module defines cached shortcuts to get databases and their specific APIs based on Juice config. Resulting API wrappers are cached, which reduces amount of objects that Juice needs to construct internally to communicate with databases.

Module Contents#

Functions#

retrieve_influxdb2_token

Retrieve the InfluxDB2 token based on the current identity.

influxdb2_client

Get an InfluxDB2 API client for the database.

influxdb2_client_async

Get an InfluxDB2 API client for the database.

influxdb2_query_api

Get an InfluxDB2 query API client for the database.

influxdb2_query_api_async

Get an InfluxDB2 query API async client for the database.

influxdb2_write_api

Get an InfluxDB2 write API client for the database.

influxdb2_write_api_async

Get an InfluxDB2 write API async client for the database.

datetime_to_unix_ns_int

Return a Unix Nanosecond object from a native python datetime object.

API#

orangeqs.juice.client.influxdb2.retrieve_influxdb2_token() → str#

Retrieve the InfluxDB2 token based on the current identity.

Returns#

  • (The InfluxDB2 token.)

orangeqs.juice.client.influxdb2.influxdb2_client() → influxdb_client.client.influxdb_client.InfluxDBClient#

Get an InfluxDB2 API client for the database.

Returns#

  • (InfluxDB client.)

orangeqs.juice.client.influxdb2.influxdb2_client_async() → influxdb_client.client.influxdb_client_async.InfluxDBClientAsync#

Get an InfluxDB2 API client for the database.

Returns#

  • (InfluxDBAsync client.)

orangeqs.juice.client.influxdb2.influxdb2_query_api() → influxdb_client.client.query_api.QueryApi#

Get an InfluxDB2 query API client for the database.

Returns#

  • (InfluxDB query API.)

orangeqs.juice.client.influxdb2.influxdb2_query_api_async() → influxdb_client.client.query_api_async.QueryApiAsync#

Get an InfluxDB2 query API async client for the database.

Returns#

  • (InfluxDBAsync query API.)

orangeqs.juice.client.influxdb2.influxdb2_write_api(write_options: influxdb_client.client.write_api.WriteOptions = WriteOptions()) → influxdb_client.client.write_api.WriteApi#

Get an InfluxDB2 write API client for the database.

Parameters#

  • write_options (WriteOptions, optional): Configuration options for batching, retries, etc.

Returns#

  • (WriteApi)

orangeqs.juice.client.influxdb2.influxdb2_write_api_async() → influxdb_client.client.write_api_async.WriteApiAsync#

Get an InfluxDB2 write API async client for the database.

Returns#

  • (WriteApiAsync)

orangeqs.juice.client.influxdb2.datetime_to_unix_ns_int(dt_obj: datetime.datetime) → int#

Return a Unix Nanosecond object from a native python datetime object.

This is useful when making influxdb2 queries as it expects either RFC3339 compliant strings or unix ns integers https://docs.influxdata.com/influxdb/v2/query-data/flux/operate-on-timestamps/#rfc3339-to-unix-nanosecond