feat(oracle): add oracle dialect support

.github/workflows/ci.yml

@@ -47,6 +47,33 @@ jobs:
       - run: yarn install --frozen-lockfile
       - run: yarn add --dev typescript@~${{ matrix.ts-version }}
       - run: yarn test-typings
+  test-oracle:
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [10, 16]
+    name: Oracle DB (Node ${{ matrix.node-version }})
+    runs-on: ubuntu-latest
+    env:
+      DIALECT: oracle
+      SEQ_ORACLE_USER: sequelizetest
+      SEQ_ORACLE_PW: sequelizepassword
+      SEQ_ORACLE_DB: XEPDB1
+      SEQ_ORACLE_HOST: localhost
+      SEQ_ORACLE_PORT: 1521
+      UV_THREADPOOL_SIZE: 128
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: yarn install --frozen-lockfile --ignore-engines
+      - name: Install Local Oracle DB
+        run: yarn start-oracle
+      - name: Unit Tests
+        run: yarn test-unit
+      - name: Integration Tests
+        run: yarn test-integration-oracle
   test-db2:
     strategy:
       fail-fast: false

dev/oracle/latest/docker-compose.yml

@@ -0,0 +1,17 @@
+# Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved
+
+services:
+  oraclexedb:
+    container_name: oraclexedb
+    image: gvenzl/oracle-xe:latest
+    environment:
+      ORACLE_PASSWORD: password
+    ports:
+      - 1521:1521
+    healthcheck:
+      test: ["CMD-SHELL", "sqlplus", "system/password@XEPDB1"]
+      retries: 10
+
+networks:
+  default:
+    name: sequelize-oraclexedb-network

dev/oracle/latest/privileges.sql

@@ -0,0 +1,27 @@
+-- Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved
+
+create user sequelizetest identified by sequelizepassword;
+grant connect to sequelizetest with admin option;
+grant create session to sequelizetest with admin option;
+grant grant any privilege to sequelizetest with admin option;
+grant grant any role to sequelizetest with admin option;
+grant create any table to sequelizetest with admin option;
+grant insert any table to sequelizetest with admin option;
+grant select any table to sequelizetest with admin option;
+grant update any table to sequelizetest with admin option;
+grant delete any table to sequelizetest with admin option;
+grant drop any table to sequelizetest with admin option;
+grant create view to sequelizetest with admin option;
+grant create user to sequelizetest with admin option;
+grant drop user to sequelizetest with admin option;
+grant create any trigger to sequelizetest with admin option;
+grant create any procedure to sequelizetest with admin option;
+grant create any sequence to sequelizetest with admin option;
+grant select any sequence to sequelizetest with admin option;
+grant drop any sequence to sequelizetest with admin option;
+grant create any synonym to sequelizetest with admin option;
+grant create any index to sequelizetest with admin option;
+grant alter user to sequelizetest with admin option;
+grant alter any table to sequelizetest with admin option;
+alter user sequelizetest quota unlimited on users;
+exit;

dev/oracle/latest/start.sh

@@ -0,0 +1,44 @@
+# Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved
+
+#!/usr/bin/env bash
+set -Eeuxo pipefail # https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/
+cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")" # https://stackoverflow.com/a/17744637
+
+# Remove an existing Oracle DB docker image
+docker-compose -p oraclexedb down --remove-orphans
+
+# Bring up new Oracle DB docker image
+docker-compose -p oraclexedb up -d
+
+# Wait until Oracle DB is set up and docker state is healthy
+./wait-until-healthy.sh oraclexedb
+
+# Moving privileges.sql to docker container
+docker cp privileges.sql oraclexedb:/opt/oracle/. 
+
+# Granting all the needed privileges to sequelizetest user
+docker exec -t oraclexedb sqlplus system/password@XEPDB1 @privileges.sql
+
+# Setting up Oracle instant client for oracledb
+if [ ! -d  ~/oracle ] && [ $(uname) == 'Linux' ]
+then 
+    mkdir ~/oracle && 
+    wget https://download.oracle.com/otn_software/linux/instantclient/instantclient-basic-linuxx64.zip --no-check-certificate && 
+    unzip instantclient-basic-linuxx64.zip -d ~/oracle/ &&
+    rm instantclient-basic-linuxx64.zip &&
+    mv ~/oracle/instantclient_21_6 ~/oracle/instantclient
+
+    echo "Local Oracle instant client has been setup!"
+elif [ ! -d  ~/Downloads/instantclient_19_8 ] && [ $(uname) == 'Darwin' ]
+then
+    curl -O https://download.oracle.com/otn_software/mac/instantclient/instantclient-basic-macos.dmg && 
+    hdiutil mount instantclient-basic-macos.dmg &&
+    /Volumes/instantclient-basic-macos.x64-19.8.0.0.0dbru/install_ic.sh &&
+    hdiutil unmount /Volumes/instantclient-basic-macos.x64-19.8.0.0.0dbru &&
+    rm instantclient-basic-macos.dmg &&
+    ln -s ~/Downloads/instantclient_19_8/libclntsh.dylib ../../../node_modules/oracledb/build/Release/
+
+    echo "Local Oracle instant client has been setup!"
+fi
+
+echo "Local Oracle DB is ready for use!"

