@graffy/pg 0.16.20-alpha.9 → 0.16.21-alpha.1

package/index.cjs

@@ -79,6 +79,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 output.join("").trim();
+}
 const getJsonBuildTrusted = (variadic) => {
   const args = join(
     Object.entries(variadic).map(([name, value]) => {
@@ -116,6 +130,33 @@ const aggSql = {
   $max: (prop) => sql`max((${lookupNumeric(prop)})::numeric)`,
   $min: (prop) => sql`min((${lookupNumeric(prop)})::numeric)`
 };
+const getOptimisedJsonBuild = (object, path, parentPropertyName, options) => {
+  const propertyNames = Object.keys(object);
+  const propertyPath = [...path, parentPropertyName];
+  const buildConfig = [];
+  path = path || [];
+  propertyNames.forEach((propertyName) => {
+    const property = object[propertyName];
+    if (typeof property === "object") {
+      const childJSONBuild = getOptimisedJsonBuild(
+        property,
+        propertyPath,
+        propertyName,
+        options
+      );
+      buildConfig.push(
+        sql`${propertyName}::text, jsonb_build_object(${join(childJSONBuild, ", ")})`
+      );
+    } else {
+      if (property === true) {
+        buildConfig.push(
+          sql`${propertyName}::text, ${lookup([...propertyPath, propertyName].join("."), options)}`
+        );
+      }
+    }
+  });
+  return buildConfig;
+};
 const getSelectCols = (options, projection = null) => {
   if (!projection) return sql`*`;
   const sqls = [];
@@ -130,11 +171,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 {
       sqls.push(sql`"${raw(key)}"`);
     }
   }
-  return join(sqls, ", ");
+  return sqls.length ? join(sqls, ", ") : sql`TRUE AS "$"`;
 };
 function vertexSql(array, nullValue) {
   return sql`array[${join(
@@ -715,7 +768,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;
@@ -766,19 +819,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, ...qArgs } = args.$explain;
+      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);
@@ -797,7 +864,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

@@ -77,6 +77,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 output.join("").trim();
+}
 const getJsonBuildTrusted = (variadic) => {
   const args = join(
     Object.entries(variadic).map(([name, value]) => {
@@ -114,6 +128,33 @@ const aggSql = {
   $max: (prop) => sql`max((${lookupNumeric(prop)})::numeric)`,
   $min: (prop) => sql`min((${lookupNumeric(prop)})::numeric)`
 };
+const getOptimisedJsonBuild = (object, path, parentPropertyName, options) => {
+  const propertyNames = Object.keys(object);
+  const propertyPath = [...path, parentPropertyName];
+  const buildConfig = [];
+  path = path || [];
+  propertyNames.forEach((propertyName) => {
+    const property = object[propertyName];
+    if (typeof property === "object") {
+      const childJSONBuild = getOptimisedJsonBuild(
+        property,
+        propertyPath,
+        propertyName,
+        options
+      );
+      buildConfig.push(
+        sql`${propertyName}::text, jsonb_build_object(${join(childJSONBuild, ", ")})`
+      );
+    } else {
+      if (property === true) {
+        buildConfig.push(
+          sql`${propertyName}::text, ${lookup([...propertyPath, propertyName].join("."), options)}`
+        );
+      }
+    }
+  });
+  return buildConfig;
+};
 const getSelectCols = (options, projection = null) => {
   if (!projection) return sql`*`;
   const sqls = [];
@@ -128,11 +169,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 {
       sqls.push(sql`"${raw(key)}"`);
     }
   }
-  return join(sqls, ", ");
+  return sqls.length ? join(sqls, ", ") : sql`TRUE AS "$"`;
 };
 function vertexSql(array, nullValue) {
   return sql`array[${join(
@@ -713,7 +766,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;
@@ -764,19 +817,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, ...qArgs } = args.$explain;
+      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);
@@ -795,7 +862,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-alpha.9",
+  "version": "0.16.21-alpha.1",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,8 +16,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.16.20-alpha.9",
-    "debug": "^4.3.7"
+    "@graffy/common": "0.16.21-alpha.1",
+    "debug": "^4.3.3"
   },
   "peerDependencies": {
     "pg": "^8.0.0"

package/types/Db.d.ts

@@ -6,8 +6,8 @@ export default class Db {
     writeSql(sql: any, tableOptions: any): Promise<any>;
     ensureSchema(tableOptions: any, typeOids: any): Promise<void>;
     read(rootQuery: any, tableOptions: any): Promise<{
-        key: Uint8Array;
-        end: Uint8Array;
+        key: Uint8Array<ArrayBuffer>;
+        end: Uint8Array<ArrayBuffer>;
         version: number;
     }[]>;
     write(rootChange: any, tableOptions: any): Promise<any[]>;

package/types/sql/format.d.ts

@@ -0,0 +1 @@
+export default function formatSql(sql: any): string;