oracledb 5.5.0 → 6.0.0

package/lib/sodaDatabase.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,82 +26,64 @@
 
 'use strict';
 
+const SodaCollection = require('./sodaCollection.js');
+const SodaDocument = require('./sodaDocument.js');
+const errors = require('./errors.js');
 const nodbUtil = require('./util.js');
-
-//-----------------------------------------------------------------------------
-// createCollection()
-//   Creates a SODA collection.
-//-----------------------------------------------------------------------------
-async function createCollection(name, a2) {
-  let options = {};
-
-  nodbUtil.checkArgCount(arguments, 1, 2);
-  nodbUtil.assert(typeof name === 'string', 'NJS-005', 1);
-
-  if (arguments.length == 2) {
-    nodbUtil.assert(nodbUtil.isObject(a2), 'NJS-005', 2);
-    options = a2;
-    if (options.metaData) {
-      if (!nodbUtil.isObject(options.metaData)) {
-        throw new Error(nodbUtil.getErrorMessage('NJS-005', 2));
-      }
-      options.metaData = JSON.stringify(options.metaData);
-    }
-  }
-
-  return await this._createCollection(name, options);
-}
-
-
-//-----------------------------------------------------------------------------
-// openCollection()
-//   Open an existing SODA collection and return it to the caller.
-//-----------------------------------------------------------------------------
-async function openCollection(name) {
-  nodbUtil.checkArgCount(arguments, 1, 1);
-  nodbUtil.assert(typeof name === 'string', 'NJS-005', 1);
-  return await this._openCollection(name);
-}
-
-
-//-----------------------------------------------------------------------------
-// getCollectionNames()
-//   Return an array of the names of the collections in the database.
-//-----------------------------------------------------------------------------
-async function getCollectionNames(a1) {
-  let options = {};
-
-  nodbUtil.checkArgCount(arguments, 0, 1);
-  if (arguments.length == 1) {
-    nodbUtil.assert(nodbUtil.isObject(a1), 'NJS-005', 1);
-    options = a1;
-  }
-  return await this._getCollectionNames(options);
-}
-
+const settings = require('./settings.js');
 
 class SodaDatabase {
 
-  _extend() {
-    this.createCollection = nodbUtil.callbackify(nodbUtil.serialize(createCollection));
-    this.getCollectionNames = nodbUtil.callbackify(nodbUtil.serialize(getCollectionNames));
-    this.openCollection = nodbUtil.callbackify(nodbUtil.serialize(openCollection));
-  }
-
   _getConnection() {
     return this._connection;
   }
 
-  // To create a SODA document object based content and (optional) other fields
+  //---------------------------------------------------------------------------
+  // createCollection()
+  //
+  // Creates a SODA collection.
+  //---------------------------------------------------------------------------
+  async createCollection(name, a2) {
+    const options = {autoCommit: settings.autoCommit};
+
+    errors.assertArgCount(arguments, 1, 2);
+    errors.assertParamValue(typeof name === 'string', 1);
+
+    if (arguments.length == 2) {
+      errors.assertParamValue(nodbUtil.isObject(a2), 2);
+      if (a2.mode !== undefined) {
+        errors.assertParamPropValue(Number.isInteger(a2.mode) && a2.mode > 0,
+          2, "mode");
+        options.mode = a2.mode;
+      }
+      if (a2.metaData !== undefined) {
+        errors.assertParamPropValue(nodbUtil.isObject(a2.metaData), 2,
+          "metaData");
+        options.metaData = JSON.stringify(a2.metaData);
+      }
+    }
+
+    const coll = new SodaCollection();
+    coll._impl = await this._impl.createCollection(name, options);
+    return coll;
+  }
+
+  //---------------------------------------------------------------------------
+  // createDocument()
+  //
+  // Creates a SODA document.
+  //---------------------------------------------------------------------------
   createDocument(content, a2) {
     let options = {};
 
-    nodbUtil.checkArgCount(arguments, 1, 2);
-    nodbUtil.assert(Buffer.isBuffer(content) || typeof content === 'string' ||
-        nodbUtil.isObject(content), 'NJS-005', 1);
+    errors.assertArgCount(arguments, 1, 2);
+    errors.assertParamValue(Buffer.isBuffer(content) ||
+        typeof content === 'string' || nodbUtil.isObject(content), 1);
     if (arguments.length > 1) {
-      nodbUtil.assert(nodbUtil.isObject(a2), 'NJS-005', 2);
+      errors.assertParamValue(nodbUtil.isObject(a2), 2);
       options = a2;
+      errors.assertParamPropString(options, 2, "key");
+      errors.assertParamPropString(options, 2, "mediaType");
     }
 
     if (typeof content === 'string') {
@@ -103,10 +92,57 @@ class SodaDatabase {
       content = Buffer.from(JSON.stringify(content));
     }
 
-    return this._createDocument(content, options);
+    const doc = new SodaDocument();
+    doc._impl = this._impl.createDocument(content, options);
+    return doc;
+  }
+
+  //---------------------------------------------------------------------------
+  // getCollectionNames()
+  //
+  // Return an array of the names of the collections in the database.
+  //---------------------------------------------------------------------------
+  async getCollectionNames(a1) {
+    let options = {};
+
+    errors.assertArgCount(arguments, 0, 1);
+    if (arguments.length == 1) {
+      errors.assertParamValue(nodbUtil.isObject(a1), 1);
+      options = a1;
+      if (options.startsWith !== undefined) {
+        errors.assertParamPropValue(typeof options.startsWith === 'string', 1,
+          "startsWith");
+      }
+      if (options.limit !== undefined) {
+        errors.assertParamPropValue(Number.isInteger(options.limit), 1,
+          "limit");
+      }
+    }
+    return await this._impl.getCollectionNames(options);
+  }
+
+  //---------------------------------------------------------------------------
+  // openCollection()
+  //
+  // Open an existing SODA collection and return it to the caller.
+  //---------------------------------------------------------------------------
+  async openCollection(name) {
+    errors.assertArgCount(arguments, 1, 1);
+    errors.assertParamValue(typeof name === 'string', 1);
+    const options = {autoCommit: settings.autoCommit};
+    const collImpl = await this._impl.openCollection(name, options);
+    if (collImpl) {
+      const coll = new SodaCollection();
+      coll._impl = collImpl;
+      return coll;
+    }
   }
 
 }
 
+nodbUtil.wrapFns(SodaDatabase.prototype,
+  "createCollection",
+  "getCollectionNames",
+  "openCollection");
 
 module.exports = SodaDatabase;

package/lib/sodaDocCursor.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,39 +26,44 @@
 
 'use strict';
 
+const errors = require('./errors.js');
 const nodbUtil = require('./util.js');
-
-//-----------------------------------------------------------------------------
-// getNext()
-//   Return the new document available from the cursor.
-//-----------------------------------------------------------------------------
-async function getNext() {
-  nodbUtil.checkArgCount(arguments, 0, 0);
-  return await this._getNext();
-}
-
-
-//-----------------------------------------------------------------------------
-// close()
-//   Close the cursor and make it unusable for further operations.
-//----------------------------------------------------------------------------
-async function close() {
-  nodbUtil.checkArgCount(arguments, 0, 0);
-  await this._close();
-}
-
+const SodaDocument = require('./sodaDocument.js');
 
 class SodaDocCursor {
 
-  _extend() {
-    this.close = nodbUtil.callbackify(nodbUtil.serialize(close));
-    this.getNext = nodbUtil.callbackify(nodbUtil.serialize(getNext));
+  //---------------------------------------------------------------------------
+  // close()
+  //
+  // Close the cursor and make it unusable for further operations.
+  //--------------------------------------------------------------------------
+  async close() {
+    errors.assertArgCount(arguments, 0, 0);
+    errors.assert(this._impl, errors.ERR_INVALID_SODA_DOC_CURSOR);
+    await this._impl.close();
+    delete this._impl;
   }
 
-  _getConnection() {
-    return this._operation._getConnection();
+  //---------------------------------------------------------------------------
+  // getNext()
+  //
+  // Return the next document available from the cursor.
+  //---------------------------------------------------------------------------
+  async getNext() {
+    errors.assertArgCount(arguments, 0, 0);
+    errors.assert(this._impl, errors.ERR_INVALID_SODA_DOC_CURSOR);
+    const docImpl = await this._impl.getNext();
+    if (docImpl) {
+      const doc = new SodaDocument();
+      doc._impl = docImpl;
+      return doc;
+    }
   }
 
 }
 
+nodbUtil.wrapFns(SodaDocCursor.prototype,
+  "close",
+  "getNext");
+
 module.exports = SodaDocCursor;

package/lib/sodaDocument.js

@@ -2,16 +2,23 @@
 
 //-----------------------------------------------------------------------------
 //
-// 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.
 //
@@ -21,25 +28,80 @@
 
 class SodaDocument {
 
-  _extend() {
-    this._sodaDocumentMarker = true;
+  //---------------------------------------------------------------------------
+  // createdOn
+  //
+  // Property for the created date of the document.
+  //---------------------------------------------------------------------------
+  get createdOn() {
+    return this._impl.getCreatedOn();
   }
 
-  // returns the document content as a Javascript object
+  //---------------------------------------------------------------------------
+  // getContent()
+  //
+  // Returns the document content as a Javascript object.
+  //---------------------------------------------------------------------------
   getContent() {
-    return JSON.parse(this._getContentAsString());
+    return JSON.parse(this._impl.getContentAsString());
   }
 
-  // returns the document content as a buffer
+  //---------------------------------------------------------------------------
+  // getContentAsBuffer()
+  //
+  // Returns the document content as a buffer.
+  //---------------------------------------------------------------------------
   getContentAsBuffer() {
-    return this._getContentAsBuffer();
+    return this._impl.getContentAsBuffer();
   }
 
-  // returns the document content as a string
+  //---------------------------------------------------------------------------
+  // getContentAsString()
+  //
+  // Returns the document content as a string.
+  //---------------------------------------------------------------------------
   getContentAsString() {
-    return this._getContentAsString();
+    return this._impl.getContentAsString();
+  }
+
+  //---------------------------------------------------------------------------
+  // key
+  //
+  // Property for the key of the document.
+  //---------------------------------------------------------------------------
+  get key() {
+    return this._impl.getKey();
+  }
+
+  //---------------------------------------------------------------------------
+  // lastModified
+  //
+  // Property for the last modified date of the document.
+  //---------------------------------------------------------------------------
+  get lastModified() {
+    return this._impl.getLastModified();
+  }
+
+  //---------------------------------------------------------------------------
+  // mediaType
+  //
+  // Property for the media type of the document.
+  //---------------------------------------------------------------------------
+  get mediaType() {
+    return this._impl.getMediaType();
+  }
+
+  //---------------------------------------------------------------------------
+  // verison
+  //
+  // Property for the version of the document.
+  //---------------------------------------------------------------------------
+  get version() {
+    return this._impl.getVersion();
   }
 
 }
 
+SodaDocument.prototype._sodaDocumentMarker = true;
+
 module.exports = SodaDocument;