Skip to content

Commit c7fa36c

Browse files
authored
Merge pull request #33 from lukaszbudnik/updated-readme
updated documentation
2 parents e04cecb + 77dd354 commit c7fa36c

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Migrator [![Build Status](https://travis-ci.org/lukaszbudnik/migrator.svg?branch=master)](https://travis-ci.org/lukaszbudnik/migrator)
22

3-
DB migration tool written in go.
3+
Fast and lightweight DB migration & evolution tool written in go.
4+
5+
migrator manages all the DB changes for you and completely eliminates manual and error-prone administrative tasks. migrator not only supports single schemas, but also comes with a multi-tenant support.
6+
7+
migrator can run as a HTTP REST service. Further, there is a ready-to-go migrator docker image.
48

59
# Usage
610

@@ -44,7 +48,7 @@ slackWebHook: https://hooks.slack.com/services/TTT/BBB/XXX
4448

4549
Migrator will scan all directories under `baseDir` directory. Migrations listed under `singleSchemas` directories will be applied once. Migrations listed under `tenantSchemas` directories will be applied for all tenants fetched using `tenantSelectSql`.
4650

47-
SQL migrations in both `singleSchemas` and `tenantsSchemas` can use `{schema}` placeholder which is automatically replaced by migrator to the current schema. For example:
51+
SQL migrations in both `singleSchemas` and `tenantsSchemas` can use `{schema}` placeholder which will be automatically replaced by migrator with a current schema. For example:
4852

4953
```
5054
create schema if not exists {schema};
@@ -54,7 +58,7 @@ insert into {schema}.modules values ( 123, '123' );
5458

5559
# Server mode
5660

57-
When migrator is run with `-mode server` it starts a go HTTP server and exposes simple REST API which you can use to invoke migrator actions remotely.
61+
When migrator is run with `-mode server` it starts a HTTP service and exposes simple REST API which you can use to invoke migrator actions remotely.
5862

5963
All actions which you can invoke from command line can be invoked via REST API:
6064

@@ -86,6 +90,12 @@ Currently migrator supports the following databases:
8690
* MySQL - database-based multi-tenant database, transactions do not span DDL statements, driver used: https://github.com/go-sql-driver/mysql
8791
* MariaDB - enhanced near linearly scalable multi-master MySQL, driver used: https://github.com/go-sql-driver/mysql
8892

93+
# Do you speak docker?
94+
95+
Yes, since the inception of migrator (2016) there is an official docker image available on docker hub.
96+
97+
To find out more about migrator-docker please visit: https://github.com/lukaszbudnik/migrator-docker.
98+
8999
# Running unit & integration tests
90100

91101
PostgreSQL, MySQL, and MariaDB:

0 commit comments

Comments
 (0)