@saltcorn/data 0.6.1-beta.1 → 0.6.2-beta.0

package/db/pg.js

@@ -1,384 +0,0 @@
-/**
- * PostgreSQL data access layer
- * @category saltcorn-data
- * @module db/pg
- * @subcategory db
- */
-// TODO move postgresql specific to this module
-const { Pool } = require("pg");
-const copyStreams = require("pg-copy-streams");
-const { promisify } = require("util");
-const { pipeline } = require("stream");
-const { sqlsanitize, mkWhere, mkSelectOptions } = require("./internal");
-const { getConnectObject } = require("./connect");
-const { getTenantSchema } = require("./tenants");
-
-var connectObj = getConnectObject();
-
-var pool;
-if (connectObj) pool = new Pool(connectObj);
-
-var log_sql_enabled = false;
-
-/**
- * Control Logging sql statements to console
- * @param {boolean} [val = true] - if true then log sql statements to console
- */
-function set_sql_logging(val = true) {
-  log_sql_enabled = val;
-}
-
-/**
- * Get sql logging state
- * @returns {boolean} if true then sql logging eabled
- */
-function get_sql_logging() {
-  return log_sql_enabled;
-}
-
-/**
- * Log SQL statement to console
- * @param {string} sql - SQL statement
- * @param {object} [vs] - any additional parameter
- */
-function sql_log(sql, vs) {
-  if (log_sql_enabled)
-    if (typeof vs === "undefined") console.log(sql);
-    else console.log(sql, vs);
-}
-
-/**
- * Close database connection
- * @returns {Promise<void>}
- */
-const close = async () => {
-  if (pool) await pool.end();
-};
-
-/**
- * Change connection (close connection and open new connection from connObj)
- * @param {object} [connObj = {}] - connection object
- * @returns {Promise<void>}
- */
-const changeConnection = async (connObj = {}) => {
-  await close();
-  pool = new Pool(getConnectObject(connObj));
-};
-
-/**
- * Execute Select statement
- * @param {string} tbl - table name
- * @param {object} whereObj - where object
- * @param {object} [selectopts = {}] - select options
- * @returns {Promise<*>} return rows
- */
-const select = async (tbl, whereObj, selectopts = {}) => {
-  const { where, values } = mkWhere(whereObj);
-  const sql = `SELECT * FROM "${getTenantSchema()}"."${sqlsanitize(
-    tbl
-  )}" ${where} ${mkSelectOptions(selectopts)}`;
-  sql_log(sql, values);
-  const tq = await pool.query(sql, values);
-
-  return tq.rows;
-};
-
-/**
- * Reset DB Schema using drop schema and recreate it
- * Atterntion! You will lost data after call this function!
- * @param {string} schema - db schema name
- * @returns {Promise<void>} no result
- */
-const drop_reset_schema = async (schema) => {
-  const sql = `DROP SCHEMA IF EXISTS "${schema}" CASCADE;
-  CREATE SCHEMA "${schema}";
-  GRANT ALL ON SCHEMA "${schema}" TO postgres;
-  GRANT ALL ON SCHEMA "${schema}" TO "public" ;
-  COMMENT ON SCHEMA "${schema}" IS 'standard public schema';`;
-  sql_log(sql);
-
-  await pool.query(sql);
-};
-
-/**
- * Get count of rows in table
- * @param {string} - tbl - table name
- * @param {object} - whereObj - where object
- * @returns {Promise<number>} count of tables
- */
-const count = async (tbl, whereObj) => {
-  const { where, values } = mkWhere(whereObj);
-  const sql = `SELECT COUNT(*) FROM "${getTenantSchema()}"."${sqlsanitize(
-    tbl
-  )}" ${where}`;
-  sql_log(sql, values);
-  const tq = await pool.query(sql, values);
-
-  return parseInt(tq.rows[0].count);
-};
-
-/**
- * Get version of PostgreSQL
- * @param {boolean} short - if true return short version info else full version info
- * @returns {Promise<string>} returns version
- */
-const getVersion = async (short) => {
-  const sql = `SELECT version();`;
-  sql_log(sql);
-  const tq = await pool.query(sql);
-  const v = tq.rows[0].version;
-  if (short) {
-    const ws = v.split(" ");
-    return ws[1];
-  }
-  return v;
-};
-
-/**
- * Delete rows in table
- * @param {string} tbl - table name
- * @param {object} whereObj - where object
- * @param {object} [opts = {}]
- * @returns {Promise<object[]>} result of delete execution
- */
-const deleteWhere = async (tbl, whereObj, opts = {}) => {
-  const { where, values } = mkWhere(whereObj);
-  const sql = `delete FROM "${getTenantSchema()}"."${sqlsanitize(
-    tbl
-  )}" ${where}`;
-  sql_log(sql, values);
-
-  const tq = await (opts.client || pool).query(sql, values);
-
-  return tq.rows;
-};
-
-/**
- * Insert rows into table
- * @param {string} tbl - table name
- * @param {object} obj - columns names and data
- * @param {object} [opts = {}] - columns attributes
- * @returns {Promise<string>} returns primary key column or Id column value. If primary key column is not defined then return value of Id column.
- */
-const insert = async (tbl, obj, opts = {}) => {
-  const kvs = Object.entries(obj);
-  const fnameList = kvs.map(([k, v]) => `"${sqlsanitize(k)}"`).join();
-  var valPosList = [];
-  var valList = [];
-  const schema = getTenantSchema();
-  kvs.forEach(([k, v]) => {
-    if (v && v.next_version_by_id) {
-      valPosList.push(
-        `coalesce((select max(_version) from "${schema}"."${sqlsanitize(
-          tbl
-        )}" where id=${+v.next_version_by_id}), 0)+1`
-      );
-    } else {
-      valList.push(v);
-      valPosList.push(`$${valList.length}`);
-    }
-  });
-  const sql =
-    valPosList.length > 0
-      ? `insert into "${schema}"."${sqlsanitize(
-          tbl
-        )}"(${fnameList}) values(${valPosList.join()}) returning ${
-          opts.noid ? "*" : opts.pk_name || "id"
-        }`
-      : `insert into "${schema}"."${sqlsanitize(
-          tbl
-        )}" DEFAULT VALUES returning ${opts.noid ? "*" : opts.pk_name || "id"}`;
-  sql_log(sql, valList);
-  const { rows } = await (opts.client || pool).query(sql, valList);
-  if (opts.noid) return;
-  else return rows[0][opts.pk_name || "id"];
-};
-
-/**
- * Update table records
- * @param {string} tbl - table name
- * @param {object} obj - columns names and data
- * @param {number|undefined} id - id of record (primary key column value)
- * @param {object} [opts = {}] - columns attributes
- * @returns {Promise<void>} no result
- */
-const update = async (tbl, obj, id, opts = {}) => {
-  const kvs = Object.entries(obj);
-  const assigns = kvs
-    .map(([k, v], ix) => `"${sqlsanitize(k)}"=$${ix + 1}`)
-    .join();
-  var valList = kvs.map(([k, v]) => v);
-  // TBD check that is correct - because in insert function opts.noid ? "*" : opts.pk_name || "id"
-  //valList.push(id === "undefined"? obj[opts.pk_name]: id);
-  valList.push(id === "undefined" ? obj[opts.pk_name || "id"] : id);
-  const q = `update "${getTenantSchema()}"."${sqlsanitize(
-    tbl
-  )}" set ${assigns} where ${opts.pk_name || "id"}=$${kvs.length + 1}`;
-  sql_log(q, valList);
-  await pool.query(q, valList);
-};
-
-/**
- * Select one record
- * @param {srting} tbl - table name
- * @param {object} where - where object
- * @returns {Promise<object>} return first record from sql result
- * @throws {Error}
- */
-const selectOne = async (tbl, where) => {
-  const rows = await select(tbl, where);
-  if (rows.length === 0) {
-    const w = mkWhere(where);
-    throw new Error(`no ${tbl} ${w.where} are ${w.values}`);
-  } else return rows[0];
-};
-
-/**
- * Select one record or null if no records
- * @param {string} tbl - table name
- * @param {object} where - where object
- * @returns {Promise<null|object>} - null if no record or first record data
- */
-const selectMaybeOne = async (tbl, where) => {
-  const rows = await select(tbl, where);
-  if (rows.length === 0) return null;
-  else return rows[0];
-};
-
-/**
- * Open db connection
- * Only for PG.
- * @returns {Promise<*>} db connection object
- */
-// TBD Currently this function supported only for PG
-const getClient = async () => await pool.connect();
-
-/**
- * Reset sequence
- * Only for PG
- * @param {string} tblname - table name
- * @returns {Promise<void>} no result
- */
-const reset_sequence = async (tblname) => {
-  const sql = `SELECT setval(pg_get_serial_sequence('"${getTenantSchema()}"."${sqlsanitize(
-    tblname
-  )}"', 'id'), coalesce(max(id),0) + 1, false) FROM "${getTenantSchema()}"."${sqlsanitize(
-    tblname
-  )}";`;
-  await pool.query(sql);
-};
-
-/**
- * Add unique constraint
- * @param {string} table_name - table name
- * @param {string[]} field_names - list of columns (members of constraint)
- * @returns {Promise<void>} no result
- */
-const add_unique_constraint = async (table_name, field_names) => {
-  // TBD check that there are no problems with lenght of constraint name
-  const sql = `alter table "${getTenantSchema()}"."${sqlsanitize(
-    table_name
-  )}" add CONSTRAINT "${sqlsanitize(table_name)}_${field_names
-    .map((f) => sqlsanitize(f))
-    .join("_")}_unique" UNIQUE (${field_names
-    .map((f) => `"${sqlsanitize(f)}"`)
-    .join(",")});`;
-  sql_log(sql);
-  await pool.query(sql);
-};
-
-/**
- * Drop unique constraint
- * @param {string} table_name - table name
- * @param {string[]} field_names - list of columns (members of constraint)
- * @returns {Promise<void>} no results
- */
-const drop_unique_constraint = async (table_name, field_names) => {
-  // TBD check that there are no problems with lenght of constraint name
-  const sql = `alter table "${getTenantSchema()}"."${sqlsanitize(
-    table_name
-  )}" drop CONSTRAINT "${sqlsanitize(table_name)}_${field_names
-    .map((f) => sqlsanitize(f))
-    .join("_")}_unique";`;
-  sql_log(sql);
-  await pool.query(sql);
-};
-/**
- * Copy data from CSV to table?
- * Only for PG
- * @param {object} fileStream - file stream
- * @param {string} tableName - table name
- * @param {string[]} fieldNames - list of columns
- * @param {object} client - db connection
- * @returns {Promise<function>} new Promise
- */
-const copyFrom1 = (fileStream, tableName, fieldNames, client) => {
-  // TBD describe difference between CopyFrom and CopyFrom1
-  const quote = (s) => `"${s}"`;
-  const sql = `COPY "${sqlsanitize(tableName)}" (${fieldNames
-    .map(quote)
-    .join(",")}) FROM STDIN CSV HEADER`;
-  sql_log(sql);
-
-  var stream = client.query(copyStreams.from(sql));
-
-  return new Promise((resolve, reject) => {
-    fileStream.on("error", reject);
-    stream.on("error", reject);
-    stream.on("finish", resolve);
-    fileStream.pipe(stream).on("error", reject);
-  });
-};
-/**
- * Copy data from CSV to table?
- * Only for PG
- * @param {object} fileStream - file stream
- * @param {string} tableName - table name
- * @param {string[]} fieldNames - list of columns
- * @param {object} client - db connection
- * @returns {Promise<void>} no results
- */
-const copyFrom = async (fileStream, tableName, fieldNames, client) => {
-  // TBD describe difference between CopyFrom and CopyFrom1
-  const quote = (s) => `"${s}"`;
-  const sql = `COPY "${sqlsanitize(tableName)}" (${fieldNames
-    .map(quote)
-    .join(",")}) FROM STDIN CSV HEADER`;
-  sql_log(sql);
-
-  const stream = client.query(copyStreams.from(sql));
-  return await promisify(pipeline)(fileStream, stream);
-};
-
-module.exports = {
-  pool,
-  /**
-   * @param {string} text 
-   * @param {object} params 
-   * @returns {object}
-   */
-  query: (text, params) => {
-    sql_log(text, params);
-    return pool.query(text, params);
-  },
-  select,
-  selectOne,
-  selectMaybeOne,
-  count,
-  insert,
-  update,
-  deleteWhere,
-  close,
-  sql_log,
-  changeConnection,
-  set_sql_logging,
-  get_sql_logging,
-  getClient,
-  mkWhere,
-  drop_reset_schema,
-  add_unique_constraint,
-  drop_unique_constraint,
-  reset_sequence,
-  getVersion,
-  copyFrom,
-};

