xcraft-core-pickaxe 0.1.22 → 0.1.23

package/lib/operator-to-sql.js

@@ -17,6 +17,10 @@ function escape(value) {
 }
 
 const operators = {
+  unsafeSql({sql}, context) {
+    return sql;
+  },
+
   value({value}, context) {
     if (typeof value === 'boolean') {
       return value ? 'TRUE' : 'FALSE';

package/lib/operators.js

@@ -19,8 +19,8 @@ function op(value) {
   if (type === 'object' && 'operator' in value) {
     return value;
   }
-  const {ValuePick} = require('./picks.js');
-  if (value instanceof ValuePick) {
+  const {isAnyPick} = require('./picks.js');
+  if (isAnyPick(value)) {
     return value.value;
   }
 
@@ -28,6 +28,13 @@ function op(value) {
 }
 
 const operators = {
+  unsafeSql(sql) {
+    return /** @type {const} */ ({
+      operator: 'unsafeSql',
+      sql,
+    });
+  },
+
   value(value) {
     return /** @type {const} */ ({
       operator: 'value',
@@ -407,7 +414,7 @@ const operators = {
  * @typedef {Operators["count"] | Operators["avg"] | Operators["max"] | Operators["min"] | Operators["sum"] | Operators["groupArray"]} Aggregator
  */
 /**
- * @typedef {Operators["eq"] | Operators["neq"] | Operators["and"] | Operators["or"] | Operators["not"] | Operators["gt"] | Operators["gte"] | Operators["lt"] | Operators["lte"] | Operators["in"] | Operators["includes"] | Operators["some"] | Operators["glob"] | Operators["like"] | Operators["match"]} BooleanOperator
+ * @typedef {Operators["eq"] | Operators["neq"] | Operators["and"] | Operators["or"] | Operators["not"] | Operators["gt"] | Operators["gte"] | Operators["lt"] | Operators["lte"] | Operators["in"] | Operators["includes"] | Operators["some"] | Operators["glob"] | Operators["like"] | Operators["match"] | Operators["unsafeSql"]} BooleanOperator
  */
 /**
  * @typedef {Operators["abs"] | Operators["plus"] | Operators["minus"]} MathOperator

package/lib/picks.js

@@ -517,7 +517,8 @@ function isAnyPick(value) {
     value instanceof ValuePick ||
     value instanceof ObjectPick ||
     value instanceof RecordPick ||
-    value instanceof ArrayPick
+    value instanceof ArrayPick ||
+    value instanceof RowPick
   );
 }
 
@@ -539,6 +540,21 @@ class RowPick {
     this.#context = context;
   }
 
+  get type() {
+    return this.#type;
+  }
+
+  get value() {
+    const {tableName, field, path} = this.#context;
+    if (path && path.length > 0) {
+      return $o.get($o.field(field, tableName), path);
+    }
+    if (field) {
+      return $o.field(field, tableName);
+    }
+    throw new Error('Bad RowPick value');
+  }
+
   /**
    * @template {keyof T} K
    * @param {K} fieldName
@@ -568,6 +584,11 @@ class RowPick {
   get(fieldName) {
     return this.field(fieldName);
   }
+
+  isRoot() {
+    const path = this.#context.path;
+    return !path || path.length === 0;
+  }
 }
 
 /**

package/lib/query-builder.js

@@ -28,6 +28,10 @@ const {queryToSql} = require('./query-to-sql.js');
  * @typedef {import("./picks.js").BooleanValue} BooleanValue
  */
 
+/**
+ * @typedef {{name: string, query: QueryObj}} WithResult
+ */
+
 /**
  * TODO: add FinalQuery
  * @typedef {Operators["each"]} Subquery
@@ -112,7 +116,7 @@ function getTableName(table) {
   if (typeof table === 'string') {
     return table;
   }
-  if ('alias' in table) {
+  if ('alias' in table && table.alias !== undefined) {
     return table.alias;
   }
   if ('table' in table) {
@@ -137,10 +141,11 @@ function getTableName(table) {
 /**
  * @typedef {{
  *   explain?: boolean,
+ *   withs?: WithResult[],
  *   from: QueryTable,
  *   scope?: ObjectPick<any>
  *   joins?: JoinsResult[],
- *   select: SelectResult,
+ *   select: SelectResult | '*',
  *   selectOneField?: boolean,
  *   distinct?: boolean,
  *   where?: Operator,
@@ -643,6 +648,29 @@ class FromQuery {
     return new SelectQuery(this.#picks, queryParts, this.#database);
   }
 
+  /**
+   * @returns {SelectQuery<T, t<T[number]>>}
+   */
+  selectAll() {
+    const isRoot = this.#picks.every((pick) => pick.isRoot());
+    /** @type {QueryObj["select"]} */
+    let select;
+    if (isRoot) {
+      select = '*';
+    } else {
+      select = Object.fromEntries(
+        this.#picks.flatMap((pick) =>
+          Object.keys(pick.type.properties).map((key) => [key, pick.get(key)])
+        )
+      );
+    }
+    const queryParts = {
+      ...this.#queryParts,
+      select,
+    };
+    return new SelectQuery(this.#picks, queryParts, this.#database);
+  }
+
   /**
    * @param {(...args: FctArgs<T>) => BooleanValue} fct
    * @returns {FromQuery<T>}
@@ -664,18 +692,21 @@ class FromQuery {
 class QueryBuilder {
   #database;
   #getTableSchema;
+  #withs;
 
   /**
    * @param {Object} options
    * @param {*} [options.database]
    * @param {DbSchema} [options.schema]
    * @param {(tableName: string, shape: AnyObjectShape) => AnyTableSchema} [options.getTableSchema]
+   * @param {WithResult[]} [options.withs]
    */
-  constructor({database, schema, getTableSchema} = {}) {
+  constructor({database, schema, getTableSchema, withs} = {}) {
     this.#database = database;
     this.#getTableSchema =
       getTableSchema ??
       ((tableName) => (schema ? schema[tableName] : {table: tableName}));
+    this.#withs = withs;
   }
 
   /**
@@ -692,6 +723,25 @@ class QueryBuilder {
     return this.#database;
   }
 
+  /**
+   * @param {string} name
+   * @param {FinalQuery<any>} query
+   * @returns {QueryBuilder}
+   */
+  with(name, query) {
+    return new QueryBuilder({
+      database: this.#database,
+      getTableSchema: this.#getTableSchema,
+      withs: [
+        ...(this.#withs ?? []),
+        {
+          name,
+          query: query.query,
+        },
+      ],
+    });
+  }
+
   /**
    * @template {AnyObjectShape} T
    * @param {string} tableName
@@ -701,7 +751,10 @@ class QueryBuilder {
   from(tableName, shape) {
     const tableSchema = this.#getTableSchema(tableName, shape);
     const from = tableSchema;
-    const {pick, queryParts} = useTableSchema(tableSchema, shape, {from});
+    const {pick, queryParts} = useTableSchema(tableSchema, shape, {
+      from,
+      withs: this.#withs,
+    });
     return new FromQuery(
       this.#getTableSchema,
       [pick],

package/lib/query-to-sql.js

@@ -7,6 +7,28 @@
 const {joinOperators} = require('./join-operators.js');
 const {sql} = require('./operator-to-sql.js');
 
+/**
+ * @param {QueryObj["withs"]} withs
+ * @param {OperatorToSqlContext} context
+ * @returns {string}
+ */
+function withSql(withs, context) {
+  if (!withs || withs.length === 0) {
+    return '';
+  }
+  let resultSql = 'WITH ';
+  resultSql += withs
+    .map(({name, query}) => {
+      let sql = '';
+      sql += `${name} AS (\n`;
+      sql += queryToSql(query, context.values).sql;
+      sql += '\n)';
+      return sql;
+    })
+    .join(', ');
+  resultSql += '\n';
+  return resultSql;
+}
 /**
  * @param {QueryObj["from"]} table
  * @param {OperatorToSqlContext} context
@@ -41,6 +63,9 @@ function tableSql(table, context) {
  * @returns {string}
  */
 function selectFields(select, context) {
+  if (select === '*') {
+    return '*';
+  }
   if (Array.isArray(select)) {
     return select.map((value) => sql(value, context)).join(', ');
   }
@@ -107,11 +132,12 @@ function queryToSql(query, values = []) {
     useTableNames: query.joins && query.joins.length > 0,
     equalOperator: 'IS',
   };
-  const explain = query.explain ? 'EXPLAIN QUERY PLAN ' : '';
+  const explain = query.explain ? 'EXPLAIN QUERY PLAN\n' : '';
+  const withs = withSql(query.withs, context);
   const distinct = query.distinct ? 'DISTINCT ' : '';
   // Note: query.from is not validated
   const from = tableSql(query.from, context);
-  let result = `${explain}SELECT ${distinct}${selectFields(
+  let result = `${explain}${withs}SELECT ${distinct}${selectFields(
     query.select,
     context
   )}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xcraft-core-pickaxe",
-  "version": "0.1.22",
+  "version": "0.1.23",
   "description": "Query builder",
   "main": "index.js",
   "scripts": {

package/test/sql.spec.js

@@ -101,10 +101,11 @@ describe('xcraft.pickaxe', function () {
    * @returns {FromQuery<[GetShape<T>]>}
    */
   function queryAction(tableName, shape) {
+    const mainDb = getDb(tableName);
     const builder = new QueryBuilder({
       getTableSchema: (name, shape) => {
         const db = getDb(name);
-        const isJoinedDb = name !== tableName; // or compare on db
+        const isJoinedDb = db !== mainDb;
         if (isJoinedDb) {
           console.log(`Attach ${name}`);
         }
@@ -207,6 +208,40 @@ describe('xcraft.pickaxe', function () {
     expect(result.values).to.be.deep.equal(values);
   });
 
+  it('select all', function () {
+    const builder = new QueryBuilder()
+      .from('test_table', TestUserShape)
+      .selectAll()
+      .where((user, $) => user.field('role').eq('admin'));
+
+    const result = queryToSql(builder.query, null);
+
+    const sql = `
+      SELECT *
+      FROM test_table
+      WHERE role IS 'admin'
+    `;
+
+    expect(trimSql(result.sql)).to.be.equal(trimSql(sql));
+  });
+
+  it('includes unsafe sql', function () {
+    const builder = new QueryBuilder()
+      .from('test_table', TestUserShape)
+      .selectAll()
+      .where((user, $) => $.unsafeSql(`role IS 'admin'`));
+
+    const result = queryToSql(builder.query, null);
+
+    const sql = `
+      SELECT *
+      FROM test_table
+      WHERE role IS 'admin'
+    `;
+
+    expect(trimSql(result.sql)).to.be.equal(trimSql(sql));
+  });
+
   it('pick string', function () {
     const builder = new QueryBuilder()
       .from('test_table', TestUserShape)
@@ -422,6 +457,31 @@ describe('xcraft.pickaxe', function () {
     expect(trimSql(result.sql)).to.be.equal(trimSql(sql));
   });
 
+  it('select all in query action', function () {
+    const builder = queryAction('users', TestUserShape)
+      .selectAll()
+      .where((user) => user.get('age').gt(10));
+
+    const result = queryToSql(builder.query, null);
+
+    const keys = Object.keys(new TestUserShape());
+    const sql = `
+      SELECT
+        ${keys
+          .map(
+            (key) => `json_extract(action, '$.payload.state.${key}') AS ${key}`
+          )
+          .join(', ')}
+      FROM action_table
+      WHERE (
+        entityType IS 'users' AND
+        json_extract(action, '$.payload.state.age') > 10
+      )
+    `;
+
+    expect(trimSql(result.sql)).to.be.equal(trimSql(sql));
+  });
+
   it('join query action', function () {
     const builder = queryAction('users', TestUserShape)
       .leftJoin('notes', TestNoteShape, (user, note) =>
@@ -440,17 +500,94 @@ describe('xcraft.pickaxe', function () {
 
     const sql = `
       SELECT
-        json_extract(action, '$.payload.state.id') AS id,
+        json_extract(action_table.action, '$.payload.state.id') AS id,
         json_extract(notes.action, '$.payload.state.text') AS noteText
       FROM action_table
       LEFT JOIN notes_db.action_table AS notes ON
-        SUBSTR(json_extract(notes.action, '$.payload.state.id'), 0, 6) = json_extract(action, '$.payload.state.id')
+        SUBSTR(json_extract(notes.action, '$.payload.state.id'), 0, 6) = json_extract(action_table.action, '$.payload.state.id')
       WHERE (
-        (entityType IS 'users' AND notes.entityType IS 'notes') AND
-        json_extract(action, '$.payload.state.age') > 10
+        (action_table.entityType IS 'users' AND notes.entityType IS 'notes') AND
+        json_extract(action_table.action, '$.payload.state.age') > 10
       )
     `;
 
     expect(trimSql(result.sql)).to.be.equal(trimSql(sql));
   });
+
+  it('with clause', function () {
+    const builder = new QueryBuilder()
+      .with(
+        'admins',
+        new QueryBuilder()
+          .from('test_table', TestUserShape)
+          .selectAll()
+          .where((user) => user.field('role').eq('admin'))
+      )
+      .from('admins', TestUserShape)
+      .field('id')
+      .where((user) => user.field('age').gt(42));
+
+    const result = queryToSql(builder.query, null);
+
+    const sql = `
+      WITH admins AS (
+        SELECT *
+        FROM test_table
+        WHERE role IS 'admin'
+      )
+      SELECT
+        id
+      FROM admins
+      WHERE age > 42
+    `;
+
+    expect(trimSql(result.sql)).to.be.equal(trimSql(sql));
+  });
+
+  it('with clause in query action', function () {
+    const builder = new QueryBuilder()
+      .with(
+        'admins',
+        new QueryBuilder()
+          .from('action_table', ActionShape(TestUserShape))
+          .selectAll()
+          .where((row, $) =>
+            $.and(
+              row.get('entityType').eq('users'),
+              row
+                .get('action')
+                .get('payload')
+                .get('state')
+                .get('role')
+                .eq('admin')
+            )
+          )
+      )
+      .from('admins', ActionShape(TestUserShape))
+      .select((row) => ({
+        id: row.get('action').get('payload').get('state').get('id'),
+      }))
+      .where((row) =>
+        row.get('action').get('payload').get('state').get('age').gt(10)
+      );
+
+    const result = queryToSql(builder.query, null);
+
+    const sql = `
+      WITH admins AS (
+        SELECT *
+        FROM action_table
+        WHERE (
+          entityType IS 'users' AND
+          json_extract(action, '$.payload.state.role') IS 'admin'
+        )
+      )
+      SELECT
+        json_extract(action, '$.payload.state.id') AS id
+      FROM admins
+      WHERE json_extract(action, '$.payload.state.age') > 10
+    `;
+
+    expect(trimSql(result.sql)).to.be.equal(trimSql(sql));
+  });
 });