API Reference

This part of the documentation covers all the interfaces of Aioinflux


🚧 This section of the documentation is under writing and may be wrong/incomplete 🚧

Client Interface

class aioinflux.client.InfluxDBClient(host='localhost', port=8086, mode='async', output='json', db=None, *, ssl=False, unix_socket=None, username=None, password=None, database=None, loop=None)[source]

Pings InfluxDB. Returns a dictionary containing the headers of the response from influxd.

Return type:dict
query(q, *args, epoch='ns', chunked=False, chunk_size=None, db=None, parser=None, **kwargs)[source]

Sends a query to InfluxDB. Please refer to the InfluxDB documentation for all the possible queries: https://docs.influxdata.com/influxdb/latest/query_language/

  • q (AnyStr) – Raw query string
  • args – Positional arguments for query patterns
  • db (Optional[str]) – Database to be queried. Defaults to self.db.
  • epoch (str) – Precision level of response timestamps. Valid values: {'ns', 'u', 'µ', 'ms', 's', 'm', 'h'}.
  • chunked (bool) – If True, makes InfluxDB return results in streamed batches rather than as a single response. Returns an AsyncGenerator which yields responses in the same format as non-chunked queries.
  • chunk_size (Optional[int]) – Max number of points for each chunk. By default, InfluxDB chunks responses by series or by every 10,000 points, whichever occurs first.
  • kwargs – Keyword arguments for query patterns
  • parser (Optional[Callable]) – Optional parser function for ‘iterable’ mode
Return type:

Union[Asyncgenerator[+T_co, -T_contra], dict, bytes, InfluxDBResult, InfluxDBChunkedResult]


Returns an async generator if chunked is True, otherwise returns a dictionary containing the parsed JSON response.

classmethod set_query_pattern(name, qp)[source]

Defines custom methods to provide quick access to commonly used query patterns. Query patterns are plain strings, with optional the named placed holders. Named placed holders are processed as keyword arguments in str.format. Positional arguments are also supported.

Sample query pattern: "SELECT mean(load) FROM cpu_stats WHERE host = '{host}' AND time > now() - {days}d"

  • name (str) – Name of the query pattern class method. Must be a valid Python identifier.
  • qp (str) – Query pattern string
Return type:


write(data, measurement=None, db=None, precision=None, rp=None, tag_columns=None, **extra_tags)[source]

Writes data to InfluxDB. Input can be:

  1. A mapping (e.g. dict) containing the keys:
    measurement, time, tags, fields
  2. A Pandas DataFrame with a DatetimeIndex
  3. A user defined class decorated w/ lineprotocol()
  4. A string (str or bytes) properly formatted in InfluxDB’s line protocol
  5. An iterable of one of the above

Input data in formats 1-3 are parsed to the line protocol before being written to InfluxDB. See the InfluxDB docs for more details.

  • data (Union[AnyStr, Mapping[~KT, +VT_co], Iterable[Union[AnyStr, Mapping[~KT, +VT_co]]]]) – Input data (see description above).
  • measurement (Optional[str]) – Measurement name. Mandatory when when writing DataFrames only. When writing dictionary-like data, this field is treated as the default value for points that do not contain a measurement field.
  • db (Optional[str]) – Database to be written to. Defaults to self.db.
  • precision (Optional[str]) – Sets the precision for the supplied Unix time values. Ignored if input timestamp data is of non-integer type. Valid values: {'ns', 'u', 'µ', 'ms', 's', 'm', 'h'}
  • rp (Optional[str]) – Sets the target retention policy for the write. If unspecified, data is written to the default retention policy.
  • tag_columns (Optional[Iterable[+T_co]]) – Columns to be treated as tags (used when writing DataFrames only)
  • extra_tags – Additional tags to be added to all points passed.
Return type:



Returns True if insert is successful. Raises ValueError exception otherwise.

exception aioinflux.client.InfluxDBWriteError(resp)[source]


aioinflux.serialization.common.escape(string, escape_pattern)[source]

Assistant function for string escaping

aioinflux.serialization.usertype.lineprotocol(cls=None, *, schema=None, rm_none=False, extra_tags=None, placeholder=False)[source]

Adds to_lineprotocol method to arbitrary user-defined classes

  • schema – Schema dictionary (attr/type pairs).
  • rm_none – Whether apply a regex to remove None values. If False, passing None values to boolean, integer or float or time fields will result in write errors. Setting to True is “safer” but impacts performance.
  • extra_tags – Hard coded tags to be added to every point generated.
  • placeholder – If no field attributes are present, add a placeholder attribute (_) which is always equal to True. This is a workaround for creating field-less points (which is not supported natively by InfluxDB)