oracledb 5.4.0 → 6.0.0

package/lib/sodaOperation.js

@@ -1,17 +1,24 @@
-// Copyright (c) 2018, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2023, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
-// You may not use the identified files except in compliance with the Apache
-// License, Version 2.0 (the "License.")
+// This software is dual-licensed to you under the Universal Permissive License
+// (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+// 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+// either license.
 //
+// If you elect to accept the software under the Apache License, Version 2.0,
+// the following applies:
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with 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.
+//    https://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.
 //
@@ -19,144 +26,142 @@
 
 'use strict';
 
+const SodaDocCursor = require('./sodaDocCursor.js');
+const SodaDocument = require('./sodaDocument.js');
+const errors = require('./errors.js');
 const nodbUtil = require('./util.js');
+const settings = require('./settings.js');
 
-//-----------------------------------------------------------------------------
-// count()
-//   Return a count of the number of documents that match the search criteria.
-//-----------------------------------------------------------------------------
-async function count() {
-  nodbUtil.checkArgCount(arguments, 0, 0);
-  return await this._count(this._options);
-}
-
-
-//-----------------------------------------------------------------------------
-// getOne()
-//   Return the first document that matches the search criteria.
-//-----------------------------------------------------------------------------
-async function getOne() {
-  nodbUtil.checkArgCount(arguments, 0, 0);
-  return await this._getOne(this._options);
-}
-
-
-//-----------------------------------------------------------------------------
-// replaceOne()
-//   Replace the first document that matches the search criteria with the
-// specified document.
-//-----------------------------------------------------------------------------
-async function replaceOne(content) {
-  nodbUtil.checkArgCount(arguments, 1, 1);
-  nodbUtil.assert(nodbUtil.isObject(content) ||
-      nodbUtil.isSodaDocument(content), 'NJS-005', 1);
+class SodaOperation {
 
-  if (!nodbUtil.isSodaDocument(content)) {
-    content = Buffer.from(JSON.stringify(content));
+  constructor() {
+    this._options = {
+      autoCommit: settings.autoCommit,
+      fetchArraySize: settings.fetchArraySize
+    };
   }
 
-  return await this._replaceOne(this._options, content);
-}
-
-
-//-----------------------------------------------------------------------------
-// replaceOneAndGet()
-//   Replace the first document that matches the search criteria with the
-// specified document and then return a result document containing metadata.
-//-----------------------------------------------------------------------------
-async function replaceOneAndGet(content) {
-  nodbUtil.checkArgCount(arguments, 1, 1);
-  nodbUtil.assert(nodbUtil.isObject(content) ||
-      nodbUtil.isSodaDocument(content), 'NJS-005', 1);
-
-  if (!nodbUtil.isSodaDocument(content)) {
-    content = Buffer.from(JSON.stringify(content));
+  //---------------------------------------------------------------------------
+  // count()
+  //
+  // Return a count of the number of documents that match the search criteria.
+  //---------------------------------------------------------------------------
+  async count() {
+    errors.assertArgCount(arguments, 0, 0);
+    return await this._impl.count(this._options);
   }
 
-  return await this._replaceOneAndGet(this._options, content);
-}
-
-
-//-----------------------------------------------------------------------------
-// remove()
-//   Remove the documents that match the search criteria from the collection
-// and return information about the operation to the caller.
-//-----------------------------------------------------------------------------
-async function remove() {
-  nodbUtil.checkArgCount(arguments, 0, 0);
-  return await this._remove(this._options);
-}
-
-
-//-----------------------------------------------------------------------------
-// getCursor()
-//   Return a cursor which will return the documents that match the search
-// criteria.
-//-----------------------------------------------------------------------------
-async function getCursor() {
-  nodbUtil.checkArgCount(arguments, 0, 0);
-  return await this._getCursor(this._options);
-}
-
-
-//-----------------------------------------------------------------------------
-// getDocuments()
-//   Return an array of documents that match the search criteria.
-//-----------------------------------------------------------------------------
-async function getDocuments() {
-  nodbUtil.checkArgCount(arguments, 0, 0);
-  return await this._getDocuments(this._options);
-}
+  //---------------------------------------------------------------------------
+  // getCursor()
+  //
+  // Return a cursor which will return the documents that match the search
+  // criteria.
+  //---------------------------------------------------------------------------
+  async getCursor() {
+    errors.assertArgCount(arguments, 0, 0);
+    const cursor = new SodaDocCursor();
+    cursor._impl = await this._impl.getCursor(this._options);
+    return cursor;
+  }
 
+  //---------------------------------------------------------------------------
+  // getDocuments()
+  //   Return an array of documents that match the search criteria.
+  //---------------------------------------------------------------------------
+  async getDocuments() {
+    errors.assertArgCount(arguments, 0, 0);
+    const docImpls = await this._impl.getDocuments(this._options);
+    const returnVal = new Array(docImpls.length);
+    for (let i = 0; i < docImpls.length; i++) {
+      returnVal[i] = new SodaDocument();
+      returnVal[i]._impl = docImpls[i];
+    }
+    return returnVal;
+  }
 
-class SodaOperation {
+  //---------------------------------------------------------------------------
+  // getOne()
+  //
+  // Return the first document that matches the search criteria.
+  //---------------------------------------------------------------------------
+  async getOne() {
+    errors.assertArgCount(arguments, 0, 0);
+    const docImpl = await this._impl.getOne(this._options);
+    if (docImpl) {
+      const doc = new SodaDocument;
+      doc._impl = docImpl;
+      return doc;
+    }
+  }
 
-  constructor() {
-    this._options = {};
+  //---------------------------------------------------------------------------
+  // replaceOne()
+  //
+  // Replace the first document that matches the search criteria with the
+  // specified document.
+  //---------------------------------------------------------------------------
+  async replaceOne(content) {
+    errors.assertArgCount(arguments, 1, 1);
+    content = nodbUtil.verifySodaDoc(content);
+    return await this._impl.replaceOne(this._options, content);
   }
 
-  _extend() {
-    this.count = nodbUtil.callbackify(nodbUtil.serialize(count));
-    this.getCursor = nodbUtil.callbackify(nodbUtil.serialize(getCursor));
-    this.getDocuments = nodbUtil.callbackify(nodbUtil.serialize(getDocuments));
-    this.getOne = nodbUtil.callbackify(nodbUtil.serialize(getOne));
-    this.remove = nodbUtil.callbackify(nodbUtil.serialize(remove));
-    this.replaceOne = nodbUtil.callbackify(nodbUtil.serialize(replaceOne));
-    this.replaceOneAndGet = nodbUtil.callbackify(nodbUtil.serialize(replaceOneAndGet));
+  //---------------------------------------------------------------------------
+  // replaceOneAndGet()
+  //
+  // Replace the first document that matches the search criteria with the
+  // specified document and then return a result document containing metadata.
+  //---------------------------------------------------------------------------
+  async replaceOneAndGet(content) {
+    errors.assertArgCount(arguments, 1, 1);
+    content = nodbUtil.verifySodaDoc(content);
+    const docImpl = await this._impl.replaceOneAndGet(this._options, content);
+    if (docImpl) {
+      const doc = new SodaDocument();
+      doc._impl = docImpl;
+      return doc;
+    }
   }
 
-  _getConnection() {
-    return this._collection._database._connection;
+  //---------------------------------------------------------------------------
+  // remove()
+  //
+  // Remove the documents that match the search criteria from the collection
+  // and return information about the operation to the caller.
+  //---------------------------------------------------------------------------
+  async remove() {
+    errors.assertArgCount(arguments, 0, 0);
+    return await this._impl.remove(this._options);
   }
 
   // fetchArraySize - a non-terminal function that can chain further
   fetchArraySize(n) {
-    nodbUtil.checkArgCount(arguments, 1, 1);
-    nodbUtil.assert(typeof n === 'number', 'NJS-005', 1);
+    errors.assertArgCount(arguments, 1, 1);
+    errors.assertParamValue(Number.isInteger(n) && n >= 0, 1);
     this._options.fetchArraySize = n;
     return this;
   }
 
   // filter property - a non-terminal function and can chain further
   filter(f) {
-    nodbUtil.checkArgCount (arguments, 1, 1);
-    nodbUtil.assert(nodbUtil.isObject(f), 'NJS-005', 1);
+    errors.assertArgCount (arguments, 1, 1);
+    errors.assertParamValue(nodbUtil.isObject(f), 1);
     this._options.filter = JSON.stringify(f);
     return this;
   }
 
   // hint - a non-terminal function and can chain further
   hint(val) {
-    nodbUtil.checkArgCount(arguments, 1, 1);
-    nodbUtil.assert(typeof val === 'string', 'NJS-005', 1);
+    errors.assertArgCount(arguments, 1, 1);
+    errors.assertParamValue(typeof val === 'string', 1);
     this._options.hint = val;
     return this;
   }
 
   // key - a non-terminal function and can chain further
   key(k) {
-    nodbUtil.checkArgCount(arguments, 1, 1);
-    nodbUtil.assert(typeof k === 'string', 'NJS-005', 1);
+    errors.assertArgCount(arguments, 1, 1);
+    errors.assertParamValue(typeof k === 'string', 1);
     this._options.key = k;
     this._options.keys = undefined;
     return this;
@@ -164,11 +169,11 @@ class SodaOperation {
 
   // keys - a non-terminal function and can chain further
   keys(arr) {
-    nodbUtil.checkArgCount(arguments, 1, 1);
-    nodbUtil.assert(Array.isArray(arr), 'NJS-005', 1);
+    errors.assertArgCount(arguments, 1, 1);
+    errors.assertParamValue(Array.isArray(arr), 1);
 
     for (let i = 0; i < arr.length; i++) {
-      nodbUtil.assert(typeof arr[i] === 'string', 'NJS-005', 1);
+      errors.assertParamValue(typeof arr[i] === 'string', 1);
     }
 
     this._options.keys = arr;
@@ -178,29 +183,37 @@ class SodaOperation {
 
   // limit property - a non-terminal function and can chain further
   limit(n) {
-    nodbUtil.checkArgCount(arguments, 1, 1);
-    nodbUtil.assert(typeof n === 'number', 'NJS-005', 1);
+    errors.assertArgCount(arguments, 1, 1);
+    errors.assertParamValue(typeof n === 'number', 1);
     this._options.limit = n;
     return this;
   }
 
   // skip property - a non-terminal function and can chain further
   skip(n) {
-    nodbUtil.checkArgCount(arguments, 1, 1);
-    nodbUtil.assert(typeof n === 'number', 'NJS-005', 1);
+    errors.assertArgCount(arguments, 1, 1);
+    errors.assertParamValue(typeof n === 'number', 1);
     this._options.skip = n;
     return this;
   }
 
   // version property - a non-terminal function and can chain further
   version(v) {
-    nodbUtil.checkArgCount(arguments, 1, 1);
-    nodbUtil.assert(typeof v === 'string', 'NJS-005', 1);
+    errors.assertArgCount(arguments, 1, 1);
+    errors.assertParamValue(typeof v === 'string', 1);
     this._options.version = v;
     return this;
   }
 
 }
 
+nodbUtil.wrapFns(SodaOperation.prototype,
+  "count",
+  "getCursor",
+  "getDocuments",
+  "getOne",
+  "remove",
+  "replaceOne",
+  "replaceOneAndGet");
 
 module.exports = SodaOperation;