dev/oracle/latest/stop.sh

@@ -0,0 +1,10 @@
+# Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved
+
+#!/usr/bin/env bash
+set -Eeuxo pipefail # https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/
+cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")" # https://stackoverflow.com/a/17744637
+
+
+docker-compose -p oraclexedb down --remove-orphans
+
+echo "Local Oracle DB instance stopped (if it was running)."

dev/oracle/latest/wait-until-healthy.sh

@@ -0,0 +1,23 @@
+# Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved
+
+#!/usr/bin/env bash
+
+if [ "$#" -ne 1 ]; then
+  >&2 echo "Please provide the container name or hash"
+  exit 1
+fi
+
+for _ in {1..50}
+do
+  state=$(docker inspect -f '{{ .State.Health.Status }}' $1 2>&1)
+  return_code=$?
+  if [ ${return_code} -eq 0 ] && [ "$state" == "healthy" ]; then
+    echo "$1 is healthy!"
+    sleep 60
+    exit 0
+  fi
+  sleep 6
+done
+
+>&2 echo "Timeout of 5m exceeded when waiting for container to be healthy: $1"
+exit 1

package.json

@@ -106,6 +106,7 @@
     "mysql2": "^2.3.3",
     "node-hook": "^1.0.0",
     "nyc": "^15.1.0",
+    "oracledb": "^5.4.0",
     "p-map": "^4.0.0",
     "p-props": "^4.0.0",
     "p-settle": "^4.1.1",
@@ -160,6 +161,7 @@
     "db2",
     "ibm_db",
     "sql",
+    "oracledb",
     "sqlserver",
     "snowflake",
     "orm",
@@ -239,17 +241,20 @@
     "start-postgres": "bash dev/postgres/10/start.sh",
     "start-mssql": "bash dev/mssql/2019/start.sh",
     "start-db2": "bash dev/db2/11.5/start.sh",
+    "start-oracle": "bash dev/oracle/latest/start.sh",
     "stop-mariadb": "bash dev/mariadb/10.3/stop.sh",
     "stop-mysql": "bash dev/mysql/5.7/stop.sh",
     "stop-mysql-8": "bash dev/mysql/8.0/stop.sh",
     "stop-postgres": "bash dev/postgres/10/stop.sh",
     "stop-mssql": "bash dev/mssql/2019/stop.sh",
     "stop-db2": "bash dev/db2/11.5/stop.sh",
+    "stop-oracle": "bash dev/oracle/latest/stop.sh",
     "restart-mariadb": "npm run start-mariadb",
     "restart-mysql": "npm run start-mysql",
     "restart-postgres": "npm run start-postgres",
     "restart-mssql": "npm run start-mssql",
     "restart-db2": "npm run start-db2",
+    "restart-oracle": "npm run start-oracle",
     "----------------------------------------- local tests ---------------------------------------------": "",
     "test-unit-mariadb": "cross-env DIALECT=mariadb npm run test-unit",
     "test-unit-mysql": "cross-env DIALECT=mysql npm run test-unit",
@@ -259,7 +264,8 @@
     "test-unit-mssql": "cross-env DIALECT=mssql npm run test-unit",
     "test-unit-db2": "cross-env DIALECT=db2 npm run test-unit",
     "test-unit-snowflake": "cross-env DIALECT=snowflake npm run test-unit",
-    "test-unit-all": "npm run test-unit-mariadb && npm run test-unit-mysql && npm run test-unit-postgres && npm run test-unit-postgres-native && npm run test-unit-mssql && npm run test-unit-sqlite && npm run test-unit-snowflake && npm run test-unit-db2",
+    "test-unit-all": "npm run test-unit-mariadb && npm run test-unit-mysql && npm run test-unit-postgres && npm run test-unit-postgres-native && npm run test-unit-mssql && npm run test-unit-sqlite && npm run test-unit-snowflake && npm run test-unit-db2 && npm run test-unit-oracle",
+    "test-unit-oracle": "cross-env DIALECT=oracle npm run test-unit",
     "test-integration-mariadb": "cross-env DIALECT=mariadb npm run test-integration",
     "test-integration-mysql": "cross-env DIALECT=mysql npm run test-integration",
     "test-integration-postgres": "cross-env DIALECT=postgres npm run test-integration",
