🔐 Sid Gifari File Manager Pro
v8.0.5 | 2026-08-08 19:44:54 | PHP 8.2.32
📂
/ (Root)
/
opt
/
alt
/
python38
/
lib
/
python3.8
/
site-packages
/
influxdb_client
/
client
/
__pycache__
📍 /opt/alt/python38/lib/python3.8/site-packages/influxdb_client/client/__pycache__
🔄 Refresh
✏️
Editing: invokable_scripts_api.cpython-38.pyc
Read Only
U v�i�5 � @ sx d Z ddlmZmZmZmZ ddlmZmZm Z m Z m Z ddl m Z ddlmZ ddlmZmZmZ G dd� de �Zd S ) z� Use API invokable scripts to create custom InfluxDB API endpoints that query, process, and shape data. API invokable scripts let you assign scripts to API endpoints and then execute them as standard REST operations in InfluxDB Cloud. � )�List�Iterator� Generator�Any)�Script�InvokableScriptsService�ScriptCreateRequest�ScriptUpdateRequest�ScriptInvocationParams)� _BaseQueryApi)�FluxResponseMetadataMode)� FluxRecord� TableList� CSVIteratorc @ s� e Zd ZdZdd� Zeed�dd�Zee ed�dd �Z ed d �d d �Z dd� Z d ee ed�dd�Zd ee eded f d�dd�Zd!ee ee d�dd�Zd"ee ee d�dd�Zd#ee ed�dd �Zd$ee eee d�d d �Zd S )%�InvokableScriptsApizfUse API invokable scripts to create custom InfluxDB API endpoints that query, process, and shape data.c C s || _ t|j�| _dS )zInitialize defaults.N)Z_influxdb_clientr Z api_client�_invokable_scripts_service)�self�influxdb_client� r �]/opt/alt/python38/lib/python3.8/site-packages/influxdb_client/client/invokable_scripts_api.py�__init__ s z InvokableScriptsApi.__init__)�create_request�returnc C s | j j|d�S )z�Create a script. :param ScriptCreateRequest create_request: The script to create. (required) :return: The created script. )Zscript_create_request)r Z post_scripts)r r r r r � create_script s z!InvokableScriptsApi.create_script)� script_id�update_requestr c C s | j j||d�S )z�Update a script. :param str script_id: The ID of the script to update. (required) :param ScriptUpdateRequest update_request: Script updates to apply (required) :return: The updated. )r Zscript_update_request)r Zpatch_scripts_id)r r r r r r � update_script! s �z!InvokableScriptsApi.update_scriptN)r r c C s | j j|d� dS )zyDelete a script. :param str script_id: The ID of the script to delete. (required) :return: None )r N)r Zdelete_scripts_id)r r r r r � delete_script+ s z!InvokableScriptsApi.delete_scriptc K s | j jf |�jS )z�List scripts. :key int limit: The number of scripts to return. :key int offset: The offset for pagination. :return: List of scripts. :rtype: list[Script] )r Z get_scripts�scripts)r �kwargsr r r � find_scripts3 s z InvokableScriptsApi.find_scripts)r �paramsr c C s. | j j|t|d�dddd�}| j|dtjd�S )aA Invoke synchronously a script and return result as a TableList. The bind parameters referenced in the script are substitutes with `params` key-values sent in the request body. :param str script_id: The ID of the script to invoke. (required) :param params: bind parameters :return: :class:`~influxdb_client.client.flux_table.FluxTable` list wrapped into :class:`~influxdb_client.client.flux_table.TableList` :rtype: TableList Serialization the query results to flattened list of values via :func:`~influxdb_client.client.flux_table.TableList.to_values`: .. code-block:: python from influxdb_client import InfluxDBClient with InfluxDBClient(url="https://us-west-2-1.aws.cloud2.influxdata.com", token="my-token", org="my-org") as client: # Query: using Table structure tables = client.invokable_scripts_api().invoke_script(script_id="script-id") # Serialize to values output = tables.to_values(columns=['location', '_time', '_value']) print(output) .. 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], ... ] Serialization the query results to JSON via :func:`~influxdb_client.client.flux_table.TableList.to_json`: .. code-block:: python from influxdb_client import InfluxDBClient with InfluxDBClient(url="https://us-west-2-1.aws.cloud2.influxdata.com", token="my-token", org="my-org") as client: # Query: using Table structure tables = client.invokable_scripts_api().invoke_script(script_id="script-id") # Serialize to JSON output = tables.to_json(indent=5) print(output) .. 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 }, ... ] �r! F�r �script_invocation_params� async_req�_preload_contentZ_return_http_data_onlyN�Z query_optionsZresponse_metadata_mode)r �post_scripts_id_invoker Z _to_tablesr � only_names�r r r! �responser r r � invoke_script= s J�z!InvokableScriptsApi.invoke_scriptr c C s. | j j|t|d�dddd�}| j|dtjd�S )a� Invoke synchronously a script and return result as a Generator['FluxRecord']. The bind parameters referenced in the script are substitutes with `params` key-values sent in the request body. :param str script_id: The ID of the script to invoke. (required) :param params: bind parameters :return: Stream of FluxRecord. :rtype: Generator['FluxRecord'] r" Fr# Nr' )r r( r Z_to_flux_record_streamr r) r* r r r �invoke_script_stream� s ��z(InvokableScriptsApi.invoke_script_stream�r r! �data_frame_indexc C s | j |||d�}| �|�S )a4 Invoke synchronously a script and return Pandas DataFrame. The bind parameters referenced in the script are substitutes with `params` key-values sent in the request body. .. note:: If the ``script`` returns tables with differing schemas than the client generates a :class:`~DataFrame` for each of them. :param str script_id: The ID of the script to invoke. (required) :param List[str] data_frame_index: The list of columns that are used as DataFrame index. :param params: bind parameters :return: :class:`~DataFrame` or :class:`~List[DataFrame]` .. warning:: For the optimal processing of the query results use the ``pivot() function`` which align results as a table. .. code-block:: text from(bucket:"my-bucket") |> range(start: -5m, stop: now()) |> filter(fn: (r) => r._measurement == "mem") |> pivot(rowKey:["_time"], columnKey: ["_field"], valueColumn: "_value") For more info see: - https://docs.influxdata.com/resources/videos/pivots-in-flux/ - https://docs.influxdata.com/flux/latest/stdlib/universe/pivot/ - https://docs.influxdata.com/flux/latest/stdlib/influxdata/influxdb/schema/fieldsascols/ r. )� invoke_script_data_frame_streamZ_to_data_frames)r r r! r/ Z _generatorr r r �invoke_script_data_frame� s �z,InvokableScriptsApi.invoke_script_data_framec C s0 | j j|t|d�dddd�}| j||dtjd�S )aK Invoke synchronously a script and return stream of Pandas DataFrame as a Generator['pd.DataFrame']. The bind parameters referenced in the script are substitutes with `params` key-values sent in the request body. .. note:: If the ``script`` returns tables with differing schemas than the client generates a :class:`~DataFrame` for each of them. :param str script_id: The ID of the script to invoke. (required) :param List[str] data_frame_index: The list of columns that are used as DataFrame index. :param params: bind parameters :return: :class:`~Generator[DataFrame]` .. warning:: For the optimal processing of the query results use the ``pivot() function`` which align results as a table. .. code-block:: text from(bucket:"my-bucket") |> range(start: -5m, stop: now()) |> filter(fn: (r) => r._measurement == "mem") |> pivot(rowKey:["_time"], columnKey: ["_field"], valueColumn: "_value") For more info see: - https://docs.influxdata.com/resources/videos/pivots-in-flux/ - https://docs.influxdata.com/flux/latest/stdlib/universe/pivot/ - https://docs.influxdata.com/flux/latest/stdlib/influxdata/influxdb/schema/fieldsascols/ r" Fr# Nr' )r r( r Z_to_data_frame_streamr r) )r r r! r/ r+ r r r r0 � s � �z3InvokableScriptsApi.invoke_script_data_frame_streamc C s$ | j j|t|d�ddd�}| �|�S )a Invoke synchronously a script and return result as a CSV iterator. Each iteration returns a row of the CSV file. The bind parameters referenced in the script are substitutes with `params` key-values sent in the request body. :param str script_id: The ID of the script to invoke. (required) :param params: bind parameters :return: :class:`~Iterator[List[str]]` wrapped into :class:`~influxdb_client.client.flux_table.CSVIterator` :rtype: CSVIterator Serialization the query results to flattened list of values via :func:`~influxdb_client.client.flux_table.CSVIterator.to_values`: .. code-block:: python from influxdb_client import InfluxDBClient with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org") as client: # Query: using CSV iterator csv_iterator = client.invokable_scripts_api().invoke_script_csv(script_id="script-id") # Serialize to values output = csv_iterator.to_values() print(output) .. code-block:: python [ ['', 'result', 'table', '_start', '_stop', '_time', '_value', '_field', '_measurement', 'location'] ['', '', '0', '2022-06-16', '2022-06-16', '2022-06-16', '24.3', 'temperature', 'my_measurement', 'New York'] ['', '', '1', '2022-06-16', '2022-06-16', '2022-06-16', '25.3', 'temperature', 'my_measurement', 'Prague'] ... ] r" F�r r$ r% r& )r r( r Z_to_csvr* r r r �invoke_script_csv� s $�z%InvokableScriptsApi.invoke_script_csvc C s | j j|t|d�ddd�}|S )aq Invoke synchronously a script and return result as raw unprocessed result as a str. The bind parameters referenced in the script are substitutes with `params` key-values sent in the request body. :param str script_id: The ID of the script to invoke. (required) :param params: bind parameters :return: Result as a str. r" FTr2 )r r( r r* r r r �invoke_script_raw s �z%InvokableScriptsApi.invoke_script_raw)N)N)NN)NN)N)N)�__name__� __module__� __qualname__�__doc__r r r r �strr r r r �dictr r, r r r- r r1 r0 r r3 r r4 r r r r r s R %,r N)r8 �typingr r r r r r r r r r Z influxdb_client.client._baser Z&influxdb_client.client.flux_csv_parserr Z!influxdb_client.client.flux_tabler r r r r r r r �<module> s
💾 Save Changes
❌ Cancel