@saltcorn/sql 0.1.0 → 0.2.0

package/README.md

@@ -10,5 +10,5 @@ Use this view to create HTML code views of the results of arbitrary SQL queries
 2. Set output type = Table or JSON to begin with
 3. Start by creating your SQL query with no qualifiers (which will come from the URL query state). The preview table should update as you type
 4. When you are happy with the SQL query, switch to output type = HTML
-5. Create your HTML cod, use `{{ rows }}` to access rows. For instance if your query is an aggregation with a single row result (e.g. `SELECT COUNT(*) FROM...`), access this with `{{ rows[0].count }}`, for example `<h2>{{ rows[0].count }}</h2>`. You can also loop, e.g. `{{# for(const row of rows) { }}`
+5. Create your HTML code, use `{{ rows }}` to access rows. For instance if your query is an aggregation with a single row result (e.g. `SELECT COUNT(*) FROM...`), access this with `{{ rows[0].count }}`, for example `<h2>{{ rows[0].count }}</h2>`. You can also loop, e.g. `{{# for(const row of rows) { }}`
 6. When you are happy with both you are SQL and HTML code, Think about whether you need any parameters from the state. List these comma-separated, in order and use in the SQL code as `$1`, `$2` etc. Example SQL code: `select * from _sc_config where key = $1;`

package/action.js

@@ -0,0 +1,55 @@
+const db = require("@saltcorn/data/db");
+const { eval_expression } = require("@saltcorn/data/models/expression");
+
+module.exports = {
+  run_sql_code: {
+    configFields: [
+      {
+        name: "sql",
+        label: "SQL",
+        input_type: "code",
+        attributes: { mode: "text/x-sql" },
+        sublabel:
+          "Refer to row parameters in the order below with <code>$1</code>, <code>$2</code> etc",
+      },
+      {
+        name: "row_parameters",
+        label: "Row parameters",
+        sublabel:
+          "Comma separated list of row variables to use as SQL query parameters. User variables can be used as <code>user.id</code> etc",
+        type: "String",
+      },
+    ],
+    run: async ({ row, configuration: { sql, row_parameters }, user }) => {
+      const is_sqlite = db.isSQLite;
+
+      const phValues = [];
+      (row_parameters || "")
+        .split(",")
+        .filter((s) => s)
+        .forEach((sp0) => {
+          const sp = sp0.trim();
+          if (sp.startsWith("user.")) {
+            phValues.push(eval_expression(sp, {}, user));
+          } else if (typeof row[sp] === "undefined") phValues.push(null);
+          else phValues.push(row[sp]);
+        });
+
+      const client = is_sqlite ? db : await db.getClient();
+      await client.query(`BEGIN;`);
+      if (!is_sqlite) {
+        await client.query(
+          `SET LOCAL search_path TO "${db.getTenantSchema()}";`
+        );
+        await client.query(
+          `SET SESSION CHARACTERISTICS AS TRANSACTION READ ONLY;`
+        );
+      }
+      const qres = await client.query(sql, phValues);
+
+      await client.query(`COMMIT;`);
+
+      if (!is_sqlite) client.release(true);
+    },
+  },
+};

package/index.js

@@ -35,12 +35,14 @@ const configuration_workflow = () =>
                 label: "SQL",
                 input_type: "code",
                 attributes: { mode: "text/x-sql" },
+                sublabel:
+                  "Refer to state parameters in the order below with <code>$1</code>, <code>$2</code> etc",
               },
               {
                 name: "state_parameters",
                 label: "State parameters",
                 sublabel:
-                  "Comma separated list of state variables from URL querystring to use as SQL query parameters",
+                  "Comma separated list of state variables from URL querystring to use as SQL query parameters. User variables can be used as <code>user.id</code> etc",
                 type: "String",
               },
               {
@@ -79,7 +81,7 @@ const run = async (
   viewname,
   { sql, output_type, state_parameters, html_code },
   state,
-  extraArgs
+  { req }
 ) => {
   const is_sqlite = db.isSQLite;
 
@@ -89,7 +91,9 @@ const run = async (
     .filter((s) => s)
     .forEach((sp0) => {
       const sp = sp0.trim();
-      if (typeof state[sp] === "undefined") phValues.push(null);
+      if (sp.startsWith("user.")) {
+        phValues.push(eval_expression(sp, {}, req.user));
+      } else if (typeof state[sp] === "undefined") phValues.push(null);
       else phValues.push(state[sp]);
     });
 
@@ -101,7 +105,7 @@ const run = async (
   }
   const qres = await client.query(sql, phValues);
 
-  await client.query(`ROLLBACK`);
+  await client.query(`ROLLBACK;`);
 
   if (!is_sqlite) client.release(true);
   switch (output_type) {
@@ -127,6 +131,7 @@ const run = async (
 module.exports = {
   sc_plugin_api_version: 1,
   plugin_name: "sql",
+  actions: require("./action.js"),
   viewtemplates: [
     {
       name: "SQLView",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saltcorn/sql",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Actions and views based on SQL",
   "main": "index.js",
   "dependencies": {