mongodb-ops 0.9.3 → 0.10.0

package/lib/mongodb-ops.js

@@ -92,28 +92,29 @@ class MongoDBOps {
    * @param {object} [pagination] Pagination `E.g., { startIndex: 11, endIndex: 20 }`
    * @param {boolean} [isGetCount=false] Set true to get the number of doc count based on the queryExp
    * @param {string} connString Database connection string
+   * @param {object} [collation] Collation {@link https://www.mongodb.com/docs/manual/reference/collation/#std-label-collation-document-fields}
+   * @param {object} [options] Aggregate options {@link https://www.mongodb.com/docs/manual/reference/method/db.collection.aggregate/}
    * @returns {promise} Promise with object array
    */
-  static async getData(collectionName, queryExp, isAggregate = false, projection, sort, pagination, isGetCount = false, connString) {   
+  static async getData(collectionName, queryExp, isAggregate = false, projection, sort, pagination, isGetCount = false, connString, collation, options) {   
     const db = (await MongoDBOps.getDbClient(connString)).db();
+    
+    if (isAggregate) { return Promise.resolve(await db.collection(collectionName).aggregate(queryExp, options).toArray()); }
 
-    let docs;
-    if (isAggregate) { docs = await db.collection(collectionName).aggregate(queryExp).toArray(); }
-    else {
-      queryExp = queryExp || {};
-      projection = { projection: projection || {} };
+    queryExp = queryExp || {};
+    if (isGetCount) { return Promise.resolve(await db.collection(collectionName).countDocuments(queryExp)); }
 
-      const { skip, limit } = parsePagination(pagination);
-      if (limit < 1) { return Promise.resolve([]); }
+    const { skip, limit } = parsePagination(pagination);
+    if (limit < 1) { return Promise.resolve([]); }
 
-      if (isGetCount) { docs = await db.collection(collectionName).countDocuments(queryExp); }
-      else if (sort && pagination) { docs = await db.collection(collectionName).find(queryExp, projection).sort(sort).skip(skip).limit(limit).toArray(); }
-      else if (!sort && pagination) { docs = await db.collection(collectionName).find(queryExp, projection).skip(skip).limit(limit).toArray(); }
-      else if (sort && !pagination) { docs = await db.collection(collectionName).find(queryExp, projection).sort(sort).toArray(); }
-      else { docs = await db.collection(collectionName).find(queryExp, projection).toArray(); }
-    }
+    projection = { projection: projection || {} };
+    
+    let data = db.collection(collectionName).find(queryExp, projection);
+    if (sort) { data = data.sort(sort); }
+    if (pagination) { data = data.skip(skip).limit(limit); }
+    if (collation) { data = data.collation(collation); }
 
-    return Promise.resolve(docs);
+    return Promise.resolve(await data.toArray());
   }
 
   /**
@@ -128,13 +129,14 @@ class MongoDBOps {
    * @param {object} [sort] Sort {@link https://docs.mongodb.com/manual/reference/method/cursor.sort/#cursor.sort}
    * @param {object} [pagination] Pagination `E.g., { startIndex: 11, endIndex: 20 }`
    * @param {boolean} [isGetCount=false] Set true to get the number of doc count based on the queryExp
+   * @param {object} [collation] Collation {@link https://www.mongodb.com/docs/manual/reference/collation/#std-label-collation-document-fields}
+   * @param {object} [options] Aggregate options {@link https://www.mongodb.com/docs/manual/reference/method/db.collection.aggregate/}
    * @returns {promise} Promise with object array
    */
-  async getData(collectionName, queryExp, isAggregate, projection, sort, pagination, isGetCount) {
-    return Promise.resolve(await MongoDBOps.getData(collectionName, queryExp, isAggregate, projection, sort, pagination, isGetCount, this.connString));
+  async getData(collectionName, queryExp, isAggregate, projection, sort, pagination, isGetCount, collation, options) {
+    return Promise.resolve(await MongoDBOps.getData(collectionName, queryExp, isAggregate, projection, sort, pagination, isGetCount, this.connString, collation, options));
   }
 
-
   /**
    * Static method - Use altas search at MongoDB
    * {@link https://www.mongodb.com/docs/atlas/atlas-search/}

package/lib/mongodb-tool-set.js

@@ -46,11 +46,12 @@ class MongoDBToolSet extends MongoDBOps {
    * @param {object} [projection] Projection {@link https://docs.mongodb.com/manual/reference/method/db.collection.find/#find-projection}
    * @param {object} [sort] Sort filter {@link https://docs.mongodb.com/manual/reference/method/cursor.sort/#cursor.sort} 
    * @param {object} [pagination] Pagination `E.g., { startIndex: 11, endIndex: 20 }`
-   * @param {string} connString Database connection string 
+   * @param {string} connString Database connection string
+   * @param {object} [collation] Collation {@link https://www.mongodb.com/docs/manual/reference/collation/#std-label-collation-document-fields}
    * @returns {promise} Promise with object array
    */
-  static async getDataByFilter(collectionName, filter, projection, sort, pagination, connString) {
-    return Promise.resolve(await MongoDBOps.getData(collectionName, filter, false, projection, sort, pagination, undefined, connString));
+  static async getDataByFilter(collectionName, filter, projection, sort, pagination, connString, collation) {
+    return Promise.resolve(await MongoDBOps.getData(collectionName, filter, false, projection, sort, pagination, undefined, connString, collation));
   }
 
   /**
@@ -60,9 +61,32 @@ class MongoDBToolSet extends MongoDBOps {
    * @param {object} [projection] Projection {@link https://docs.mongodb.com/manual/reference/method/db.collection.find/#find-projection}
    * @param {object} [sort] Sort filter {@link https://docs.mongodb.com/manual/reference/method/cursor.sort/#cursor.sort} 
    * @param {object} [pagination] Pagination `E.g., { startIndex: 11, endIndex: 20 }`
+   * @param {object} [collation] Collation {@link https://www.mongodb.com/docs/manual/reference/collation/#std-label-collation-document-fields}
+   * @returns {promise} Promise with object array
+   */
+  async getDataByFilter(filter, projection, sort, pagination, collation) { return Promise.resolve(await MongoDBToolSet.getDataByFilter(this.collectionName, filter, projection, sort, pagination, this.connString, collation)); }
+
+  /**
+   * Static method - Get data by aggregate
+   * 
+   * @param {string} collectionName Collection name 
+   * @param {array} pipeline Aggregate pipeline {@link https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/}
+   * @param {string} connString Database connection string
+   * @param {object} [options] Aggregate options {@link https://www.mongodb.com/docs/manual/reference/method/db.collection.aggregate/}
+   * @returns {promise} Promise with object array
+   */
+  static async getDataByAggregate(collectionName, pipeline, connString, options) {
+    return Promise.resolve(await MongoDBOps.getData(collectionName, pipeline, true, undefined, undefined, undefined, undefined, connString, undefined, options));
+  }
+
+  /**
+   * Instance method - Get data by aggregate
+   * 
+   * @param {array} pipeline Aggregate pipeline {@link https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/}
+   * @param {object} [options] Aggregate options {@link https://www.mongodb.com/docs/manual/reference/method/db.collection.aggregate/}
    * @returns {promise} Promise with object array
    */
-  async getDataByFilter(filter, projection, sort, pagination,) { return Promise.resolve(await MongoDBToolSet.getDataByFilter(this.collectionName, filter, projection, sort, pagination, this.connString)); }
+  async getDataByAggregate(pipeline, options) { return Promise.resolve(await MongoDBToolSet.getDataByAggregate(this.collectionName, pipeline, this.connString, options)); }
 
   /**
    * Static method - Get data count by query

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb-ops",
-  "version": "0.9.3",
+  "version": "0.10.0",
   "description": "Read and write ops for MongoDB",
   "main": "index.js",
   "scripts": {