.. module:: sqlalchemy_singlestoredb
.. _api:
API Reference
=============
.. _api.functions:
Connections
-----------
Connections to SingleStoreDB should be done by creating an SQLAlchemy engine
first, then calling the :meth:`connect` method on that engine. See the
Getting Started section for more information.
The dialect class below is used by SQLAlchemy, but is typically
not worked with directly.
Dialect
.......
.. currentmodule:: sqlalchemy_singlestoredb.base
.. autosummary::
   :toctree: generated/
   SingleStoreDBDialect
   SingleStoreDBDialect.dbapi
   SingleStoreDBDialect.import_dbapi
   SingleStoreDBDialect.initialize
   SingleStoreDBDialect.create_connect_args