@graffy/pg 0.16.3 → 0.16.4-alpha.2

package/Readme.md

@@ -20,6 +20,9 @@ store.use(path, pg(options));
 - `table`, the name of the table. If not provided, the last segment of the `path` is used. This table must exist.
 - `idCol`: the name of the column to use as ID. Defaults to `id`. This column must exist and be the primary key or have a unique constraint.
 - `verCol`: the name of the column to store the Graffy version number. This column must exist, and must have a `DEFAULT` SQL expression defined - this expression is evaluated to calculate the version number. Graffy versions must monotonically increase, so this expression is typically based on `CURRENT_TIMESTAMP`.
+- `joins`: other tables that have foreign keys referencing the ID column in this table, where we want to filter this table using columns of that other table via a "join". The value is a map of join names to join options.
+  - join names are the names used to refer to joined tables in filter expressions. Typically, these are the names of those tables.
+  - join options are objects with optional properties `table`, `idCol`, `refCol` and `verCol`. `refCol` is the name of the column in the join table that references this one. 
 - `connection`: a [pg](https://github.com/brianc/node-postgres) Client or Pool object (recommended), or the arguments for constructing a new Pool object. Optional.
 
 ### Database connection
@@ -89,6 +92,9 @@ Tags must contain both *foo* and *bar*. Note that the array of conditions here d
 2. `{ tags: { $ctd: ['foo', 'bar', 'baz'] } }` becomes `tags <@ '{"foo","bar","baz"}'`.
 Every tag must be one of *foo*, *bar* or *baz*.
 
+#### Joins
+1. `joinName: { ...expression }`,
+
 #### Notes
 
 1. We drop several MongoDB operators while retaining the capability:

package/index.cjs

@@ -126,9 +126,7 @@ function construct(node, prop, op) {
         return construct(val, prop, key);
       }
       if (prop) {
-        if (key[0] === ".")
-          return construct(val, prop + key);
-        throw Error(`pgast.unexpected_prop: ${key}`);
+        return ["$sub", prop, construct({ [key]: val })];
       }
       return construct(val, key);
     })
