changes to loader API, added information about deprecating CLI in 2.2

Author: lukaszbudnik

README.md

@@ -8,6 +8,8 @@ migrator can run as a HTTP REST service. Further, there is a ready-to-go migrato
 
 # Usage
 
+Important: Migrator since its inception supported both CLI and REST API. However, CLI is deprecated as of v2.2 and will be removed in migrator v3.0. Starting v3.0 only REST API will be supported.
+
 Short and sweet.
 
 ```
@@ -57,14 +59,6 @@ create table if not exists {schema}.modules ( k int, v text );
 insert into {schema}.modules values ( 123, '123' );
 ```
 
-# DB Schemas
-
-When using migrator please remember about these:
-
-* migrator creates `migrator` schema (where `migrator_migrations` and `migrator_tenants` tables reside) automatically
-* when adding a new tenant migrator creates a new schema automatically
-* single schemas are not created automatically, for this you must add initial migration with `create schema` SQL statement (see example above)
-
 # Server mode
 
 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.
@@ -84,13 +78,21 @@ Some curl examples to get you started:
 curl http://localhost:8080/
 curl http://localhost:8080/diskMigrations
 curl http://localhost:8080/tenants
-curl -X POST -H "Content-Type: application/json" -d '{"name": "new_tenant"}' http://localhost:8080/tenants
 curl http://localhost:8080/migrations
 curl -X POST http://localhost:8080/migrations
+curl -X POST -H "Content-Type: application/json" -d '{"name": "new_tenant"}' http://localhost:8080/tenants
 ```
 
 Port is configurable in `migrator.yaml` and defaults to 8080. Should you need HTTPS capabilities I encourage you to use nginx/apache/haproxy for TLS offloading.
 
+# DB Schemas
+
+When using migrator please remember about these:
+
+* migrator creates `migrator` schema (where `migrator_migrations` and `migrator_tenants` tables reside) automatically
+* when adding a new tenant migrator creates a new schema automatically
+* single schemas are not created automatically, for this you must add initial migration with `create schema` SQL statement (see example above)
+
 # Supported databases
 
 Currently migrator supports the following databases and their flavours:

loader/disk_loader.go

@@ -15,13 +15,13 @@ import (
 	"github.com/lukaszbudnik/migrator/utils"
 )
 
-// DiskLoader is struct used for implementing Loader interface for loading migrations from disk
-type DiskLoader struct {
-	Config *config.Config
+// diskLoader is struct used for implementing Loader interface for loading migrations from disk
+type diskLoader struct {
+	config *config.Config
 }
 
 // GetDiskMigrations returns all migrations from disk
-func (dl *DiskLoader) GetDiskMigrations() (migrations []types.Migration, err error) {
+func (dl *diskLoader) GetDiskMigrations() (migrations []types.Migration, err error) {
 	defer func() {
 		if r := recover(); r != nil {
 			var ok bool
@@ -32,13 +32,13 @@ func (dl *DiskLoader) GetDiskMigrations() (migrations []types.Migration, err err
 		}
 	}()
 
-	dirs, err := ioutil.ReadDir(dl.Config.BaseDir)
+	dirs, err := ioutil.ReadDir(dl.config.BaseDir)
 	if err != nil {
 		panic(err.Error())
 	}
 
-	singleSchemasDirs := dl.filterSchemaDirs(dirs, dl.Config.SingleSchemas)
-	tenantSchemasDirs := dl.filterSchemaDirs(dirs, dl.Config.TenantSchemas)
+	singleSchemasDirs := dl.filterSchemaDirs(dirs, dl.config.SingleSchemas)
+	tenantSchemasDirs := dl.filterSchemaDirs(dirs, dl.config.TenantSchemas)
 
 	migrationsMap := make(map[string][]types.Migration)
 
@@ -61,7 +61,7 @@ func (dl *DiskLoader) GetDiskMigrations() (migrations []types.Migration, err err
 	return
 }
 
-func (dl *DiskLoader) filterSchemaDirs(files []os.FileInfo, schemaDirs []string) []string {
+func (dl *diskLoader) filterSchemaDirs(files []os.FileInfo, schemaDirs []string) []string {
 	var dirs []string
 	for _, f := range files {
 		if f.IsDir() {
@@ -74,15 +74,15 @@ func (dl *DiskLoader) filterSchemaDirs(files []os.FileInfo, schemaDirs []string)
 	return dirs
 }
 
-func (dl *DiskLoader) readMigrationsFromSchemaDirs(migrations map[string][]types.Migration, sourceDirs []string, migrationType types.MigrationType) {
+func (dl *diskLoader) readMigrationsFromSchemaDirs(migrations map[string][]types.Migration, sourceDirs []string, migrationType types.MigrationType) {
 	for _, sourceDir := range sourceDirs {
-		files, err := ioutil.ReadDir(filepath.Join(dl.Config.BaseDir, sourceDir))
+		files, err := ioutil.ReadDir(filepath.Join(dl.config.BaseDir, sourceDir))
 		if err != nil {
 			panic(err.Error())
 		}
 		for _, file := range files {
 			if !file.IsDir() {
-				contents, err := ioutil.ReadFile(filepath.Join(dl.Config.BaseDir, sourceDir, file.Name()))
+				contents, err := ioutil.ReadFile(filepath.Join(dl.config.BaseDir, sourceDir, file.Name()))
 				if err != nil {
 					panic(err.Error())
 				}

loader/loader.go

@@ -12,5 +12,5 @@ type Loader interface {
 
 // NewLoader returns new instance of Loader, currently DiskLoader is available
 func NewLoader(config *config.Config) Loader {
-	return &DiskLoader{config}
+	return &diskLoader{config}
 }