:tocdepth: 3

:py:mod:`gws.plugin.postgres.storage_provider`
==============================================

.. py:module:: gws.plugin.postgres.storage_provider

.. autoapi-nested-parse::

   Postgres storage provider.



**Source code:** :source:`gws.plugin.postgres.storage_provider<gws/plugin/postgres/storage_provider.py>`



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



.. py:class:: Config(*args, **kwargs)


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

   Postgres storage provider. (added in 8.4)

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

      Database provider uid.

   .. py:attribute:: tableName
      :type:  str

      Table name for the storage.


.. py:class:: Object


   Bases: :py:obj:`gws.StorageProvider`

   Storage provider.

   .. py:attribute:: db
      :type:  gws.plugin.postgres.provider.Object

   .. py:attribute:: tableName
      :type:  str

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: configure_provider()

   .. py:method:: configure_table()

   .. py:method:: delete(category, name)

   .. py:method:: list_names(category)

   .. py:method:: read(category, name)

   .. py:method:: write(category, name, data, user_uid)


.. py:data:: TABLE_DDL
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """
          CREATE TABLE IF NOT EXISTS {table_name} (
              category    TEXT NOT NULL,
              name        TEXT NOT NULL,
              user_uid    TEXT,
              data        TEXT,
              created     TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
              updated     TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
              PRIMARY KEY (category, name)
          )
      """

   .. raw:: html

      </details>