Merge pull request #726 from morigs/feat/yugabyte-support

feat: add yugabyte support
golang-migrate · Aug 26, 2022 · 5eb1604 · 5eb1604
2 parents 4bd8366 + b74509a
commit 5eb1604
Show file tree

Hide file tree

Showing 20 changed files with 726 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 SOURCE ?= file go_bindata github github_ee bitbucket aws_s3 google_cloud_storage godoc_vfs gitlab
-DATABASE ?= postgres mysql redshift cassandra spanner cockroachdb clickhouse mongodb sqlserver firebird neo4j pgx
+DATABASE ?= postgres mysql redshift cassandra spanner cockroachdb yugabytedb clickhouse mongodb sqlserver firebird neo4j pgx
 DATABASE_TEST ?= $(DATABASE) sqlite sqlite3 sqlcipher
 VERSION ?= $(shell git describe --tags 2>/dev/null | cut -c 2-)
 TEST_FLAGS ?=

diff --git a/README.md b/README.md
@@ -38,6 +38,7 @@ Database drivers run migrations. [Add a new database?](database/driver.go)
 * [Shell](database/shell) ([todo #171](https://github.com/mattes/migrate/issues/171))
 * [Google Cloud Spanner](database/spanner)
 * [CockroachDB](database/cockroachdb)
+* [YugabyteDB](database/yugabytedb)
 * [ClickHouse](database/clickhouse)
 * [Firebird](database/firebird)
 * [MS SQL Server](database/sqlserver)

diff --git a/database/yugabytedb/README.md b/database/yugabytedb/README.md
@@ -0,0 +1,22 @@
+# yugabytedb
+
+`yugabytedb://user:password@host:port/dbname?query` (`yugabyte://`, and `ysql://` work, too)
+
+| URL Query  | WithInstance Config | Description |
+|------------|---------------------|-------------|
+| `x-migrations-table` | `MigrationsTable` | Name of the migrations table |
+| `x-lock-table` | `LockTable` | Name of the table which maintains the migration lock |
+| `x-force-lock` | `ForceLock` | Force lock acquisition to fix faulty migrations which may not have released the schema lock (Boolean, default is `false`) |
+| `x-max-retries` | `MaxRetries` | How many times retry queries on retryable errors (40001, 40P01, 08006, XX000). Default is 10 |
+| `x-max-retry-interval` | `MaxRetryInterval` | Interval between retries increases exponentially. This option specifies maximum duration between retries. Default is 15s |
+| `x-max-retry-elapsed-time` | `MaxRetryElapsedTime` | Total retries timeout. Default is 30s |
+| `dbname` | `DatabaseName` | The name of the database to connect to |
+| `user` | | The user to sign in as |
+| `password` | | The user's password |
+| `host` | | The host to connect to. Values that start with / are for unix domain sockets. (default is localhost) |
+| `port` | | The port to bind to. (default is 5432) |
+| `connect_timeout` | | Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely. |
+| `sslcert` | | Cert file location. The file must contain PEM encoded data. |
+| `sslkey` | | Key file location. The file must contain PEM encoded data. |
+| `sslrootcert` | | The location of the root certificate file. The file must contain PEM encoded data. |
+| `sslmode` | | Whether or not to use SSL (disable\|require\|verify-ca\|verify-full) |
diff --git a/database/yugabytedb/examples/migrations/1085649617_create_users_table.down.sql b/database/yugabytedb/examples/migrations/1085649617_create_users_table.down.sql
@@ -0,0 +1 @@
+DROP TABLE IF EXISTS users;
diff --git a/database/yugabytedb/examples/migrations/1085649617_create_users_table.up.sql b/database/yugabytedb/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/yugabytedb/examples/migrations/1185749658_add_city_to_users.down.sql b/database/yugabytedb/examples/migrations/1185749658_add_city_to_users.down.sql
@@ -0,0 +1 @@
+ALTER TABLE users DROP COLUMN IF EXISTS city;
diff --git a/database/yugabytedb/examples/migrations/1185749658_add_city_to_users.up.sql b/database/yugabytedb/examples/migrations/1185749658_add_city_to_users.up.sql
@@ -0,0 +1,3 @@
+ALTER TABLE users ADD COLUMN city varchar(100);
+
+
diff --git a/database/yugabytedb/examples/migrations/1285849751_add_index_on_user_emails.down.sql b/database/yugabytedb/examples/migrations/1285849751_add_index_on_user_emails.down.sql
@@ -0,0 +1 @@
+DROP INDEX IF EXISTS users_email_index;
diff --git a/database/yugabytedb/examples/migrations/1285849751_add_index_on_user_emails.up.sql b/database/yugabytedb/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/yugabytedb/examples/migrations/1385949617_create_books_table.down.sql b/database/yugabytedb/examples/migrations/1385949617_create_books_table.down.sql
@@ -0,0 +1 @@
+DROP TABLE IF EXISTS books;
diff --git a/database/yugabytedb/examples/migrations/1385949617_create_books_table.up.sql b/database/yugabytedb/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/yugabytedb/examples/migrations/1485949617_create_movies_table.down.sql b/database/yugabytedb/examples/migrations/1485949617_create_movies_table.down.sql
@@ -0,0 +1 @@
+DROP TABLE IF EXISTS movies;
diff --git a/database/yugabytedb/examples/migrations/1485949617_create_movies_table.up.sql b/database/yugabytedb/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/yugabytedb/examples/migrations/1585849751_just_a_comment.up.sql b/database/yugabytedb/examples/migrations/1585849751_just_a_comment.up.sql
@@ -0,0 +1 @@
+-- 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/yugabytedb/examples/migrations/1685849751_another_comment.up.sql b/database/yugabytedb/examples/migrations/1685849751_another_comment.up.sql
@@ -0,0 +1 @@
+-- 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/yugabytedb/examples/migrations/1785849751_another_comment.up.sql b/database/yugabytedb/examples/migrations/1785849751_another_comment.up.sql
@@ -0,0 +1 @@
+-- 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/yugabytedb/examples/migrations/1885849751_another_comment.up.sql b/database/yugabytedb/examples/migrations/1885849751_another_comment.up.sql
@@ -0,0 +1 @@
+-- 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.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		ALTER TABLE users ADD COLUMN city varchar(100);
Original file line number	Diff line number	Diff line change
		@@ -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.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		-- 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.