:orphan:

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

.. py:module:: thanosql.resources._view


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

Classes
~~~~~~~

.. autoapisummary::

   thanosql.resources._view.View
   thanosql.resources._view.ViewService




.. py:class:: View(/, **data: Any)


   Bases: :py:obj:`thanosql.resources._model.BaseModel`

   Usage docs: https://docs.pydantic.dev/2.9/concepts/models/

   A base class for creating Pydantic models.

   .. attribute:: __class_vars__

      The names of the class variables defined on the model.

   .. attribute:: __private_attributes__

      Metadata about the private attributes of the model.

   .. attribute:: __signature__

      The synthesized `__init__` [`Signature`][inspect.Signature] of the model.

   .. attribute:: __pydantic_complete__

      Whether model building is completed, or if there are still undefined fields.

   .. attribute:: __pydantic_core_schema__

      The core schema of the model.

   .. attribute:: __pydantic_custom_init__

      Whether the model has a custom `__init__` function.

   .. attribute:: __pydantic_decorators__

      Metadata containing the decorators defined on the model.
      This replaces `Model.__validators__` and `Model.__root_validators__` from Pydantic V1.

   .. attribute:: __pydantic_generic_metadata__

      Metadata for generic models; contains data used for a similar purpose to
      __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

   .. attribute:: __pydantic_parent_namespace__

      Parent namespace of the model, used for automatic rebuilding of models.

   .. attribute:: __pydantic_post_init__

      The name of the post-init method for the model, if defined.

   .. attribute:: __pydantic_root_model__

      Whether the model is a [`RootModel`][pydantic.root_model.RootModel].

   .. attribute:: __pydantic_serializer__

      The `pydantic-core` `SchemaSerializer` used to dump instances of the model.

   .. attribute:: __pydantic_validator__

      The `pydantic-core` `SchemaValidator` used to validate instances of the model.

   .. attribute:: __pydantic_extra__

      A dictionary containing extra values, if [`extra`][pydantic.config.ConfigDict.extra]
      is set to `'allow'`.

   .. attribute:: __pydantic_fields_set__

      The names of fields explicitly set during instantiation.

   .. attribute:: __pydantic_private__

      Values of private attributes set on the model instance.

   .. py:attribute:: name
      :type: str

      

   .. py:attribute:: table_schema
      :type: Optional[str]

      

   .. py:attribute:: columns
      :type: List[thanosql.resources.Column]
      :value: []

      

   .. py:attribute:: definition
      :type: str
      :value: ''

      


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


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

   Service layer for view methods.

   .. attribute:: client

      The ThanoSQL client used to make requests to the engine.

      :type: ThanoSQL

   .. py:method:: list(schema: Optional[str] = None, verbose: Optional[bool] = None, offset: Optional[int] = None, limit: Optional[int] = None) -> List[View]

      Lists views stored in the workspace.

      :param schema: When specified, lists views from a specific schema only.
                     Otherwise, lists views from all available schemas.
      :type schema: str, optional
      :param verbose: When not set or set to False (default behavior), only lists
                      view names and the schema they belong to. When set to True,
                      includes column descriptions and view definition in the output
                      on top of the basic (name and schema) information.
      :type verbose: bool, optional
      :param offset: When set to n, skips the first n views and excludes them from
                     the output list. Otherwise, starts the list from the first view
                     stored. Must be greater than 0.
      :type offset: int, optional
      :param limit: When set to n, limits the number of views listed to n. Otherwise,
                    lists up to 100 views per call. Must range between 0 to 100.
      :type limit: int, optional

      :returns: A list of View objects.
      :rtype: List[View]

      :raises ThanoSQLValueError: If offset is less than 0 or if limit is not between 0 to 100 (inclusive).


   .. py:method:: get(name: str, schema: Optional[str] = None) -> View

      Shows the details of the specified view.

      :param name: The name of the view to be retrieved.
      :type name: str
      :param schema: The schema the target view is stored in. When not specified,
                     defaults to "public".
      :type schema: str, optional

      :returns: A View object.
      :rtype: View


   .. py:method:: delete(name: str, schema: Optional[str] = None) -> dict

      Deletes the specified view.

      :param name: The name of the view to be deleted.
      :type name: str
      :param schema: The schema the target view is stored in. When not specified,
                     defaults to "public".
      :type schema: str, optional

      :returns: A dictionary containing a success message and the name of the
                deleted view in the format of::

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