@graffy/pg 0.16.20 → 0.16.21-alpha.2

package/index.cjs

@@ -3,6 +3,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const common = require("@graffy/common");
 const debug = require("debug");
 const pg$1 = require("pg");
+const sqlFormatter = require("sql-formatter");
 class Sql {
   constructor(rawStrings, rawValues) {
     if (rawStrings.length - 1 !== rawValues.length) {
@@ -79,6 +80,20 @@ const empty = raw("");
 function sql(strings, ...values) {
   return new Sql(strings, values);
 }
+function formatSql(sql2) {
+  const strings = sql2.strings.slice(0);
+  const values = sql2.values.slice(0);
+  const output = [];
+  while (strings.length) {
+    output.push(strings.shift().replace(/\s+/g, " "));
+    if (!values.length) break;
+    const value = values.shift();
+    output.push(
+      typeof value === "number" ? value.toString() : typeof value === "object" ? `'${JSON.stringify(value)}'` : `'${value}'`
+    );
+  }
+  return sqlFormatter.format(output.join("").trim(), { language: "postgresql" });
+}
 const getJsonBuildTrusted = (variadic) => {
   const args = join(
     Object.entries(variadic).map(([name, value]) => {
@@ -157,23 +172,23 @@ const getSelectCols = (options, projection = null) => {
       sqls.push(
         sql`jsonb_build_object(${join(subSqls, ", ")}) AS "${raw(key)}"`
       );
+    }
+    if (key[0] === "$") continue;
+    if (typeof projection[key] === "object") {
+      const optimisedJsonBuild = getOptimisedJsonBuild(
+        projection[key],
+        [],
+        key,
+        options
+      );
+      sqls.push(
+        sql`jsonb_build_object(${join(optimisedJsonBuild, ", ")}) AS "${raw(key)}"`
+      );
     } else {
-      if (typeof projection[key] === "object") {
-        const optimisedJsonBuild = getOptimisedJsonBuild(
-          projection[key],
-          [],
-          key,
-          options
-        );
-        sqls.push(
-          sql`jsonb_build_object(${join(optimisedJsonBuild, ", ")}) AS "${raw(key)}"`
-        );
-      } else {
-        sqls.push(sql`"${raw(key)}"`);
-      }
+      sqls.push(sql`"${raw(key)}"`);
     }
   }
-  return join(sqls, ", ");
+  return sqls.length ? join(sqls, ", ") : sql`TRUE AS "$"`;
 };
 function vertexSql(array, nullValue) {
   return sql`array[${join(
@@ -754,7 +769,7 @@ class Db {
   /*
     Adds .schema to tableOptions if it doesn't exist yet.
     It mutates the argument, to "persist" the results and
-    avoid this query in every operation. 
+    avoid this query in every operation.
   */
   async ensureSchema(tableOptions, typeOids) {
     if (tableOptions.schema) return;
@@ -805,19 +820,33 @@ class Db {
     const prefix = common.encodePath(rawPrefix);
     await this.ensureSchema(tableOptions);
     const getByArgs = async (args, projection) => {
-      const result = await this.readSql(
-        selectByArgs(args, projection, tableOptions),
-        tableOptions
-      );
+      const sql2 = selectByArgs(args, projection, tableOptions);
+      const result = await this.readSql(sql2, tableOptions);
       const wrappedGraph = common.encodeGraph(common.wrapObject(result, rawPrefix));
       log("getByArgs", wrappedGraph);
       common.merge(results, wrappedGraph);
     };
-    const getByIds = async () => {
-      const result = await this.readSql(
-        selectByIds(Object.keys(idQueries), null, tableOptions),
-        tableOptions
+    const explainArgs = async (args, projection) => {
+      const { analyze, $explain: qArgs } = args;
+      const qSql = selectByArgs(qArgs, null, tableOptions);
+      const sql$1 = sql`EXPLAIN (${analyze ? sql`ANALYZE, BUFFERS, TIMING, ` : sql``}COSTS, VERBOSE, FORMAT JSON) ${qSql}`;
+      const result = await this.readSql(sql$1, tableOptions);
+      const wrappedGraph = common.encodeGraph(
+        common.wrapObject(
+          {
+            $key: args,
+            sql: formatSql(qSql),
+            plan: result[0]["QUERY PLAN"][0]
+          },
+          rawPrefix
+        )
       );
+      log("explainArgs", wrappedGraph);
+      common.merge(results, wrappedGraph);
+    };
+    const getByIds = async () => {
+      const sql2 = selectByIds(Object.keys(idQueries), null, tableOptions);
+      const result = await this.readSql(sql2, tableOptions);
       for (const object of result) {
         const wrappedGraph = common.encodeGraph(common.wrapObject(object, rawPrefix));
         log("getByIds", wrappedGraph);
@@ -836,7 +865,11 @@ class Db {
           }
         } else {
           const projection = node.children ? common.decodeQuery(node.children) : null;
-          promises.push(getByArgs(args, projection));
+          if (args.$explain) {
+            promises.push(explainArgs(args));
+          } else {
+            promises.push(getByArgs(args, projection));
+          }
         }
       } else {
         idQueries[args] = node.children;

package/index.mjs

@@ -1,6 +1,7 @@
 import { isEmpty, isPlainObject, encodePath, unwrap, decodeArgs, decodeQuery, finalize, wrap, isRange, cmp, decodeGraph, mergeObject, wrapObject, merge, encodeGraph, remove } from "@graffy/common";
 import debug from "debug";
 import pg$1 from "pg";
+import { format } from "sql-formatter";
 class Sql {
   constructor(rawStrings, rawValues) {
     if (rawStrings.length - 1 !== rawValues.length) {
@@ -77,6 +78,20 @@ const empty = raw("");
 function sql(strings, ...values) {
   return new Sql(strings, values);
 }
+function formatSql(sql2) {
+  const strings = sql2.strings.slice(0);
+  const values = sql2.values.slice(0);
+  const output = [];
+  while (strings.length) {
+    output.push(strings.shift().replace(/\s+/g, " "));
+    if (!values.length) break;
+    const value = values.shift();
+    output.push(
+      typeof value === "number" ? value.toString() : typeof value === "object" ? `'${JSON.stringify(value)}'` : `'${value}'`
+    );
+  }
+  return format(output.join("").trim(), { language: "postgresql" });
+}
 const getJsonBuildTrusted = (variadic) => {
   const args = join(
     Object.entries(variadic).map(([name, value]) => {
@@ -155,23 +170,23 @@ const getSelectCols = (options, projection = null) => {
       sqls.push(
         sql`jsonb_build_object(${join(subSqls, ", ")}) AS "${raw(key)}"`
       );
+    }
+    if (key[0] === "$") continue;
+    if (typeof projection[key] === "object") {
+      const optimisedJsonBuild = getOptimisedJsonBuild(
+        projection[key],
+        [],
+        key,
+        options
+      );
+      sqls.push(
+        sql`jsonb_build_object(${join(optimisedJsonBuild, ", ")}) AS "${raw(key)}"`
+      );
     } else {
-      if (typeof projection[key] === "object") {
-        const optimisedJsonBuild = getOptimisedJsonBuild(
-          projection[key],
-          [],
-          key,
-          options
-        );
-        sqls.push(
-          sql`jsonb_build_object(${join(optimisedJsonBuild, ", ")}) AS "${raw(key)}"`
-        );
-      } else {
-        sqls.push(sql`"${raw(key)}"`);
-      }
+      sqls.push(sql`"${raw(key)}"`);
     }
   }
-  return join(sqls, ", ");
+  return sqls.length ? join(sqls, ", ") : sql`TRUE AS "$"`;
 };
 function vertexSql(array, nullValue) {
   return sql`array[${join(
@@ -708,7 +723,7 @@ class Db {
     const cubeOid = Number.parseInt(((_b = (_a = tableOptions == null ? void 0 : tableOptions.schema) == null ? void 0 : _a.typeOids) == null ? void 0 : _b.cube) || "0") || null;
     try {
       sql2.types = {
-        getTypeParser: (oid, format) => {
+        getTypeParser: (oid, format2) => {
           if (oid === types.builtins.INT8) {
             return (value) => Number.parseInt(value, 10);
           }
@@ -720,7 +735,7 @@ class Db {
               return array.length > 1 ? array : array[0];
             };
           }
-          return types.getTypeParser(oid, format);
+          return types.getTypeParser(oid, format2);
         }
       };
       return await this.client.query(sql2);
@@ -752,7 +767,7 @@ class Db {
   /*
     Adds .schema to tableOptions if it doesn't exist yet.
     It mutates the argument, to "persist" the results and
-    avoid this query in every operation. 
+    avoid this query in every operation.
   */
   async ensureSchema(tableOptions, typeOids) {
     if (tableOptions.schema) return;
@@ -803,19 +818,33 @@ class Db {
     const prefix = encodePath(rawPrefix);
     await this.ensureSchema(tableOptions);
     const getByArgs = async (args, projection) => {
-      const result = await this.readSql(
-        selectByArgs(args, projection, tableOptions),
-        tableOptions
-      );
+      const sql2 = selectByArgs(args, projection, tableOptions);
+      const result = await this.readSql(sql2, tableOptions);
       const wrappedGraph = encodeGraph(wrapObject(result, rawPrefix));
       log("getByArgs", wrappedGraph);
       merge(results, wrappedGraph);
     };
-    const getByIds = async () => {
-      const result = await this.readSql(
-        selectByIds(Object.keys(idQueries), null, tableOptions),
-        tableOptions
+    const explainArgs = async (args, projection) => {
+      const { analyze, $explain: qArgs } = args;
+      const qSql = selectByArgs(qArgs, null, tableOptions);
+      const sql$1 = sql`EXPLAIN (${analyze ? sql`ANALYZE, BUFFERS, TIMING, ` : sql``}COSTS, VERBOSE, FORMAT JSON) ${qSql}`;
+      const result = await this.readSql(sql$1, tableOptions);
+      const wrappedGraph = encodeGraph(
+        wrapObject(
+          {
+            $key: args,
+            sql: formatSql(qSql),
+            plan: result[0]["QUERY PLAN"][0]
+          },
+          rawPrefix
+        )
       );
+      log("explainArgs", wrappedGraph);
+      merge(results, wrappedGraph);
+    };
+    const getByIds = async () => {
+      const sql2 = selectByIds(Object.keys(idQueries), null, tableOptions);
+      const result = await this.readSql(sql2, tableOptions);
       for (const object of result) {
         const wrappedGraph = encodeGraph(wrapObject(object, rawPrefix));
         log("getByIds", wrappedGraph);
@@ -834,7 +863,11 @@ class Db {
           }
         } else {
           const projection = node.children ? decodeQuery(node.children) : null;
-          promises.push(getByArgs(args, projection));
+          if (args.$explain) {
+            promises.push(explainArgs(args));
+          } else {
+            promises.push(getByArgs(args, projection));
+          }
         }
       } else {
         idQueries[args] = node.children;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graffy/pg",
   "description": "The standard Postgres module for Graffy. Each instance this module mounts a Postgres table as a Graffy subtree.",
   "author": "aravind (https://github.com/aravindet)",
-  "version": "0.16.20",
+  "version": "0.16.21-alpha.2",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,8 +16,9 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.16.20",
-    "debug": "^4.3.3"
+    "@graffy/common": "0.16.21-alpha.2",
+    "debug": "^4.3.3",
+    "sql-formatter": "^15.6.2"
   },
   "peerDependencies": {
     "pg": "^8.0.0"

package/types/sql/format.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param {import('sql-template-tag').Sql} sql
+ * @returns {string}
+ */
+export default function formatSql(sql: import("sql-template-tag").Sql): string;