Documentation improved
This commit is contained in:
parent
97a3d196f2
commit
7a151f80ab
18
README.md
18
README.md
|
@ -39,8 +39,8 @@ The default working directory is the current one and unless otherwise indicated,
|
||||||
the default environment is *production*.
|
the default environment is *production*.
|
||||||
|
|
||||||
Available actions are:
|
Available actions are:
|
||||||
* **structure**: Export the database structure.
|
* **structure**: Export database structure.
|
||||||
* **fixtures**: Export the database structure.
|
* **fixtures**: Export database fixtures.
|
||||||
* **routines**: Export database routines.
|
* **routines**: Export database routines.
|
||||||
* **apply**: Apply changes into database, uses *local* environment by default.
|
* **apply**: Apply changes into database, uses *local* environment by default.
|
||||||
* **run**: Builds and starts local database server container.
|
* **run**: Builds and starts local database server container.
|
||||||
|
@ -50,9 +50,17 @@ Each action can have its own specific commandline options.
|
||||||
|
|
||||||
## Basic information
|
## Basic information
|
||||||
|
|
||||||
Create database connection configuration files for each environment at main
|
First of of you have to import *structure.sql* into your database. This script
|
||||||
project folder using the standard MySQL *.ini* parameters. The predefined
|
includes the tables where MyVC stores information about applied versions.
|
||||||
environment names are *production* and *testing*.
|
|
||||||
|
Then, create *myvc.config.json* main configuration file at the root of your
|
||||||
|
project folder, this file should include the project codename and schemas/tables
|
||||||
|
wich are exported when you use *structure*, *fixtures* or *routines* actions.
|
||||||
|
you have an example of a configuration file in the root folder of this project.
|
||||||
|
|
||||||
|
Also, create database connection configuration files for each environment at
|
||||||
|
main project folder using standard MySQL *.ini*. The predefined environment
|
||||||
|
names are *production* and *testing*.
|
||||||
```text
|
```text
|
||||||
db.[environment].ini
|
db.[environment].ini
|
||||||
```
|
```
|
||||||
|
|
|
@ -0,0 +1,17 @@
|
||||||
|
{
|
||||||
|
"code": "my-app",
|
||||||
|
"structure": [
|
||||||
|
"schema1",
|
||||||
|
"schema2"
|
||||||
|
],
|
||||||
|
"fixtures": {
|
||||||
|
"schema1": [
|
||||||
|
"table1.1",
|
||||||
|
"table2.1"
|
||||||
|
],
|
||||||
|
"schema2": [
|
||||||
|
"table2.1",
|
||||||
|
"table2.2"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue