graphile-build-pg 4.4.5 → 4.5.3

package/README.md

@@ -24,7 +24,8 @@ And please give some love to our featured sponsors 🤩:
 
 <table><tr>
 <td align="center"><a href="http://chads.website/"><img src="https://www.graphile.org/images/sponsors/chadf.png" width="90" height="90" alt="Chad Furman" /><br />Chad Furman</a></td>
-<td align="center"><a href="https://timescale.com/"><img src="https://www.graphile.org/images/sponsors/timescale.svg" width="90" height="90" alt="Timescale" /><br />Timescale</a></td>
+<td align="center"><a href="https://storyscript.io/?utm_source=postgraphile"><img src="https://www.graphile.org/images/sponsors/storyscript.png" width="90" height="90" alt="Storyscript" /><br />Storyscript</a></td>
+<td align="center"><a href="http://p72.vc/"><img src="https://www.graphile.org/images/sponsors/p72.png" width="90" height="90" alt="Point72 Ventures" /><br />Point72 Ventures</a></td>
 </tr></table>
 
 <!-- SPONSORS_END -->

package/node8plus/QueryBuilder.d.ts

@@ -42,8 +42,8 @@ export default class QueryBuilder {
   public setOrderIsUnique(): void;
   public orderBy(
     exprGen: SQLGen,
-    ascending: boolean,
-    nullsFirst: boolean | null
+    ascending?: boolean,
+    nullsFirst?: boolean | null
   ): void;
   public limit(limitGen: NumberGen): void;
   public offset(offsetGen: NumberGen): void;
@@ -93,6 +93,14 @@ export default class QueryBuilder {
     addNotDistinctFromNullCase?: boolean;
     useAsterisk?: boolean;
   }): SQL;
+  public buildChild(): QueryBuilder;
+  public buildNamedChildSelecting(
+    name: RawAlias,
+    from: SQLGen,
+    selectExpression: SQLGen,
+    alias?: SQLAlias
+  ): QueryBuilder;
+  public getNamedChild(name: RawAlias): QueryBuilder | undefined;
 
   // ----------------------------------------
 

package/node8plus/QueryBuilder.js

