n8n-nodes-base
Version:
Base nodes of n8n
646 lines • 26 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.getItemsCopy = getItemsCopy;
exports.getItemCopy = getItemCopy;
exports.generateReturning = generateReturning;
exports.wrapData = wrapData;
exports.pgQuery = pgQuery;
exports.pgQueryV2 = pgQueryV2;
exports.pgInsert = pgInsert;
exports.pgInsertV2 = pgInsertV2;
exports.pgUpdate = pgUpdate;
exports.pgUpdateV2 = pgUpdateV2;
const errors_1 = require("@n8n/errors");
const utilities_1 = require("../../../utils/utilities");
/**
* Returns of a shallow copy of the items which only contains the json data and
* of that only the define properties
*
* @param {INodeExecutionData[]} items The items to copy
* @param {string[]} properties The properties it should include
*/
function getItemsCopy(items, properties, guardedColumns) {
let newItem;
return items.map((item) => {
newItem = {};
if (guardedColumns) {
Object.keys(guardedColumns).forEach((column) => {
newItem[column] = item.json[guardedColumns[column]];
});
}
else {
for (const property of properties) {
newItem[property] = item.json[property];
}
}
return newItem;
});
}
/**
* Returns of a shallow copy of the item which only contains the json data and
* of that only the define properties
*
* @param {INodeExecutionData} item The item to copy
* @param {string[]} properties The properties it should include
*/
function getItemCopy(item, properties, guardedColumns) {
const newItem = {};
if (guardedColumns) {
Object.keys(guardedColumns).forEach((column) => {
newItem[column] = item.json[guardedColumns[column]];
});
}
else {
for (const property of properties) {
newItem[property] = item.json[property];
}
}
return newItem;
}
/**
* Returns a returning clause from a comma separated string
* @param {pgPromise.IMain<{}, pg.IClient>} pgp The pgPromise instance
* @param string returning The comma separated string
*/
function generateReturning(pgp, returning) {
return (' RETURNING ' +
returning
.split(',')
.map((returnedField) => pgp.as.name(returnedField.trim()))
.join(', '));
}
function wrapData(data) {
if (!Array.isArray(data)) {
return [{ json: data }];
}
return data.map((item) => ({
json: item,
}));
}
/**
* Executes the given SQL query on the database.
*
* @param {Function} getNodeParam The getter for the Node's parameters
* @param {pgPromise.IMain<{}, pg.IClient>} pgp The pgPromise instance
* @param {PgpDatabase} db The pgPromise database connection
* @param {input[]} input The Node's input data
*/
async function pgQuery(
// eslint-disable-next-line @typescript-eslint/no-restricted-types
getNodeParam, pgp, db, items, continueOnFail, overrideMode) {
const additionalFields = getNodeParam('additionalFields', 0);
let valuesArray = [];
if (additionalFields.queryParams) {
const propertiesString = additionalFields.queryParams;
const properties = propertiesString.split(',').map((column) => column.trim());
const paramsItems = getItemsCopy(items, properties);
valuesArray = paramsItems.map((row) => properties.map((col) => row[col]));
}
const allQueries = [];
for (let i = 0; i < items.length; i++) {
const query = getNodeParam('query', i);
const values = valuesArray[i];
const queryFormat = { query, values };
allQueries.push(queryFormat);
}
const mode = overrideMode ? overrideMode : (additionalFields.mode ?? 'multiple');
if (mode === 'multiple') {
return (await db.multi(pgp.helpers.concat(allQueries))).flat(1);
}
else if (mode === 'transaction') {
return await db.tx(async (t) => {
const result = [];
for (let i = 0; i < allQueries.length; i++) {
try {
Array.prototype.push.apply(result, await t.any(allQueries[i].query, allQueries[i].values));
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
...items[i].json,
code: err.code,
message: err.message,
});
return result;
}
}
return result;
});
}
else if (mode === 'independently') {
return await db.task(async (t) => {
const result = [];
for (let i = 0; i < allQueries.length; i++) {
try {
Array.prototype.push.apply(result, await t.any(allQueries[i].query, allQueries[i].values));
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
...items[i].json,
code: err.code,
message: err.message,
});
}
}
return result;
});
}
throw new errors_1.ApplicationError('multiple, independently or transaction are valid options', {
level: 'warning',
});
}
async function pgQueryV2(pgp, db, items, continueOnFail, options) {
const additionalFields = this.getNodeParameter('additionalFields', 0);
let valuesArray = [];
if (additionalFields.queryParams) {
const propertiesString = additionalFields.queryParams;
const properties = propertiesString.split(',').map((column) => column.trim());
const paramsItems = getItemsCopy(items, properties);
valuesArray = paramsItems.map((row) => properties.map((col) => row[col]));
}
const allQueries = new Array();
for (let i = 0; i < items.length; i++) {
let query = this.getNodeParameter('query', i);
if (options?.resolveExpression) {
for (const resolvable of (0, utilities_1.getResolvables)(query)) {
query = query.replace(resolvable, this.evaluateExpression(resolvable, i));
}
}
const values = valuesArray[i];
const queryFormat = { query, values };
allQueries.push(queryFormat);
}
const mode = options?.overrideMode
? options.overrideMode
: (additionalFields.mode ?? 'multiple');
if (mode === 'multiple') {
return (await db.multi(pgp.helpers.concat(allQueries)))
.map((result, i) => {
return this.helpers.constructExecutionMetaData(wrapData(result), {
itemData: { item: i },
});
})
.flat();
}
else if (mode === 'transaction') {
return await db.tx(async (t) => {
const result = [];
for (let i = 0; i < allQueries.length; i++) {
try {
const transactionResult = await t.any(allQueries[i].query, allQueries[i].values);
const executionData = this.helpers.constructExecutionMetaData(wrapData(transactionResult), { itemData: { item: i } });
result.push(...executionData);
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
json: { ...items[i].json },
code: err.code,
message: err.message,
pairedItem: { item: i },
});
return result;
}
}
return result;
});
}
else if (mode === 'independently') {
return await db.task(async (t) => {
const result = [];
for (let i = 0; i < allQueries.length; i++) {
try {
const transactionResult = await t.any(allQueries[i].query, allQueries[i].values);
const executionData = this.helpers.constructExecutionMetaData(wrapData(transactionResult), { itemData: { item: i } });
result.push(...executionData);
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
json: { ...items[i].json },
code: err.code,
message: err.message,
pairedItem: { item: i },
});
}
}
return result;
});
}
throw new errors_1.ApplicationError('multiple, independently or transaction are valid options', {
level: 'warning',
});
}
/**
* Inserts the given items into the database.
*
* @param {Function} getNodeParam The getter for the Node's parameters
* @param {pgPromise.IMain<{}, pg.IClient>} pgp The pgPromise instance
* @param {PgpDatabase} db The pgPromise database connection
* @param {INodeExecutionData[]} items The items to be inserted
*/
async function pgInsert(
// eslint-disable-next-line @typescript-eslint/no-restricted-types
getNodeParam, pgp, db, items, continueOnFail, overrideMode) {
const table = getNodeParam('table', 0);
const schema = getNodeParam('schema', 0);
const columnString = getNodeParam('columns', 0);
const guardedColumns = {};
const columns = columnString
.split(',')
.map((column) => column.trim().split(':'))
.map(([name, cast], i) => {
guardedColumns[`column${i}`] = name;
return { name, cast, prop: `column${i}` };
});
const columnNames = columns.map((column) => column.name);
const cs = new pgp.helpers.ColumnSet(columns, { table: { table, schema } });
const additionalFields = getNodeParam('additionalFields', 0);
const mode = overrideMode ? overrideMode : (additionalFields.mode ?? 'multiple');
const returning = generateReturning(pgp, getNodeParam('returnFields', 0));
if (mode === 'multiple') {
const query = pgp.helpers.insert(getItemsCopy(items, columnNames, guardedColumns), cs) + returning;
return await db.any(query);
}
else if (mode === 'transaction') {
return await db.tx(async (t) => {
const result = [];
for (let i = 0; i < items.length; i++) {
const itemCopy = getItemCopy(items[i], columnNames, guardedColumns);
try {
result.push(await t.one(pgp.helpers.insert(itemCopy, cs) + returning));
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
...itemCopy,
code: err.code,
message: err.message,
});
return result;
}
}
return result;
});
}
else if (mode === 'independently') {
return await db.task(async (t) => {
const result = [];
for (let i = 0; i < items.length; i++) {
const itemCopy = getItemCopy(items[i], columnNames, guardedColumns);
try {
const insertResult = await t.oneOrNone(pgp.helpers.insert(itemCopy, cs) + returning);
if (insertResult !== null) {
result.push(insertResult);
}
}
catch (err) {
if (!continueOnFail) {
throw err;
}
result.push({
...itemCopy,
code: err.code,
message: err.message,
});
}
}
return result;
});
}
throw new errors_1.ApplicationError('multiple, independently or transaction are valid options', {
level: 'warning',
});
}
/**
* Inserts the given items into the database.
*
* @param {Function} getNodeParam The getter for the Node's parameters
* @param {pgPromise.IMain<{}, pg.IClient>} pgp The pgPromise instance
* @param {PgpDatabase} db`` The pgPromise database connection
* @param {INodeExecutionData[]} items The items to be inserted
*/
async function pgInsertV2(pgp, db, items, continueOnFail, overrideMode) {
const table = this.getNodeParameter('table', 0);
const schema = this.getNodeParameter('schema', 0);
const columnString = this.getNodeParameter('columns', 0);
const guardedColumns = {};
const columns = columnString
.split(',')
.map((column) => column.trim().split(':'))
.map(([name, cast], i) => {
guardedColumns[`column${i}`] = name;
return { name, cast, prop: `column${i}` };
});
const columnNames = columns.map((column) => column.name);
const cs = new pgp.helpers.ColumnSet(columns, { table: { table, schema } });
const additionalFields = this.getNodeParameter('additionalFields', 0);
const mode = overrideMode ? overrideMode : (additionalFields.mode ?? 'multiple');
const returning = generateReturning(pgp, this.getNodeParameter('returnFields', 0));
if (mode === 'multiple') {
const query = pgp.helpers.insert(getItemsCopy(items, columnNames, guardedColumns), cs) + returning;
const queryResult = await db.any(query);
return queryResult
.map((result, i) => {
return this.helpers.constructExecutionMetaData(wrapData(result), {
itemData: { item: i },
});
})
.flat();
}
else if (mode === 'transaction') {
return await db.tx(async (t) => {
const result = [];
for (let i = 0; i < items.length; i++) {
const itemCopy = getItemCopy(items[i], columnNames, guardedColumns);
try {
const insertResult = await t.one(pgp.helpers.insert(itemCopy, cs) + returning);
result.push(...this.helpers.constructExecutionMetaData(wrapData(insertResult), {
itemData: { item: i },
}));
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
json: { ...itemCopy },
code: err.code,
message: err.message,
pairedItem: { item: i },
});
return result;
}
}
return result;
});
}
else if (mode === 'independently') {
return await db.task(async (t) => {
const result = [];
for (let i = 0; i < items.length; i++) {
const itemCopy = getItemCopy(items[i], columnNames, guardedColumns);
try {
const insertResult = await t.oneOrNone(pgp.helpers.insert(itemCopy, cs) + returning);
if (insertResult !== null) {
const executionData = this.helpers.constructExecutionMetaData(wrapData(insertResult), {
itemData: { item: i },
});
result.push(...executionData);
}
}
catch (err) {
if (!continueOnFail) {
throw err;
}
result.push({
json: { ...itemCopy },
code: err.code,
message: err.message,
pairedItem: { item: i },
});
}
}
return result;
});
}
throw new errors_1.ApplicationError('multiple, independently or transaction are valid options', {
level: 'warning',
});
}
/**
* Updates the given items in the database.
*
* @param {Function} getNodeParam The getter for the Node's parameters
* @param {pgPromise.IMain<{}, pg.IClient>} pgp The pgPromise instance
* @param {PgpDatabase} db The pgPromise database connection
* @param {INodeExecutionData[]} items The items to be updated
*/
async function pgUpdate(
// eslint-disable-next-line @typescript-eslint/no-restricted-types
getNodeParam, pgp, db, items, continueOnFail = false) {
const table = getNodeParam('table', 0);
const schema = getNodeParam('schema', 0);
const updateKey = getNodeParam('updateKey', 0);
const columnString = getNodeParam('columns', 0);
const guardedColumns = {};
const columns = columnString
.split(',')
.map((column) => column.trim().split(':'))
.map(([name, cast], i) => {
guardedColumns[`column${i}`] = name;
return { name, cast, prop: `column${i}` };
});
const updateKeys = updateKey.split(',').map((key, i) => {
const [name, cast] = key.trim().split(':');
const targetCol = columns.find((column) => column.name === name);
const updateColumn = { name, cast, prop: targetCol ? targetCol.prop : `updateColumn${i}` };
if (!targetCol) {
guardedColumns[updateColumn.prop] = name;
columns.unshift(updateColumn);
}
else if (!targetCol.cast) {
targetCol.cast = updateColumn.cast || targetCol.cast;
}
return updateColumn;
});
const additionalFields = getNodeParam('additionalFields', 0);
const mode = additionalFields.mode ?? 'multiple';
const cs = new pgp.helpers.ColumnSet(columns, { table: { table, schema } });
// Prepare the data to update and copy it to be returned
const columnNames = columns.map((column) => column.name);
const updateItems = getItemsCopy(items, columnNames, guardedColumns);
const returning = generateReturning(pgp, getNodeParam('returnFields', 0));
if (mode === 'multiple') {
const query = pgp.helpers.update(updateItems, cs) +
' WHERE ' +
updateKeys
.map((entry) => {
const key = pgp.as.name(entry.name);
return 'v.' + key + ' = t.' + key;
})
.join(' AND ') +
returning;
return await db.any(query);
}
else {
const where = ' WHERE ' +
updateKeys
// eslint-disable-next-line n8n-local-rules/no-interpolation-in-regular-string
.map((entry) => pgp.as.name(entry.name) + ' = ${' + entry.prop + '}')
.join(' AND ');
if (mode === 'transaction') {
return await db.tx(async (t) => {
const result = [];
for (let i = 0; i < items.length; i++) {
const itemCopy = getItemCopy(items[i], columnNames, guardedColumns);
try {
Array.prototype.push.apply(result, await t.any(pgp.helpers.update(itemCopy, cs) +
pgp.as.format(where, itemCopy) +
returning));
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
...itemCopy,
code: err.code,
message: err.message,
});
return result;
}
}
return result;
});
}
else if (mode === 'independently') {
return await db.task(async (t) => {
const result = [];
for (let i = 0; i < items.length; i++) {
const itemCopy = getItemCopy(items[i], columnNames, guardedColumns);
try {
Array.prototype.push.apply(result, await t.any(pgp.helpers.update(itemCopy, cs) +
pgp.as.format(where, itemCopy) +
returning));
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
...itemCopy,
code: err.code,
message: err.message,
});
}
}
return result;
});
}
}
throw new errors_1.ApplicationError('multiple, independently or transaction are valid options', {
level: 'warning',
});
}
/**
* Updates the given items in the database.
*
* @param {Function} getNodeParam The getter for the Node's parameters
* @param {pgPromise.IMain<{}, pg.IClient>} pgp The pgPromise instance
* @param {PgpDatabase} db The pgPromise database connection
* @param {INodeExecutionData[]} items The items to be updated
*/
async function pgUpdateV2(pgp, db, items, continueOnFail = false) {
const table = this.getNodeParameter('table', 0);
const schema = this.getNodeParameter('schema', 0);
const updateKey = this.getNodeParameter('updateKey', 0);
const columnString = this.getNodeParameter('columns', 0);
const guardedColumns = {};
const columns = columnString
.split(',')
.map((column) => column.trim().split(':'))
.map(([name, cast], i) => {
guardedColumns[`column${i}`] = name;
return { name, cast, prop: `column${i}` };
});
const updateKeys = updateKey.split(',').map((key, i) => {
const [name, cast] = key.trim().split(':');
const targetCol = columns.find((column) => column.name === name);
const updateColumn = { name, cast, prop: targetCol ? targetCol.prop : `updateColumn${i}` };
if (!targetCol) {
guardedColumns[updateColumn.prop] = name;
columns.unshift(updateColumn);
}
else if (!targetCol.cast) {
targetCol.cast = updateColumn.cast || targetCol.cast;
}
return updateColumn;
});
const additionalFields = this.getNodeParameter('additionalFields', 0);
const mode = additionalFields.mode ?? 'multiple';
const cs = new pgp.helpers.ColumnSet(columns, { table: { table, schema } });
// Prepare the data to update and copy it to be returned
const columnNames = columns.map((column) => column.name);
const updateItems = getItemsCopy(items, columnNames, guardedColumns);
const returning = generateReturning(pgp, this.getNodeParameter('returnFields', 0));
if (mode === 'multiple') {
const query = pgp.helpers.update(updateItems, cs) +
' WHERE ' +
updateKeys
.map((entry) => {
const key = pgp.as.name(entry.name);
return 'v.' + key + ' = t.' + key;
})
.join(' AND ') +
returning;
const updateResult = await db.any(query);
return updateResult;
}
else {
const where = ' WHERE ' +
updateKeys
// eslint-disable-next-line n8n-local-rules/no-interpolation-in-regular-string
.map((entry) => pgp.as.name(entry.name) + ' = ${' + entry.prop + '}')
.join(' AND ');
if (mode === 'transaction') {
return await db.tx(async (t) => {
const result = [];
for (let i = 0; i < items.length; i++) {
const itemCopy = getItemCopy(items[i], columnNames, guardedColumns);
try {
const transactionResult = await t.any(pgp.helpers.update(itemCopy, cs) +
pgp.as.format(where, itemCopy) +
returning);
const executionData = this.helpers.constructExecutionMetaData(wrapData(transactionResult), { itemData: { item: i } });
result.push(...executionData);
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
...itemCopy,
code: err.code,
message: err.message,
});
return result;
}
}
return result;
});
}
else if (mode === 'independently') {
return await db.task(async (t) => {
const result = [];
for (let i = 0; i < items.length; i++) {
const itemCopy = getItemCopy(items[i], columnNames, guardedColumns);
try {
const independentResult = await t.any(pgp.helpers.update(itemCopy, cs) +
pgp.as.format(where, itemCopy) +
returning);
const executionData = this.helpers.constructExecutionMetaData(wrapData(independentResult), { itemData: { item: i } });
result.push(...executionData);
}
catch (err) {
if (!continueOnFail)
throw err;
result.push({
json: { ...items[i].json },
code: err.code,
message: err.message,
pairedItem: { item: i },
});
}
}
return result;
});
}
}
throw new errors_1.ApplicationError('multiple, independently or transaction are valid options', {
level: 'warning',
});
}
//# sourceMappingURL=genericFunctions.js.map