:orphan:

:py:mod:`thanosql.resources._schema`
====================================

.. py:module:: thanosql.resources._schema


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

Classes
~~~~~~~

.. autoapisummary::

   thanosql.resources._schema.SchemaService




.. py:class:: SchemaService(client: thanosql._client.ThanoSQL)


   Bases: :py:obj:`thanosql._service.ThanoSQLService`

   Service layer for schema methods.

   .. attribute:: client

      The ThanoSQL client used to make requests to the engine.

      :type: ThanoSQL

   .. py:method:: list() -> dict

      Lists schemas stored in the workspace.

      Does not have any parameters.

      :returns:

                A dictionary containing the names of stored schemas in the format of::

                    {
                        "schemas": [
                            {
                                "name": "string"
                            }
                        ]
                    }
      :rtype: dict


   .. py:method:: create(name: str) -> dict

      Creates a new schema in the workspace.

      :param name: The name of the schema to be created.
      :type name: str

      :returns: A dictionary containing the name of the created schema and
                a success message in the format of::

                    {
                        "schema": "string",
                        "message": "string"
                    }
      :rtype: dict