Engines¶

Warning

This page is partially outdated as of 06/2020. Proceed with care.

The parser can use several database backend engines that serve as wrappers around SQLAlchemy Engines and sessionmakers.

Common functionality¶

Database engines¶

The available engines are:

SQLite¶

class cimpyorm.backends.SQLite(path='out.db', echo=False, driver=None, dataset_loc=None)[source]¶

__init__(path='out.db', echo=False, driver=None, dataset_loc=None)[source]¶

Default constructor for SQLite backend instance

Parameters

path – Storage location for the .db-file (default: “out.db” in cwd)
echo – SQLAlchemy “echo” parameter (default: False)
driver – Python SQLite driver (default: sqlite3)
dataset_loc – Dataset location used to automatically determine storage location (in the dataset folder)

For convenience, there is a named backend for In-Memory SQLite databases:

class cimpyorm.backends.InMemory(echo=False, driver=None)[source]¶

__init__(echo=False, driver=None)[source]¶

Default constructor for In-Memory-SQLite instances

Parameters

echo – SQLAlchemy “echo” parameter (default: False)
driver – Python SQLite driver (default: sqlite3)

Client-Server¶

MariaDB¶

class cimpyorm.backends.MariaDB(username='root', password='', driver='pymysql', host='127.0.0.1', port=3306, path='cim', echo=False)[source]¶

__init__(username='root', password='', driver='pymysql', host='127.0.0.1', port=3306, path='cim', echo=False)[source]¶

Default constructor for MariaDB backend instance

Parameters

username – Username for the MariaDB database (default: root)
password – Password for username (at) MariaDB database (default: “”)
driver – Python MariaDB driver (default: mysqlclient)
host – Database host (default: localhost)
port – Database port (default: 3306)
path – Database name (default: “cim”)
echo – SQLAlchemy “echo” parameter (default: False)

MySQL¶

class cimpyorm.backends.MySQL(username='root', password='', driver='pymysql', host='127.0.0.1', port=3306, path='cim', echo=False)[source]¶

__init__(username='root', password='', driver='pymysql', host='127.0.0.1', port=3306, path='cim', echo=False)[source]¶

Default constructor for MySQL backend instance

Parameters

username – Username for the MySQL database (default: root)
password – Password for username (at) MySQL database (default: “”)
driver – Python MariaDB driver (default: pymysql)
host – Database host (default: localhost)
port – Database port (default: 3306)
path – Database name (default: “cim”)
echo – SQLAlchemy “echo” parameter (default: False)