@@ -268,13 +274,15 @@
     "test-integration-mssql": "cross-env DIALECT=mssql npm run test-integration",
     "test-integration-db2": "cross-env DIALECT=db2 npm run test-integration",
     "test-integration-snowflake": "cross-env DIALECT=snowflake npm run test-integration",
+    "test-integration-oracle": "cross-env LD_LIBRARY_PATH=$HOME/oracle/instantclient/ DIALECT=oracle UV_THREADPOOL_SIZE=128 npm run test-integration",
     "test-mariadb": "cross-env DIALECT=mariadb npm test",
     "test-mysql": "cross-env DIALECT=mysql npm test",
     "test-sqlite": "cross-env DIALECT=sqlite npm test",
     "test-postgres": "cross-env DIALECT=postgres npm test",
     "test-postgres-native": "cross-env DIALECT=postgres-native npm test",
     "test-mssql": "cross-env DIALECT=mssql npm test",
     "test-db2": "cross-env DIALECT=db2 npm test",
+    "test-oracle": "cross-env LD_LIBRARY_PATH=$HOME/oracle/instantclient/ DIALECT=oracle UV_THREADPOOL_SIZE=128 npm test",
     "----------------------------------------- development ---------------------------------------------": "",
     "sscce": "node sscce.js",
     "sscce-mariadb": "cross-env DIALECT=mariadb node sscce.js",
@@ -284,6 +292,7 @@
     "sscce-sqlite": "cross-env DIALECT=sqlite node sscce.js",
     "sscce-mssql": "cross-env DIALECT=mssql node sscce.js",
     "sscce-db2": "cross-env DIALECT=db2 node sscce.js",
+    "sscce-oracle": "cross-env LD_LIBRARY_PATH=$HOME/oracle/instantclient/ DIALECT=oracle node sscce.js",
     "prepare": "npm run build && husky install",
     "build": "node ./build.js",
     "---------------------------------------------------------------------------------------------------": ""

src/data-types.js

@@ -1060,6 +1060,7 @@ dialectMap.sqlite = require('./dialects/sqlite/data-types')(DataTypes);
 dialectMap.mssql = require('./dialects/mssql/data-types')(DataTypes);
 dialectMap.db2 = require('./dialects/db2/data-types')(DataTypes);
 dialectMap.snowflake = require('./dialects/snowflake/data-types')(DataTypes);
+dialectMap.oracle = require('./dialects/oracle/data-types')(DataTypes);
 
 const dialectList = Object.values(dialectMap);
 

src/dialects/abstract/query-generator.js

@@ -88,6 +88,16 @@ class QueryGenerator {
     return `ALTER TABLE ${this.quoteTable(before)} RENAME TO ${this.quoteTable(after)};`;
   }
 
