Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#1254]: extend data lake measure endpoints get method to process query parameters #1349

Conversation

bossenti
Copy link
Contributor

@bossenti bossenti commented Feb 24, 2023

Purpose

Add support of several query parameters that are available for the data lake measurement endpoint to the corresponding get() method of the Python client. This allows one now to only query for a whole data lake measurement but to refine the query with the following parameters:

   columns: Optional[str]
        A comma separated list of column names (e.g., `time,value`)<br>
        If provided, the returned data only consists of the given columns.
    end_date: Optional[datetime]
        Restricts queried data to be younger than the specified time.
    limit: Optional[int]
        Amount of records returned at maximum (default: `1000`) <br>
        This needs to at least `1`
    offset: Optional[int]
        Offset to be applied to returned data <br>
        This needs to at least `0`
    order: Optional[str]
        Ordering of query results <br>
        Allowed values: `ASC` and `DESC` (default: `ASC`)
    page_no: Optional[int]
        Page number used for paging operation <br>
        This needs to at least `1`
    start_date: Optional[datetime]
        Restricts queried data to be older than the specified time

Remarks

PR introduces (a) breaking change(s): no

PR introduces (a) deprecation(s): no

@github-actions github-actions bot added python Pull requests that update Python code testing Relates to any kind of test (unit test, integration, or E2E test). labels Feb 24, 2023
@bossenti bossenti added the enhancement New feature or request label Feb 24, 2023
@bossenti bossenti requested a review from SvenO3 February 24, 2023 16:58
@bossenti bossenti self-assigned this Feb 24, 2023
@bossenti bossenti force-pushed the feature/1254-adapt-data-lake-measure-endpoints-get-method-to-process-query-parameter-in-python branch from 7291cdc to 62bae9e Compare February 24, 2023 17:16
Signed-off-by: bossenti <[email protected]>
@github-actions github-actions bot added the documentation Everything related to documentation label Feb 27, 2023
Signed-off-by: bossenti <[email protected]>
@bossenti bossenti merged commit f71bd96 into dev Feb 27, 2023
@bossenti bossenti deleted the feature/1254-adapt-data-lake-measure-endpoints-get-method-to-process-query-parameter-in-python branch February 27, 2023 17:47
bossenti added a commit that referenced this pull request Feb 27, 2023
…ry parameters (#1349)

* feature(#1254): add query parameters for get endpoint for measurements

Signed-off-by: bossenti <[email protected]>

* feature(#1254): add examples for query parameters

Signed-off-by: bossenti <[email protected]>

* chore: update example notebooks

Signed-off-by: bossenti <[email protected]>

* chore: add missing update of unit tests

Signed-off-by: bossenti <[email protected]>

* chore: add missing file headers

Signed-off-by: bossenti <[email protected]>

* chore: fix typo

Signed-off-by: bossenti <[email protected]>

* chore: fix typos

Signed-off-by: bossenti <[email protected]>

* feature(#1254): add examples to docs

Signed-off-by: bossenti <[email protected]>

* chore: add demo for initial setup

Signed-off-by: bossenti <[email protected]>

* chore: fix formatting

Signed-off-by: bossenti <[email protected]>

---------

Signed-off-by: bossenti <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Everything related to documentation enhancement New feature or request python Pull requests that update Python code testing Relates to any kind of test (unit test, integration, or E2E test).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adapt data lake measure endpoint's get() method to process query parameter in Python
3 participants