airflow.providers.influxdb.hooks.influxdb
¶
This module allows to connect to a InfluxDB database.
Module Contents¶
Classes¶
Interact with InfluxDB. |
- class airflow.providers.influxdb.hooks.influxdb.InfluxDBHook(conn_id=default_conn_name, *args, **kwargs)[source]¶
Bases:
airflow.hooks.base.BaseHook
Interact with InfluxDB.
Performs a connection to InfluxDB and retrieves client.
- Parameters
influxdb_conn_id – Reference to Influxdb connection id.
- classmethod get_connection_form_widgets()[source]¶
Return connection widgets to add to connection form.
- query(query)[source]¶
Run the query.
Note: The bucket name should be included in the query.
- Parameters
query – InfluxDB query
- Returns
List
- Return type
list[influxdb_client.client.flux_table.FluxTable]
- query_to_df(query)[source]¶
Run the query and return a pandas dataframe.
Note: The bucket name should be included in the query.
- Parameters
query – InfluxDB query
- Returns
pd.DataFrame
- Return type
- write(bucket_name, point_name, tag_name, tag_value, field_name, field_value, synchronous=False)[source]¶
Write a Point to the bucket specified.
Example:
Point("my_measurement").tag("location", "Prague").field("temperature", 25.3)