:py:mod:`rhino_health.lib.endpoints.sql_query.sql_query_endpoints`
==================================================================

.. py:module:: rhino_health.lib.endpoints.sql_query.sql_query_endpoints


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.endpoints.sql_query.sql_query_endpoints.SQLQueryEndpoints




Attributes
~~~~~~~~~~

.. autoapisummary::

   rhino_health.lib.endpoints.sql_query.sql_query_endpoints.BUFFER_TIME_IN_SEC


.. py:data:: BUFFER_TIME_IN_SEC
   :value: 300

   

.. py:class:: SQLQueryEndpoints(session)


   Bases: :py:obj:`rhino_health.lib.endpoints.endpoint.Endpoint`

   


   Endpoints to interact with a remote SQL server on the FCP















   ..
       !! processed by numpydoc !!
   .. py:method:: 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










      .. rubric:: Examples

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



      ..
          !! processed by numpydoc !!

   .. py:method:: 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










      .. rubric:: Examples

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



      ..
          !! processed by numpydoc !!

   .. py:method:: 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










      .. rubric:: Examples

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



      ..
          !! processed by numpydoc !!