package/db/single-tenant.js

@@ -1,26 +0,0 @@
-/**
- * @category saltcorn-data
- * @module db/single-tenant
- * @subcategory db
- */
-
-module.exports = (connObj) => ({
-  /**
-   * @returns {string}
-   */
-  getTenantSchema: () => connObj.default_schema,
-  /** 
-   * @returns {false}
-   */
-  is_it_multi_tenant: () => false,
-  enable_multi_tenant() {},
-  /**
-   * @param {*} t 
-   * @param {function} f 
-   * @returns {*}
-   */
-  runWithTenant(t, f) {
-    return f();
-  },
-});
-

package/db/sqlite.js

@@ -1,297 +0,0 @@
-/**
- * SQLite3 data access layer
- * @category saltcorn-data
- * @module db/sqlite
- * @subcategory db
- */
-// TODO move all sqlite specific to this module
-const sqlite3 = require("sqlite3").verbose();
-const { sqlsanitize, mkWhere, mkSelectOptions } = require("./internal");
-const { getConnectObject } = require("./connect");
-const fs = require("fs").promises;
-const connectObj = getConnectObject(); // was var
-/**
- * Get sqlite path
- * @returns {string}
- */
-const get_db_filepath = () => {
-  if (connectObj.sqlite_path) return connectObj.sqlite_path;
-};
-
-let current_filepath = get_db_filepath();
-let sqliteDatabase = new sqlite3.Database(current_filepath);
-
-let log_sql_enabled = false;
-
-/**
- * Control Logging sql statements to console
- * @param {boolean} [val = true] - if true then log sql statements to console
- */
-function set_sql_logging(val = true) {
-  log_sql_enabled = val;
-}
-
-/**
- * Get sql logging state
- * @returns {boolean} if true then sql logging eabled
- */
-function get_sql_logging() {
-  return log_sql_enabled;
-}
-/**
- * Log SQL statement to console
- * @param {string} sql - SQL statement
- * @param {object} [vs] - any additional parameter
- */
-function sql_log(sql, vs) {
-  if (log_sql_enabled)
-    if (typeof vs === "undefined") console.log(sql);
-    else console.log(sql, vs);
-}
-
-/**
- * @param {string} sql 
- * @param {object} params 
- * @returns {Promise<Object[]>}
- */
-function query(sql, params) {
-  sql_log(sql, params);
-  return new Promise((resolve, reject) => {
-    sqliteDatabase.all(sql, params, function (err, rows) {
-      if (err) {
-        reject(err);
-      } else {
-        resolve({ rows });
-      }
-    });
-  });
-}
-/**
- * Change connection (close connection and open new connection from connObj)
- * @param {object} connObj - connection object
- * @returns {Promise<void>}
- */
-const changeConnection = async (connObj) => {
-  await sqliteDatabase.close();
-  current_filepath = connObj.sqlite_path;
-  sqliteDatabase = new sqlite3.Database(current_filepath);
-};
-/**
- * Close database connection
- * @returns {Promise<void>}
- */
-const close = async () => {
-  await sqliteDatabase.close();
-};
-/**
- * Execute Select statement
- * @param {string} tbl - table name
- * @param {object} whereObj - where object
- * @param {object} [selectopts = {}] - select options
- * @returns {Promise<*>} return rows
- */
-const select = async (tbl, whereObj, selectopts = {}) => {
-  const { where, values } = mkWhere(whereObj, true);
-  const sql = `SELECT * FROM "${sqlsanitize(tbl)}" ${where} ${mkSelectOptions(
-    selectopts
-  )}`;
-  const tq = await query(sql, values);
-
-  return tq.rows;
-};
-/**
- *
- * @param v
- * @returns {boolean}
- */
-// TODO Utility function - needs ti be moved out this module
-/**
- * @param {object} v 
- * @returns {boolean}
- */
-const reprAsJson = (v) =>
-  typeof v === "object" && v !== null && !(v instanceof Date);
-/**
- * @param {object[]} opts
- * @param {*} opts.k
- * @param {object} opts.v
- * @returns {object}
- */
-const mkVal = ([k, v]) => (reprAsJson(v) ? JSON.stringify(v) : v);
-
-/**
- * Drop unique constraint
- * @param {string} tbl - table name
- * @param {object[]} obj - list of column=value pairs
- * @param {number} id - primary key column value
- * @returns {Promise<void>} no results
- */
-const update = async (tbl, obj, id) => {
-  const kvs = Object.entries(obj);
-  const assigns = kvs.map(([k, v], ix) => `"${sqlsanitize(k)}"=?`).join();
-  let valList = kvs.map(mkVal);
-  valList.push(id);
-  const q = `update "${sqlsanitize(tbl)}" set ${assigns} where id=?`;
-  await query(q, valList);
-};
-
-/**
- * Delete rows in table
- * @param {string} tbl - table name
- * @param {object} whereObj - where object
- * @returns {Promise<void>} result of delete execution
- */
-const deleteWhere = async (tbl, whereObj) => {
-  const { where, values } = mkWhere(whereObj, true);
-  const sql = `delete FROM "${sqlsanitize(tbl)}" ${where}`;
-
-  const tq = await query(sql, values);
-};
-/**
- * Insert rows into table
- * @param {string} tbl - table name
- * @param {object} obj - columns names and data
- * @param {object} [opts = {}] - columns attributes
- * @returns {Promise<string>} returns id.
- */
-const insert = async (tbl, obj, opts = {}) => {
-  const kvs = Object.entries(obj);
-  const fnameList = kvs.map(([k, v]) => `"${sqlsanitize(k)}"`).join();
-  const valPosList = kvs
-    .map(([k, v], ix) =>
-      v && v.next_version_by_id
-        ? `coalesce((select max(_version) from "${sqlsanitize(
-            tbl
-          )}" where id=${+v.next_version_by_id}), 0)+1`
-        : reprAsJson(v)
-        ? "json(?)"
-        : "?"
-    )
-    .join();
-  const valList = kvs
-    .filter(([k, v]) => !(v && v.next_version_by_id))
-    .map(mkVal);
-  const sql = `insert into "${sqlsanitize(
-    tbl
-  )}"(${fnameList}) values(${valPosList})`;
-
-  await query(sql, valList);
-  if (opts.noid) return;
-  // TBD Support of primary key column different from id
-  const ids = await query("SELECT last_insert_rowid() as id");
-  return ids.rows[0].id;
-};
-
-/**
- * Select one record
- * @param {string} tbl - table name
- * @param {object} where - where object
- * @throws {Error}
- * @returns {Promise<object>} return first record from sql result
- */
-const selectOne = async (tbl, where) => {
-  const rows = await select(tbl, where);
-  if (rows.length === 0) {
-    const w = mkWhere(where, true);
-    throw new Error(`no ${tbl} ${w.where} are ${w.values}`);
-  } else return rows[0];
-};
-
-/**
- * Select one record or null if no records
- * @param {string} tbl - table name
- * @param {object} where - where object
- * @returns {Promise<object>} - null if no record or first record data
- */
-const selectMaybeOne = async (tbl, where) => {
-  const rows = await select(tbl, where);
-  if (rows.length === 0) return null;
-  else return rows[0];
-};
-
-/**
- * Get count of rows in table
- * @param {string} tbl - table name
- * @param {object} whereObj - where object
- * @returns {Promise<number>} count of tables
- */
-const count = async (tbl, whereObj) => {
-  const { where, values } = mkWhere(whereObj, true);
-  const sql = `SELECT COUNT(*) FROM "${sqlsanitize(tbl)}" ${where}`;
-  const tq = await query(sql, values);
-  return parseInt(tq.rows[0]["COUNT(*)"]);
-};
-/**
- * Get version of PostgreSQL
- * @returns {Promise<string>} returns version
- */
-const getVersion = async () => {
-  const sql = `SELECT sqlite_version();`;
-  sql_log(sql);
-  const tq = await query(sql);
-  return tq.rows[0]["sqlite_version()"];
-};
-
-/**
- * Reset DB Schema using drop schema and recreate it.
- * Attention! You will lost data after call this function!
- * @returns {Promise<void>} no result
- */
-const drop_reset_schema = async () => {
-  await sqliteDatabase.close();
-  await fs.unlink(current_filepath);
-  sqliteDatabase = new sqlite3.Database(current_filepath);
-};
-
-/**
- * Add unique constraint
- * @param {string} table_name - table name
- * @param {string[]} field_names - list of columns (members of constraint)
- * @returns {Promise<void>} no result
- */
-const add_unique_constraint = async (table_name, field_names) => {
-  const sql = `create unique index ${sqlsanitize(
-    table_name
-  )}_${field_names
-    .map((f) => sqlsanitize(f))
-    .join("_")}_unique on "${sqlsanitize(table_name)}"(${field_names
-    .map((f) => `"${sqlsanitize(f)}"`)
-    .join(",")});`;
-  sql_log(sql);
-  await query(sql);
-};
-
-/**
- * Drop unique constraint
- * @param {string} table_name - table name
- * @param {string[]} field_names - list of columns (members of constraint)
- * @returns {Promise<void>} no results
- */
-const drop_unique_constraint = async (table_name, field_names) => {
-  const sql = `drop index ${sqlsanitize(table_name)}_${field_names
-    .map((f) => sqlsanitize(f))
-    .join("_")}_unique;`;
-  sql_log(sql);
-  await query(sql);
-};
-
-module.exports = {
-  sql_log,
-  set_sql_logging,
-  get_sql_logging,
-  sqliteDatabase,
-  changeConnection,
-  query,
-  select,
-  selectOne,
-  selectMaybeOne,
-  insert,
-  count,
-  close,
-  drop_reset_schema,
-  update,
-  deleteWhere,
-  add_unique_constraint,
-  drop_unique_constraint,
-  getVersion,
-};

package/db/tenants.js

@@ -1,12 +0,0 @@
-/**
- * @category saltcorn-data
- * @module db/tenants
- * @subcategory db
- */
-const { getConnectObject } = require("./connect");
-
-var connectObj = getConnectObject();
-module.exports = connectObj.multi_tenant
-  ? require("./multi-tenant")(connectObj)
-  : require("./single-tenant")(connectObj);
-