Waylay Query: timeseries queries (v1 protocol) Types
Project description
Waylay Queries Service
Execute and store queries on the Waylay timeseries.
Protocol version: v1.
This Python package is automatically generated based on the Waylay Queries OpenAPI specification (API version: 0.5.0) For more information, please visit the openapi specification.
It is considered an extension of the waylay-sdk-queries package, and it consists of the typed model classes for all path params, query params, body params and responses for each of the api methods in waylay-sdk-queries
.
Requirements.
This package requires Python 3.9+.
Installation
Normally this package is installed together with support for other services using the waylay-sdk umbrella package:
pip install waylay-sdk
will installwaylay-sdk-queries
together with the SDK api packages for other services.pip install waylay-sdk[types-queries]
will additionally install the types packagewaylay-sdk-queries-types
.pip install waylay-sdk[types]
will install the types packages for this and all other services.
Alternatively, you can install support for this queries service only, installing or extending an existing waylay-sdk-core:
pip install waylay-sdk-queries
to only install api support for queries.pip install waylay-sdk-queries[types]
to additionally install type support for queries.
Usage
from pprint import pprint
# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError
# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()
# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-queries-types` is installed
from waylay.services.queries.models.query_input import QueryInput
from waylay.services.queries.models.query_result import QueryResult
try:
# Execute Query
# calls `POST /queries/v1/data`
api_response = await waylay_client.queries.execute.execute(
# query parameters:
query = {
'resource': '13efb488-75ac-4dac-828a-d49c5c2ebbfc'
'metric': 'temperature'
},
# json data: use a generated model or a json-serializable python data structure (dict, list)
json = waylay.services.queries.QueryInput() # QueryInput |
headers = {
'accept': 'accept_example',
},
)
print("The response of queries.execute.execute:\n")
pprint(api_response)
except ApiError as e:
print("Exception when calling queries.execute.execute: %s\n" % e)
For more information, please visit the Waylay API documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for waylay_sdk_queries_types-0.5.0.20240809.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9101131df7b69b22f24be66fb1a7dee1293a86f066275c3a66315de898d1cdb1 |
|
MD5 | b620ea9d2f9cfbd0324787cb598662e3 |
|
BLAKE2b-256 | 8c2a40b93bb3d2820f58d9872899e85d53a80e9b0a54e7162751cbe80f6aa510 |
Hashes for waylay_sdk_queries_types-0.5.0.20240809-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9e8556f6584aec4c57aba74d0173f0bcb58531eb81295d0ef7a4b1962313533 |
|
MD5 | 3a8067628a9466fe02ad87ef9137f169 |
|
BLAKE2b-256 | ce412bc93fdce476cf5911917435ae5729a6b2a8c8896ff808e39432729bd992 |