alphadb 1.0.0b19

MySQL Database versioning toolset

AlphaDB

A toolset for MySQL database versioning.

Still in alpha stage

AlphaDB is currently in beta stage. Breaking changes should be expected.

Table of Contents

1. Documentation
2. Installation
   • Install using PIP
3. Usage
4. Exceptions
5. License

Documentation

Visit the official documentation

Installation

Install using PIP

pip install alphadb

Note that pip refers to the Python 3 package manager. In an environment where Python 2 is also present the correct command may be pip3.

Usage

Import AlphaDB

from alphadb import AlphaDB

Connect to a database.

db = AlphaDB()
db.connect(
    host="localhost",
    user="user",
    password="password",
    database="database"
)

Make sure the database is empty, back it up if necessary. If the database is not empty, you can use the vacate method. Note that this function will erase ALL data in the database and there is no way to get it back. For extra safety the argument confirm=True is required for the function to run.

db.vacate(confirm=True)

The database is now ready to be initialized. The init method will create the adb_conf table. This holds configuration data for the database.

db.init()

Now we update the database. For this we need to give it a structure. The database version information is a JSON structure formatted as such:

database_version_source = {
    "name": "mydb", ## Database name, does not have to, but is advised to match the actual database name
    "version": [ ## List containing database versions
        {
            "_id": "0.1.0", ## Database version
            "createtable": { ## Object containing tables to be created,
                "customers": { ## Object key will be used as table name
                    "primary_key": "id",
                    "name": { ## Object key will be used as column name
                        "type": "VARCHAR", ## Data type
                        "length": 100, ## Date max length,
                    },
                    "id": {
                        "type": "INT",
                        "a_i": True
                    }
                },
            }
        },
        {
            "_id": "1.0.0",
            "createtable": {
                "orders": {
                    "primary_key": "id",
                    "id": {
                        "type": "INT",
                        "a_i": True
                    },
                    "date": {
                        "type": "DATETIME",
                    },
                    "note": {
                        "type": "TEXT",
                        "null": True
                    }
                }
            }
        }
    ]
}

Then call the update method.

db.update(version_source=database_version_source)

Exceptions

NoConnection

The NoConnection exception is thrown when a method is called while no database connection is active.

DBNotInitialized

The DBNotInitialized exception is thrown when the database is not yet initialized.

Database.init() ## Will initialize the database and thus resolve the error

DBTemplateNoMatch

The DBTemplateNoMatch exception is thrown when de database was previously updated using another version source. On initialization, a table adb_conf is created. In this table the column template is used to save the version source template name. Make sure it matches.

License

GPL-3.0 LICENSE