From 7a151f80ab2d5aa48793dc3d9f8630703c096566 Mon Sep 17 00:00:00 2001 From: Juan Ferrer Toribio Date: Sun, 15 Nov 2020 19:38:23 +0100 Subject: [PATCH] Documentation improved --- README.md | 18 +++++++++++++----- myvc.config.json | 17 +++++++++++++++++ 2 files changed, 30 insertions(+), 5 deletions(-) create mode 100755 myvc.config.json diff --git a/README.md b/README.md index 210efe7..259591f 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,8 @@ The default working directory is the current one and unless otherwise indicated, the default environment is *production*. Available actions are: - * **structure**: Export the database structure. - * **fixtures**: Export the database structure. + * **structure**: Export database structure. + * **fixtures**: Export database fixtures. * **routines**: Export database routines. * **apply**: Apply changes into database, uses *local* environment by default. * **run**: Builds and starts local database server container. @@ -50,9 +50,17 @@ Each action can have its own specific commandline options. ## Basic information -Create database connection configuration files for each environment at main -project folder using the standard MySQL *.ini* parameters. The predefined -environment names are *production* and *testing*. +First of of you have to import *structure.sql* into your database. This script +includes the tables where MyVC stores information about applied versions. + +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 db.[environment].ini ``` diff --git a/myvc.config.json b/myvc.config.json new file mode 100755 index 0000000..7e4279c --- /dev/null +++ b/myvc.config.json @@ -0,0 +1,17 @@ +{ + "code": "my-app", + "structure": [ + "schema1", + "schema2" + ], + "fixtures": { + "schema1": [ + "table1.1", + "table2.1" + ], + "schema2": [ + "table2.1", + "table2.2" + ] + } +}