Metadata-Version: 2.0
Name: sqlalchemy-mongobi
Version: 0.2.0
Summary: MongoDB connector for BI SQLAlchemy Dialect
Home-page: https://github.com/smarzola/sqlalchemy-mongobi
Author: Simone Marzola
Author-email: marzolasimone@gmail.com
License: MIT license
Keywords: sqlalchemy mongodb
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: sqlalchemy

==================
sqlalchemy-mongobi
==================


MongoDB connector for BI SQLAlchemy dialect.


.. image:: https://img.shields.io/pypi/v/sqlalchemy_mongobi.svg
        :target: https://pypi.python.org/pypi/sqlalchemy_mongobi

.. image:: https://img.shields.io/travis/smarzola/sqlalchemy-mongobi.svg
        :target: https://travis-ci.org/smarzola/sqlalchemy-mongobi


MongoDB connector for BI does not have support for transactions but SQLAlchemy DBAPI
layer uses ROLLBACKs after the connection initialization even if the connection pool is
configured with `reset_on_return=False`. This dialect ignores COMMITs and ROLLBACKs, and
uses the `NullPool` connection pool (which means no pooling, opens and closes the underlying
DB-API connection per each connection open/close).


Usage
-----
The DSN format is similar to that of mysql::

    engine = create_engine(
        "mongobi://user?source=auth_db:password@url:port/database",
        connect_args={
            "ssl": {
                "mode": "PREFERRED"
            }
        },
        pool_reset_on_return=False,
    )


DBAPI Support
-------------
The following DBAPI options are available:

* mysqlclient::

    mongobi+mysqldb://user?source=auth_db:password@url:port/database


* PyMySQL::

    mongobi+pymysql://user?source=auth_db:password@url:port/database



