Impelement oracle database migration

Makefile

@@ -1,6 +1,6 @@
 SOURCE ?= file go_bindata github github_ee bitbucket aws_s3 google_cloud_storage godoc_vfs gitlab
 DATABASE ?= postgres mysql redshift cassandra spanner cockroachdb yugabytedb clickhouse mongodb sqlserver firebird neo4j pgx pgx5
-DATABASE_TEST ?= $(DATABASE) sqlite sqlite3 sqlcipher
+DATABASE_TEST ?= $(DATABASE) sqlite sqlite3 sqlcipher oracle
 VERSION ?= $(shell git describe --tags 2>/dev/null | cut -c 2-)
 TEST_FLAGS ?=
 REPO_OWNER ?= $(shell cd .. && basename "$$(pwd)")

README.md

@@ -43,6 +43,7 @@ Database drivers run migrations. [Add a new database?](database/driver.go)
 * [ClickHouse](database/clickhouse)
 * [Firebird](database/firebird)
 * [MS SQL Server](database/sqlserver)
+* [Oracle](database/oracle)
 
 ### Database URLs
 

database/oracle/README.md

@@ -0,0 +1,105 @@
+# oracle
+
+The supported oracle specific options can be configured in the query section of the oracle
+URL `oracle://user:password@host:port/ServiceName?query`
+
+| URL Query                | WithInstance Config  | Description                                                                                                             |
+|--------------------------|----------------------|-------------------------------------------------------------------------------------------------------------------------|
+| `x-migrations-table`     | `MigrationsTable`    | Name of the migrations table in UPPER case                                                                              |
+| `x-multi-stmt-enabled`   | `MultiStmtEnabled`   | If the migration files are in multi-statements style                                                                    |
+| `x-multi-stmt-separator` | `MultiStmtSeparator` | a single line which use as the token to spilt multiple statements in single migration file, triple-dash separator `---` |
+
+## Write migration files
+
+There are two ways to write the migration files,
+
+1. Single statement file in which it contains only one SQL statement or one PL/SQL statement(Default)
+2. Multi statements file in which it can have multi statements(can be SQL or PL/SQL or mixed)
+
+### Single statement file
+
+Oracle godor driver support process one statement at a time, so it is natural to support single statement per file as
+the default.
+Check the [single statement migration files](examples/migrations) as an example.
+
+### Multi statements file
+
+Although the golang oracle driver [godror](https://github.com/godror/godror) does not natively support executing
+multiple
+statements in a single query, it's more friendly and handy to support multi statements in a single migration file in
+some case,
+so the multi statements can be separated with a line separator(default to triple-dash separator ---), for example:
+
+```
+statement 1
+---
+statement 2
+```
+
+Check the [multi statements' migration files](examples/migrations-multistmt) as an example.
+
+## Supported & tested version
+
+- 18-xe
+
+## Build cli
+
+```bash
+$ cd /path/to/repo/dir
+$ go build  -tags 'oracle' -o bin/migrate github.com/golang-migrate/migrate/v4/cli
+```
+
+## Run test code
+
+There are two ways to run the test code:
+
+- Run the test code locally with an existing Oracle Instance(Recommended)
+- Run the test code inside a container just like CI, It will require to start an Oracle container every time, and it's
+  very time expense.
+
+### Run the test code locally with an existing Oracle Instance
+
+1. Start the `Oracle Database Instance` via docker first, so that you can reuse whenever you want to run the test code.
+
+```bash
+$ cat docker-compose.yaml
+---
+version: '2'
+services:
+  orclxe:
+    image: container-registry.oracle.com/database/express:18.4.0-xe
+    ports:
+      - 1521:1521
+    container_name: orclxe
+    environment:
+      ORACLE_PWD: oracle
+    volumes:
+      - ${HOME}/data/orclxe:/opt/oracle/oradata  # permission chown -R 54321:54321 ${HOME}/data/orclxe
+
+```
+
+2. Go into the sqlplus console
+
+```bash
+$ docker exec -it orclxe bash
+# su oracle
+$ sqlplus / as sysdba
+```
+
+3. Create a test DB
+
+```sql
+alter session set container=XEPDB1;
+create user orcl identified by orcl;
+grant dba to orcl;
+grant create session to orcl;
+grant connect, resource to orcl;
+grant all privileges to orcl;
+```
+
+4. Run the test code
+
+```bash
+$ cd /path/to/repo/database/oracle/dir
+$ ORACLE_DSN=oracle://orcl:orcl@localhost:1521/XEPDB1 go test -tags "oracle" -race -v -covermode atomic ./... -coverprofile .coverage  -timeout 20m
+```

database/oracle/examples/migrations-multistmt/1085649617_create_users_table.down.sql

@@ -0,0 +1,8 @@
+BEGIN
+EXECUTE IMMEDIATE 'DROP TABLE USERS_MS';
+EXCEPTION
+    WHEN OTHERS THEN
+        IF SQLCODE != -942 THEN
+            RAISE;
+        END IF;
+END;

database/oracle/examples/migrations-multistmt/1085649617_create_users_table.up.sql

@@ -0,0 +1,24 @@
+CREATE TABLE USERS_MS (
+  USER_ID integer unique,
+  NAME    varchar(40),
+  EMAIL   varchar(40)
+);
+
+---
+
+BEGIN
+EXECUTE IMMEDIATE 'DROP TABLE USERS_MS';
+EXCEPTION
+    WHEN OTHERS THEN
+        IF SQLCODE != -942 THEN
+            RAISE;
+        END IF;
+END;
+
+---
+
+CREATE TABLE USERS_MS (
+   USER_ID integer unique,
+   NAME    varchar(40),
+   EMAIL   varchar(40)
+);

database/oracle/examples/migrations-multistmt/1185749658_add_city_to_users.down.sql

@@ -0,0 +1,14 @@
+DECLARE
+    v_column_exists number := 0;
+BEGIN
+    SELECT COUNT(*)
+    INTO v_column_exists
+    FROM user_tab_cols
+    WHERE  table_name = 'USERS_MS'
+      AND column_name = 'CITY';
+
+    IF( v_column_exists = 1 )
+    THEN
+        EXECUTE IMMEDIATE 'ALTER TABLE USERS_MS DROP COLUMN CITY';
+    END IF;
+END;

database/oracle/examples/migrations-multistmt/1185749658_add_city_to_users.up.sql

@@ -0,0 +1,5 @@
+ALTER TABLE USERS_MS ADD CITY varchar(100);
+---
+ALTER TABLE USERS_MS ADD ALIAS varchar(100);
+
+

database/oracle/examples/migrations-multistmt/1285849751_add_index_on_user_emails.down.sql

@@ -0,0 +1,12 @@
+DECLARE
+   COUNT_INDEXES   INTEGER;
+BEGIN
+   SELECT COUNT ( * )
+     INTO COUNT_INDEXES_MS
+     FROM USERS_MS_INDEXES
+    WHERE INDEX_NAME = 'users_ms_email_index';
+   IF COUNT_INDEXES > 0
+   THEN
+      EXECUTE IMMEDIATE 'DROP INDEX users_ms_email_index';
+   END IF;
+END;

database/oracle/examples/migrations-multistmt/1285849751_add_index_on_user_emails.up.sql

@@ -0,0 +1 @@
+CREATE UNIQUE INDEX users_ms_email_index ON users_ms (email);

database/oracle/examples/migrations-multistmt/1385949617_create_books_table.down.sql

@@ -0,0 +1,8 @@
+BEGIN
+EXECUTE IMMEDIATE 'DROP TABLE BOOKS_MS';
+EXCEPTION
+    WHEN OTHERS THEN
+        IF SQLCODE != -942 THEN
+            RAISE;
+        END IF;
+END;

database/oracle/examples/migrations-multistmt/1385949617_create_books_table.up.sql

@@ -0,0 +1,5 @@
+CREATE TABLE BOOKS_MS (
+  USER_ID integer,
+  NAME    varchar(40),
+  AUTHOR  varchar(40)
+);

database/oracle/examples/migrations-multistmt/1485949617_create_movies_table.down.sql

@@ -0,0 +1,8 @@
+BEGIN
+EXECUTE IMMEDIATE 'DROP TABLE MOVIES_MS';
+EXCEPTION
+    WHEN OTHERS THEN
+        IF SQLCODE != -942 THEN
+            RAISE;
+        END IF;
+END;

database/oracle/examples/migrations-multistmt/1485949617_create_movies_table.up.sql

@@ -0,0 +1,5 @@
+CREATE TABLE MOVIES_MS (
+  USER_ID   integer,
+  NAME      varchar(40),
+  DIRECTOR  varchar(40)
+);

database/oracle/examples/migrations-multistmt/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.

database/oracle/examples/migrations-multistmt/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.

database/oracle/examples/migrations-multistmt/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.

database/oracle/examples/migrations-multistmt/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.

database/oracle/examples/migrations/1085649617_create_users_table.down.sql

@@ -0,0 +1,8 @@
+BEGIN
+EXECUTE IMMEDIATE 'DROP TABLE USERS';
+EXCEPTION
+    WHEN OTHERS THEN
+        IF SQLCODE != -942 THEN
+            RAISE;
+        END IF;
+END;

database/oracle/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)
+)

