README.md

This is a Coraline Database Manager Package on PyPI. Now, only SQL DB is supported

Installation

pip install -U coralinedb

How to use

1. Initial database object by specify host, username and password

from coralinedb import MySQLDB
db = MySQLDB(host, username, password)

2. Load a table or tables using

new_table = db.load_table("database_name", "table_name")

or

table1, table2 = db.load_table("database_name", ["table_name1", "table_name2"])

3. Save dataframe to a table using

db.save_table(df, "database_name", "table_name")

4. Get number of rows for a table

n_rows = db.get_count("database_name", "table_name")

5. Run other SQL statement on host (with or without database name)

e.g.
db.query("show databases;")
db.query("SELECT * FROM ...", "database_name")

6. Run store procedure on host (with or without database name)

e.g.
affected_row = db.call_procedure("CALL store_procedure")
dataframe = db.call_procedure("CALL store_procedure", return_df=True)

Compatibility with Django

After Django version 2.1.7, Django uses mysqlclient library to connect with MySQL Database. Therefore, Coralinedb uses pymsql library and this library is comptaible with Django only version 2.1.7 or lower.