-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
129 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
nisystemlink/clients/dataframe/models/_query_tables_request.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
from datetime import datetime | ||
from typing import List, Optional, Union | ||
|
||
from nisystemlink.clients.core._uplink._with_paging import WithPaging | ||
from pydantic import StrictBool, StrictInt | ||
|
||
from ._order_by import OrderBy | ||
|
||
|
||
class QueryTablesRequest(WithPaging): | ||
"""Request parameters for querying tables.""" | ||
|
||
filter: str | ||
"""The table query filter in `Dynamic LINQ`_ format. | ||
.. _Dynamic LINQ: https://github.com/ni/systemlink-OpenAPI-documents/wiki/Dynamic-Linq-Query-Language | ||
Allowed properties in the filter are: | ||
* ``createdAt``: DateTime the table was created | ||
* ``createdWithin``: TimeSpan in which the table was created | ||
* ``id``: String value uniquely identifying the table | ||
* ``name``: String name for the table | ||
* ``metadataModifiedAt``: DateTime the table's metadata was last modified | ||
* ``metadataModifiedWithin``: TimeSpan in which the table's metadata was | ||
last modified | ||
* ``properties``: Dictionary with string keys and values representing table | ||
metadata | ||
* ``rowsModifiedAt``: DateTime rows were last appended to the table | ||
* ``rowsModifiedWithin``: TimeSpan within rows were last appended to the | ||
table | ||
* ``rowCount``: Int32 number of rows in the table | ||
* ``supportsAppend``: Boolean indicating whether or not the table supports | ||
appending additional rows of data | ||
* ``workspace``: String value ID of the workspace the table belongs to | ||
* ``workspaceName``: String value name of the workspace the table belongs to | ||
Allowed constants in the filter are: | ||
* ``RelativeTime.CurrentDay``: TimeSpan representing the elapsed time | ||
between now and the start of the current day | ||
* ``RelativeTime.CurrentWeek``: TimeSpan representing the elapsed time | ||
between now and the start of the current week | ||
* ``RelativeTime.CurrentMonth``: TimeSpan representing the elapsed time | ||
between now and the start of the current month | ||
* ``RelativeTime.CurrentYear``: TimeSpan representing the elapsed time | ||
between now and the start of the current year | ||
""" | ||
|
||
substitutions: Optional[List[Union[StrictInt, StrictBool, str, None]]] = None | ||
"""Make substitutions in the query filter expression. | ||
Substitutions for the query expression are indicated by non-negative | ||
integers that are prefixed with the ``@`` symbol. Each substitution in the given | ||
expression will be replaced by the element at the corresponding index | ||
(zero-based) in this list. For example, ``@0`` in the filter expression will be | ||
replaced with the element at the zeroth index of the substitutions list. | ||
""" | ||
|
||
reference_time: Optional[datetime] = None | ||
"""The date and time to use as the reference point for `RelativeTime` filters, | ||
including time zone information. Defaults to the time on the server in UTC.""" | ||
|
||
take: Optional[int] = None | ||
"""Limits the returned list to the specified number of results.""" | ||
|
||
order_by: Optional[OrderBy] = None | ||
"""The sort order of the returned list of tables.""" | ||
|
||
order_by_descending: Optional[bool] = None | ||
"""Whether to sort descending instead of ascending. | ||
The elements in the list are sorted ascending by default. If the | ||
orderByDescending parameter is specified, the elements in the list are | ||
sorted based on it's value. The orderByDescending value must be a boolean | ||
string. The elements in the list are sorted ascending if false and | ||
descending if true. | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters