import { IExecuteFunctions } from 'n8n-core'; import { IDataObject, INodeExecutionData, INodeType, INodeTypeDescription, NodeOperationError, } from 'n8n-workflow'; import * as pgPromise from 'pg-promise'; import { pgInsert, pgQuery, } from '../Postgres/Postgres.node.functions'; export class QuestDb implements INodeType { description: INodeTypeDescription = { displayName: 'QuestDB', name: 'questDb', icon: 'file:questdb.png', group: ['input'], version: 1, description: 'Gets, add and update data in QuestDB.', defaults: { name: 'QuestDB', color: '#2C4A79', }, inputs: ['main'], outputs: ['main'], credentials: [ { name: 'questDb', required: true, }, ], properties: [ { displayName: 'Operation', name: 'operation', type: 'options', options: [ { name: 'Execute Query', value: 'executeQuery', description: 'Executes a SQL query.', }, { name: 'Insert', value: 'insert', description: 'Insert rows in database.', }, ], default: 'insert', description: 'The operation to perform.', }, // ---------------------------------- // executeQuery // ---------------------------------- { displayName: 'Query', name: 'query', type: 'string', typeOptions: { rows: 5, }, 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: 'hidden', // Schema is used by pgInsert displayOptions: { show: { operation: [ 'insert', ], }, }, default: '', 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: '', placeholder: 'id,name,description', description: 'Comma separated list of the properties which should used as columns for the new rows.', }, { displayName: 'Return Fields', name: 'returnFields', type: 'string', displayOptions: { show: { operation: ['insert'], }, }, 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: {}, displayOptions: { show: { operation: [ 'executeQuery', ], }, }, options: [ { displayName: 'Mode', name: 'mode', type: 'options', options: [ { name: 'Independently', value: 'independently', description: 'Execute each query independently', }, { name: 'Transaction', value: 'transaction', description: 'Executes all queries in a single transaction', }, ], default: 'independently', description: [ 'The way queries should be sent to database.', 'Can be used in conjunction with Continue on Fail.', 'See the docs for more examples', ].join('
'), }, { 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.', }, ], }, { displayName: 'Additional Fields', name: 'additionalFields', type: 'hidden', default: {}, displayOptions: { show: { operation: [ 'insert', ], }, }, }, ], }; async execute(this: IExecuteFunctions): Promise { const credentials = this.getCredentials('questDb'); if (credentials === undefined) { throw new NodeOperationError(this.getNode(), 'No credentials got returned!'); } const pgp = pgPromise(); const config = { 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, ssl: !['disable', undefined].includes(credentials.ssl as string | undefined), sslmode: (credentials.ssl as string) || 'disable', }; const db = pgp(config); let returnItems: INodeExecutionData[] = []; const items = this.getInputData(); const operation = this.getNodeParameter('operation', 0) as string; if (operation === 'executeQuery') { // ---------------------------------- // executeQuery // ---------------------------------- const additionalFields = this.getNodeParameter('additionalFields', 0) as IDataObject; const mode = (additionalFields.mode || 'independently') as string; const queryResult = await pgQuery(this.getNodeParameter, pgp, db, items, this.continueOnFail(), mode); returnItems = this.helpers.returnJsonArray(queryResult); } else if (operation === 'insert') { // ---------------------------------- // insert // ---------------------------------- // Transaction and multiple won't work properly with QuestDB. // So we send queries independently. await pgInsert(this.getNodeParameter, pgp, db, items, this.continueOnFail(), 'independently'); const returnFields = this.getNodeParameter('returnFields', 0) as string; const table = this.getNodeParameter('table', 0) as string; const insertData = await db.any('SELECT ${columns:name} from ${table:name}', { columns: returnFields.split(',').map(value => value.trim()).filter(value => !!value), table, }); returnItems = this.helpers.returnJsonArray(insertData); } else { await pgp.end(); throw new NodeOperationError(this.getNode(), `The operation "${operation}" is not supported!`); } // Close the connection await pgp.end(); return this.prepareOutputData(returnItems); } }