@naturalcycles/db-lib 8.29.0 → 8.30.0

package/dist/commondao/common.dao.d.ts

@@ -39,6 +39,7 @@ export declare class CommonDao<BM extends Partial<ObjectWithId>, DBM extends Obj
      */
     query(table?: string): RunnableDBQuery<BM, DBM, TM>;
     runQuery(q: DBQuery<DBM>, opt?: CommonDaoOptions): Promise<Saved<BM>[]>;
+    runQuerySingleColumn<T = any>(q: DBQuery<DBM>, opt?: CommonDaoOptions): Promise<T[]>;
     /**
      * Convenience method that runs multiple queries in parallel and then merges their results together.
      * Does deduplication by id.

package/dist/commondao/common.dao.js

@@ -184,6 +184,12 @@ class CommonDao {
         const { rows } = await this.runQueryExtended(q, opt);
         return rows;
     }
+    async runQuerySingleColumn(q, opt) {
+        (0, js_lib_1._assert)(q._selectedFieldNames?.length === 1, `runQuerySingleColumn requires exactly 1 column to be selected: ${q.pretty()}`);
+        const col = q._selectedFieldNames[0];
+        const { rows } = await this.runQueryExtended(q, opt);
+        return rows.map(r => r[col]);
+    }
     /**
      * Convenience method that runs multiple queries in parallel and then merges their results together.
      * Does deduplication by id.

package/dist/query/dbQuery.d.ts

@@ -65,6 +65,7 @@ export declare class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
      */
     _selectedFieldNames?: (keyof ROW)[];
     _groupByFieldNames?: (keyof ROW)[];
+    _distinct: boolean;
     filter(name: keyof ROW, op: DBQueryFilterOperator, val: any): this;
     filterEq(name: keyof ROW, val: any): this;
     limit(limit: number): this;
@@ -72,6 +73,7 @@ export declare class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
     order(name: keyof ROW, descending?: boolean): this;
     select(fieldNames: (keyof ROW)[]): this;
     groupBy(fieldNames: (keyof ROW)[]): this;
+    distinct(distinct?: boolean): this;
     startCursor(startCursor?: string): this;
     endCursor(endCursor?: string): this;
     clone(): DBQuery<ROW>;
@@ -88,6 +90,7 @@ export declare class RunnableDBQuery<BM extends Partial<ObjectWithId>, DBM exten
      */
     constructor(dao: CommonDao<BM, DBM, TM>, table?: string);
     runQuery(opt?: CommonDaoOptions): Promise<Saved<BM>[]>;
+    runQuerySingleColumn<T = any>(opt?: CommonDaoOptions): Promise<T[]>;
     runQueryAsDBM(opt?: CommonDaoOptions): Promise<DBM[]>;
     runQueryAsTM(opt?: CommonDaoOptions): Promise<TM[]>;
     runQueryExtended(opt?: CommonDaoOptions): Promise<RunQueryResult<Saved<BM>>>;

package/dist/query/dbQuery.js

