:py:mod:`thanosql`
==================

.. py:module:: thanosql


Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   resources/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   thanosql.ThanoSQL




.. py:class:: ThanoSQL(api_token: Optional[str] = None, engine_url: Optional[str] = None, api_version: str = 'v1')


   Bases: :py:obj:`thanosql._base_client.ThanoSQLBaseClient`

   Client for accessing the ThanoSQL engine.

   :param api_token: The workspace/engine API token. If not supplied, will be retrieved
                     from the THANOSQL_API_TOKEN environment variable.
   :type api_token: str, optional
   :param engine_url: The workspace engine URL. If not supplied, will be retrieved from
                      the THANOSQL_ENGINE_URL environment variable.
   :type engine_url: str, optional
   :param api_version: The version of the API used.
   :type api_version: str, default "v1"

   .. attribute:: query

      The service layer for query APIs.

      :type: QueryService

   .. attribute:: file

      The service layer for file APIs.

      :type: FileService

   .. attribute:: schema

      The service layer for schema APIs.

      :type: SchemaService

   .. attribute:: table

      The service layer for table APIs.

      :type: TableService

   .. attribute:: view

      The service layer for view APIs.

      :type: ViewService

   :raises ThanoSQLValueError: If API token and/or engine URL is neither passed in as parameters
       nor set as environment variables.

   .. py:property:: query
      :type: thanosql.resources.QueryService

      Access the QueryService.

   .. py:property:: file
      :type: thanosql.resources.FileService

      Access the FileService.

   .. py:property:: schema
      :type: thanosql.resources.SchemaService

      Access the SchemaService.

   .. py:property:: table
      :type: thanosql.resources.TableService

      Access the TableService.

   .. py:property:: view
      :type: thanosql.resources.ViewService

      Access the ViewService.