@saltcorn/postgres 1.6.0 → 1.7.0-alpha.0

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This is the postgres package
+ * @module
+ */
+export * from "./postgres.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+// For the typedoc documentation
+/**
+ * This is the postgres package
+ * @module
+ */
+export * from "./postgres.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC;;;GAGG;AACH,cAAc,eAAe,CAAC"}

package/dist/postgres.d.ts

@@ -0,0 +1,286 @@
+/**
+ * PostgreSQL data access layer
+ * @category postgres
+ * @module postgres
+ */
+import { Pool } from "pg";
+import type { PoolClient } from "pg";
+import { mkWhere } from "@saltcorn/db-common/internal";
+import type { Where, SelectOptions, Row } from "@saltcorn/db-common/internal";
+export declare let pool: Pool | null;
+/**
+ * Control Logging sql statements to console
+ * @param {boolean} [val = true] - if true then log sql statements to console
+ */
+export declare function set_sql_logging(val?: boolean): void;
+/**
+ * Get sql logging state
+ * @returns {boolean} if true then sql logging eabled
+ */
+export declare function get_sql_logging(): boolean;
+/**
+ * Log SQL statement to console
+ * @param {string} sql - SQL statement
+ * @param {object} [vs] - any additional parameter
+ */
+export declare function sql_log(sql: string, vs?: any): void;
+/**
+ * Close database connection
+ * @returns {Promise<void>}
+ */
+export declare const close: () => Promise<void>;
+/**
+ * Change connection (close connection and open new connection from connObj)
+ * @param {object} [connObj = {}] - connection object
+ * @returns {Promise<void>}
+ */
+export declare const changeConnection: (connObj?: any) => Promise<void>;
+export declare const begin: () => Promise<void>;
+export declare const commit: () => Promise<void>;
+export declare const rollback: () => Promise<void>;
+/**
+ * Execute Select statement
+ * @param {string} tbl - table name
+ * @param {object} whereObj - where object
+ * @param {object} [selectopts = {}] - select options
+ * @returns {Promise<*>} return rows
+ */
+export declare const select: (tbl: string, whereObj: Where, selectopts?: SelectOptions & {
+    [key: string]: any;
+}) => Promise<Row[]>;
+/**
+ * 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
+ */
+export declare const drop_reset_schema: (schema: string) => Promise<void>;
+/**
+ * Create the Postgres schema backing a tenant namespace.
+ * @param {string} name - tenant/schema name
+ * @param {boolean} [ifNotExists] - use IF NOT EXISTS (idempotent, used by tests)
+ * @returns {Promise<void>} no result
+ */
+export declare const create_tenant_schema: (name: string, ifNotExists?: boolean) => Promise<void>;
+/**
+ * Drop the Postgres schema backing a tenant namespace.
+ * @param {string} name - tenant/schema name
+ * @returns {Promise<void>} no result
+ */
+export declare const drop_tenant_schema: (name: string) => Promise<void>;
+/**
+ * Upsert a row into _sc_config.
+ * @param {string} key
+ * @param {any} value
+ * @returns {Promise<void>} no result
+ */
+export declare const upsert_config: (key: string, value: any) => Promise<void>;
+/**
+ * Build the express-session Store backed by this Postgres pool.
+ * @param {any} session - the express-session module instance the app uses
+ * @param {object} [opts]
+ * @returns {any} a session.Store instance
+ */
+export declare const getExpressSessionStore: (session: any, opts?: {
+    pruneInterval?: number;
+}) => any;
+/**
+ * Get count of rows in table
+ * @param {string} - tbl - table name
+ * @param {object} - whereObj - where object
+ * @returns {Promise<number>} count of tables
+ */
+export declare const count: (tbl: string, whereObj: Where, opts?: SelectOptions & {
+    [key: string]: any;
+}) => Promise<number>;
+/**
+ * Get version of PostgreSQL
+ * @param {boolean} short - if true return short version info else full version info
+ * @returns {Promise<string>} returns version
+ */
+export declare const getVersion: (short?: boolean) => Promise<string>;
+/**
+ * Delete rows in table
+ * @param {string} tbl - table name
+ * @param {object} whereObj - where object
+ * @param {object} [opts = {}]
+ * @returns {Promise<object[]>} result of delete execution
+ */
+export declare const deleteWhere: (tbl: string, whereObj: Where, opts?: {
+    schema?: string;
+    client?: any;
+}) => Promise<Row[]>;
+export declare const truncate: (tbl: string) => Promise<Row[]>;
+/**
+ * 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.
+ */
+export declare const insert: (tbl: string, obj: Row, opts?: {
+    schema?: string;
+    onConflictDoNothing?: boolean;
+    noid?: boolean;
+    pk_name?: string;
+    client?: any;
+}) => Promise<any>;
+/**
+ * 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
+ */
+export declare const update: (tbl: string, obj: Row, id: any, opts?: {
+    schema?: string;
+    pk_name?: string;
+    client?: any;
+}) => Promise<void>;
+/**
+ * Update table records
+ * @param {string} tbl - table name
+ * @param {object} obj - columns names and data
+ * @param {object} whereObj - where object
+ * @param {object} opts - can contain a db client for transactions
+ * @returns {Promise<void>} no result
+ */
+export declare const updateWhere: (tbl: string, obj: Row, whereObj: Where, opts?: {
+    client?: any;
+}) => Promise<void>;
+/**
+ * Select one record
+ * @param {srting} tbl - table name
+ * @param {object} where - where object
+ * @param {object} [selectopts = {}] - select options
+ * @returns {Promise<object>} return first record from sql result
+ * @throws {Error}
+ */
+export declare const selectOne: (tbl: string, where: Where, selectopts?: SelectOptions) => Promise<Row>;
+/**
+ * Select one record or null if no records
+ * @param {string} tbl - table name
+ * @param {object} where - where object
+ * @param {object} [selectopts = {}] - select options
+ * @returns {Promise<null|object>} - null if no record or first record data
+ */
+export declare const selectMaybeOne: (tbl: string, where: Where, selectopts?: SelectOptions) => Promise<Row | null>;
+/**
+ * Open db connection
+ * Only for PG.
+ * @returns {Promise<*>} db connection object
+ */
+export declare const getClient: () => Promise<PoolClient>;
+/**
+ * Reset sequence
+ * Only for PG
+ * @param {string} tblname - table name
+ * @returns {Promise<void>} no result
+ */
+export declare const reset_sequence: (tblname: string, pkname?: string) => Promise<void>;
+/**
+ * Add unique constraint
+ * @param {string} table_name - table name
+ * @param {string[]} field_names - list of columns (members of constraint)
+ * @returns {Promise<void>} no result
+ */
+export declare const add_unique_constraint: (table_name: string, field_names: string[]) => Promise<void>;
+/**
+ * Drop unique constraint
+ * @param {string} table_name - table name
+ * @param {string[]} field_names - list of columns (members of constraint)
+ * @returns {Promise<void>} no results
+ */
+export declare const drop_unique_constraint: (table_name: string, field_names: string[]) => Promise<void>;
+/**
+ * Add index
+ * @param {string} table_name - table name
+ * @param {string} field_name - list of columns (members of constraint)
+ * @returns {Promise<void>} no result
+ */
+export declare const add_index: (table_name: string, field_name: string) => Promise<void>;
+/**
+ * Add Full-text search index
+ * @param {string} table_name - table name
+ * @param {string} field_name - list of columns (members of constraint)
+ * @returns {Promise<void>} no result
+ */
+export declare const add_fts_index: (table_name: string, field_expression: string, language?: string, disable_fts?: boolean) => Promise<void>;
+export declare const drop_fts_index: (table_name: string) => Promise<void>;
+/**
+ * Add index
+ * @param {string} table_name - table name
+ * @param {string} field_name - list of columns (members of constraint)
+ * @returns {Promise<void>} no result
+ */
+export declare const drop_index: (table_name: string, field_name: string) => Promise<void>;
+/**
+ * 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
+ */
+export declare const copyFrom: (fileStream: any, tableName: string, fieldNames: string[], client: any) => Promise<any>;
+export declare const copyToJson: (fileStream: any, tableName: string, client?: any) => Promise<any>;
+export declare const slugify: (s: string) => string;
+export declare const time: () => Promise<Date>;
+/**
+ *
+ * @returns
+ */
+export declare const listTables: () => Promise<{
+    name: string;
+}[]>;
+/**
+ *
+ * @returns
+ */
+export declare const listUserDefinedTables: () => Promise<{
+    name: string;
+}[]>;
+/**
+ *
+ * @returns
+ */
+export declare const listScTables: () => Promise<{
+    name: string;
+}[]>;
+export declare const setRequestUserContext: (client: any, isLocal?: boolean) => Promise<void>;
+export declare const withTransaction: (f: (rollback: () => Promise<void>) => Promise<any>, onError?: (e: Error) => any) => Promise<any>;
+export declare const commitAndBeginNewTransaction: () => Promise<void>;
+export declare const tryCatchInTransaction: (f: () => Promise<any>, onError?: (e: Error) => any) => Promise<any>;
+/**
+ * Should be used for code that is sometimes called from within a withTransaction block
+ * and sometimes not.
+ * @param {Function} f logic to execute
+ * @param {Function} onError error handler
+ * @returns
+ */
+export declare const openOrUseTransaction: (f: (rollback?: () => Promise<void>) => Promise<any>, onError?: (e: Error) => any) => Promise<any>;
+/**
+ * Wait some time until current transaction COMMITs,
+ * then open another transaction.
+ * @param {Function} f logic to execute
+ * @param {Function} onError error handler
+ * @returns
+ */
+export declare const whenTransactionisFree: (f: (rollback?: () => Promise<void>) => Promise<any>, onError?: (e: Error) => any) => Promise<any>;
+export declare const query: (text: string, params?: any[]) => Promise<any>;
+export { mkWhere };
+export declare const driverName = "postgres";
+export declare const array_agg_sql_fn = "array_agg";
+export declare const serial_pk_sql_type = "serial";
+export declare const json_sql_type = "jsonb";
+export declare const indexable_text_sql_type = "text";
+export declare const supports_search_path = true;
+/**
+ * Initializes internals of the the postgres module.
+ * It must be called after importing the module.
+ * @param getConnectObjectPara function returning the connection object
+ */
+export declare const init: (getConnectObjectPara: (connObj?: any) => any) => void;
+//# sourceMappingURL=postgres.d.ts.map