@@ -30,6 +30,7 @@ class DBQuery {
         this._limitValue = 0; // 0 means "no limit"
         this._offsetValue = 0; // 0 means "no offset"
         this._orders = [];
+        this._distinct = false;
     }
     /**
      * Convenience method.
@@ -71,6 +72,10 @@ class DBQuery {
         this._groupByFieldNames = fieldNames;
         return this;
     }
+    distinct(distinct = true) {
+        this._distinct = distinct;
+        return this;
+    }
     startCursor(startCursor) {
         this._startCursor = startCursor;
         return this;
@@ -86,6 +91,8 @@ class DBQuery {
             _offsetValue: this._offsetValue,
             _orders: [...this._orders],
             _selectedFieldNames: this._selectedFieldNames && [...this._selectedFieldNames],
+            _groupByFieldNames: this._groupByFieldNames && [...this._groupByFieldNames],
+            _distinct: this._distinct,
             _startCursor: this._startCursor,
             _endCursor: this._endCursor,
         });
@@ -99,7 +106,7 @@ class DBQuery {
         //   tokens.push(`"${this.name}"`)
         // }
         if (this._selectedFieldNames) {
-            tokens.push(`select(${this._selectedFieldNames.join(',')})`);
+            tokens.push(`select${this._distinct ? ' distinct' : ''}(${this._selectedFieldNames.join(',')})`);
         }
         tokens.push(...this._filters.map(f => `${f.name}${f.op}${f.val}`), ...this._orders.map(o => `order by ${o.name}${o.descending ? ' desc' : ''}`));
         if (this._groupByFieldNames) {
@@ -135,6 +142,9 @@ class RunnableDBQuery extends DBQuery {
     async runQuery(opt) {
         return await this.dao.runQuery(this, opt);
     }
+    async runQuerySingleColumn(opt) {
+        return await this.dao.runQuerySingleColumn(this, opt);
+    }
     async runQueryAsDBM(opt) {
         return await this.dao.runQueryAsDBM(this, opt);
     }

package/package.json

@@ -43,7 +43,7 @@
   "engines": {
     "node": ">=14.15"
   },
-  "version": "8.29.0",
+  "version": "8.30.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/commondao/common.dao.ts

@@ -1,4 +1,5 @@
 import {
+  _assert,
   _filterNullishValues,
   _filterUndefinedValues,
   _passthroughPredicate,
@@ -262,6 +263,18 @@ export class CommonDao<
     return rows
   }
 
+  async runQuerySingleColumn<T = any>(q: DBQuery<DBM>, opt?: CommonDaoOptions): Promise<T[]> {
+    _assert(
+      q._selectedFieldNames?.length === 1,
+      `runQuerySingleColumn requires exactly 1 column to be selected: ${q.pretty()}`,
+    )
+
+    const col = q._selectedFieldNames[0]!
+
+    const { rows } = await this.runQueryExtended(q, opt)
+    return rows.map(r => r[col as any])
+  }
+
   /**
    * Convenience method that runs multiple queries in parallel and then merges their results together.
    * Does deduplication by id.

package/src/query/dbQuery.ts

@@ -97,6 +97,7 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
    */
   _selectedFieldNames?: (keyof ROW)[]
   _groupByFieldNames?: (keyof ROW)[]
+  _distinct = false
 
   filter(name: keyof ROW, op: DBQueryFilterOperator, val: any): this {
     this._filters.push({ name, op, val })
@@ -136,6 +137,11 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
     return this
   }
 
+  distinct(distinct = true): this {
+    this._distinct = distinct
+    return this
+  }
+
   startCursor(startCursor?: string): this {
     this._startCursor = startCursor
     return this
@@ -153,6 +159,8 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
       _offsetValue: this._offsetValue,
       _orders: [...this._orders],
       _selectedFieldNames: this._selectedFieldNames && [...this._selectedFieldNames],
+      _groupByFieldNames: this._groupByFieldNames && [...this._groupByFieldNames],
+      _distinct: this._distinct,
       _startCursor: this._startCursor,
       _endCursor: this._endCursor,
     })
@@ -170,7 +178,9 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
     // }
 
     if (this._selectedFieldNames) {
-      tokens.push(`select(${this._selectedFieldNames.join(',')})`)
+      tokens.push(
+        `select${this._distinct ? ' distinct' : ''}(${this._selectedFieldNames.join(',')})`,
+      )
     }
 
     tokens.push(
@@ -221,6 +231,10 @@ export class RunnableDBQuery<
     return await this.dao.runQuery(this, opt)
   }
 
+  async runQuerySingleColumn<T = any>(opt?: CommonDaoOptions): Promise<T[]> {
+    return await this.dao.runQuerySingleColumn<T>(this, opt)
+  }
+
   async runQueryAsDBM(opt?: CommonDaoOptions): Promise<DBM[]> {
     return await this.dao.runQueryAsDBM(this, opt)
   }