:tocdepth: 3

:py:mod:`gws.base.database.model`
=================================

.. py:module:: gws.base.database.model

.. autoapi-nested-parse::

   Database-based models.



**Source code:** :source:`gws.base.database.model<gws/base/database/model.py>`



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



.. py:class:: Config


   Bases: :py:obj:`gws.base.model.Config`

   Configuration for the database model.

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

      Database provider uid.

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

      Extra SQL filter.

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

      Table name for the model.


.. py:class:: Object


   Bases: :py:obj:`gws.base.model.Object`, :py:obj:`gws.DatabaseModel`

   Database-based data model.

   .. py:method:: build_select(mc)

      Build a SQLAlchemy Select statement based on the provided ModelContext.


   .. py:method:: column(column_name)

      Retrieve the SQLAlchemy Column object for the given column name.


   .. py:method:: configure()

      Configuration hook.


   .. py:method:: configure_provider()

   .. py:method:: create_feature(feature, mc)

   .. py:method:: delete_feature(feature, mc)

   .. py:method:: describe()

   .. py:method:: fetch_features(select)

      Fetch features from the database based on the provided SQLAlchemy Select statement.


   .. py:method:: find_features(search, mc)

   .. py:method:: init_feature(feature, mc)

   .. py:method:: table()

      Return the SQLAlchemy Table object for this database model.


   .. py:method:: uid_column()

      Return the SQLAlchemy Column object representing the unique identifier column.


   .. py:method:: update_feature(feature, mc)


.. py:class:: Props


   Bases: :py:obj:`gws.base.model.Props`