Documentation added

This commit is contained in:
Juan Ferrer 2020-11-17 13:04:57 +01:00
parent cc645c3991
commit a05c5ad3df
2 changed files with 12 additions and 3 deletions

View File

@ -43,10 +43,13 @@ $ myvc [-w|--workspace] [-e|--env] [-h|--help] command
The default working directory is the current one and unless otherwise indicated,
the default environment is *production*.
Available commands are:
Commands for database versioning:
* **pull**: Exports database routines into workspace.
* **push**: Apply changes into database, uses *test* environment by default.
Commands for local server management:
* **dump**: Export database structure and fixtures.
* **run**: Builds and starts local database server container.
* **start**: Starts local database server container.
@ -118,6 +121,12 @@ Versions should be placed inside *changes* folder with the following structure.
`- 00-sameNumbers.sql
```
### Local server
The local server will be created as a MariaDB Docker container using the base
dump created with the *dump* command plus pushing local versions and changed
routines.
## Why
The main reason for starting this project it's because there are no fully free
@ -134,7 +143,7 @@ Pending improvements.
* Improve the pull command to, instead of completely overwriting the routines
directory, merge the database changes with the local SQL files. It is possible
using a library that allows to manipulate git repositories (nodegit) and running
thefollowing steps:
the following steps:
1. Save the current git HEAD
2. Check out to the last database push commit (saved versioning datatables)

View File

@ -1,6 +1,6 @@
{
"name": "myvc",
"version": "1.0.10",
"version": "1.0.11",
"author": "Verdnatura Levante SL",
"description": "MySQL Version Control",
"license": "GPL-3.0",