+  /**
+   * Helper method for getting the returning into bind information 
+   * that is needed by some dialects (currently Oracle)
+   * 
+   * @private
+   */
+  getInsertQueryReturnIntoBinds() {
+    // noop by default
+  }
+
   /**
    * Returns an insert into command
    *
@@ -103,12 +113,14 @@ class QueryGenerator {
     _.defaults(options, this.options);
 
     const modelAttributeMap = {};
-    const bind = [];
+    const bind = options.bind || [];
     const fields = [];
     const returningModelAttributes = [];
+    const returnTypes = [];
     const values = [];
     const quotedTable = this.quoteTable(table);
     const bindParam = options.bindParam === undefined ? this.bindParam(bind) : options.bindParam;
+    const returnAttributes = [];
     let query;
     let valueQuery = '';
     let emptyQuery = '';
@@ -132,10 +144,14 @@ class QueryGenerator {
       emptyQuery += ' VALUES ()';
     }
 
-    if (this._dialect.supports.returnValues && options.returning) {
+    if ((this._dialect.supports.returnValues || this._dialect.supports.returnIntoValues) && options.returning) {
       const returnValues = this.generateReturnValues(modelAttributes, options);
 
       returningModelAttributes.push(...returnValues.returnFields);
+      // Storing the returnTypes for dialects that need to have returning into bind information for outbinds
+      if (this._dialect.supports.returnIntoValues) {
+        returnTypes.push(...returnValues.returnTypes);
+      }
       returningFragment = returnValues.returningFragment;
       tmpTable = returnValues.tmpTable || '';
       outputFragment = returnValues.outputFragment || '';
@@ -244,7 +260,12 @@ class QueryGenerator {
       emptyQuery += returningFragment;
     }
 
-    query = `${replacements.attributes.length ? valueQuery : emptyQuery};`;
+    if (this._dialect.supports.returnIntoValues && options.returning) {
+      // Populating the returnAttributes array and performing operations needed for output binds of insertQuery 
+      this.getInsertQueryReturnIntoBinds(returnAttributes, bind.length, returningModelAttributes, returnTypes, options);
+    }
+
+    query = `${replacements.attributes.length ? valueQuery : emptyQuery}${returnAttributes.join(',')};`;
     if (this._dialect.supports.finalTable) {
       query = `SELECT * FROM FINAL TABLE(${ replacements.attributes.length ? valueQuery : emptyQuery });`;
     }
@@ -383,8 +404,18 @@ class QueryGenerator {
     const bindParam = options.bindParam === undefined ? this.bindParam(bind) : options.bindParam;
 
     if (this._dialect.supports['LIMIT ON UPDATE'] && options.limit) {
-      if (this.dialect !== 'mssql' && this.dialect !== 'db2') {
+      if (this.dialect !== 'mssql' && this.dialect !== 'db2' && this.dialect !== 'oracle') {
         suffix = ` LIMIT ${this.escape(options.limit)} `;
+      } else if (this.dialect === 'oracle') {
+        //This cannot be setted in where because rownum will be quoted
+        if (where && (where.length && where.length > 0 || Object.keys(where).length > 0)) {
+          //If we have a where clause, we add AND
+          suffix += ' AND ';
+        } else {
+          //No where clause, we add where
+          suffix += ' WHERE ';
+        }
+        suffix += `rownum <= ${this.escape(options.limit)} `;
       }
     }
 
@@ -1188,6 +1219,7 @@ class QueryGenerator {
     let mainJoinQueries = [];
     let subJoinQueries = [];
     let query;
+    const hasAs = this._dialect.name === 'oracle' ? '' : 'AS ';
 
     // Aliases can be passed through subqueries and we don't want to reset them
     if (this.options.minifyAliases && !options.aliasesMapping) {
@@ -1312,7 +1344,12 @@ class QueryGenerator {
         } else {
           // Ordering is handled by the subqueries, so ordering the UNION'ed result is not needed
           groupedLimitOrder = options.order;
-          delete options.order;
+
+          // For the Oracle dialect, the result of a select is a set, not a sequence, and so is the result of UNION.  
+          // So the top level ORDER BY is required
+          if (this._dialect.name !== 'oracle') {
+            delete options.order;
+          }
           where[Op.placeholder] = true;
         }
 
@@ -1332,7 +1369,7 @@ class QueryGenerator {
             model
           },
           model
-        ).replace(/;$/, '')}) AS sub`; // Every derived table must have its own alias
+        ).replace(/;$/, '')}) ${hasAs}sub`; // Every derived table must have its own alias
         const placeHolder = this.whereItemQuery(Op.placeholder, true, { model });
         const splicePos = baseQuery.indexOf(placeHolder);
 
@@ -1426,7 +1463,7 @@ class QueryGenerator {
 
     if (subQuery) {
       this._throwOnEmptyAttributes(attributes.main, { modelName: model && model.name, as: mainTable.as });
-      query = `SELECT ${attributes.main.join(', ')} FROM (${subQueryItems.join('')}) AS ${mainTable.as}${mainJoinQueries.join('')}${mainQueryItems.join('')}`;
+      query = `SELECT ${attributes.main.join(', ')} FROM (${subQueryItems.join('')}) ${hasAs}${mainTable.as}${mainJoinQueries.join('')}${mainQueryItems.join('')}`;
     } else {
       query = mainQueryItems.join('');
     }
@@ -1566,6 +1603,8 @@ class QueryGenerator {
           prefix = `(${this.quoteIdentifier(includeAs.internalAs)}.${attr.replace(/\(|\)/g, '')})`;
         } else if (/json_extract\(/.test(attr)) {
           prefix = attr.replace(/json_extract\(/i, `json_extract(${this.quoteIdentifier(includeAs.internalAs)}.`);
+        } else if (/json_value\(/.test(attr)) {
+          prefix = attr.replace(/json_value\(/i, `json_value(${this.quoteIdentifier(includeAs.internalAs)}.`); 
         } else {
           prefix = `${this.quoteIdentifier(includeAs.internalAs)}.${this.quoteIdentifier(attr)}`;
         }
@@ -1822,6 +1861,8 @@ class QueryGenerator {
 
     if (this._dialect.supports.returnValues.returning) {
       returningFragment = ` RETURNING ${returnFields.join(',')}`;
+    } else if (this._dialect.supports.returnIntoValues) {
+      returningFragment = ` RETURNING ${returnFields.join(',')} INTO `;
     } else if (this._dialect.supports.returnValues.output) {
       outputFragment = ` OUTPUT ${returnFields.map(field => `INSERTED.${field}`).join(',')}`;
 
@@ -1835,7 +1876,7 @@ class QueryGenerator {
       }
     }
 
-    return { outputFragment, returnFields, returningFragment, tmpTable };
+    return { outputFragment, returnFields, returnTypes, returningFragment, tmpTable };
   }
 
   generateThroughJoin(include, includeAs, parentTableName, topLevelInfo) {