feat(database): Add YDB support (#592)

pressly · Oct 25, 2023 · 0c243fb · 0c243fb
1 parent 257b523
commit 0c243fb
Show file tree

Hide file tree

Showing 26 changed files with 540 additions and 14 deletions.
diff --git a/.github/workflows/e2e.yaml b/.github/workflows/e2e.yaml
@@ -14,7 +14,7 @@ jobs:
     strategy:
       max-parallel: 2
       matrix:
-        dialect: ["postgres", "mysql", "vertica", "clickhouse"]
+        dialect: ["postgres", "mysql", "vertica", "clickhouse", "ydb"]
 
     steps:
       - name: Checkout code

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+- Added YDB support
 
 ## [v3.15.1] - 2023-10-10
 

diff --git a/Makefile b/Makefile
@@ -7,6 +7,7 @@ DB_NAME ?= testdb
 DB_POSTGRES_PORT ?= 5433
 DB_MYSQL_PORT ?= 3307
 DB_CLICKHOUSE_PORT ?= 9001
+DB_YDB_PORT ?= 2136
 
 .PHONY: dist
 dist:
@@ -36,7 +37,7 @@ test-packages:
 test-packages-short:
 	go test -test.short $(GO_TEST_FLAGS) $$(go list ./... | grep -v -e /tests -e /bin -e /cmd -e /examples)
 
-test-e2e: test-e2e-postgres test-e2e-mysql test-e2e-clickhouse test-e2e-vertica
+test-e2e: test-e2e-postgres test-e2e-mysql test-e2e-clickhouse test-e2e-vertica test-e2e-ydb
 
 test-e2e-postgres:
 	go test $(GO_TEST_FLAGS) ./tests/e2e -dialect=postgres
@@ -50,6 +51,9 @@ test-e2e-clickhouse:
 test-e2e-vertica:
 	go test $(GO_TEST_FLAGS) ./tests/vertica
 
+test-e2e-ydb:
+	go test $(GO_TEST_FLAGS) -parallel=1 ./tests/e2e -dialect=ydb
+
 docker-cleanup:
 	docker stop -t=0 $$(docker ps --filter="label=goose_test" -aq)
 

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # goose [![Goose CI](https://github.com/pressly/goose/actions/workflows/ci.yaml/badge.svg)](https://github.com/pressly/goose/actions/workflows/ci.yaml) [![Go Reference](https://pkg.go.dev/badge/github.com/pressly/goose/v3.svg)](https://pkg.go.dev/github.com/pressly/goose/v3)
 
 <p align="center">
-  <img src="assets/goose_logo.png" width="125"">
+  <img src="assets/goose_logo.png" width="125">
 </p>
 
 Goose is a database migration tool. Manage your database schema by creating incremental SQL changes or Go functions.
@@ -44,7 +44,7 @@ This will install the `goose` binary to your `$GOPATH/bin` directory.
 For a lite version of the binary without DB connection dependent commands, use the exclusive build tags:
 
 ```shell
-go build -tags='no_postgres no_mysql no_sqlite3' -o goose ./cmd/goose
+go build -tags='no_postgres no_mysql no_sqlite3 no_ydb' -o goose ./cmd/goose
 ```
 
 For macOS users `goose` is available as a [Homebrew Formulae](https://formulae.brew.sh/formula/goose#default):
@@ -69,6 +69,7 @@ Drivers:
     tidb
     clickhouse
     vertica
+    ydb
 
 Examples:
     goose sqlite3 ./foo.db status
@@ -84,6 +85,7 @@ Examples:
     goose mssql "sqlserver://user:password@dbname:1433?database=master" status
     goose clickhouse "tcp://127.0.0.1:9000" status
     goose vertica "vertica://user:password@localhost:5433/dbname?connection_load_balance=1" status
+    goose ydb "grpc://localhost:2136/local?go_query_mode=scripting&go_fake_tx=scripting&go_query_bind=declare,numeric" status
 
 Options:
 

diff --git a/cmd/goose/driver_ydb.go b/cmd/goose/driver_ydb.go
@@ -0,0 +1,8 @@
+//go:build !no_ydb
+// +build !no_ydb
+
+package main
+
+import (
+	_ "github.com/ydb-platform/ydb-go-sdk/v3"
+)
diff --git a/cmd/goose/main.go b/cmd/goose/main.go
@@ -204,6 +204,7 @@ Drivers:
     tidb
     clickhouse
     vertica
+    ydb
 
 Examples:
     goose sqlite3 ./foo.db status
@@ -219,6 +220,7 @@ Examples:
     goose mssql "sqlserver://user:password@dbname:1433?database=master" status
     goose clickhouse "tcp://127.0.0.1:9000" status
     goose vertica "vertica://user:password@localhost:5433/dbname?connection_load_balance=1" status
+    goose ydb "grpcs://localhost:2135/local?go_query_mode=scripting&go_fake_tx=scripting&go_query_bind=declare,numeric" status
 
     GOOSE_DRIVER=sqlite3 GOOSE_DBSTRING=./foo.db goose status
     GOOSE_DRIVER=sqlite3 GOOSE_DBSTRING=./foo.db goose create init sql

diff --git a/db.go b/db.go
@@ -22,7 +22,7 @@ func OpenDBWithDriver(driver string, dbstring string) (*sql.DB, error) {
 	}
 
 	switch driver {
-	case "postgres", "pgx", "sqlite3", "sqlite", "mysql", "sqlserver", "clickhouse", "vertica", "azuresql":
+	case "postgres", "pgx", "sqlite3", "sqlite", "mysql", "sqlserver", "clickhouse", "vertica", "azuresql", "ydb":
 		return sql.Open(driver, dbstring)
 	default:
 		return nil, fmt.Errorf("unsupported driver %s", driver)

diff --git a/dialect.go b/dialect.go
@@ -46,6 +46,8 @@ func SetDialect(s string) error {
 		d = dialect.Clickhouse
 	case "vertica":
 		d = dialect.Vertica
+	case "ydb":
+		d = dialect.Ydb
 	default:
 		return fmt.Errorf("%q: unknown dialect", s)
 	}

diff --git a/go.mod b/go.mod
@@ -10,6 +10,7 @@ require (
 	github.com/ory/dockertest/v3 v3.10.0
 	github.com/sethvargo/go-retry v0.2.4
 	github.com/vertica/vertica-sql-go v1.3.3
+	github.com/ydb-platform/ydb-go-sdk/v3 v3.52.2
 	github.com/ziutek/mymysql v1.5.4
 	go.uber.org/multierr v1.11.0
 	golang.org/x/sync v0.4.0
@@ -34,14 +35,17 @@ require (
 	github.com/go-faster/city v1.0.1 // indirect
 	github.com/go-faster/errors v0.6.1 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang-jwt/jwt/v4 v4.5.0 // indirect
 	github.com/golang-sql/civil v0.0.0-20220223132316-b832511892a9 // indirect
 	github.com/golang-sql/sqlexp v0.1.0 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
 	github.com/google/uuid v1.3.1 // indirect
 	github.com/imdario/mergo v0.3.16 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
 	github.com/joeshaw/multierror v0.0.0-20140124173710-69b34d4ec901 // indirect
+	github.com/jonboulle/clockwork v0.3.0 // indirect
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
 	github.com/klauspost/compress v1.17.0 // indirect
 	github.com/lib/pq v1.10.9 // indirect
@@ -62,13 +66,18 @@ require (
 	github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
 	github.com/xeipuuv/gojsonschema v1.2.0 // indirect
+	github.com/ydb-platform/ydb-go-genproto v0.0.0-20230801151335-81e01be38941 // indirect
 	go.opentelemetry.io/otel v1.19.0 // indirect
 	go.opentelemetry.io/otel/trace v1.19.0 // indirect
 	golang.org/x/crypto v0.13.0 // indirect
 	golang.org/x/mod v0.12.0 // indirect
+	golang.org/x/net v0.15.0 // indirect
 	golang.org/x/sys v0.13.0 // indirect
 	golang.org/x/text v0.13.0 // indirect
 	golang.org/x/tools v0.13.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19 // indirect
+	google.golang.org/grpc v1.57.0 // indirect
+	google.golang.org/protobuf v1.30.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	howett.net/plist v1.0.0 // indirect