package/dist/postgres.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgres.d.ts","sourceRoot":"","sources":["../postgres.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,IAAI,EAAS,MAAM,IAAI,CAAC;AACjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAMrC,OAAO,EAEL,OAAO,EAER,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAEV,KAAK,EACL,aAAa,EACb,GAAG,EACJ,MAAM,8BAA8B,CAAC;AAWtC,eAAO,IAAI,IAAI,EAAE,IAAI,GAAG,IAAW,CAAC;AAQpC;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,GAAE,OAAc,GAAG,IAAI,CAEzD;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAEzC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,GAAG,GAAG,IAAI,CAInD;AAED;;;GAGG;AACH,eAAO,MAAM,KAAK,QAAa,OAAO,CAAC,IAAI,CAG1C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAC3B,UAAS,GAAyB,KACjC,OAAO,CAAC,IAAI,CAGd,CAAC;AAEF,eAAO,MAAM,KAAK,QAAa,OAAO,CAAC,IAAI,CAG1C,CAAC;AAEF,eAAO,MAAM,MAAM,QAAa,OAAO,CAAC,IAAI,CAE3C,CAAC;AAEF,eAAO,MAAM,QAAQ,QAAa,OAAO,CAAC,IAAI,CAE7C,CAAC;AAOF;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,GACjB,KAAK,MAAM,EACX,UAAU,KAAK,EACf,aAAY,aAAa,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAwB,KACvE,OAAO,CAAC,GAAG,EAAE,CA6Cf,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAU,QAAQ,MAAM,KAAG,OAAO,CAAC,IAAI,CASpE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,MAAM,MAAM,EACZ,cAAc,OAAO,KACpB,OAAO,CAAC,IAAI,CAMd,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAU,MAAM,MAAM,KAAG,OAAO,CAAC,IAAI,CAInE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAU,KAAK,MAAM,EAAE,OAAO,GAAG,KAAG,OAAO,CAAC,IAAI,CAKzE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GACjC,SAAS,GAAG,EACZ,OAAM;IAAE,aAAa,CAAC,EAAE,MAAM,CAAA;CAAO,KACpC,GAUF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAChB,KAAK,MAAM,EACX,UAAU,KAAK,EACf,OAAO,aAAa,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,KAC5C,OAAO,CAAC,MAAM,CAoChB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAU,QAAQ,OAAO,KAAG,OAAO,CAAC,MAAM,CAUhE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GACtB,KAAK,MAAM,EACX,UAAU,KAAK,EACf,OAAM;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,GAAG,CAAA;CAAwB,KAC5D,OAAO,CAAC,GAAG,EAAE,CAUf,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAU,KAAK,MAAM,KAAG,OAAO,CAAC,GAAG,EAAE,CAOzD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,GACjB,KAAK,MAAM,EACX,KAAK,GAAG,EACR,OAAM;IACJ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,GAAG,CAAC;CACQ,KACtB,OAAO,CAAC,GAAG,CAmCb,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,GACjB,KAAK,MAAM,EACX,KAAK,GAAG,EACR,IAAI,GAAG,EACP,OAAM;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,GAAG,CAAA;CAEtD,KACA,OAAO,CAAC,IAAI,CA4Bd,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,GACtB,KAAK,MAAM,EACX,KAAK,GAAG,EACR,UAAU,KAAK,EACf,OAAM;IAAE,MAAM,CAAC,EAAE,GAAG,CAAA;CAAwB,KAC3C,OAAO,CAAC,IAAI,CAcd,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,GACpB,KAAK,MAAM,EACX,OAAO,KAAK,EACZ,aAAY,aAAmC,KAC9C,OAAO,CAAC,GAAG,CAMb,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GACzB,KAAK,MAAM,EACX,OAAO,KAAK,EACZ,aAAY,aAAmC,KAC9C,OAAO,CAAC,GAAG,GAAG,IAAI,CAIpB,CAAC;AAEF;;;;GAIG;AAEH,eAAO,MAAM,SAAS,QAAa,OAAO,CAAC,UAAU,CAA0B,CAAC;AAEhF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,SAAS,MAAM,EACf,SAAQ,MAAa,KACpB,OAAO,CAAC,IAAI,CAOd,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,YAAY,MAAM,EAClB,aAAa,MAAM,EAAE,KACpB,OAAO,CAAC,IAAI,CAWd,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GACjC,YAAY,MAAM,EAClB,aAAa,MAAM,EAAE,KACpB,OAAO,CAAC,IAAI,CASd,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GACpB,YAAY,MAAM,EAClB,YAAY,MAAM,KACjB,OAAO,CAAC,IAAI,CASd,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GACxB,YAAY,MAAM,EAClB,kBAAkB,MAAM,EACxB,WAAW,MAAM,EACjB,cAAc,OAAO,KACpB,OAAO,CAAC,IAAI,CAsBd,CAAC;AACF,eAAO,MAAM,cAAc,GAAU,YAAY,MAAM,KAAG,OAAO,CAAC,IAAI,CAOrE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GACrB,YAAY,MAAM,EAClB,YAAY,MAAM,KACjB,OAAO,CAAC,IAAI,CAOd,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,GACnB,YAAY,GAAG,EACf,WAAW,MAAM,EACjB,YAAY,MAAM,EAAE,EACpB,QAAQ,GAAG,KACV,OAAO,CAAC,GAAG,CAQb,CAAC;AAEF,eAAO,MAAM,UAAU,GACrB,YAAY,GAAG,EACf,WAAW,MAAM,EACjB,SAAS,GAAG,KACX,OAAO,CAAC,GAAG,CAOb,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,GAAG,MAAM,KAAG,MAIT,CAAC;AAE5B,eAAO,MAAM,IAAI,QAAa,OAAO,CAAC,IAAI,CAIzC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,QAAa,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,CAO7D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAAa,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,CAOxE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,QAAa,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,CAO/D,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAAU,QAAQ,GAAG,EAAE,iBAAe,kBAavE,CAAC;AASF,eAAO,MAAM,eAAe,GAC1B,GAAG,CAAC,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,EAClD,UAAU,CAAC,CAAC,EAAE,KAAK,KAAK,GAAG,KAC1B,OAAO,CAAC,GAAG,CAsCb,CAAC;AAEF,eAAO,MAAM,4BAA4B,QAAa,OAAO,CAAC,IAAI,CAMjE,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAChC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,EACrB,UAAU,CAAC,CAAC,EAAE,KAAK,KAAK,GAAG,KAC1B,OAAO,CAAC,GAAG,CAYb,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAC/B,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,EACnD,UAAU,CAAC,CAAC,EAAE,KAAK,KAAK,GAAG,KAC1B,OAAO,CAAC,GAAG,CAIb,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAChC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,EACnD,UAAU,CAAC,CAAC,EAAE,KAAK,KAAK,GAAG,KAC1B,OAAO,CAAC,GAAG,CAoBb,CAAC;AAEF,eAAO,MAAM,KAAK,GAAI,MAAM,MAAM,EAAE,SAAS,GAAG,EAAE,KAAG,OAAO,CAAC,GAAG,CAG/D,CAAC;AAEF,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB,eAAO,MAAM,UAAU,aAAa,CAAC;AACrC,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAC5C,eAAO,MAAM,kBAAkB,WAAW,CAAC;AAC3C,eAAO,MAAM,aAAa,UAAU,CAAC;AACrC,eAAO,MAAM,uBAAuB,SAAS,CAAC;AAC9C,eAAO,MAAM,oBAAoB,OAAO,CAAC;AAEzC;;;;GAIG;AACH,eAAO,MAAM,IAAI,GAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE,GAAG,KAAK,GAAG,KAAG,IAYnE,CAAC"}