Skip to main content

Waylay Query: timeseries queries (v1 protocol)

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 consists of a plugin for the waylay-sdk-core package, and contains the Queries api methods. Note that the typed model classes for all path params, query params, body params and responses for each of the api methods are contained in a separate package called waylay-sdk-queries-types.

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 install waylay-sdk-queries together with the SDK api packages for other services.
  • pip install waylay-sdk[types-queries] will additionally install the types package waylay-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/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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

waylay_sdk_queries-0.5.0.20240802.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file waylay_sdk_queries-0.5.0.20240802.tar.gz.

File metadata

File hashes

Hashes for waylay_sdk_queries-0.5.0.20240802.tar.gz
Algorithm Hash digest
SHA256 3716e6d2436124876171c6fbe58fa7827630586304955c9030c033c480a92194
MD5 448214108dc6731fe30c670638fc4c8b
BLAKE2b-256 798b026d824473b764584d9585a388c5a5fb1f9186869a8228c712ee1a445ea9

See more details on using hashes here.

File details

Details for the file waylay_sdk_queries-0.5.0.20240802-py3-none-any.whl.

File metadata

File hashes

Hashes for waylay_sdk_queries-0.5.0.20240802-py3-none-any.whl
Algorithm Hash digest
SHA256 880be52a9a4e8355976a78edc6099ebfddd580c043f1ea1b8a99aa3135a6fc55
MD5 720a7a3b687840aa09f95a38034e92c6
BLAKE2b-256 eb8ba511da613c265dfd7b297b8ebfc4264a3b6623535d0e91c7163055af69a2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page