@@ -70,6 +70,7 @@ class QueryBuilder {
       // As a performance optimisation, we're going to list a number of lock
       // types so that V8 doesn't need to mutate the object too much
       cursorComparator: false,
+      fixedSelectExpression: false,
       select: false,
       selectCursor: false,
       from: false,
@@ -88,6 +89,7 @@ class QueryBuilder {
     this.data = {
       // TODO: refactor `cursorPrefix`, it shouldn't be here (or should at least have getters/setters)
       cursorPrefix: ["natural"],
+      fixedSelectExpression: null,
       select: [],
       selectCursor: null,
       from: null,
@@ -107,6 +109,7 @@ class QueryBuilder {
         // As a performance optimisation, we're going to list a number of lock
         // types so that V8 doesn't need to mutate the object too much
         cursorComparator: [],
+        fixedSelectExpression: [],
         select: [],
         selectCursor: [],
         from: [],
@@ -125,6 +128,7 @@ class QueryBuilder {
     };
     this.compiledData = {
       cursorPrefix: ["natural"],
+      fixedSelectExpression: null,
       select: [],
       selectCursor: null,
       from: null,
@@ -142,6 +146,7 @@ class QueryBuilder {
       last: null,
       cursorComparator: null
     };
+    this._children = new Map();
     this.beforeLock("select", () => {
       this.lock("selectCursor");
 
@@ -259,9 +264,28 @@ ${sql.join(Object.keys(allRequirements).map(key => sql.fragment`, ${sql.literal(
       this.compiledData.cursorComparator(cursorValue, isAfter);
     });
   }
+  /** this method is experimental */
+
+
+  fixedSelectExpression(exprGen) {
+    this.checkLock("fixedSelectExpression");
+    this.lock("select");
+    this.lock("selectCursor");
+
+    if (this.data.select.length > 0) {
+      throw new Error("Cannot use .fixedSelectExpression() with .select()");
+    }
+
+    if (this.data.selectCursor) {
+      throw new Error("Cannot use .fixedSelectExpression() with .selectCursor()");
+    }
+
+    this.data.fixedSelectExpression = exprGen;
+  }
 
   select(exprGen, alias) {
     this.checkLock("select");
+    this.lock("fixedSelectExpression");
 
     if (typeof alias === "string") {
       // To protect against vulnerabilities such as
@@ -293,6 +317,7 @@ ${sql.join(Object.keys(allRequirements).map(key => sql.fragment`, ${sql.literal(
 
   selectCursor(exprGen) {
     this.checkLock("selectCursor");
+    this.lock("fixedSelectExpression");
     this.data.selectCursor = exprGen;
   }
 
@@ -489,6 +514,11 @@ ${sql.join(Object.keys(allRequirements).map(key => sql.fragment`, ${sql.literal(
 
   buildSelectFields() {
     this.lockEverything();
+
+    if (this.compiledData.fixedSelectExpression) {
+      return this.compiledData.fixedSelectExpression;
+    }
+
     return sql.join(this.compiledData.select.map(([sqlFragment, alias]) => sql.fragment`to_json(${sqlFragment}) as ${sql.identifier(alias)}`), ", ");
   }
 
@@ -565,6 +595,14 @@ ${sql.join(Object.keys(allRequirements).map(key => sql.fragment`, ${sql.literal(
   }
 
   build(options = {}) {
+    this.lockEverything();
+
+    if (this.compiledData.fixedSelectExpression) {
+      if (Object.keys(options).length > 0) {
+        throw new Error("Do not pass options to QueryBuilder.build() when using `buildNamedChildSelecting`");
+      }
+    }
+
     const {
       asJson = false,
       asJsonAggregate = false,
@@ -573,7 +611,6 @@ ${sql.join(Object.keys(allRequirements).map(key => sql.fragment`, ${sql.literal(
       addNotDistinctFromNullCase = false,
       useAsterisk = false
     } = options;
-    this.lockEverything();
 
     if (onlyJsonField) {
       return this.buildSelectJson({
@@ -609,9 +646,15 @@ with ${sql.identifier(flipAlias)} as (
 select *
 from ${sql.identifier(flipAlias)}
 order by (row_number() over (partition by 1)) desc`;
+      /* We don't need to factor useAsterisk into this row_number() usage */
     }
 
     if (useAsterisk) {
+      /*
+       * NOTE[useAsterisk/row_number]: since LIMIT/OFFSET is inside this
+       * subquery, row_number() outside of this subquery WON'T include the
+       * offset. We must add it back wherever row_number() is used.
+       */
       fragment = sql.fragment`select ${fields} from (${fragment}) ${this.getTableAlias()}`;
     }
 
@@ -656,6 +699,8 @@ order by (row_number() over (partition by 1)) desc`;
       // Handle properties separately
       this.compiledData[type].lower = callIfNecessaryArray(this.data[type].lower, context);
       this.compiledData[type].upper = callIfNecessaryArray(this.data[type].upper, context);
+    } else if (type === "fixedSelectExpression") {
+      this.compiledData[type] = callIfNecessary(this.data[type], context);
     } else if (type === "select") {
       /*
        * NOTICE: locking select can cause additional selects to be added, so the
@@ -743,9 +788,43 @@ order by (row_number() over (partition by 1)) desc`;
     this.lock("first");
     this.lock("last"); // We must execute select after orderBy otherwise we cannot generate a cursor
 
+    this.lock("fixedSelectExpression");
     this.lock("selectCursor");
     this.lock("select");
   }
+  /** this method is experimental */
+
+
+  buildChild() {
+    const options = {
+      supportsJSONB: this.supportsJSONB
+    };
+    const child = new QueryBuilder(options, this.context, this.rootValue);
+    child.parentQueryBuilder = this;
+    return child;
+  }
+  /** this method is experimental */
+
+
+  buildNamedChildSelecting(name, from, selectExpression, alias) {
+    if (this._children.has(name)) {
+      throw new Error(`QueryBuilder already has a child named ${name.toString()}`);
+    }
+
+    const child = this.buildChild();
+    child.from(from, alias);
+    child.fixedSelectExpression(selectExpression);
+
+    this._children.set(name, child);
+
+    return child;
+  }
+  /** this method is experimental */
+
+
+  getNamedChild(name) {
+    return this._children.get(name);
+  }
 
 }
 

package/node8plus/QueryBuilder.js.flow

@@ -80,6 +80,7 @@ class QueryBuilder {
   selectedIdentifiers: boolean;
   data: {
     cursorPrefix: Array<string>,
+    fixedSelectExpression: ?SQLGen,
     select: Array<[SQLGen, RawAlias]>,
     selectCursor: ?SQLGen,
     from: ?[SQLGen, SQLAlias],
@@ -106,6 +107,7 @@ class QueryBuilder {
   };
   compiledData: {
     cursorPrefix: Array<string>,
+    fixedSelectExpression: ?SQL,
     select: Array<[SQL, RawAlias]>,
     selectCursor: ?SQL,
     from: ?[SQL, SQLAlias],
@@ -126,6 +128,7 @@ class QueryBuilder {
   lockContext: {
     queryBuilder: QueryBuilder,
   };
+  _children: Map<RawAlias, QueryBuilder>;
 
   constructor(
     options: QueryBuilderOptions = {},
@@ -144,6 +147,7 @@ class QueryBuilder {
       // As a performance optimisation, we're going to list a number of lock
       // types so that V8 doesn't need to mutate the object too much
       cursorComparator: false,
+      fixedSelectExpression: false,
       select: false,
       selectCursor: false,
       from: false,
@@ -162,6 +166,7 @@ class QueryBuilder {
     this.data = {
       // TODO: refactor `cursorPrefix`, it shouldn't be here (or should at least have getters/setters)
       cursorPrefix: ["natural"],
+      fixedSelectExpression: null,
       select: [],
       selectCursor: null,
       from: null,
@@ -181,6 +186,7 @@ class QueryBuilder {
         // As a performance optimisation, we're going to list a number of lock
         // types so that V8 doesn't need to mutate the object too much
         cursorComparator: [],
+        fixedSelectExpression: [],
         select: [],
         selectCursor: [],
         from: [],
@@ -199,6 +205,7 @@ class QueryBuilder {
     };
     this.compiledData = {
       cursorPrefix: ["natural"],
+      fixedSelectExpression: null,
       select: [],
       selectCursor: null,
       from: null,
@@ -216,6 +223,7 @@ class QueryBuilder {
       last: null,
       cursorComparator: null,
     };
+    this._children = new Map();
     this.beforeLock("select", () => {
       this.lock("selectCursor");
       if (this.compiledData.selectCursor) {
@@ -363,8 +371,24 @@ ${sql.join(
       this.compiledData.cursorComparator(cursorValue, isAfter);
     });
   }
+  /** this method is experimental */
+  fixedSelectExpression(exprGen: SQLGen) {
+    this.checkLock("fixedSelectExpression");
+    this.lock("select");
+    this.lock("selectCursor");
+    if (this.data.select.length > 0) {
+      throw new Error("Cannot use .fixedSelectExpression() with .select()");
+    }
+    if (this.data.selectCursor) {
+      throw new Error(
+        "Cannot use .fixedSelectExpression() with .selectCursor()"
+      );
+    }
+    this.data.fixedSelectExpression = exprGen;
+  }
   select(exprGen: SQLGen, alias: RawAlias) {
     this.checkLock("select");
+    this.lock("fixedSelectExpression");
     if (typeof alias === "string") {
       // To protect against vulnerabilities such as
       //
@@ -403,6 +427,7 @@ ${sql.join(
   }
   selectCursor(exprGen: SQLGen) {
     this.checkLock("selectCursor");
+    this.lock("fixedSelectExpression");
     this.data.selectCursor = exprGen;
   }
   from(expr: SQLGen, alias?: SQLAlias = sql.identifier(Symbol())) {
@@ -572,6 +597,9 @@ ${sql.join(
   }
   buildSelectFields() {
     this.lockEverything();
+    if (this.compiledData.fixedSelectExpression) {
+      return this.compiledData.fixedSelectExpression;
+    }
     return sql.join(
       this.compiledData.select.map(
         ([sqlFragment, alias]) =>
@@ -675,6 +703,15 @@ ${sql.join(
       useAsterisk?: boolean,
     } = {}
   ) {
+    this.lockEverything();
+
+    if (this.compiledData.fixedSelectExpression) {
+      if (Object.keys(options).length > 0) {
+        throw new Error(
+          "Do not pass options to QueryBuilder.build() when using `buildNamedChildSelecting`"
+        );
+      }
+    }
     const {
       asJson = false,
       asJsonAggregate = false,
@@ -684,7 +721,6 @@ ${sql.join(
       useAsterisk = false,
     } = options;
 
-    this.lockEverything();
     if (onlyJsonField) {
       return this.buildSelectJson({ addNullCase, addNotDistinctFromNullCase });
     }
@@ -734,9 +770,14 @@ with ${sql.identifier(flipAlias)} as (
 )
 select *
 from ${sql.identifier(flipAlias)}
-order by (row_number() over (partition by 1)) desc`;
+order by (row_number() over (partition by 1)) desc`; /* We don't need to factor useAsterisk into this row_number() usage */
     }
     if (useAsterisk) {
+      /*
+       * NOTE[useAsterisk/row_number]: since LIMIT/OFFSET is inside this
+       * subquery, row_number() outside of this subquery WON'T include the
+       * offset. We must add it back wherever row_number() is used.
+       */
       fragment = sql.fragment`select ${fields} from (${fragment}) ${this.getTableAlias()}`;
     }
     if (asJsonAggregate) {
@@ -782,6 +823,8 @@ order by (row_number() over (partition by 1)) desc`;
         this.data[type].upper,
         context
       );
+    } else if (type === "fixedSelectExpression") {
+      this.compiledData[type] = callIfNecessary(this.data[type], context);
     } else if (type === "select") {
       /*
        * NOTICE: locking select can cause additional selects to be added, so the
@@ -871,9 +914,39 @@ order by (row_number() over (partition by 1)) desc`;
     this.lock("first");
     this.lock("last");
     // We must execute select after orderBy otherwise we cannot generate a cursor
+    this.lock("fixedSelectExpression");
     this.lock("selectCursor");
     this.lock("select");
   }
+  /** this method is experimental */
+  buildChild() {
+    const options = { supportsJSONB: this.supportsJSONB };
+    const child = new QueryBuilder(options, this.context, this.rootValue);
+    child.parentQueryBuilder = this;
+    return child;
+  }
+  /** this method is experimental */
+  buildNamedChildSelecting(
+    name: RawAlias,
+    from: SQLGen,
+    selectExpression: SQLGen,
+    alias?: SQLAlias
+  ) {
+    if (this._children.has(name)) {
+      throw new Error(
+        `QueryBuilder already has a child named ${name.toString()}`
+      );
+    }
+    const child = this.buildChild();
+    child.from(from, alias);
+    child.fixedSelectExpression(selectExpression);
+    this._children.set(name, child);
+    return child;
+  }
+  /** this method is experimental */
+  getNamedChild(name: string) {
+    return this._children.get(name);
+  }
 }
 
 export default QueryBuilder;