@@ -140,6 +138,8 @@ function simplify(node) {
     node[1] = node[1].map((subnode) => simplify(subnode));
   } else if (op === "$not") {
     node[1] = simplify(node[1]);
+  } else if (op === "$sub") {
+    node[2] = simplify(node[2]);
   }
   if (op === "$and") {
     if (!node[1].length)
@@ -385,36 +385,48 @@ function getBinarySql(lhs, type, op, value, textLhs) {
     return sql`${lhs} ${sqlOp} ${cubeLiteralSql(value)}`;
   return sql`${lhs} ${sqlOp} ${value}`;
 }
-function getSql(filter, options) {
-  function getNodeSql(ast) {
-    if (typeof ast === "boolean")
-      return ast;
-    const op = ast[0];
-    if (op === "$and" || op === "$or") {
-      return sql`(${join(
-        ast[1].map((node) => getNodeSql(node)),
-        `) ${opSql[op]} (`
-      )})`;
-    } else if (op === "$not") {
-      return sql`${opSql[op]} (${getNodeSql(ast[1])})`;
-    }
-    const [prefix, ...suffix] = ast[1].split(".");
-    const { types: types2 } = options.schema;
-    if (!types2[prefix])
-      throw Error(`pg.no_column ${prefix}`);
-    if (types2[prefix] === "jsonb") {
-      const [lhs, textLhs] = suffix.length ? [
-        sql`"${raw(prefix)}" #> ${suffix}`,
-        sql`"${raw(prefix)}" #>> ${suffix}`
-      ] : [sql`"${raw(prefix)}"`, sql`"${raw(prefix)}" #>> '{}'`];
-      return getBinarySql(lhs, "jsonb", op, ast[2], textLhs);
-    } else {
-      if (suffix.length)
-        throw Error(`pg.lookup_not_jsonb ${prefix}`);
-      return getBinarySql(sql`"${raw(prefix)}"`, types2[prefix], op, ast[2]);
-    }
+function getNodeSql(ast, options) {
+  if (typeof ast === "boolean")
+    return ast;
+  const op = ast[0];
+  if (op === "$and" || op === "$or") {
+    return sql`(${join(
+      ast[1].map((node) => getNodeSql(node, options)),
+      `) ${opSql[op]} (`
+    )})`;
+  } else if (op === "$not") {
+    return sql`${opSql[op]} (${getNodeSql(ast[1], options)})`;
+  }
+  if (op === "$sub") {
+    const joinName = ast[1];
+    if (!options.joins[joinName])
+      throw Error(`pg.no_join ${joinName}`);
+    const { idCol, schema } = options;
+    const joinOptions = options.joins[joinName];
+    const { table: joinTable, refCol } = options.joins[joinName];
+    return sql`"${raw(idCol)}" IN (SELECT "${raw(refCol)}"::${raw(
+      schema.types[idCol]
+    )} FROM "${raw(joinTable)}" WHERE ${getNodeSql(ast[2], joinOptions)})`;
+  }
+  const [prefix, ...suffix] = ast[1].split(".");
+  const { types: types2 = {} } = options.schema;
+  if (!types2[prefix])
+    throw Error(`pg.no_column ${prefix}`);
+  if (types2[prefix] === "jsonb") {
+    const [lhs, textLhs] = suffix.length ? [
+      sql`"${raw(prefix)}" #> ${suffix}`,
+      sql`"${raw(prefix)}" #>> ${suffix}`
+    ] : [sql`"${raw(prefix)}"`, sql`"${raw(prefix)}" #>> '{}'`];
+    return getBinarySql(lhs, "jsonb", op, ast[2], textLhs);
+  } else {
+    if (suffix.length)
+      throw Error(`pg.lookup_not_jsonb ${prefix}`);
+    return getBinarySql(sql`"${raw(prefix)}"`, types2[prefix], op, ast[2]);
   }
-  return getNodeSql(getAst(filter));
+}
+function getSql(filter, options) {
+  const ast = getAst(filter);
+  return getNodeSql(ast, options);
 }
 const getIdMeta = ({ idCol, verDefault }) => sql`"${raw(idCol)}" AS "$key", ${raw(verDefault)} AS "$ver"`;
 const getArgMeta = (key, { prefix, idCol, verDefault }) => sql`
@@ -442,7 +454,12 @@ function getArgSql({ $first, $last, $after, $before, $since, $until, $all, $curs
   if (!common.isEmpty(filter))
     where.push(getSql(filter, options));
   if (!hasRangeArg)
-    return { meta: meta(baseKey), where, limit: 1 };
+    return {
+      meta: meta(baseKey),
+      where,
+      limit: 1,
+      ensureSingleRow: $group === true
+    };
   const groupCols = Array.isArray($group) && $group.length && $group.map((prop) => lookup(prop, options));
   const group = groupCols ? join(groupCols, ", ") : void 0;
   const orderCols = ($order || [idCol]).map(
@@ -469,7 +486,8 @@ function getArgSql({ $first, $last, $after, $before, $since, $until, $all, $curs
     where,
     order,
     group,
-    limit: $first || $last
+    limit: $first || $last,
+    ensureSingleRow: true
   };
 }
 function getBoundCond(orderCols, bound, kind) {
@@ -503,9 +521,23 @@ function getBoundCond(orderCols, bound, kind) {
 }
 const MAX_LIMIT = 4096;
 function selectByArgs(args, projection, options) {
-  const { table } = options;
-  const { where, order, group, limit, meta } = getArgSql(args, options);
+  const { table, idCol } = options;
+  const { where, order, group, limit, meta, ensureSingleRow } = getArgSql(
+    args,
+    options
+  );
   const clampedLimit = Math.min(MAX_LIMIT, limit || MAX_LIMIT);
+  if (!ensureSingleRow) {
+    return sql`
+      SELECT
+      ${getSelectCols(options, projection)}, ${meta}
+      FROM "${raw(table)}" WHERE "${raw(idCol)}" = (
+        SELECT "${raw(idCol)}" FROM "${raw(table)}"
+        ${where.length ? sql`WHERE ${join(where, " AND ")}` : empty}
+        LIMIT 2
+      )
+    `;
+  }
   return sql`
     SELECT
     ${getSelectCols(options, projection)}, ${meta}
@@ -541,7 +573,7 @@ function getSingleSql(arg, options) {
         SELECT "${raw(idCol)}"
         FROM "${raw(table)}"
         WHERE ${join(where, " AND ")}
-        LIMIT 1
+        LIMIT 2
       )`,
     meta
   };
@@ -638,10 +670,10 @@ class Db {
     }
     return res.rows[0];
   }
-  async ensureSchema(tableOptions) {
+  async ensureSchema(tableOptions, typeOids) {
     if (tableOptions.schema)
       return;
-    const { table, verCol } = tableOptions;
+    const { table, verCol, joins } = tableOptions;
     const tableSchema = (await this.query(sql`
         SELECT table_schema
         FROM information_schema.tables
@@ -656,7 +688,7 @@ class Db {
           table_schema = ${tableSchema}`)).rows[0].column_types;
     if (!types2)
       throw Error(`pg.missing_table ${table}`);
-    const typeOids = (await this.query(sql`
+    typeOids = typeOids || (await this.query(sql`
         SELECT jsonb_object_agg(typname, oid) AS type_oids
         FROM pg_type
         WHERE typname = 'cube'`)).rows[0].type_oids;
@@ -670,6 +702,11 @@ class Db {
     if (!verDefault) {
       throw Error(`pg.verCol_without_default ${verCol}`);
     }
+    await Promise.all(
+      Object.values(joins).map(
+        (joinOptions) => this.ensureSchema(joinOptions, typeOids)
+      )
+    );
     log("ensureSchema", types2);
     tableOptions.schema = { types: types2, typeOids };
     tableOptions.verDefault = verDefault;
@@ -760,18 +797,33 @@ class Db {
     return result;
   }
 }
-const pg = ({ table, idCol, verCol, connection, schema, verDefault }) => (store) => {
-  store.on("read", read);
-  store.on("write", write);
-  const prefix = store.path;
-  const tableOpts = {
-    prefix,
-    table: table || prefix[prefix.length - 1] || "default",
+function getTableOpts(name, { table, idCol, verCol, joins, schema, verDefault } = {}, parentName = null) {
+  const tableName = table || name;
+  return {
+    table: table || name,
     idCol: idCol || "id",
     verCol: verCol || "updatedAt",
+    joins: Object.fromEntries(
+      Object.entries(joins || {}).map(
+        ([joinName, { refCol = parentName, ...joinOptions }]) => [
+          joinName,
+          {
+            refCol,
+            ...getTableOpts(joinName, joinOptions, tableName)
+          }
+        ]
+      )
+    ),
     schema,
     verDefault
   };
+}
+const pg = ({ connection, ...rawOptions }) => (store) => {
+  store.on("read", read);
+  store.on("write", write);
+  const prefix = store.path;
+  const tableOpts = getTableOpts(prefix[prefix.length - 1], rawOptions);
+  tableOpts.prefix = prefix;
   const defaultDb = new Db(connection);
   function read(query, options, next) {
     const { pgClient } = options;

package/index.mjs

@@ -124,9 +124,7 @@ function construct(node, prop, op) {
         return construct(val, prop, key);
       }
       if (prop) {
-        if (key[0] === ".")
-          return construct(val, prop + key);
-        throw Error(`pgast.unexpected_prop: ${key}`);
+        return ["$sub", prop, construct({ [key]: val })];
       }
       return construct(val, key);
     })
@@ -138,6 +136,8 @@ function simplify(node) {
     node[1] = node[1].map((subnode) => simplify(subnode));
   } else if (op === "$not") {
     node[1] = simplify(node[1]);
+  } else if (op === "$sub") {
+    node[2] = simplify(node[2]);
   }
   if (op === "$and") {
     if (!node[1].length)
@@ -383,36 +383,48 @@ function getBinarySql(lhs, type, op, value, textLhs) {
     return sql`${lhs} ${sqlOp} ${cubeLiteralSql(value)}`;
   return sql`${lhs} ${sqlOp} ${value}`;
 }
-function getSql(filter, options) {
-  function getNodeSql(ast) {
-    if (typeof ast === "boolean")
-      return ast;
-    const op = ast[0];
-    if (op === "$and" || op === "$or") {
-      return sql`(${join(
-        ast[1].map((node) => getNodeSql(node)),
-        `) ${opSql[op]} (`
-      )})`;
-    } else if (op === "$not") {
-      return sql`${opSql[op]} (${getNodeSql(ast[1])})`;
-    }
-    const [prefix, ...suffix] = ast[1].split(".");
-    const { types: types2 } = options.schema;
-    if (!types2[prefix])
-      throw Error(`pg.no_column ${prefix}`);
-    if (types2[prefix] === "jsonb") {
-      const [lhs, textLhs] = suffix.length ? [
-        sql`"${raw(prefix)}" #> ${suffix}`,
-        sql`"${raw(prefix)}" #>> ${suffix}`
-      ] : [sql`"${raw(prefix)}"`, sql`"${raw(prefix)}" #>> '{}'`];
-      return getBinarySql(lhs, "jsonb", op, ast[2], textLhs);
-    } else {
-      if (suffix.length)
-        throw Error(`pg.lookup_not_jsonb ${prefix}`);
-      return getBinarySql(sql`"${raw(prefix)}"`, types2[prefix], op, ast[2]);
-    }
+function getNodeSql(ast, options) {
+  if (typeof ast === "boolean")
+    return ast;
+  const op = ast[0];
+  if (op === "$and" || op === "$or") {
+    return sql`(${join(
+      ast[1].map((node) => getNodeSql(node, options)),
+      `) ${opSql[op]} (`
+    )})`;
+  } else if (op === "$not") {
+    return sql`${opSql[op]} (${getNodeSql(ast[1], options)})`;
+  }
+  if (op === "$sub") {
+    const joinName = ast[1];
+    if (!options.joins[joinName])
+      throw Error(`pg.no_join ${joinName}`);
+    const { idCol, schema } = options;
+    const joinOptions = options.joins[joinName];
+    const { table: joinTable, refCol } = options.joins[joinName];
+    return sql`"${raw(idCol)}" IN (SELECT "${raw(refCol)}"::${raw(
+      schema.types[idCol]
+    )} FROM "${raw(joinTable)}" WHERE ${getNodeSql(ast[2], joinOptions)})`;
+  }
+  const [prefix, ...suffix] = ast[1].split(".");
+  const { types: types2 = {} } = options.schema;
+  if (!types2[prefix])
+    throw Error(`pg.no_column ${prefix}`);
+  if (types2[prefix] === "jsonb") {
+    const [lhs, textLhs] = suffix.length ? [
+      sql`"${raw(prefix)}" #> ${suffix}`,
+      sql`"${raw(prefix)}" #>> ${suffix}`
+    ] : [sql`"${raw(prefix)}"`, sql`"${raw(prefix)}" #>> '{}'`];
+    return getBinarySql(lhs, "jsonb", op, ast[2], textLhs);
+  } else {
+    if (suffix.length)
+      throw Error(`pg.lookup_not_jsonb ${prefix}`);
+    return getBinarySql(sql`"${raw(prefix)}"`, types2[prefix], op, ast[2]);
   }
-  return getNodeSql(getAst(filter));
+}
+function getSql(filter, options) {
+  const ast = getAst(filter);
+  return getNodeSql(ast, options);
 }
 const getIdMeta = ({ idCol, verDefault }) => sql`"${raw(idCol)}" AS "$key", ${raw(verDefault)} AS "$ver"`;
 const getArgMeta = (key, { prefix, idCol, verDefault }) => sql`
@@ -440,7 +452,12 @@ function getArgSql({ $first, $last, $after, $before, $since, $until, $all, $curs
   if (!isEmpty(filter))
     where.push(getSql(filter, options));
   if (!hasRangeArg)
-    return { meta: meta(baseKey), where, limit: 1 };
+    return {
+      meta: meta(baseKey),
+      where,
+      limit: 1,
+      ensureSingleRow: $group === true
+    };
   const groupCols = Array.isArray($group) && $group.length && $group.map((prop) => lookup(prop, options));
   const group = groupCols ? join(groupCols, ", ") : void 0;
   const orderCols = ($order || [idCol]).map(
@@ -467,7 +484,8 @@ function getArgSql({ $first, $last, $after, $before, $since, $until, $all, $curs
     where,
     order,
     group,
-    limit: $first || $last
+    limit: $first || $last,
+    ensureSingleRow: true
   };
 }
 function getBoundCond(orderCols, bound, kind) {
@@ -501,9 +519,23 @@ function getBoundCond(orderCols, bound, kind) {
 }
 const MAX_LIMIT = 4096;
 function selectByArgs(args, projection, options) {
-  const { table } = options;
-  const { where, order, group, limit, meta } = getArgSql(args, options);
+  const { table, idCol } = options;
+  const { where, order, group, limit, meta, ensureSingleRow } = getArgSql(
+    args,
+    options
+  );
   const clampedLimit = Math.min(MAX_LIMIT, limit || MAX_LIMIT);
+  if (!ensureSingleRow) {
+    return sql`
+      SELECT
+      ${getSelectCols(options, projection)}, ${meta}
+      FROM "${raw(table)}" WHERE "${raw(idCol)}" = (
+        SELECT "${raw(idCol)}" FROM "${raw(table)}"
+        ${where.length ? sql`WHERE ${join(where, " AND ")}` : empty}
+        LIMIT 2
+      )
+    `;
+  }
   return sql`
     SELECT
     ${getSelectCols(options, projection)}, ${meta}
@@ -539,7 +571,7 @@ function getSingleSql(arg, options) {
         SELECT "${raw(idCol)}"
         FROM "${raw(table)}"
         WHERE ${join(where, " AND ")}
-        LIMIT 1
+        LIMIT 2
       )`,
     meta
   };
@@ -636,10 +668,10 @@ class Db {
     }
     return res.rows[0];
   }
-  async ensureSchema(tableOptions) {
+  async ensureSchema(tableOptions, typeOids) {
     if (tableOptions.schema)
       return;
-    const { table, verCol } = tableOptions;
+    const { table, verCol, joins } = tableOptions;
     const tableSchema = (await this.query(sql`
         SELECT table_schema
         FROM information_schema.tables
@@ -654,7 +686,7 @@ class Db {
           table_schema = ${tableSchema}`)).rows[0].column_types;
     if (!types2)
       throw Error(`pg.missing_table ${table}`);
-    const typeOids = (await this.query(sql`
+    typeOids = typeOids || (await this.query(sql`
         SELECT jsonb_object_agg(typname, oid) AS type_oids
         FROM pg_type
         WHERE typname = 'cube'`)).rows[0].type_oids;
@@ -668,6 +700,11 @@ class Db {
     if (!verDefault) {
       throw Error(`pg.verCol_without_default ${verCol}`);
     }
+    await Promise.all(
+      Object.values(joins).map(
+        (joinOptions) => this.ensureSchema(joinOptions, typeOids)
+      )
+    );
     log("ensureSchema", types2);
     tableOptions.schema = { types: types2, typeOids };
     tableOptions.verDefault = verDefault;
@@ -758,18 +795,33 @@ class Db {
     return result;
   }
 }
-const pg = ({ table, idCol, verCol, connection, schema, verDefault }) => (store) => {
-  store.on("read", read);
-  store.on("write", write);
-  const prefix = store.path;
-  const tableOpts = {
-    prefix,
-    table: table || prefix[prefix.length - 1] || "default",
+function getTableOpts(name, { table, idCol, verCol, joins, schema, verDefault } = {}, parentName = null) {
+  const tableName = table || name;
+  return {
+    table: table || name,
     idCol: idCol || "id",
     verCol: verCol || "updatedAt",
+    joins: Object.fromEntries(
+      Object.entries(joins || {}).map(
+        ([joinName, { refCol = parentName, ...joinOptions }]) => [
+          joinName,
+          {
+            refCol,
+            ...getTableOpts(joinName, joinOptions, tableName)
+          }
+        ]
+      )
+    ),
     schema,
     verDefault
   };
+}
+const pg = ({ connection, ...rawOptions }) => (store) => {
+  store.on("read", read);
+  store.on("write", write);
+  const prefix = store.path;
+  const tableOpts = getTableOpts(prefix[prefix.length - 1], rawOptions);
+  tableOpts.prefix = prefix;
   const defaultDb = new Db(connection);
   function read(query, options, next) {
     const { pgClient } = options;

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.3",
+  "version": "0.16.4-alpha.2",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,7 +16,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.16.3",
+    "@graffy/common": "0.16.4-alpha.2",
     "debug": "^4.3.3"
   },
   "peerDependencies": {

package/types/Db.d.ts

@@ -4,7 +4,7 @@ export default class Db {
     query(sql: any, tableOptions: any): Promise<any>;
     readSql(sql: any, tableOptions: any): Promise<any>;
     writeSql(sql: any, tableOptions: any): Promise<any>;
-    ensureSchema(tableOptions: any): Promise<void>;
+    ensureSchema(tableOptions: any, typeOids: any): Promise<void>;
     read(rootQuery: any, tableOptions: any): Promise<any>;
     write(rootChange: any, tableOptions: any): Promise<any[]>;
 }

package/types/index.d.ts

@@ -1,8 +1,13 @@
-export function pg({ table, idCol, verCol, connection, schema, verDefault }: {
-    table?: string;
-    idCol?: string;
-    verCol?: string;
-    connection?: any;
+export function pg({ connection, ...rawOptions }: Partial<TableOpts> & {
+    connection: any;
+}): Function;
+export type TableOpts = {
+    table: string;
+    idCol: string;
+    verCol: string;
+    joins: Record<string, Partial<TableOpts> & {
+        refCol: string;
+    }>;
     schema?: any;
     verDefault?: string;
-}): (store: any) => void;
+};

package/types/sql/getArgSql.d.ts

@@ -5,7 +5,7 @@
   @param {{prefix: string, idCol: string, verDefault: string}} options
 
   @typedef { import('sql-template-tag').Sql } Sql
-  @return {{ meta: Sql, where: Sql[], order?: Sql, group?: Sql, limit: number }}
+  @return {{ meta: Sql, where: Sql[], order?: Sql, group?: Sql, limit: number, ensureSingleRow: boolean }}
 */
 export default function getArgSql({ $first, $last, $after, $before, $since, $until, $all, $cursor: _, ...rest }: object, options: {
     prefix: string;
@@ -17,6 +17,7 @@ export default function getArgSql({ $first, $last, $after, $before, $since, $unt
     order?: Sql;
     group?: Sql;
     limit: number;
+    ensureSingleRow: boolean;
 };
 /**
  * Uses the args object (typically passed in the $key attribute)