Added Firebird support (golang-migrate#191)

kmuratov · dhui · commit 2c9773ed89ae · 2019-03-21T01:51:49.000-07:00
* Added Firebird support

* Fixed typo

* Refactoring

* Schema migrations table name don't have to be upper case

* Fixed readme

* Added Firebird 2.5 support

* Removed SchemaName

* Refactoring
diff --git a/README.md b/README.md
@@ -36,6 +36,7 @@ Database drivers run migrations. [Add a new database?](database/driver.go)
   * [Google Cloud Spanner](database/spanner)
   * [CockroachDB](database/cockroachdb)
   * [ClickHouse](database/clickhouse)
+  * [Firebird](database/firebird)
 
 ### Database URLs
 
diff --git a/database/firebird/README.md b/database/firebird/README.md
@@ -0,0 +1,12 @@
+# firebird
+
+`firebirdsql://user:password@servername[:port_number]/database_name_or_file[?params1=value1[&param2=value2]...]`
+
+| URL Query  | WithInstance Config | Description |
+|------------|---------------------|-------------|
+| `x-migrations-table` | `MigrationsTable` | Name of the migrations table |
+| `auth_plugin_name` | | Authentication plugin name. Srp256/Srp/Legacy_Auth are available. (default is Srp) |
+| `column_name_to_lower` | | Force column name to lower. (default is false) |
+| `role` | | Role name |
+| `tzname` | | Time Zone name. (For Firebird 4.0+) |
+| `wire_crypt` | | Enable wire data encryption or not. For Firebird 3.0+ (default is true) |
diff --git a/database/firebird/examples/migrations/1085649617_create_users_table.down.sql b/database/firebird/examples/migrations/1085649617_create_users_table.down.sql
@@ -0,0 +1 @@
+DROP TABLE users;
diff --git a/database/firebird/examples/migrations/1085649617_create_users_table.up.sql b/database/firebird/examples/migrations/1085649617_create_users_table.up.sql
@@ -0,0 +1,5 @@
+CREATE TABLE users (
+  user_id integer unique,
+  name    varchar(40),
+  email   varchar(40)
+);
diff --git a/database/firebird/examples/migrations/1185749658_add_city_to_users.down.sql b/database/firebird/examples/migrations/1185749658_add_city_to_users.down.sql
@@ -0,0 +1 @@
+ALTER TABLE users DROP city;
diff --git a/database/firebird/examples/migrations/1185749658_add_city_to_users.up.sql b/database/firebird/examples/migrations/1185749658_add_city_to_users.up.sql
@@ -0,0 +1,3 @@
+ALTER TABLE users ADD city varchar(100);
+
+
diff --git a/database/firebird/examples/migrations/1285849751_add_index_on_user_emails.down.sql b/database/firebird/examples/migrations/1285849751_add_index_on_user_emails.down.sql
@@ -0,0 +1 @@
+DROP INDEX users_email_index;
diff --git a/database/firebird/examples/migrations/1285849751_add_index_on_user_emails.up.sql b/database/firebird/examples/migrations/1285849751_add_index_on_user_emails.up.sql
@@ -0,0 +1,3 @@
+CREATE UNIQUE INDEX users_email_index ON users (email);
+
+-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sed interdum velit, tristique iaculis justo. Pellentesque ut porttitor dolor. Donec sit amet pharetra elit. Cras vel ligula ex. Phasellus posuere.
diff --git a/database/firebird/examples/migrations/1385949617_create_books_table.down.sql b/database/firebird/examples/migrations/1385949617_create_books_table.down.sql
@@ -0,0 +1 @@
+DROP TABLE books;
diff --git a/database/firebird/examples/migrations/1385949617_create_books_table.up.sql b/database/firebird/examples/migrations/1385949617_create_books_table.up.sql
@@ -0,0 +1,5 @@
+CREATE TABLE books (
+  user_id integer,
+  name    varchar(40),
+  author  varchar(40)
+);
diff --git a/database/firebird/examples/migrations/1485949617_create_movies_table.down.sql b/database/firebird/examples/migrations/1485949617_create_movies_table.down.sql
@@ -0,0 +1 @@
+DROP TABLE movies;
diff --git a/database/firebird/examples/migrations/1485949617_create_movies_table.up.sql b/database/firebird/examples/migrations/1485949617_create_movies_table.up.sql
@@ -0,0 +1,5 @@
+CREATE TABLE movies (
+  user_id   integer,
+  name      varchar(40),
+  director  varchar(40)
+);
diff --git a/database/firebird/firebird.go b/database/firebird/firebird.go
@@ -0,0 +1,246 @@
+// +build go1.9
+
+package firebird
+
+import (
+	"context"
+	"database/sql"
+	"fmt"
+	"github.com/golang-migrate/migrate/v4"
+	"github.com/golang-migrate/migrate/v4/database"
+	"github.com/hashicorp/go-multierror"
+	_ "github.com/nakagami/firebirdsql"
+	"io"
+	"io/ioutil"
+	nurl "net/url"
+)
+
+func init() {
+	db := Firebird{}
+	database.Register("firebird", &db)
+	database.Register("firebirdsql", &db)
+}
+
+var DefaultMigrationsTable = "schema_migrations"
+
+var (
+	ErrNilConfig = fmt.Errorf("no config")
+)
+
+type Config struct {
+	DatabaseName    string
+	MigrationsTable string
+}
+
+type Firebird struct {
+	// Locking and unlocking need to use the same connection
+	conn     *sql.Conn
+	db       *sql.DB
+	isLocked bool
+
+	// Open and WithInstance need to guarantee that config is never nil
+	config *Config
+}
+
+func WithInstance(instance *sql.DB, config *Config) (database.Driver, error) {
+	if config == nil {
+		return nil, ErrNilConfig
+	}
+
+	if err := instance.Ping(); err != nil {
+		return nil, err
+	}
+
+	if len(config.MigrationsTable) == 0 {
+		config.MigrationsTable = DefaultMigrationsTable
+	}
+
+	conn, err := instance.Conn(context.Background())
+	if err != nil {
+		return nil, err
+	}
+
+	fb := &Firebird{
+		conn:   conn,
+		db:     instance,
+		config: config,
+	}
+
+	if err := fb.ensureVersionTable(); err != nil {
+		return nil, err
+	}
+
+	return fb, nil
+}
+
+func (f *Firebird) Open(dsn string) (database.Driver, error) {
+	purl, err := nurl.Parse(dsn)
+	if err != nil {
+		return nil, err
+	}
+
+	db, err := sql.Open("firebirdsql", migrate.FilterCustomQuery(purl).String())
+	if err != nil {
+		return nil, err
+	}
+
+	px, err := WithInstance(db, &Config{
+		MigrationsTable: purl.Query().Get("x-migrations-table"),
+		DatabaseName:    purl.Path,
+	})
+
+	if err != nil {
+		return nil, err
+	}
+
+	return px, nil
+}
+
+func (f *Firebird) Close() error {
+	connErr := f.conn.Close()
+	dbErr := f.db.Close()
+	if connErr != nil || dbErr != nil {
+		return fmt.Errorf("conn: %v, db: %v", connErr, dbErr)
+	}
+	return nil
+}
+
+func (f *Firebird) Lock() error {
+	if f.isLocked {
+		return database.ErrLocked
+	}
+	f.isLocked = true
+	return nil
+}
+
+func (f *Firebird) Unlock() error {
+	f.isLocked = false
+	return nil
+}
+
+func (f *Firebird) Run(migration io.Reader) error {
+	migr, err := ioutil.ReadAll(migration)
+	if err != nil {
+		return err
+	}
+
+	// run migration
+	query := string(migr[:])
+	if _, err := f.conn.ExecContext(context.Background(), query); err != nil {
+		return database.Error{OrigErr: err, Err: "migration failed", Query: migr}
+	}
+
+	return nil
+}
+
+func (f *Firebird) SetVersion(version int, dirty bool) error {
+	if version < 0 {
+		return nil
+	}
+
+	query := fmt.Sprintf(`EXECUTE BLOCK AS BEGIN
+					DELETE FROM "%v";
+					INSERT INTO "%v" (version, dirty) VALUES (%v, %v);
+				END;`,
+		f.config.MigrationsTable, f.config.MigrationsTable, version, btoi(dirty))
+
+	if _, err := f.conn.ExecContext(context.Background(), query, version, btoi(dirty)); err != nil {
+		return &database.Error{OrigErr: err, Query: []byte(query)}
+	}
+
+	return nil
+}
+
+func (f *Firebird) Version() (version int, dirty bool, err error) {
+	var d int
+	query := fmt.Sprintf(`SELECT FIRST 1 version, dirty FROM "%v"`, f.config.MigrationsTable)
+	err = f.conn.QueryRowContext(context.Background(), query).Scan(&version, &d)
+	switch {
+	case err == sql.ErrNoRows:
+		return database.NilVersion, false, nil
+	case err != nil:
+		return 0, false, &database.Error{OrigErr: err, Query: []byte(query)}
+
+	default:
+		return version, itob(d), nil
+	}
+}
+
+func (f *Firebird) Drop() error {
+	// select all tables
+	query := `SELECT rdb$relation_name FROM rdb$relations WHERE rdb$view_blr IS NULL AND (rdb$system_flag IS NULL OR rdb$system_flag = 0);`
+	tables, err := f.conn.QueryContext(context.Background(), query)
+	if err != nil {
+		return &database.Error{OrigErr: err, Query: []byte(query)}
+	}
+	defer tables.Close()
+
+	// delete one table after another
+	tableNames := make([]string, 0)
+	for tables.Next() {
+		var tableName string
+		if err := tables.Scan(&tableName); err != nil {
+			return err
+		}
+		if len(tableName) > 0 {
+			tableNames = append(tableNames, tableName)
+		}
+	}
+
+	// delete one by one ...
+	for _, t := range tableNames {
+		query := fmt.Sprintf(`EXECUTE BLOCK AS BEGIN
+						if (not exists(select 1 from rdb$relations where rdb$relation_name = '%v')) then
+						execute statement 'drop table "%v"';
+					END;`,
+			t, t)
+
+		if _, err := f.conn.ExecContext(context.Background(), query); err != nil {
+			return &database.Error{OrigErr: err, Query: []byte(query)}
+		}
+	}
+
+	return nil
+}
+
+// ensureVersionTable checks if versions table exists and, if not, creates it.
+func (f *Firebird) ensureVersionTable() (err error) {
+	if err = f.Lock(); err != nil {
+		return err
+	}
+
+	defer func() {
+		if e := f.Unlock(); e != nil {
+			if err == nil {
+				err = e
+			} else {
+				err = multierror.Append(err, e)
+			}
+		}
+	}()
+
+	query := fmt.Sprintf(`EXECUTE BLOCK AS BEGIN
+			if (not exists(select 1 from rdb$relations where rdb$relation_name = '%v')) then
+			execute statement 'create table "%v" (version bigint not null primary key, dirty smallint not null)';
+		END;`,
+		f.config.MigrationsTable, f.config.MigrationsTable)
+
+	if _, err = f.conn.ExecContext(context.Background(), query); err != nil {
+		return &database.Error{OrigErr: err, Query: []byte(query)}
+	}
+
+	return nil
+}
+
+// btoi converts bool to int
+func btoi(v bool) int {
+	if v {
+		return 1
+	}
+	return 0
+}
+
+// itob converts int to bool
+func itob(v int) bool {
+	return v != 0
+}
diff --git a/database/firebird/firebird_test.go b/database/firebird/firebird_test.go
diff --git a/database/postgres/postgres.go b/database/postgres/postgres.go
diff --git a/database/redshift/redshift.go b/database/redshift/redshift.go
diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum
diff --git a/internal/cli/build_firebird.go b/internal/cli/build_firebird.go

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+ALTER TABLE users ADD city varchar(100);`
	`2`	`+`
	`3`	`+`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+CREATE UNIQUE INDEX users_email_index ON users (email);`
	`2`	`+`
	`3`	`+-- Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sed interdum velit, tristique iaculis justo. Pellentesque ut porttitor dolor. Donec sit amet pharetra elit. Cras vel ligula ex. Phasellus posuere.`