rhino_health.lib.endpoints.sql_query.sql_query_endpoints

Module Contents

Classes

SQLQueryEndpoints

Endpoints to interact with a remote SQL server on the FCP

Attributes

BUFFER_TIME_IN_SEC

rhino_health.lib.endpoints.sql_query.sql_query_endpoints.BUFFER_TIME_IN_SEC = 300

class rhino_health.lib.endpoints.sql_query.sql_query_endpoints.SQLQueryEndpoints(session)

Bases: rhino_health.lib.endpoints.endpoint.Endpoint

Endpoints to interact with a remote SQL server on the FCP

get_sql_query(sql_query_uid: str)

Returns a SQL dataclass

Parameters:

sql_query_uid: str

UID for the SQL query

Returns:

dataset: SQLQuery

SQLQuery dataclass

Examples

>>> session.sql_query_input.get_sql_query(my_query_uid)
Dataset()

import_dataset_from_sql_query(sql_query_input: rhino_health.lib.endpoints.sql_query.sql_query_dataclass.SQLQueryImportInput)

Returns a SQLQuery dataclass

Parameters:

sql_query_input: SQLQueryImportInput

SQLQueryImportInput dataclass

Returns:

sql_query_input: SQLQuery

SQLQuery dataclass

Examples

>>> session.sql_query.import_dataset_from_sql_query(sql_query_input)
SQLQuery()

run_sql_query(sql_query_input: rhino_health.lib.endpoints.sql_query.sql_query_dataclass.SQLQueryInput)

Returns a SQLQuery dataclass

Parameters:

sql_query_input: SQLQueryImportInput

SQLQueryImportInput dataclass

Returns:

sql_query_input: SQLQuery

SQLQuery dataclass

Examples

>>> session.sql_query.run_sql_query(sql_query_input)
SQLQuery()