database/oracle/examples/migrations/1185749658_add_city_to_users.down.sql

@@ -0,0 +1,14 @@
+DECLARE
+    v_column_exists number := 0;
+BEGIN
+    SELECT COUNT(*)
+    INTO v_column_exists
+    FROM user_tab_cols
+    WHERE  table_name = 'USERS'
+      AND column_name = 'CITY';
+
+    IF( v_column_exists = 1 )
+    THEN
+        EXECUTE IMMEDIATE 'ALTER TABLE users DROP COLUMN CITY';
+    END IF;
+END;

database/oracle/examples/migrations/1185749658_add_city_to_users.up.sql

@@ -0,0 +1,3 @@
+ALTER TABLE USERS ADD CITY varchar(100)
+
+

database/oracle/examples/migrations/1285849751_add_index_on_user_emails.down.sql

@@ -0,0 +1,12 @@
+DECLARE
+   COUNT_INDEXES   INTEGER;
+BEGIN
+   SELECT COUNT ( * )
+     INTO COUNT_INDEXES
+     FROM USER_INDEXES
+    WHERE INDEX_NAME = 'users_email_index';
+   IF COUNT_INDEXES > 0
+   THEN
+      EXECUTE IMMEDIATE 'DROP INDEX users_email_index';
+   END IF;
+END;

