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

257 lines
6.5 KiB
TypeScript
Raw Normal View History

2019-11-19 00:36:56 -08:00
import { IExecuteFunctions } from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
// @ts-ignore
import * as mysql2 from 'mysql2/promise';
2019-11-19 00:36:56 -08:00
import { copyInputItems } from './GenericFunctions';
2019-12-12 18:24:55 -08:00
export class MySql implements INodeType {
2019-11-19 00:36:56 -08:00
description: INodeTypeDescription = {
displayName: 'MySQL',
2019-12-12 18:24:55 -08:00
name: 'mySql',
2019-11-19 00:36:56 -08:00
icon: 'file:mysql.png',
group: ['input'],
version: 1,
description: 'Get, add and update data in MySQL.',
2019-11-19 00:36:56 -08:00
defaults: {
name: 'MySQL',
color: '#4279a2',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
2019-12-12 18:24:55 -08:00
name: 'mySql',
2019-11-19 00:36:56 -08:00
required: true,
2020-10-22 06:46:03 -07:00
},
2019-11-19 00:36:56 -08:00
],
properties: [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
options: [
{
name: 'Execute Query',
value: 'executeQuery',
description: 'Execute an SQL query.',
2019-11-19 00:36:56 -08:00
},
{
name: 'Insert',
value: 'insert',
description: 'Insert rows in database.',
},
{
name: 'Update',
value: 'update',
description: 'Update rows in database.',
2019-11-19 00:36:56 -08:00
},
],
default: 'insert',
description: 'The operation to perform.',
},
// ----------------------------------
// executeQuery
// ----------------------------------
{
displayName: 'Query',
name: 'query',
type: 'string',
typeOptions: {
rows: 5,
},
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'executeQuery',
2019-11-19 00:36:56 -08:00
],
},
},
default: '',
placeholder: 'SELECT id, name FROM product WHERE id < 40',
required: true,
description: 'The SQL query to execute.',
},
// ----------------------------------
// insert
// ----------------------------------
{
displayName: 'Table',
name: 'table',
type: 'string',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'insert',
2019-11-19 00:36:56 -08:00
],
},
},
default: '',
required: true,
description: 'Name of the table in which to insert data to.',
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'insert',
2019-11-19 00:36:56 -08:00
],
},
},
default: '',
placeholder: 'id,name,description',
description: 'Comma separated list of the properties which should used as columns for the new rows.',
},
// ----------------------------------
// update
// ----------------------------------
{
displayName: 'Table',
name: 'table',
type: 'string',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'update',
2019-11-19 00:36:56 -08:00
],
},
},
default: '',
required: true,
description: 'Name of the table in which to update data in',
},
{
displayName: 'Update Key',
name: 'updateKey',
type: 'string',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'update',
2019-11-19 00:36:56 -08:00
],
},
},
default: 'id',
required: true,
description: 'Name of the property which decides which rows in the database should be updated. Normally that would be "id".',
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
operation: [
2020-10-22 06:46:03 -07:00
'update',
2019-11-19 00:36:56 -08:00
],
},
},
default: '',
placeholder: 'name,description',
description: 'Comma separated list of the properties which should used as columns for rows to update.',
},
2020-10-22 06:46:03 -07:00
],
2019-11-19 00:36:56 -08:00
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
2019-12-12 18:24:55 -08:00
const credentials = this.getCredentials('mySql');
2019-11-19 00:36:56 -08:00
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
const connection = await mysql2.createConnection(credentials);
2019-11-19 00:36:56 -08:00
const items = this.getInputData();
const operation = this.getNodeParameter('operation', 0) as string;
let returnItems = [];
if (operation === 'executeQuery') {
// ----------------------------------
// executeQuery
// ----------------------------------
const queryQueue = items.map((item, index) => {
const rawQuery = this.getNodeParameter('query', index) as string;
return connection.query(rawQuery);
2019-11-19 00:36:56 -08:00
});
let queryResult = await Promise.all(queryQueue);
queryResult = queryResult.reduce((collection, result) => {
const [rows, fields] = result;
2019-12-12 18:24:55 -08:00
if (Array.isArray(rows)) {
return collection.concat(rows);
2019-11-19 00:36:56 -08:00
}
collection.push(rows);
2019-11-19 00:36:56 -08:00
return collection;
2019-11-19 00:36:56 -08:00
}, []);
returnItems = this.helpers.returnJsonArray(queryResult as IDataObject[]);
} else if (operation === 'insert') {
// ----------------------------------
// insert
// ----------------------------------
const table = this.getNodeParameter('table', 0) as string;
const columnString = this.getNodeParameter('columns', 0) as string;
const columns = columnString.split(',').map(column => column.trim());
const insertItems = copyInputItems(items, columns);
const insertPlaceholder = `(${columns.map(column => '?').join(',')})`;
const insertSQL = `INSERT INTO ${table}(${columnString}) VALUES ${items.map(item => insertPlaceholder).join(',')};`;
2019-12-12 18:24:55 -08:00
const queryItems = insertItems.reduce((collection, item) => collection.concat(Object.values(item as any)), []); // tslint:disable-line:no-any
const queryResult = await connection.query(insertSQL, queryItems);
2019-11-19 00:36:56 -08:00
returnItems = this.helpers.returnJsonArray(queryResult[0] as IDataObject);
2019-11-19 00:36:56 -08:00
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
const table = this.getNodeParameter('table', 0) as string;
const updateKey = this.getNodeParameter('updateKey', 0) as string;
const columnString = this.getNodeParameter('columns', 0) as string;
const columns = columnString.split(',').map(column => column.trim());
if (!columns.includes(updateKey)) {
columns.unshift(updateKey);
}
const updateItems = copyInputItems(items, columns);
const updateSQL = `UPDATE ${table} SET ${columns.map(column => `${column} = ?`).join(',')} WHERE ${updateKey} = ?;`;
const queryQueue = updateItems.map((item) => connection.query(updateSQL, Object.values(item).concat(item[updateKey])));
let queryResult = await Promise.all(queryQueue);
2019-11-19 00:36:56 -08:00
queryResult = queryResult.map(result => result[0]);
returnItems = this.helpers.returnJsonArray(queryResult as IDataObject[]);
2019-11-19 00:36:56 -08:00
} else {
await connection.end();
2019-11-19 00:36:56 -08:00
throw new Error(`The operation "${operation}" is not supported!`);
}
await connection.end();
2019-11-19 00:36:56 -08:00
return this.prepareOutputData(returnItems);
}
}