server.web.db.engine
====================

.. py:module:: server.web.db.engine


Attributes
----------

.. autoapisummary::

   server.web.db.engine.log
   server.web.db.engine._engine
   server.web.db.engine._SessionMaker


Functions
---------

.. autoapisummary::

   server.web.db.engine.get_engine
   server.web.db.engine.get_sessionmaker
   server.web.db.engine._reset_singletons
   server.web.db.engine.get_dialect_name
   server.web.db.engine.is_mysql
   server.web.db.engine.is_sqlite


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

.. py:data:: log

.. py:data:: _engine
   :type:  sqlalchemy.engine.Engine | None
   :value: None


.. py:data:: _SessionMaker
   :type:  sqlalchemy.orm.sessionmaker | None
   :value: None


.. py:function:: get_engine() -> sqlalchemy.engine.Engine

   Return the lazily-initialised SQLAlchemy engine.


.. py:function:: get_sessionmaker() -> sqlalchemy.orm.sessionmaker

   Get the SQLAlchemy sessionmaker singleton.


.. py:function:: _reset_singletons() -> None

.. py:function:: get_dialect_name() -> str

   Lower-case dialect string, e.g. 'mysql', 'sqlite', 'postgresql'.


.. py:function:: is_mysql() -> bool

   Check if the current database dialect is MySQL.


.. py:function:: is_sqlite() -> bool

   Check if the current database dialect is SQLite.