database/oracle/examples/migrations/1285849751_add_index_on_user_emails.up.sql

@@ -0,0 +1 @@
+CREATE UNIQUE INDEX users_email_index ON users (email)

database/oracle/examples/migrations/1385949617_create_books_table.down.sql

@@ -0,0 +1,8 @@
+BEGIN
+EXECUTE IMMEDIATE 'DROP TABLE BOOKS';
+EXCEPTION
+    WHEN OTHERS THEN
+        IF SQLCODE != -942 THEN
+            RAISE;
+        END IF;
+END;

database/oracle/examples/migrations/1385949617_create_books_table.up.sql

@@ -0,0 +1,5 @@
+CREATE TABLE BOOKS (
+  USER_ID integer,
+  NAME    varchar(40),
+  AUTHOR  varchar(40)
+)

database/oracle/examples/migrations/1485949617_create_movies_table.down.sql

@@ -0,0 +1,8 @@
+BEGIN
+EXECUTE IMMEDIATE 'DROP TABLE MOVIES';
+EXCEPTION
+    WHEN OTHERS THEN
+        IF SQLCODE != -942 THEN
+            RAISE;
+        END IF;
+END;

database/oracle/examples/migrations/1485949617_create_movies_table.up.sql

@@ -0,0 +1,5 @@
+CREATE TABLE MOVIES (
+  USER_ID   integer,
+  NAME      varchar(40),
+  DIRECTOR  varchar(40)
+)

database/oracle/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.

database/oracle/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.

database/oracle/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.

database/oracle/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.