diff --git a/README.md b/README.md index dc74fad..d01acaa 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,20 @@ Create a config-.json file under the current directory according to the dat * { "name": "table_name", "where": "column_name" } * ignoreTables - allows you to set which tables should be excluded from backups as unused tables. +## Install + +```shell +gem install mysql_db_tool +``` + ## Data backup ```shell -./bin/backup -e {env} -i {backup id} -r {run?} --gzip +mysql_backup -e {env} -i {backup id} -r {run?} --gzip ``` +you can get help by running `mysql_backup -h` + * env - default (local), key to find the configuration file. e.g.) config-local.json * backup id - default (0), ID to use when restoring as a string * run? - Default (false), you can check in advance which command will be executed, if true, it will be executed @@ -52,9 +60,11 @@ After execution, a directory named "backup-{backup id}" will be created under th ## restore backup data ```shell -./bin/restore -e {env} -i {backup id} -r {run?} --drop-all-tables +mysql_restore -e {env} -i {backup id} -r {run?} --drop-all-tables ``` +you can get help by running `mysql_restore -h` + * drop all tables? - Default (false), to keep existing tables, or true, which may cause integration check error if not set to true ## Generate creating db and user sql @@ -62,7 +72,7 @@ After execution, a directory named "backup-{backup id}" will be created under th You can generate a sql script to create a db and user. ```shell -./bin/gen_create_db_user {user} {password} {db} {host} +gen_create_db_user {user} {password} {db} {host} ``` ## Installing Ruby diff --git a/README_KO.md b/README_KO.md index cedb631..cda082e 100644 --- a/README_KO.md +++ b/README_KO.md @@ -33,12 +33,20 @@ MySQL 데이터 백업 및 복구를 위한 Ruby 스크립트 도구 * { "name": "table_name", "where": "column_name" } * ignoreTables - 제외할 테이블을 설정한다. +## 설치 + +```shell +gem install mysql_db_tool +``` + ## 데이터 백업 ```shell -./bin/backup -e {env} -i {backup id} -r {run?} --gzip +mysql_backup -e {env} -i {backup id} -r {run?} --gzip ``` +`mysql_backup -h` 로 도움말을 표시할 수 있다. + * env - 기본(dev), 설정 파일을 찾기위한 키, DB 접속 정보가 있음 * backup id - 기본(0), 문자열로 복구할때 사용할 id * run? - 기본(false), 실제 구동될 명령을 미리 확인 할 수 있음, true 이면 실제 실행됨 @@ -52,9 +60,11 @@ MySQL 데이터 백업 및 복구를 위한 Ruby 스크립트 도구 ## 백업 데이터 복구 ```shell -./bin/restore -e {env} -i {backup id} -r {run?} --drop-all-tables +mysql_restore -e {env} -i {backup id} -r {run?} --drop-all-tables ``` +`mysql_restore -h` 로 도움말을 표시할 수 있다. + * drop all tables? - 기본(false), 기존 테이블을 유지하면 false, 아니면 true, true 로 하지 않으면 integration check 오류 날 수 있음 ## 사용자와 데이터베이스 생성 sql 생성 @@ -62,7 +72,7 @@ MySQL 데이터 백업 및 복구를 위한 Ruby 스크립트 도구 데이터베이스와 사용자를 생성하는 sql 문을 생성할 수 있다. ```shell -./bin/gen_create_db_user {user} {password} {db} {host} +gen_create_db_user {user} {password} {db} {host} ``` ## Installing Ruby