feat(MySQL Node): Overhaul

packages/nodes-base/nodes/MySql/v2/actions/database/upsert.operation.ts

@@ -0,0 +1,199 @@
+import type { IExecuteFunctions } from 'n8n-core';
+import type { IDataObject, INodeExecutionData, INodeProperties } from 'n8n-workflow';
+
+import type { QueryRunner, QueryValues, QueryWithValues } from '../../helpers/interfaces';
+import { AUTO_MAP, DATA_MODE } from '../../helpers/interfaces';
+
+import { updateDisplayOptions } from '../../../../../utils/utilities';
+
+import { replaceEmptyStringsByNulls } from '../../helpers/utils';
+
+import { optionsCollection } from '../common.descriptions';
+
+const properties: INodeProperties[] = [
+	{
+		displayName: 'Data Mode',
+		name: 'dataMode',
+		type: 'options',
+		options: [
+			{
+				name: 'Auto-Map Input Data to Columns',
+				value: DATA_MODE.AUTO_MAP,
+				description: 'Use when node input properties names exactly match the table column names',
+			},
+			{
+				name: 'Map Each Column Below',
+				value: DATA_MODE.MANUAL,
+				description: 'Set the value for each destination column manually',
+			},
+		],
+		default: AUTO_MAP,
+		description:
+			'Whether to map node input properties and the table data automatically or manually',
+	},
+	{
+		displayName: `
+		In this mode, make sure incoming data fields are named the same as the columns in your table. If needed, use a 'Set' node before this node to change the field names.
+		`,
+		name: 'notice',
+		type: 'notice',
+		default: '',
+		displayOptions: {
+			show: {
+				dataMode: [DATA_MODE.AUTO_MAP],
+			},
+		},
+	},
+	{
+		// eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased, n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options
+		displayName: 'Column to Match On',
+		name: 'columnToMatchOn',
+		type: 'options',
+		required: true,
+		description:
+			'The column to compare when finding the rows to update. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
+		typeOptions: {
+			loadOptionsMethod: 'getColumns',
+			loadOptionsDependsOn: ['schema.value', 'table.value'],
+		},
+		default: '',
+		hint: "Used to find the correct row to update. Doesn't get changed. Has to be unique.",
+	},
+	{
+		displayName: 'Value of Column to Match On',
+		name: 'valueToMatchOn',
+		type: 'string',
+		default: '',
+		description:
+			'Rows with a value in the specified "Column to Match On" that corresponds to the value in this field will be updated. New rows will be created for non-matching items.',
+		displayOptions: {
+			show: {
+				dataMode: [DATA_MODE.MANUAL],
+			},
+		},
+	},
+	{
+		displayName: 'Values to Send',
+		name: 'valuesToSend',
+		placeholder: 'Add Value',
+		type: 'fixedCollection',
+		typeOptions: {
+			multipleValueButtonText: 'Add Value',
+			multipleValues: true,
+		},
+		displayOptions: {
+			show: {
+				dataMode: [DATA_MODE.MANUAL],
+			},
+		},
+		default: {},
+		options: [
+			{
+				displayName: 'Values',
+				name: 'values',
+				values: [
+					{
+						// eslint-disable-next-line n8n-nodes-base/node-param-display-name-wrong-for-dynamic-options
+						displayName: 'Column',
+						name: 'column',
+						type: 'options',
+						description:
+							'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
+						typeOptions: {
+							loadOptionsMethod: 'getColumnsWithoutColumnToMatchOn',
+							loadOptionsDependsOn: ['schema.value', 'table.value'],
+						},
+						default: [],
+					},
+					{
+						displayName: 'Value',
+						name: 'value',
+						type: 'string',
+						default: '',
+					},
+				],
+			},
+		],
+	},
+	optionsCollection,
+];
+
+const displayOptions = {
+	show: {
+		resource: ['database'],
+		operation: ['upsert'],
+	},
+	hide: {
+		table: [''],
+	},
+};
+
+export const description = updateDisplayOptions(displayOptions, properties);
+
+export async function execute(
+	this: IExecuteFunctions,
+	inputItems: INodeExecutionData[],
+	runQueries: QueryRunner,
+	nodeOptions: IDataObject,
+): Promise<INodeExecutionData[]> {
+	let returnData: INodeExecutionData[] = [];
+
+	const items = replaceEmptyStringsByNulls(inputItems, nodeOptions.replaceEmptyStrings as boolean);
+
+	const queries: QueryWithValues[] = [];
+
+	for (let i = 0; i < items.length; i++) {
+		const table = this.getNodeParameter('table', i, undefined, {
+			extractValue: true,
+		}) as string;
+
+		const columnToMatchOn = this.getNodeParameter('columnToMatchOn', i) as string;
+
+		const dataMode = this.getNodeParameter('dataMode', i) as string;
+
+		let item: IDataObject = {};
+
+		if (dataMode === DATA_MODE.AUTO_MAP) {
+			item = items[i].json;
+		}
+
+		if (dataMode === DATA_MODE.MANUAL) {
+			const valuesToSend = (this.getNodeParameter('valuesToSend', i, []) as IDataObject)
+				.values as IDataObject[];
+
+			item = valuesToSend.reduce((acc, { column, value }) => {
+				acc[column as string] = value;
+				return acc;
+			}, {} as IDataObject);
+
+			item[columnToMatchOn] = this.getNodeParameter('valueToMatchOn', i) as string;
+		}
+
+		const onConflict = 'ON DUPLICATE KEY UPDATE';
+
+		const columns = Object.keys(item);
+		const escapedColumns = columns.map((column) => `\`${column}\``).join(', ');
+		const placeholder = `${columns.map(() => '?').join(',')}`;
+
+		const insertQuery = `INSERT INTO \`${table}\`(${escapedColumns}) VALUES(${placeholder})`;
+
+		const values = Object.values(item) as QueryValues;
+
+		const updateColumns = Object.keys(item).filter((column) => column !== columnToMatchOn);
+
+		const updates: string[] = [];
+
+		for (const column of updateColumns) {
+			updates.push(`\`${column}\` = ?`);
+			values.push(item[column] as string);
+		}
+
+		const query = `${insertQuery} ${onConflict} ${updates.join(', ')}`;
+
+		queries.push({ query, values });
+	}
+
+	returnData = await runQueries(queries);
+
+	return returnData;
+}