@saltcorn/sql 0.3.1 → 0.3.3

package/README.md

@@ -2,7 +2,7 @@
 
 Actions and views based on SQL
 
-### SQLView
+### SQLView view
 
 Use this view to create HTML code views of the results of arbitrary SQL queries
 
@@ -12,3 +12,29 @@ Use this view to create HTML code views of the results of arbitrary SQL queries
 4. When you are happy with the SQL query, switch to output type = HTML
 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;`
+
+### run_sql_code action
+
+This action allows you to run arbitrary SQL. You specify values from the row that needs to be included in the query using positional parameters `$1`, `$2` etc.
+
+### SQL query table provider
+
+This will give you a Saltcorn "virtual table" based on an SQL
+query and specifying result fields (these will be guessed from the query
+result, but you need to check and assign a primary key).
+
+Normally you don't need to worry about the where clause when this is
+filtered by one of the columns in a view. Your query will be parsed,
+and the appropriate where clause will be inserted before the final query
+is run.
+
+There are some very specific cases in which you need to include information
+about the user in the query in a way that cannot be done in the normal way by state filtering. In this case, you can use string interpolation to include information about the user. For instance:
+
+```
+... where baz in (select id from zubs where user_zub = {{ user.myzub }} ) ...
+```
+
+User row values used in this way are automatically escaped by the
+[sqlstring](https://www.npmjs.com/package/sqlstring) to prevent SQL
+injection.

package/package.json

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

package/table-provider.js

@@ -96,7 +96,7 @@ const configuration_workflow = (req) =>
                     name: "primary_key",
                     label: "Primary key",
                     type: "Bool",
-                    showIf: { type: pkey_options },
+                    //showIf: { type: pkey_options },
                   },
                 ],
               }),
@@ -145,7 +145,7 @@ const sqlEscapeObject = (o) => {
   return r;
 };
 
-const runQuery = async (cfg, where) => {
+const runQuery = async (cfg, where, opts) => {
   const sqlTmpl = cfg?.sql || "";
   const template = _.template(sqlTmpl || "", {
     evaluate: /\{\{#(.+?)\}\}/g,
@@ -154,7 +154,9 @@ const runQuery = async (cfg, where) => {
 
   const qctx = {};
 
-  if (where.forUser) qctx.user = sqlEscapeObject(where.forUser);
+  if (opts?.forUser) qctx.user = sqlEscapeObject(opts.forUser);
+  else if (where?.forUser)
+    qctx.user = sqlEscapeObject(where.forUser); //workaround legacy bug
   else qctx.user = null;
 
   const sql = template(qctx);
@@ -172,10 +174,16 @@ const runQuery = async (cfg, where) => {
   const phValues = [];
   for (const k of Object.keys(where)) {
     if (!colNames.has(k)) continue;
+    const sqlCol = (ast[0].columns || []).find((c) => k === c.as);
+    let left = {
+      type: "column_ref",
+      table: sqlCol?.expr?.table,
+      column: db.sqlsanitize(k),
+    };
     const newClause = {
       type: "binary_expr",
       operator: "=",
-      left: { type: "column_ref", table: null, column: db.sqlsanitize(k) },
+      left,
       right: { type: "number", value: "$" + phIndex },
     };
     phIndex += 1;
@@ -227,8 +235,8 @@ module.exports = {
     fields: (cfg) => cfg?.columns || [],
     get_table: (cfg) => {
       return {
-        getRows: async (where) => {
-          const qres = await runQuery(cfg, where);
+        getRows: async (where, opts) => {
+          const qres = await runQuery(cfg, where, opts);
           return qres.rows;
         },
       };