MySQL¶

Installation¶

Use extras mysql to install all required packages.

$ pip install mara-db[mysql]

Configuration examples¶

import mara_db.dbs
mara_db.config.databases = lambda: {
    'dwh': mara_db.dbs.MysqlDB(
        host='localhost',
        user='root',
        password='<my_strong_password>',
        database='dwh'),
}

API reference¶

This section contains database specific API in the module.

Configuration¶

class mara_db.dbs.MysqlDB(host: Optional[str] = None, port: Optional[int] = None, database: Optional[str] = None, user: Optional[str] = None, password: Optional[str] = None, ssl: Optional[bool] = None, charset: Optional[str] = None)¶

__init__(host: Optional[str] = None, port: Optional[int] = None, database: Optional[str] = None, user: Optional[str] = None, password: Optional[str] = None, ssl: Optional[bool] = None, charset: Optional[str] = None)¶

property sqlalchemy_url¶: Returns the SQLAlchemy url for a database

Cursor context¶

mara_db.mysql.mysql_cursor_context(db: Union[str, mara_db.dbs.MysqlDB]) → MySQLdb.cursors.Cursor¶: Creates a context with a mysql-client cursor for a database alias or database