U
vi$ @ s d Z ddlZddlZddlmZ ddlmZ ddlmZm Z ddl
m Z G dd dZ G d d
d
eZ
G d d d e ZG d
d de ZG dd de ZG dd dee ZG dd de ee ZdS )zt
Flux employs a basic data model built from basic data types.
The data model consists of tables, records, columns.
N) HTTPResponse) JSONEncoder)ListIterator)_UTF_8_encodingc @ s e Zd ZdZdS )
FluxStructurez4The data model consists of tables, records, columns.N)__name__
__module__ __qualname____doc__ r r R/opt/alt/python38/lib/python3.8/site-packages/influxdb_client/client/flux_table.pyr s r c s e Zd ZdZ fddZ ZS )FluxStructureEncoderz:The FluxStructure encoder to encode query results to JSON.c s> ddl }t|tr|jS t||j |jfr2| S t |S )z,Return serializable objects for JSONEncoder.r N)datetime
isinstancer __dict__date isoformatsuperdefault)selfobjr __class__r r
r s
z FluxStructureEncoder.default)r r r
r r
__classcell__r r r r
r s r c @ s> e Zd ZdZddddZdd Zdd Zd
d Zd d
ZdS ) FluxTableaA
A table is set of records with a common set of columns and a group key.
The table can be serialized into JSON by::
import json
from influxdb_client.client.flux_table import FluxStructureEncoder
output = json.dumps(tables, cls=FluxStructureEncoder, indent=2)
print(output)
Nreturnc C s g | _ g | _dS zInitialize defaults.N)columnsrecordsr r r r
__init__/ s zFluxTable.__init__c C s t tdd | jS )u
Group key is a list of columns.
A table’s group key denotes which subset of the entire dataset is assigned to the table.
c S s
| j dkS )NT)group)columnr r r
: z)FluxTable.get_group_key..)listfilterr r! r r r
get_group_key4 s zFluxTable.get_group_keyc C s2 t | j}|d tt| j d tt| j S )Return formatted output.z () columns: z , records: )typer strlenr r r cls_namer r r
__str__< s
zFluxTable.__str__c C s* dt | j dt| j dt| j dS )Format for inspection.)r+ r r- r r r! r r r
__repr__A s zFluxTable.__repr__c C s
t | jS )zIterate over records.)iterr r! r r r
__iter__E s zFluxTable.__iter__) r r r
r r" r) r0 r3 r5 r r r r
r ! s
r c @ s( e Zd ZdZdddddZdd ZdS )
FluxColumnz%A column has a label and a data type.Nr c C s" || _ || _|| _|| _|| _dS r )
default_valuer# data_typelabelindex)r r: r9 r8 r# r7 r r r
r" M s
zFluxColumn.__init__c s: t jg fdddD }t j dd| dS )r1 c s. g | ]&}t |d k r| dt |qS )N=)getattr).0namer! r r
W s z'FluxColumn.__repr__..)r9 r8 r# r7 (, ))reprr: r+ r join)r fieldsr r! r
r3 U s zFluxColumn.__repr__)NNNNN)r r r
r r" r3 r r r r
r6 J s r6 c @ sp e Zd ZdZdddddZdd Zdd Zd
d Zd d
Zdd Z dd Z
dd Z dd Z dd Z
dd ZdS )
FluxRecordzLA record is a tuple of named values and is represented using an object type.Nr c C s" |dkr i }|| _ || _g | _dS r )tablevaluesrow)r rG rH r r r
r" b s
zFluxRecord.__init__c C s | d S )zGet '_start' value._startr r! r r r
get_startj s zFluxRecord.get_startc C s | d S )zGet '_stop' value._stopr r! r r r
get_stopn s zFluxRecord.get_stopc C s | d S )zGet timestamp._timer r! r r r
get_timer s zFluxRecord.get_timec C s | d S )zGet field value._valuer r! r r r
get_valuev s zFluxRecord.get_valuec C s | d S )zGet field name._fieldr r! r r r
get_fieldz s zFluxRecord.get_fieldc C s | d S )zGet measurement name.Z _measurementr r! r r r
get_measurement~ s zFluxRecord.get_measurementc C s | j |S )zGet value by key.)rH __getitem__)r keyr r r
rU s zFluxRecord.__getitem__c C s | j ||S )z Set value with key and value.)rH __setitem__)r rV valuer r r
rW s zFluxRecord.__setitem__c C s* t | j}|d t| j d t| j S )r* z
() table: rA )r+ r r, rG rH r. r r r
r0 s
zFluxRecord.__str__c C s. dt | j d| jd d| jd dS )r1 r2 z: field=rR z, value=rP >)r+ r rH getr! r r r
r3 s zFluxRecord.__repr__)N)r r r
r r" rK rM rO rQ rS rT rU rW r0 r3 r r r r
rF _ s rF c @ sL e Zd ZdZd ed eee dddZd ed edddZd d
Z dS )
TableListzy:class:`~influxdb_client.client.flux_table.FluxTable` list with additionally functional to better handle of query result.Nr, )r r c s fdd}| |S )a
Serialize query results to a flattened list of values.
:param columns: if not ``None`` then only specified columns are presented in results
:return: :class:`~list` of values
Output example:
.. code-block:: python
[
['New York', datetime.datetime(2022, 6, 7, 11, 3, 22, 917593, tzinfo=tzutc()), 24.3],
['Prague', datetime.datetime(2022, 6, 7, 11, 3, 22, 917593, tzinfo=tzutc()), 25.3],
...
]
Configure required columns:
.. code-block:: python
from influxdb_client import InfluxDBClient
with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org") as client:
# Query: using Table structure
tables = client.query_api().query('from(bucket:"my-bucket") |> range(start: -10m)')
# Serialize to values
output = tables.to_values(columns=['location', '_time', '_value'])
print(output)
c s$ d k r fddD S j S )Nc s g | ]} j |qS r )rH rZ )r= krecordr r
r? s z>TableList.to_values..filter_values..)rH r] r r] r
filter_values s z*TableList.to_values..filter_values)
_to_values)r r r` r r_ r
to_values s ! zTableList.to_valuesc s@ d|krd|d< fdd}ddl }|j| |fdti|S )a
Serialize query results to a JSON formatted :class:`~str`.
:param columns: if not ``None`` then only specified columns are presented in results
:return: :class:`~str`
The query results is flattened to array:
.. code-block:: javascript
[
{
"_measurement": "mem",
"_start": "2021-06-23T06:50:11.897825+00:00",
"_stop": "2021-06-25T06:50:11.897825+00:00",
"_time": "2020-02-27T16:20:00.897825+00:00",
"region": "north",
"_field": "usage",
"_value": 15
},
{
"_measurement": "mem",
"_start": "2021-06-23T06:50:11.897825+00:00",
"_stop": "2021-06-25T06:50:11.897825+00:00",
"_time": "2020-02-27T16:20:01.897825+00:00",
"region": "west",
"_field": "usage",
"_value": 10
},
...
]
The JSON format could be configured via ``**kwargs`` arguments:
.. code-block:: python
from influxdb_client import InfluxDBClient
with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org") as client:
# Query: using Table structure
tables = client.query_api().query('from(bucket:"my-bucket") |> range(start: -10m)')
# Serialize to JSON
output = tables.to_json(indent=5)
print(output)
For all available options see - `json.dump `_.
indent c s& d k r fdd| j D S | j S )Nc s i | ]\}}| kr||qS r r )r= r\ vr_ r r
s z.filter_values..)rH itemsr] r_ r r
r` s z(TableList.to_json..filter_valuesr Ncls)jsondumpsra r )r r kwargsr` ri r r_ r
to_json s
2 zTableList.to_jsonc s fdd| D S )Nc s g | ]}|j D ] } |qqS r )r )r= rG r^ mappingr r
r? s z(TableList._to_values..r )r rn r rm r
ra s zTableList._to_values)N)N)
r r r
r r objectrb r, rl ra r r r r
r[ s (=r[ c @ sF e Zd ZdZeddddZdd Zdd Zeee d
d d Z
dS )
CSVIteratorz[:class:`Iterator[List[str]]` with additionally functional to better handle of query result.N)responser c C s t t|t| _dS )zInitialize ``csv.reader``.N)csvreadercodecs
iterdecoder delegate)r rq r r r
r" s zCSVIterator.__init__c C s | S )zReturn an iterator object.r r! r r r
r5 s zCSVIterator.__iter__c C s | j }|s| j }q
|S )z)Retrieve the next item from the iterator.)rv __next__)r rI r r r
rw s
zCSVIterator.__next__r c C s t | S )ak
Serialize query results to a flattened list of values.
:return: :class:`~list` of values
Output example:
.. code-block:: python
[
['New York', '2022-06-14T08:00:51.749072045Z', '24.3'],
['Prague', '2022-06-14T08:00:51.749072045Z', '25.3'],
...
]
)r' r5 r! r r r
rb s zCSVIterator.to_values) r r r
r r r" r5 rw r r, rb r r r r
rp s
rp )r rt rr http.clientr ri r typingr r Zinfluxdb_client.restr r r r r6 rF r[ r, rp r r r r
s
)5l