verdnatura/myt
verdnatura
/
myt
0
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation updated, keywords

This commit is contained in:
Juan Ferrer 2020-11-16 01:58:27 +01:00
parent 670d236892
commit 8d825c4284
3 changed files with 31 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE
View File

@ -1,4 +1,4 @@
Copyright (C) 2018 - Verdnatura Levante S.L. Copyright (C) 2020 - Verdnatura Levante S.L.
This package is free software; you can redistribute it and/or modify This package is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by

31
README.md
View File

@ -21,6 +21,7 @@ Required applications.
It's recommended to install the package globally. It's recommended to install the package globally.
```text ```text
# npm install -g myvc # npm install -g myvc
$ myvc [action]
``` ```
You can also install locally and use the *npx* command to execute it. You can also install locally and use the *npx* command to execute it.
@ -50,32 +51,42 @@ Each action can have its own specific commandline options.
## Basic information ## Basic information
First of of you have to import *structure.sql* into your database. This script First of all you have to import *structure.sql* into your database. This script
includes the tables where MyVC stores information about applied versions. includes the tables where MyVC stores information about applied versions.
Then, create *myvc.config.json* main configuration file at the root of your Create *myvc.config.json* main configuration file at the root of your project
project folder, this file should include the project codename and schemas/tables folder, this file should include the project codename and schemas/tables wich
wich are exported when you use *structure*, *fixtures* or *routines* actions. are exported when you use *structure*, *fixtures* or *routines* actions. You
you have an example of a configuration file in the root folder of this project. have an example of a configuration file in the root folder of this project.
Also, create database connection configuration files for each environment at ### Environments
main project folder using standard MySQL *.ini*. The predefined environment
names are *production* and *testing*. 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
``` ```
### Dumps
Structure and fixture dumps will be created inside *dump* folder. Structure and fixture dumps will be created inside *dump* folder.
* *structure.sql* * *structure.sql*
* *fixtures.sql* * *fixtures.sql*
### Local
You can also create your local fixture and structure files inside *dump* folder.
* *structure.local.sql*
* *fixtures.local.sql* * *fixtures.local.sql*
### Routines ### Routines
Routines should be placed inside *routines* folder. All objects that have Routines should be placed inside *routines* folder. All objects that have
PL/SQL code are considered routines. It includes functions, triggers, views and PL/SQL code are considered routines. It includes events, functions, procedures,
events with the following structure. triggers and views with the following structure.
```text ```text
routines routines
`- schema `- schema

14
package.json
View File

@ -1,12 +1,10 @@
{ {
"name": "myvc", "name": "myvc",
"version": "1.0.5", "version": "1.0.6",
"author": "Verdnatura Levante SL", "author": "Verdnatura Levante SL",
"description": "MySQL Version Control", "description": "MySQL Version Control",
"license": "GPL-3.0", "license": "GPL-3.0",
"bin": { "bin": "myvc.js",
"myvc": "myvc.js"
},
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/verdnatura/myvc.git" "url": "https://github.com/verdnatura/myvc.git"
@ -26,5 +24,11 @@
"devDependencies": {}, "devDependencies": {},
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
} },
"keywords": [
"mysql",
"mariadb",
"version",
"control"
]
} }