n8n/packages/nodes-base/nodes/Postgres/Postgres.node.ts

272 lines
6.2 KiB
TypeScript
Raw Normal View History

2019-08-21 09:44:10 -07:00
import { IExecuteFunctions } from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription
2019-08-21 09:44:10 -07:00
} from 'n8n-workflow';
import * as pgPromise from 'pg-promise';
2020-07-08 05:36:40 -07:00
import { pgInsert, pgQuery, pgUpdate } from './Postgres.node.functions';
2019-08-21 09:44:10 -07:00
export class Postgres implements INodeType {
description: INodeTypeDescription = {
displayName: 'Postgres',
name: 'postgres',
icon: 'file:postgres.png',
group: ['input'],
version: 1,
description: 'Gets, add and update data in Postgres.',
defaults: {
name: 'Postgres',
color: '#336791',
2019-08-21 09:44:10 -07:00
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'postgres',
required: true,
},
2019-08-21 09:44:10 -07:00
],
properties: [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
options: [
{
name: 'Execute Query',
value: 'executeQuery',
description: 'Execute an SQL query',
2019-08-21 09:44:10 -07:00
},
{
name: 'Insert',
value: 'insert',
description: 'Insert rows in database',
2019-08-21 09:44:10 -07:00
},
{
name: 'Update',
value: 'update',
description: 'Update rows in database',
},
2019-08-21 09:44:10 -07:00
],
default: 'insert',
description: 'The operation to perform.',
2019-08-21 09:44:10 -07:00
},
// ----------------------------------
// executeQuery
// ----------------------------------
{
displayName: 'Query',
name: 'query',
type: 'string',
typeOptions: {
rows: 5,
2019-08-21 09:44:10 -07:00
},
displayOptions: {
show: {
operation: ['executeQuery'],
},
2019-08-21 09:44:10 -07:00
},
default: '',
placeholder: 'SELECT id, name FROM product WHERE id < 40',
required: true,
description: 'The SQL query to execute.',
2019-08-21 09:44:10 -07:00
},
// ----------------------------------
// insert
// ----------------------------------
2020-03-17 16:49:21 -07:00
{
displayName: 'Schema',
name: 'schema',
type: 'string',
displayOptions: {
show: {
operation: ['insert'],
},
2020-03-17 16:49:21 -07:00
},
default: 'public',
required: true,
description: 'Name of the schema the table belongs to',
2020-03-17 16:49:21 -07:00
},
2019-08-21 09:44:10 -07:00
{
displayName: 'Table',
name: 'table',
type: 'string',
displayOptions: {
show: {
operation: ['insert'],
},
2019-08-21 09:44:10 -07:00
},
default: '',
required: true,
description: 'Name of the table in which to insert data to.',
2019-08-21 09:44:10 -07:00
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
operation: ['insert'],
},
2019-08-21 09:44:10 -07:00
},
default: '',
placeholder: 'id,name,description',
2020-07-07 09:31:38 -07:00
description:
'Comma separated list of the properties which should used as columns for the new rows.',
2019-08-21 09:44:10 -07:00
},
2020-03-17 16:49:21 -07:00
{
displayName: 'Return Fields',
name: 'returnFields',
type: 'string',
displayOptions: {
show: {
operation: ['insert'],
},
2020-03-17 16:49:21 -07:00
},
default: '*',
2020-07-09 08:16:45 -07:00
description: 'Comma separated list of the fields that the operation will return',
2020-03-17 16:49:21 -07:00
},
2019-08-21 09:44:10 -07:00
// ----------------------------------
// update
// ----------------------------------
{
displayName: 'Schema',
name: 'schema',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
},
},
default: 'public',
required: true,
description: 'Name of the schema the table belongs to',
},
2019-08-21 09:44:10 -07:00
{
displayName: 'Table',
name: 'table',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
},
2019-08-21 09:44:10 -07:00
},
default: '',
required: true,
description: 'Name of the table in which to update data in',
2019-08-21 09:44:10 -07:00
},
{
displayName: 'Update Key',
name: 'updateKey',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
},
2019-08-21 09:44:10 -07:00
},
default: 'id',
required: true,
2020-07-07 09:31:38 -07:00
description:
'Name of the property which decides which rows in the database should be updated. Normally that would be "id".',
2019-08-21 09:44:10 -07:00
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
},
2019-08-21 09:44:10 -07:00
},
default: '',
placeholder: 'name,description',
2020-07-07 09:31:38 -07:00
description:
'Comma separated list of the properties which should used as columns for rows to update.',
},
],
2019-08-21 09:44:10 -07:00
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const credentials = this.getCredentials('postgres');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
const pgp = pgPromise();
const config: IDataObject = {
host: credentials.host as string,
port: credentials.port as number,
database: credentials.database as string,
user: credentials.user as string,
password: credentials.password as string,
};
if (credentials.allowUnauthorizedCerts === true) {
config.ssl = {
rejectUnauthorized: false,
};
} else {
config.ssl = !['disable', undefined].includes(credentials.ssl as string | undefined);
config.sslmode = (credentials.ssl as string) || 'disable';
}
const db = pgp(config);
2019-08-21 09:44:10 -07:00
let returnItems = [];
const items = this.getInputData();
const operation = this.getNodeParameter('operation', 0) as string;
if (operation === 'executeQuery') {
// ----------------------------------
// executeQuery
// ----------------------------------
2020-07-08 05:36:40 -07:00
const queryResult = await pgQuery(this.getNodeParameter, pgp, db, items);
2019-08-21 09:44:10 -07:00
returnItems = this.helpers.returnJsonArray(queryResult as IDataObject[]);
} else if (operation === 'insert') {
// ----------------------------------
// insert
// ----------------------------------
2020-07-09 08:16:45 -07:00
const [insertData, insertItems] = await pgInsert(this.getNodeParameter, pgp, db, items);
2019-08-21 09:44:10 -07:00
// Add the id to the data
for (let i = 0; i < insertData.length; i++) {
returnItems.push({
json: {
...insertData[i],
...insertItems[i],
},
2019-08-21 09:44:10 -07:00
});
}
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
2020-07-08 05:36:40 -07:00
const updateItems = await pgUpdate(this.getNodeParameter, pgp, db, items);
2019-08-21 09:44:10 -07:00
2020-07-08 05:36:40 -07:00
returnItems = this.helpers.returnJsonArray(updateItems);
2019-08-21 09:44:10 -07:00
} else {
await pgp.end();
2019-08-21 09:44:10 -07:00
throw new Error(`The operation "${operation}" is not supported!`);
}
// Close the connection
await pgp.end();
2019-08-21 09:44:10 -07:00
return this.prepareOutputData(returnItems);
}
}