# [](http://migratore.hive.pt)
Simple migration framework / infra-structure for SQL based databases.
## Installation
```bash
pip install migratore
```
## Execution
```bash
HOST=${HOST} DB=${DB_NAME} USERNAME=${DB_USER} PASSWORD=${DB_PASS} migratore upgrade
```
## Variables
* `HOST` - Hostname or IP address of the database system for migration
* `PORT` - TCP port to be used in the connection with the database system
* `UNIX_SOCKET` - Filesystem path to the UNIX socket file to be used in connection
* `DB` - Name of the database used as the migration target
* `USERNAME` - Username for authentication in database
* `PASSWORD` - Password to be used for authentication in database
* `FS` - Base file system path for file migration (may depend on migration context)
## Commands
* `help` - Prints a help message about the CLI interface
* `version` - Prints the current version of migratore
* `environ` - Displays the current environment in the standard output
* `list` - Lists the executed migrations on the current database
* `errors` - Lists the various errors from migration of the database
* `trace [id]` - Prints the traceback for the error execution with the provided id
* `rebuild [id]` - Run the partial execution of the migration with the given id
* `upgrade [path]` - Executes the pending migrations using the defined directory or current
* `skip [path]` - Skips the current migration (next to be run) using the defined directory or current
* `generate [path]` - Generates a new migration file into the target path
## Examples
```python
database = Migratore.get_database()
table = database.get_table("users")
table.add_column("username", type = "text")
```
## License
Migratore is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
## Build Automation
[](https://travis-ci.com/github/hivesolutions/migratore)
[](https://github.com/hivesolutions/migratore/actions)
[](https://coveralls.io/r/hivesolutions/migratore?branch=master)
[](https://pypi.python.org/pypi/migratore)
[](https://www.apache.org/licenses/)
Raw data
{
"_id": null,
"home_page": "http://migratore.hive.pt",
"name": "migratore",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "migratore migration sql",
"author": "Hive Solutions Lda.",
"author_email": "development@hive.pt",
"download_url": "https://files.pythonhosted.org/packages/4e/90/57707dc7fc4adcdd673fa8d02d7f44cf26a55eb8696e7920673bbba59553/migratore-0.5.5.tar.gz",
"platform": null,
"description": "# [](http://migratore.hive.pt)\n\nSimple migration framework / infra-structure for SQL based databases.\n\n## Installation\n\n```bash\npip install migratore\n```\n\n## Execution\n\n```bash\nHOST=${HOST} DB=${DB_NAME} USERNAME=${DB_USER} PASSWORD=${DB_PASS} migratore upgrade\n```\n\n## Variables\n\n* `HOST` - Hostname or IP address of the database system for migration\n* `PORT` - TCP port to be used in the connection with the database system\n* `UNIX_SOCKET` - Filesystem path to the UNIX socket file to be used in connection\n* `DB` - Name of the database used as the migration target\n* `USERNAME` - Username for authentication in database\n* `PASSWORD` - Password to be used for authentication in database\n* `FS` - Base file system path for file migration (may depend on migration context)\n\n## Commands\n\n* `help` - Prints a help message about the CLI interface\n* `version` - Prints the current version of migratore\n* `environ` - Displays the current environment in the standard output\n* `list` - Lists the executed migrations on the current database\n* `errors` - Lists the various errors from migration of the database\n* `trace [id]` - Prints the traceback for the error execution with the provided id\n* `rebuild [id]` - Run the partial execution of the migration with the given id\n* `upgrade [path]` - Executes the pending migrations using the defined directory or current\n* `skip [path]` - Skips the current migration (next to be run) using the defined directory or current\n* `generate [path]` - Generates a new migration file into the target path\n\n## Examples\n\n```python\ndatabase = Migratore.get_database()\ntable = database.get_table(\"users\")\ntable.add_column(\"username\", type = \"text\")\n```\n\n## License\n\nMigratore is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).\n\n## Build Automation\n\n[](https://travis-ci.com/github/hivesolutions/migratore)\n[](https://github.com/hivesolutions/migratore/actions)\n[](https://coveralls.io/r/hivesolutions/migratore?branch=master)\n[](https://pypi.python.org/pypi/migratore)\n[](https://www.apache.org/licenses/)\n\n\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Migratore Infra-structure",
"version": "0.5.5",
"project_urls": {
"Homepage": "http://migratore.hive.pt"
},
"split_keywords": [
"migratore",
"migration",
"sql"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "981911243acabd59e4935787591e146af7f5172cfd4200a33f108958b5184c27",
"md5": "eb22f2586233dcb0160618a4c7dce1c2",
"sha256": "5a57b62e2db4d3e57115cf1b04baea4d117ba1e735d457028b04f1094bd09d2a"
},
"downloads": -1,
"filename": "migratore-0.5.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb22f2586233dcb0160618a4c7dce1c2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 18875,
"upload_time": "2024-01-08T11:34:27",
"upload_time_iso_8601": "2024-01-08T11:34:27.375319Z",
"url": "https://files.pythonhosted.org/packages/98/19/11243acabd59e4935787591e146af7f5172cfd4200a33f108958b5184c27/migratore-0.5.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4e9057707dc7fc4adcdd673fa8d02d7f44cf26a55eb8696e7920673bbba59553",
"md5": "72904cf095bbdfb37615cc1a04194dc5",
"sha256": "4a1185a3ec35e32404863767fdf03249c98cc4f54b45d5978ee199220777d073"
},
"downloads": -1,
"filename": "migratore-0.5.5.tar.gz",
"has_sig": false,
"md5_digest": "72904cf095bbdfb37615cc1a04194dc5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15059,
"upload_time": "2024-01-08T11:34:29",
"upload_time_iso_8601": "2024-01-08T11:34:29.097766Z",
"url": "https://files.pythonhosted.org/packages/4e/90/57707dc7fc4adcdd673fa8d02d7f44cf26a55eb8696e7920673bbba59553/migratore-0.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-08 11:34:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "migratore"
}
JSON