Feature/paired item support (#3869)

* Add paired item helper and implement it in some nodes
2025-12-17 10:02:05 +00:00 · 2022-08-30 17:55:33 +02:00
parent 087d3f99f1
commit b2c674591c
150 changed files with 4027 additions and 1625 deletions
--- a/packages/nodes-base/nodes/Postgres/Postgres.node.functions.ts
+++ b/packages/nodes-base/nodes/Postgres/Postgres.node.functions.ts
@@ -1,3 +1,4 @@
+import { IExecuteFunctions } from 'n8n-core';
 import { IDataObject, INodeExecutionData, JsonObject } from 'n8n-workflow';
 import pgPromise from 'pg-promise';
 import pg from 'pg-promise/typescript/pg-subset';
@@ -156,6 +157,93 @@ export async function pgQuery(
 	throw new Error('multiple, independently or transaction are valid options');
 }

+export async function pgQueryV2(
+	this: IExecuteFunctions,
+	pgp: pgPromise.IMain<{}, pg.IClient>,
+	db: pgPromise.IDatabase<{}, pg.IClient>,
+	items: INodeExecutionData[],
+	continueOnFail: boolean,
+	overrideMode?: string,
+): Promise<IDataObject[]> {
+	const additionalFields = this.getNodeParameter('additionalFields', 0) as IDataObject;
+
+	let valuesArray = [] as string[][];
+	if (additionalFields.queryParams) {
+		const propertiesString = additionalFields.queryParams as string;
+		const properties = propertiesString.split(',').map((column) => column.trim());
+		const paramsItems = getItemsCopy(items, properties);
+		valuesArray = paramsItems.map((row) => properties.map((col) => row[col])) as string[][];
+	}
+
+	type QueryWithValues = { query: string; values?: string[] };
+	const allQueries = new Array<QueryWithValues>();
+	for (let i = 0; i < items.length; i++) {
+		const query = this.getNodeParameter('query', i) as string;
+		const values = valuesArray[i];
+		const queryFormat = { query, values };
+		allQueries.push(queryFormat);
+	}
+
+	const mode = overrideMode ? overrideMode : ((additionalFields.mode ?? 'multiple') as string);
+	if (mode === 'multiple') {
+		(await db.multi(pgp.helpers.concat(allQueries)))
+			.map((result, i) => {
+				return this.helpers.constructExecutionMetaData(this.helpers.returnJsonArray([...result]), {
+					itemData: { item: i },
+				});
+			})
+			.flat();
+	} else if (mode === 'transaction') {
+		return db.tx(async (t) => {
+			const result: INodeExecutionData[] = [];
+			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(
+						this.helpers.returnJsonArray(transactionResult),
+						{ itemData: { item: i } },
+					);
+					result.push(...executionData);
+				} catch (err) {
+					if (continueOnFail === false) throw err;
+					result.push({
+						json: { ...items[i].json },
+						code: (err as JsonObject).code,
+						message: (err as JsonObject).message,
+						pairedItem: { item: i },
+					} as INodeExecutionData);
+					return result;
+				}
+			}
+			return result;
+		});
+	} else if (mode === 'independently') {
+		return db.task(async (t) => {
+			const result: INodeExecutionData[] = [];
+			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(
+						this.helpers.returnJsonArray(transactionResult),
+						{ itemData: { item: i } },
+					);
+					result.push(...executionData);
+				} catch (err) {
+					if (continueOnFail === false) throw err;
+					result.push({
+						json: { ...items[i].json },
+						code: (err as JsonObject).code,
+						message: (err as JsonObject).message,
+						pairedItem: { item: i },
+					} as INodeExecutionData);
+				}
+			}
+			return result;
+		});
+	}
+	throw new Error('multiple, independently or transaction are valid options');
+}
+
 /**
 * Inserts the given items into the database.
 *
@@ -245,6 +333,112 @@ export async function pgInsert(
 	throw new Error('multiple, independently or transaction are valid options');
 }

+/**
+ * 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 {pgPromise.IDatabase<{}, pg.IClient>} db The pgPromise database connection
+ * @param {INodeExecutionData[]} items The items to be inserted
+ * @returns Promise<Array<IDataObject>>
+ */
+export async function pgInsertV2(
+	this: IExecuteFunctions,
+	pgp: pgPromise.IMain<{}, pg.IClient>,
+	db: pgPromise.IDatabase<{}, pg.IClient>,
+	items: INodeExecutionData[],
+	continueOnFail: boolean,
+	overrideMode?: string,
+): Promise<IDataObject[]> {
+	const table = this.getNodeParameter('table', 0) as string;
+	const schema = this.getNodeParameter('schema', 0) as string;
+	const columnString = this.getNodeParameter('columns', 0) as string;
+	const guardedColumns: { [key: string]: string } = {};
+
+	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) as IDataObject;
+	const mode = overrideMode ? overrideMode : ((additionalFields.mode ?? 'multiple') as string);
+
+	const returning = generateReturning(pgp, this.getNodeParameter('returnFields', 0) as string);
+	if (mode === 'multiple') {
+		const query =
+			pgp.helpers.insert(getItemsCopy(items, columnNames, guardedColumns), cs) + returning;
+		return (await db.any(query))
+			.map((result, i) => {
+				return this.helpers.constructExecutionMetaData(this.helpers.returnJsonArray([...result]), {
+					itemData: { item: i },
+				});
+			})
+			.flat();
+	} else if (mode === 'transaction') {
+		return db.tx(async (t) => {
+			const result: IDataObject[] = [];
+			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(this.helpers.returnJsonArray(insertResult), {
+							itemData: { item: i },
+						}),
+					);
+				} catch (err) {
+					if (continueOnFail === false) throw err;
+					result.push({
+						json: { ...itemCopy },
+						code: (err as JsonObject).code,
+						message: (err as JsonObject).message,
+						pairedItem: { item: i },
+					} as INodeExecutionData);
+					return result;
+				}
+			}
+			return result;
+		});
+	} else if (mode === 'independently') {
+		return db.task(async (t) => {
+			const result: IDataObject[] = [];
+			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(
+							this.helpers.returnJsonArray(insertResult),
+							{ itemData: { item: i } },
+						);
+						result.push(...executionData);
+					}
+				} catch (err) {
+					if (continueOnFail === false) {
+						throw err;
+					}
+					result.push({
+						json: { ...itemCopy },
+						code: (err as JsonObject).code,
+						message: (err as JsonObject).message,
+						pairedItem: { item: i },
+					} as INodeExecutionData);
+				}
+			}
+			return result;
+		});
+	}
+
+	throw new Error('multiple, independently or transaction are valid options');
+}
+
 /**
 * Updates the given items in the database.
 *
@@ -367,3 +561,132 @@ export async function pgUpdate(
 	}
 	throw new Error('multiple, independently or transaction are valid options');
 }
+
+/**
+ * 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 {pgPromise.IDatabase<{}, pg.IClient>} db The pgPromise database connection
+ * @param {INodeExecutionData[]} items The items to be updated
+ * @returns Promise<Array<IDataObject>>
+ */
+export async function pgUpdateV2(
+	this: IExecuteFunctions,
+	pgp: pgPromise.IMain<{}, pg.IClient>,
+	db: pgPromise.IDatabase<{}, pg.IClient>,
+	items: INodeExecutionData[],
+	continueOnFail = false,
+): Promise<IDataObject[]> {
+	const table = this.getNodeParameter('table', 0) as string;
+	const schema = this.getNodeParameter('schema', 0) as string;
+	const updateKey = this.getNodeParameter('updateKey', 0) as string;
+	const columnString = this.getNodeParameter('columns', 0) as string;
+	const guardedColumns: { [key: string]: string } = {};
+
+	const columns: Array<{ name: string; cast: string; prop: string }> = 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) as IDataObject;
+	const mode = additionalFields.mode ?? ('multiple' as string);
+
+	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) as string);
+	if (mode === 'multiple') {
+		const query =
+			pgp.helpers.update(updateItems, cs) +
+			' WHERE ' +
+			updateKeys
+				.map((updateKey) => {
+					const key = pgp.as.name(updateKey.name);
+					return 'v.' + key + ' = t.' + key;
+				})
+				.join(' AND ') +
+			returning;
+		const updateResult = await db.any(query);
+		return updateResult;
+	} else {
+		const where =
+			' WHERE ' +
+			updateKeys
+				.map((updateKey) => pgp.as.name(updateKey.name) + ' = ${' + updateKey.prop + '}')
+				.join(' AND ');
+		if (mode === 'transaction') {
+			return db.tx(async (t) => {
+				const result: IDataObject[] = [];
+				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(
+							this.helpers.returnJsonArray(transactionResult),
+							{ itemData: { item: i } },
+						);
+						result.push(...executionData);
+					} catch (err) {
+						if (continueOnFail === false) throw err;
+						result.push({
+							...itemCopy,
+							code: (err as JsonObject).code,
+							message: (err as JsonObject).message,
+						});
+						return result;
+					}
+				}
+				return result;
+			});
+		} else if (mode === 'independently') {
+			return db.task(async (t) => {
+				const result: IDataObject[] = [];
+				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(
+							this.helpers.returnJsonArray(independentResult),
+							{ itemData: { item: i } },
+						);
+						result.push(...executionData);
+					} catch (err) {
+						if (continueOnFail === false) throw err;
+						result.push({
+							json: { ...items[i].json },
+							code: (err as JsonObject).code,
+							message: (err as JsonObject).message,
+							pairedItem: { item: i },
+						} as INodeExecutionData);
+					}
+				}
+				return result;
+			});
+		}
+	}
+	throw new Error('multiple, independently or transaction are valid options');
+}