oracledb 3.1.2 → 4.2.0

package/lib/resultset.js

@@ -1,36 +1,32 @@
-/* Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. */
-
-/******************************************************************************
- *
- * You may not use the identified files except in compliance with the Apache
- * License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at
- * http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- *****************************************************************************/
+// Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved
+
+//-----------------------------------------------------------------------------
+//
+// You may not use the identified files except in compliance with the Apache
+// License, Version 2.0 (the "License.")
+//
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0.
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//-----------------------------------------------------------------------------
 
 'use strict';
 
-var QueryStream = require('./querystream.js');
-var nodbUtil = require('./util.js');
-var closePromisified;
-var getRowPromisified;
-var getRowsPromisified;
+const QueryStream = require('./queryStream.js');
+const nodbUtil = require('./util.js');
 
-// This close function is just a place holder to allow for easier extension later.
+// close the result set
 function close(closeCb) {
-  var self = this;
+  const self = this;
 
-  nodbUtil.assert(arguments.length === 1, 'NJS-009');
-  nodbUtil.assert(typeof closeCb === 'function', 'NJS-006', 1);
+  nodbUtil.checkAsyncArgs(arguments, 1, 1);
 
   if (self._convertedToStream) {
     closeCb(new Error(nodbUtil.getErrorMessage('NJS-042')));
@@ -45,16 +41,14 @@ function close(closeCb) {
   });
 }
 
-closePromisified = nodbUtil.promisify(close);
 
-// getRow is a JavaScript based wrapper on getRows. It buffers rows in a JavaScript
-// array to avoid the trips through the thread pool that would be required if
-// implemented in C.
+// getRow is a JavaScript based wrapper on getRows. It buffers rows in a
+// JavaScript array to avoid the trips through the thread pool that would be
+// required if implemented in C.
 function getRow(getRowCb) {
-  var self = this;
+  const self = this;
 
-  nodbUtil.assert(arguments.length === 1, 'NJS-009');
-  nodbUtil.assert(typeof getRowCb === 'function', 'NJS-006', 1);
+  nodbUtil.checkAsyncArgs(arguments, 1, 1);
 
   if (self._convertedToStream && !self._allowGetRowCall) {
     getRowCb(new Error(nodbUtil.getErrorMessage('NJS-042')));
@@ -85,19 +79,19 @@ function getRow(getRowCb) {
   });
 }
 
-getRowPromisified = nodbUtil.promisify(getRow);
 
