Skip to main content

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 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/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.

Metadata

Release files for waylay-sdk-queries-types 0.5.0.20241025

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for waylay-sdk-queries-types 0.5.0.20241025
File Size Uploaded Provenance Actions
waylay_sdk_queries_types-0.5.0.20241025.tar.gz 24.1 kB With provenance Details for waylay_sdk_queries_types-0.5.0.20241025.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for waylay-sdk-queries-types 0.5.0.20241025
File Interpreter ABI Platform Actions
waylay_sdk_queries_types-0.5.0.20241025-py3-none-any.whl Python 3 none any Details for waylay_sdk_queries_types-0.5.0.20241025-py3-none-any.whl

Total release size: 102.8 kB

Release files / waylay_sdk_queries_types-0.5.0.20241025.tar.gz

Download URL waylay_sdk_queries_types-0.5.0.20241025.tar.gz
Size 24.1 kB
Tags Source
SHA-256 checksum
How to use checksums
502abc763b1df92589d58616e9fe3c52ce2e937f2d0244d73a91172708d0fea2
BLAKE2b-256 checksum
How to use checksums
b434476fb50d78d0ad46f1514aaa3c7b915dc4877edd0eba8e73cb2cef640d7d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.

Transparency log

Release files / waylay_sdk_queries_types-0.5.0.20241025-py3-none-any.whl

Download URL waylay_sdk_queries_types-0.5.0.20241025-py3-none-any.whl
Size 78.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dde79977c7f8e0e3abcb4979b9d85dca6097fe92f36be7a1597e4e05e7c8ed7d
BLAKE2b-256 checksum
How to use checksums
028a9f84bbaad9c8a6ac54d21282aaa7b5e3fdc63dc261f700df9ec8f0bedaa6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.

Transparency log

Security for waylay-sdk-queries-types 0.5.0.20241025

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for waylay_sdk_queries_types-0.5.0.20241025.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page