first commit
Security: Sync from Public / sync-from-public (push) Has been cancelled
Test: Benchmark Nightly / build (push) Has been cancelled
Test: Benchmark Nightly / Notify Cats on failure (push) Has been cancelled
CI: Python / Checks (push) Has been cancelled
Test: Evals Python / Workflow Comparison Python (push) Has been cancelled
Util: Check Docs URLs / check-docs-urls (push) Has been cancelled
Test: Visual Storybook / Cloudflare Pages (push) Has been cancelled
Test: E2E Performance / build-and-test-performance (push) Has been cancelled
Test: Workflows Nightly / Run Workflow Tests (push) Has been cancelled
Util: Cleanup CI Docker Images / Delete stale CI images (push) Has been cancelled
Test: Benchmark Destroy Env / build (push) Has been cancelled
Util: Update Node Popularity / update-popularity (push) Has been cancelled
Test: E2E Coverage Weekly / Coverage Tests (push) Has been cancelled

This commit is contained in:
2026-03-17 16:22:57 +03:30
commit 3d5eaf9445
15349 changed files with 2847338 additions and 0 deletions
@@ -0,0 +1,390 @@
import type {
ICredentialsDecrypted,
ICredentialTestFunctions,
IExecuteFunctions,
INodeCredentialTestResult,
INodeExecutionData,
INodeType,
INodeTypeBaseDescription,
INodeTypeDescription,
} from 'n8n-workflow';
import { NodeConnectionTypes, NodeOperationError } from 'n8n-workflow';
import { oldVersionNotice } from '@utils/descriptions';
import { pgInsertV2, pgQueryV2, pgUpdate, wrapData } from './genericFunctions';
import { configurePostgres } from '../transport';
import type { PgpConnection, PostgresNodeCredentials } from '../v2/helpers/interfaces';
const versionDescription: INodeTypeDescription = {
displayName: 'Postgres',
name: 'postgres',
icon: 'file:postgres.svg',
group: ['input'],
version: 1,
description: 'Get, add and update data in Postgres',
defaults: {
name: 'Postgres',
},
inputs: [NodeConnectionTypes.Main],
outputs: [NodeConnectionTypes.Main],
credentials: [
{
name: 'postgres',
required: true,
testedBy: 'postgresConnectionTest',
},
],
properties: [
oldVersionNotice,
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Execute Query',
value: 'executeQuery',
description: 'Execute an SQL query',
action: 'Execute a SQL query',
},
{
name: 'Insert',
value: 'insert',
description: 'Insert rows in database',
action: 'Insert rows in database',
},
{
name: 'Update',
value: 'update',
description: 'Update rows in database',
action: 'Update rows in database',
},
],
default: 'insert',
},
// ----------------------------------
// executeQuery
// ----------------------------------
{
displayName: 'Query',
name: 'query',
type: 'string',
noDataExpression: true,
typeOptions: {
editor: 'sqlEditor',
sqlDialect: 'PostgreSQL',
},
displayOptions: {
show: {
operation: ['executeQuery'],
},
},
default: '',
placeholder: 'SELECT id, name FROM product WHERE quantity > $1 AND price <= $2',
required: true,
description:
'The SQL query to execute. You can use n8n expressions or $1 and $2 in conjunction with query parameters.',
},
// ----------------------------------
// insert
// ----------------------------------
{
displayName: 'Schema',
name: 'schema',
type: 'string',
displayOptions: {
show: {
operation: ['insert'],
},
},
default: 'public',
required: true,
description: 'Name of the schema the table belongs to',
},
{
displayName: 'Table',
name: 'table',
type: 'string',
displayOptions: {
show: {
operation: ['insert'],
},
},
default: '',
required: true,
description: 'Name of the table in which to insert data to',
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
operation: ['insert'],
},
},
default: '',
// eslint-disable-next-line n8n-nodes-base/node-param-placeholder-miscased-id
placeholder: 'id:int,name:text,description',
// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-id
description:
'Comma-separated list of the properties which should used as columns for the new rows. You can use type casting with colons (:) like id:int.',
},
// ----------------------------------
// update
// ----------------------------------
{
displayName: 'Schema',
name: 'schema',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
},
},
default: 'public',
description: 'Name of the schema the table belongs to',
},
{
displayName: 'Table',
name: 'table',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
},
},
default: '',
required: true,
description: 'Name of the table in which to update data in',
},
{
displayName: 'Update Key',
name: 'updateKey',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
},
},
default: 'id',
required: true,
// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-id
description:
'Comma-separated list of the properties which decides which rows in the database should be updated. Normally that would be "id".',
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
},
},
default: '',
placeholder: 'name:text,description',
// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-id
description:
'Comma-separated list of the properties which should used as columns for rows to update. You can use type casting with colons (:) like id:int.',
},
// ----------------------------------
// insert,update
// ----------------------------------
{
displayName: 'Return Fields',
name: 'returnFields',
type: 'string',
requiresDataPath: 'multiple',
displayOptions: {
show: {
operation: ['insert', 'update'],
},
},
default: '*',
description: 'Comma-separated list of the fields that the operation will return',
},
// ----------------------------------
// Additional fields
// ----------------------------------
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
options: [
{
displayName: 'Mode',
name: 'mode',
type: 'options',
options: [
{
name: 'Independently',
value: 'independently',
description: 'Execute each query independently',
},
{
name: 'Multiple Queries',
value: 'multiple',
description: '<b>Default</b>. Sends multiple queries at once to database.',
},
{
name: 'Transaction',
value: 'transaction',
description: 'Executes all queries in a single transaction',
},
],
default: 'multiple',
description:
'The way queries should be sent to database. Can be used in conjunction with <b>Continue on Fail</b>. See <a href="https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.postgres/">the docs</a> for more examples',
},
{
displayName: 'Output Large-Format Numbers As',
name: 'largeNumbersOutput',
type: 'options',
options: [
{
name: 'Numbers',
value: 'numbers',
},
{
name: 'Text',
value: 'text',
description:
'Use this if you expect numbers longer than 16 digits (otherwise numbers may be incorrect)',
},
],
hint: 'Applies to NUMERIC and BIGINT columns only',
default: 'text',
},
{
displayName: 'Query Parameters',
name: 'queryParams',
type: 'string',
displayOptions: {
show: {
'/operation': ['executeQuery'],
},
},
default: '',
placeholder: 'quantity,price',
description:
'Comma-separated list of properties which should be used as query parameters',
},
],
},
],
};
export class PostgresV1 implements INodeType {
description: INodeTypeDescription;
constructor(baseDescription: INodeTypeBaseDescription) {
this.description = {
...baseDescription,
...versionDescription,
};
}
methods = {
credentialTest: {
async postgresConnectionTest(
this: ICredentialTestFunctions,
credential: ICredentialsDecrypted,
): Promise<INodeCredentialTestResult> {
const credentials = credential.data as PostgresNodeCredentials;
let connection: PgpConnection | undefined;
try {
const { db } = await configurePostgres.call(this, credentials, {});
// Acquires a new connection that can be used to to run multiple
// queries on the same connection and must be released again
// manually.
connection = await db.connect();
} catch (error) {
return {
status: 'Error',
message: error.message,
};
} finally {
if (connection) {
// release connection
await connection.done();
}
}
return {
status: 'OK',
message: 'Connection successful!',
};
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const credentials = await this.getCredentials<PostgresNodeCredentials>('postgres');
const largeNumbersOutput = this.getNodeParameter(
'additionalFields.largeNumbersOutput',
0,
'',
) as string;
const { db, pgp } = await configurePostgres.call(this, credentials, {
largeNumbersOutput:
largeNumbersOutput === 'numbers' || largeNumbersOutput === 'text'
? largeNumbersOutput
: undefined,
});
let returnItems: INodeExecutionData[] = [];
const items = this.getInputData();
const operation = this.getNodeParameter('operation', 0);
if (operation === 'executeQuery') {
// ----------------------------------
// executeQuery
// ----------------------------------
const queryResult = await pgQueryV2.call(this, pgp, db, items, this.continueOnFail());
returnItems = queryResult as INodeExecutionData[];
} else if (operation === 'insert') {
// ----------------------------------
// insert
// ----------------------------------
const insertData = await pgInsertV2.call(this, pgp, db, items, this.continueOnFail());
// returnItems = this.helpers.returnJsonArray(insertData);
returnItems = insertData as INodeExecutionData[];
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
const updateItems = await pgUpdate(
this.getNodeParameter,
pgp,
db,
items,
this.continueOnFail(),
);
returnItems = wrapData(updateItems);
} else {
throw new NodeOperationError(
this.getNode(),
`The operation "${operation}" is not supported!`,
);
}
return [returnItems];
}
}
@@ -0,0 +1,737 @@
import { ApplicationError } from '@n8n/errors';
import type { IExecuteFunctions, IDataObject, INodeExecutionData, JsonObject } from 'n8n-workflow';
import type pgPromise from 'pg-promise';
import type pg from 'pg-promise/typescript/pg-subset';
import { getResolvables } from '@utils/utilities';
import type { PgpDatabase } from '../v2/helpers/interfaces';
/**
* 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
*/
export function getItemsCopy(
items: INodeExecutionData[],
properties: string[],
guardedColumns?: { [key: string]: string },
): IDataObject[] {
let newItem: IDataObject;
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
*/
export function getItemCopy(
item: INodeExecutionData,
properties: string[],
guardedColumns?: { [key: string]: string },
): IDataObject {
const newItem: IDataObject = {};
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
*/
export function generateReturning(pgp: pgPromise.IMain<{}, pg.IClient>, returning: string): string {
return (
' RETURNING ' +
returning
.split(',')
.map((returnedField) => pgp.as.name(returnedField.trim()))
.join(', ')
);
}
export function wrapData(data: IDataObject[]): INodeExecutionData[] {
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
*/
export async function pgQuery(
// eslint-disable-next-line @typescript-eslint/no-restricted-types
getNodeParam: Function,
pgp: pgPromise.IMain<{}, pg.IClient>,
db: PgpDatabase,
items: INodeExecutionData[],
continueOnFail: boolean,
overrideMode?: string,
): Promise<IDataObject[]> {
const additionalFields = getNodeParam('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[][];
}
const allQueries = [] as Array<{ query: string; values?: string[] }>;
for (let i = 0; i < items.length; i++) {
const query = getNodeParam('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') {
return (await db.multi(pgp.helpers.concat(allQueries))).flat(1);
} else if (mode === 'transaction') {
return await db.tx(async (t) => {
const result: IDataObject[] = [];
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 as JsonObject).code,
message: (err as JsonObject).message,
});
return result;
}
}
return result;
});
} else if (mode === 'independently') {
return await db.task(async (t) => {
const result: IDataObject[] = [];
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 as JsonObject).code,
message: (err as JsonObject).message,
});
}
}
return result;
});
}
throw new ApplicationError('multiple, independently or transaction are valid options', {
level: 'warning',
});
}
export async function pgQueryV2(
this: IExecuteFunctions,
pgp: pgPromise.IMain<{}, pg.IClient>,
db: PgpDatabase,
items: INodeExecutionData[],
continueOnFail: boolean,
options?: {
overrideMode?: string;
resolveExpression?: boolean;
},
): Promise<IDataObject[]> {
const additionalFields = this.getNodeParameter('additionalFields', 0);
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++) {
let query = this.getNodeParameter('query', i) as string;
if (options?.resolveExpression) {
for (const resolvable of getResolvables(query)) {
query = query.replace(resolvable, this.evaluateExpression(resolvable, i) as string);
}
}
const values = valuesArray[i];
const queryFormat = { query, values };
allQueries.push(queryFormat);
}
const mode = options?.overrideMode
? options.overrideMode
: ((additionalFields.mode ?? 'multiple') as string);
if (mode === 'multiple') {
return (await db.multi(pgp.helpers.concat(allQueries)))
.map((result, i) => {
return this.helpers.constructExecutionMetaData(wrapData(result as IDataObject[]), {
itemData: { item: i },
});
})
.flat();
} else if (mode === 'transaction') {
return await 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(
wrapData(transactionResult as IDataObject[]),
{ itemData: { item: i } },
);
result.push(...executionData);
} catch (err) {
if (!continueOnFail) 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 await 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(
wrapData(transactionResult as IDataObject[]),
{ itemData: { item: i } },
);
result.push(...executionData);
} catch (err) {
if (!continueOnFail) 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 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
*/
export async function pgInsert(
// eslint-disable-next-line @typescript-eslint/no-restricted-types
getNodeParam: Function,
pgp: pgPromise.IMain<{}, pg.IClient>,
db: PgpDatabase,
items: INodeExecutionData[],
continueOnFail: boolean,
overrideMode?: string,
): Promise<IDataObject[]> {
const table = getNodeParam('table', 0) as string;
const schema = getNodeParam('schema', 0) as string;
const columnString = getNodeParam('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 = getNodeParam('additionalFields', 0) as IDataObject;
const mode = overrideMode ? overrideMode : ((additionalFields.mode ?? 'multiple') as string);
const returning = generateReturning(pgp, getNodeParam('returnFields', 0) as string);
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: IDataObject[] = [];
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 as JsonObject).code,
message: (err as JsonObject).message,
});
return result;
}
}
return result;
});
} else if (mode === 'independently') {
return await 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) {
result.push(insertResult as IDataObject);
}
} catch (err) {
if (!continueOnFail) {
throw err;
}
result.push({
...itemCopy,
code: (err as JsonObject).code,
message: (err as JsonObject).message,
});
}
}
return result;
});
}
throw new 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
*/
export async function pgInsertV2(
this: IExecuteFunctions,
pgp: pgPromise.IMain<{}, pg.IClient>,
db: PgpDatabase,
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);
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;
const queryResult = await db.any(query);
return queryResult
.map((result, i) => {
return this.helpers.constructExecutionMetaData(wrapData(result as IDataObject[]), {
itemData: { item: i },
});
})
.flat();
} else if (mode === 'transaction') {
return await 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(wrapData(insertResult as IDataObject[]), {
itemData: { item: i },
}),
);
} catch (err) {
if (!continueOnFail) 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 await 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(
wrapData(insertResult as IDataObject[]),
{
itemData: { item: i },
},
);
result.push(...executionData);
}
} catch (err) {
if (!continueOnFail) {
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 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
*/
export async function pgUpdate(
// eslint-disable-next-line @typescript-eslint/no-restricted-types
getNodeParam: Function,
pgp: pgPromise.IMain<{}, pg.IClient>,
db: PgpDatabase,
items: INodeExecutionData[],
continueOnFail = false,
): Promise<IDataObject[]> {
const table = getNodeParam('table', 0) as string;
const schema = getNodeParam('schema', 0) as string;
const updateKey = getNodeParam('updateKey', 0) as string;
const columnString = getNodeParam('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 = getNodeParam('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, getNodeParam('returnFields', 0) as string);
if (mode === 'multiple') {
const query =
(pgp.helpers.update(updateItems, cs) as string) +
' 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: IDataObject[] = [];
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) as string) +
pgp.as.format(where, itemCopy) +
returning,
),
);
} catch (err) {
if (!continueOnFail) throw err;
result.push({
...itemCopy,
code: (err as JsonObject).code,
message: (err as JsonObject).message,
});
return result;
}
}
return result;
});
} else if (mode === 'independently') {
return await db.task(async (t) => {
const result: IDataObject[] = [];
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) as string) +
pgp.as.format(where, itemCopy) +
returning,
),
);
} catch (err) {
if (!continueOnFail) throw err;
result.push({
...itemCopy,
code: (err as JsonObject).code,
message: (err as JsonObject).message,
});
}
}
return result;
});
}
}
throw new 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
*/
export async function pgUpdateV2(
this: IExecuteFunctions,
pgp: pgPromise.IMain<{}, pg.IClient>,
db: PgpDatabase,
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);
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) as string) +
' 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: 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) as string) +
pgp.as.format(where, itemCopy) +
returning,
);
const executionData = this.helpers.constructExecutionMetaData(
wrapData(transactionResult as IDataObject[]),
{ itemData: { item: i } },
);
result.push(...executionData);
} catch (err) {
if (!continueOnFail) throw err;
result.push({
...itemCopy,
code: (err as JsonObject).code,
message: (err as JsonObject).message,
});
return result;
}
}
return result;
});
} else if (mode === 'independently') {
return await 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) as string) +
pgp.as.format(where, itemCopy) +
returning,
);
const executionData = this.helpers.constructExecutionMetaData(
wrapData(independentResult as IDataObject[]),
{ itemData: { item: i } },
);
result.push(...executionData);
} catch (err) {
if (!continueOnFail) 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 ApplicationError('multiple, independently or transaction are valid options', {
level: 'warning',
});
}