File: implementation.rst

package info (click to toggle)
python-aioinflux 0.9.0-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 320 kB
  • sloc: python: 1,402; makefile: 41
file content (16 lines) | stat: -rw-r--r-- 712 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Implementation details
======================

Since InfluxDB exposes all its functionality through an `HTTP
API <https://docs.influxdata.com/influxdb/latest/tools/api/>`__,
:class:`~aioinflux.client.InfluxDBClient` tries to be nothing more
than a thin and simple wrapper around that API.

The InfluxDB HTTP API exposes exactly three endpoints/functions:
:meth:`~aioinflux.client.InfluxDBClient.ping`,
:meth:`~aioinflux.client.InfluxDBClient.write` and
:meth:`~aioinflux.client.InfluxDBClient.query`.

:class:`~aioinflux.client.InfluxDBClient` merely wraps these three functions and provides
some parsing functionality for generating line protocol data (when
writing) and parsing JSON responses (when querying).