-// The JS getRows will first check to see if any rows are in the JS buffer (which
-// could result from interspersed calls to getRow and getRows). If no rows are in the
-// buffer, the call is just proxied to the C layer. Otherwise, rows are pulled from
-// the buffer and potentially concatenated with rows from a call to getRows.
+// The JS getRows will first check to see if any rows are in the JS buffer
+// (which could result from interspersed calls to getRow and getRows). If no
+// rows are in the buffer, the call is just proxied to the C layer. Otherwise,
+// rows are pulled from the buffer and potentially concatenated with rows from
+// a call to getRows.
 function getRows(numRows, getRowsCb) {
-  var self = this;
-  var rowsNeeded;
+  const self = this;
+  let rowsNeeded;
 
-  nodbUtil.assert(arguments.length === 2, 'NJS-009');
-  nodbUtil.assert(typeof numRows === 'number', 'NJS-006', 1);
-  nodbUtil.assert(typeof getRowsCb === 'function', 'NJS-006', 2);
+  nodbUtil.checkAsyncArgs(arguments, 2, 2);
+  nodbUtil.assert(Number.isInteger(numRows), 'NJS-005', 2);
+  nodbUtil.assert(numRows > 0, 'NJS-005', 2);
 
   if (self._convertedToStream) {
     getRowsCb(new Error(nodbUtil.getErrorMessage('NJS-042')));
@@ -107,7 +101,7 @@ function getRows(numRows, getRowsCb) {
   self._processingStarted = true;
 
   if (self._rowCache.length === 0) {
-    self._getRows.apply(self, arguments);
+    self._getRows(numRows, getRowsCb);
   } else {
     rowsNeeded = numRows - self._rowCache.length;
 
@@ -115,7 +109,7 @@ function getRows(numRows, getRowsCb) {
       getRowsCb(null, self._rowCache.splice(0, numRows));
     } else {
       self._getRows(rowsNeeded, function(err, rows) {
-        var requestedRows;
+        let requestedRows;
 
         if (err) {
           getRowsCb(err);
@@ -132,97 +126,53 @@ function getRows(numRows, getRowsCb) {
   }
 }
 
-getRowsPromisified = nodbUtil.promisify(getRows);
 
-function toQueryStream() {
-  var self = this;
-  var stream;
+class ResultSet {
 
-  nodbUtil.assert(arguments.length === 0, 'NJS-009');
+  constructor() {
+    this._rowCache = [];
+    this._processingStarted = false;
+    this._convertedToStream = false;
+    this._allowGetRowCall = false;
+  }
 
-  if (self._processingStarted) {
-    throw new Error(nodbUtil.getErrorMessage('NJS-041'));
+  _extend(oracledb) {
+    this._oracledb = oracledb;
+    this.close = nodbUtil.promisify(oracledb, close);
+    this.getRow = nodbUtil.promisify(oracledb, getRow);
+    this.getRows = nodbUtil.promisify(oracledb, getRows);
   }
 
-  if (self._convertedToStream) {
-    throw new Error(nodbUtil.getErrorMessage('NJS-043'));
+  _getDbObjectClassJS(schema, name) {
+    return this._connection._getDbObjectClassJS(schema, name);
   }
 
-  self._convertedToStream = true;
+  _setup(executeOpts) {
+    this._fetchArraySize = this._oracledb.fetchArraySize;
+    if (executeOpts && executeOpts.fetchArraySize) {
+      this._fetchArraySize = executeOpts.fetchArraySize;
+    }
+  }
 
-  stream = new QueryStream(self, self._oracledb);
+  toQueryStream() {
+    const self = this;
 
-  return stream;
-}
+    nodbUtil.checkArgCount(arguments, 0, 0);
 
-// The extend method is used to extend the ResultSet instance from the C layer with
-// custom properties and method overrides. References to the original methods are
-// maintained so they can be invoked by the overriding method at the right time.
-function extend(resultSet, oracledb, executeOpts) {
-  var fetchArraySize = oracledb.fetchArraySize;
+    if (self._processingStarted) {
+      throw new Error(nodbUtil.getErrorMessage('NJS-041'));
+    }
 
-  if (executeOpts && executeOpts.fetchArraySize) {
-    fetchArraySize = executeOpts.fetchArraySize;
+    if (self._convertedToStream) {
+      throw new Error(nodbUtil.getErrorMessage('NJS-043'));
+    }
+
+    self._convertedToStream = true;
+
+    return new QueryStream(self);
   }
 
-  // Using Object.defineProperties to add properties to the ResultSet instance with
-  // special properties, such as enumerable but not writable.
-  Object.defineProperties(
-    resultSet,
-    {
-      _oracledb: { // storing a reference to the base instance to avoid circular references with require
-        value: oracledb
-      },
-      _fetchArraySize: { // stores the value of fetchArraySize that was passed to conn.execute (if any)
-        value: fetchArraySize
-      },
-      _rowCache: { // used for storing rows when getRow is used
-        value: [],
-        writable: true
-      },
-      _processingStarted: { // used to prevent conversion to stream after invoking methods
-        value: false,
-        writable: true
-      },
-      _convertedToStream: { // used to prevent invoking methods after conversion to stream
-        value: false,
-        writable: true
-      },
-      _allowGetRowCall: { // allows getRow call after conversion to queryStream
-        value: false,
-        writable: true
-      },
-      _close: {
-        value: resultSet.close
-      },
-      close: {
-        value: closePromisified,
-        enumerable: true,
-        writable: true
-      },
-      _getRow: {
-        value: resultSet.getRow
-      },
-      getRow: {
-        value: getRowPromisified,
-        enumerable: true,
-        writable: true
-      },
-      _getRows: {
-        value: resultSet.getRows
-      },
-      getRows: {
-        value: getRowsPromisified,
-        enumerable: true,
-        writable: true
-      },
-      toQueryStream: {
-        value: toQueryStream,
-        enumerable: true,
-        writable: true
-      }
-    }
-  );
 }
 
-module.exports.extend = extend;
+
+module.exports = ResultSet;

package/lib/sodaCollection.js

@@ -1,235 +1,169 @@
-/* Copyright (c) 2018, Oracle and/or its affiliates.  All rights reserved */
-
-/**************************************************************************
- *
- * You may not use the identified files except in compliance with the Apache
- * License, Version 2.0 (the "License.")
- *
- * You may obtain a copy of the License at
- * http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- *****************************************************************************/
+// Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved
+
+//-----------------------------------------------------------------------------
+//
+// You may not use the identified files except in compliance with the Apache
+// License, Version 2.0 (the "License.")
+//
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0.
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//-----------------------------------------------------------------------------
 
 'use strict';
 
 const nodbUtil = require('./util.js');
-const sodaDocument = require('./sodaDocument.js');
-const sodaOperation = require('./sodaOperation.js');
-
-var dropCollectionPromisified;
-var insertOnePromisified;
-var insertOneAndGetPromisified;
-var createIndexPromisified;
-var dropIndexPromisified;
-var getDataGuidePromisified;
-
 
 // To drop the collection
 function drop(cb) {
-  var self = this;
+  nodbUtil.checkAsyncArgs(arguments, 1, 1);
+  this._drop(cb);
+}
 
-  nodbUtil.assert(arguments.length === 1, 'NJS-009');
-  nodbUtil.assert(typeof cb === 'function', 'NJS-006', 1);
 
-  self._drop(cb);
+// To insert a given document to the current collection
+function insertMany(docs, cb) {
+  nodbUtil.checkAsyncArgs(arguments, 2, 2);
+  nodbUtil.assert(Array.isArray(docs), 'NJS-005', 1);
+
+  if (docs.length == 0) {
+    cb(new Error(nodbUtil.getErrorMessage('NJS-005', 1)));
+    return;
+  }
+
+  let actualDocs = Array(docs.length);
+  for (let i = 0; i < docs.length; i++) {
+    let content = docs[i];
+    if (!nodbUtil.isSodaDocument(content)) {
+      content = Buffer.from(JSON.stringify(content));
+    }
+    actualDocs[i] = content;
+  }
+
+  this._insertMany(actualDocs, cb);
 }
 
-dropCollectionPromisified = nodbUtil.promisify(drop);
 
+// To insert a given document into the current collection and return the
+// metadata of the new document (result-document)
+function insertManyAndGet(docs, cb) {
+  nodbUtil.checkAsyncArgs(arguments, 2, 2);
+  nodbUtil.assert(Array.isArray(docs), 'NJS-005', 1);
+
+  if (docs.length == 0) {
+    cb(new Error(nodbUtil.getErrorMessage('NJS-005', 1)));
+    return;
+  }
+
+  let actualDocs = Array(docs.length);
+  for (let i = 0; i < docs.length; i++) {
+    let content = docs[i];
+    if (!nodbUtil.isSodaDocument(content)) {
+      content = Buffer.from(JSON.stringify(content));
+    }
+    actualDocs[i] = content;
+  }
+
+  this._insertManyAndGet(actualDocs, cb);
+}
 
 // To insert a given document to the current collection
 function insertOne(content, cb) {
-  var self = this;
-
-  nodbUtil.assert(arguments.length === 2, 'NJS-009');
+  nodbUtil.checkAsyncArgs(arguments, 2, 2);
   nodbUtil.assert(nodbUtil.isObject(content) ||
-      nodbUtil.isSodaDocument(content), 'NJS-006', 1);
-  nodbUtil.assert(typeof cb === 'function', 'NJS-006', 2);
+      nodbUtil.isSodaDocument(content), 'NJS-005', 1);
 
   if (!nodbUtil.isSodaDocument(content)) {
     content = Buffer.from(JSON.stringify(content));
   }
 
-  self._insertOne(content, cb);
+  this._insertOne(content, cb);
 }
 
-insertOnePromisified = nodbUtil.promisify(insertOne);
-
 
 // To insert a given document into the current collection and return the
 // metadata of the new document (result-document)
 function insertOneAndGet(content, cb) {
-  var self = this;
-
-  nodbUtil.assert(arguments.length === 2, 'NJS-009');
+  nodbUtil.checkAsyncArgs(arguments, 2, 2);
   nodbUtil.assert(nodbUtil.isObject(content) ||
-      nodbUtil.isSodaDocument(content), 'NJS-006', 1);
-  nodbUtil.assert(typeof cb === 'function', 'NJS-006', 2);
+      nodbUtil.isSodaDocument(content), 'NJS-005', 1);
 
   if (!nodbUtil.isSodaDocument(content)) {
     content = Buffer.from(JSON.stringify(content));
   }
 
-  self._insertOneAndGet(content, function(err, doc) {
-    if (doc) {
-      sodaDocument.extend(doc);
-    }
-    cb(err, doc);
-  });
+  this._insertOneAndGet(content, cb);
 }
 
-insertOneAndGetPromisified = nodbUtil.promisify(insertOneAndGet);
-
 
 // To create an index on documens
 function createIndex(spec, cb) {
-  var self = this;
-
-  nodbUtil.assert(arguments.length === 2, 'NJS-009', 1);
-  nodbUtil.assert(nodbUtil.isObject(spec), 'NJS-006', 1);
-  nodbUtil.assert(typeof cb === 'function', 'NJS-006', 2);
+  nodbUtil.checkAsyncArgs(arguments, 2, 2);
+  nodbUtil.assert(nodbUtil.isObject(spec), 'NJS-005', 1);
 
-  self._createIndex(JSON.stringify(spec), cb);
+  this._createIndex(JSON.stringify(spec), cb);
 }
 
-createIndexPromisified = nodbUtil.promisify(createIndex);
-
 
 // To drop an index from document-collection
 function dropIndex(indexName, a2, a3) {
-  var self = this;
-  var options = {};
-  var dropIndexCb;
+  let options = {};
+  let dropIndexCb;
 
-  nodbUtil.assert(arguments.length >= 2 && arguments.length <= 3, 'NJS-009');
-  nodbUtil.assert(typeof indexName === 'string', 'NJS-006', 1);
+  nodbUtil.checkAsyncArgs(arguments, 2, 3);
+  nodbUtil.assert(typeof indexName === 'string', 'NJS-005', 1);
 
   switch (arguments.length) {
     case 2:
-      nodbUtil.assert(typeof a2 === 'function', 'NJS-006', 2);
       dropIndexCb = a2;
       break;
     case 3:
-      nodbUtil.assert(typeof a2 === 'object', 'NJS-006', 2);
-      nodbUtil.assert(typeof a3 === 'function', 'NJS-006', 3);
+      nodbUtil.assert(typeof a2 === 'object', 'NJS-005', 2);
       options = a2;
       dropIndexCb = a3;
       break;
   }
 
-  self._dropIndex(indexName, options, dropIndexCb);
+  this._dropIndex(indexName, options, dropIndexCb);
 }
 
-dropIndexPromisified = nodbUtil.promisify(dropIndex);
-
 
 // To obtain the dataGuide of the document collection
 function getDataGuide(cb) {
-  var self = this;
-
-  nodbUtil.assert(typeof cb === 'function', 'NJS-009');
-
-  self._getDataGuide(function(err, doc) {
-    if (doc) {
-      sodaDocument.extend(doc);
-    }
-    cb(err, doc);
-  });
+  nodbUtil.checkAsyncArgs(arguments, 1, 1);
+  this._getDataGuide(cb);
 }
 
-getDataGuidePromisified = nodbUtil.promisify(getDataGuide);
 
+class SodaCollection {
 
-// Creates an instance of sodaOperation object which supports
-// terminal/non-terminal functions for find operation.
-function find() {
-  var self = this;
-
-  var op = self._find();
-  sodaOperation.extend(op, self._oracledb);
+  _extend(oracledb) {
+    this.createIndex = nodbUtil.promisify(oracledb, createIndex);
+    this.drop = nodbUtil.promisify(oracledb, drop);
+    this.dropIndex = nodbUtil.promisify(oracledb, dropIndex);
+    this.getDataGuide = nodbUtil.promisify(oracledb, getDataGuide);
+    this.insertMany = nodbUtil.promisify(oracledb, insertMany);
+    this.insertManyAndGet = nodbUtil.promisify(oracledb, insertManyAndGet);
+    this.insertOne = nodbUtil.promisify(oracledb, insertOne);
+    this.insertOneAndGet = nodbUtil.promisify(oracledb, insertOneAndGet);
+  }
 
-  return op;
-}
+  find() {
+    nodbUtil.checkArgCount(arguments, 0, 0 );
+    return this._find();
+  }
 
+  get metaData() {
+    return JSON.parse(this._metaData);
+  }
 
-// The extend method is used to extend the collection instance from C Layer
-// with custom properties and method overrides.  References to the original
-// methods are maintained so they can be invoked by the overriding method at
-// the right time
-function extend(coll, oracledb) {
-  // Using Object.defineProperties to add properties to the soda instance with
-  // special properties.
-  Object.defineProperties (
-    coll,
-    {
-      _oracledb: {
-        value: oracledb
-      },
-      _drop: {
-        value: coll.drop
-      },
-      drop: {
-        value: dropCollectionPromisified,
-        enumerable: true,
-        writable: true
-      },
-      _insertOne: {
-        value: coll.insertOne
-      },
-      insertOne: {
-        value: insertOnePromisified,
-        enumerable: true,
-        writable: true
-      },
-      _insertOneAndGet: {
-        value: coll.insertOneAndGet
-      },
-      insertOneAndGet: {
-        value: insertOneAndGetPromisified,
-        enumerable: true,
-        writable: true
-      },
-      _createIndex:  {
-        value: coll.createIndex
-      },
-      createIndex: {
-        value: createIndexPromisified,
-        enumerable: true,
-        writable: true
-      },
-      _dropIndex :  {
-        value: coll.dropIndex
-      },
-      dropIndex: {
-        value: dropIndexPromisified,
-        enumerable: true,
-        writable: true
-      },
-      _getDataGuide: {
-        value: coll.getDataGuide
-      },
-      getDataGuide: {
-        value: getDataGuidePromisified,
-        enumerable: true,
-        writable: true
-      },
-      _find: {
-        value: coll.find
-      },
-      find: {
-        value: find,
-        enumerable: true,
-        writable: true
-      }
-    }
-  );
 }
 
-module.exports.extend = extend;
+module.exports = SodaCollection;