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

232 lines
6 KiB
TypeScript
Raw Normal View History

import type { IExecuteFunctions } from 'n8n-core';
import type {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import { connect, copyInputItems, destroy, execute } from './GenericFunctions';
2020-12-10 01:17:16 -08:00
import snowflake from 'snowflake-sdk';
2020-12-10 01:17:16 -08:00
export class Snowflake implements INodeType {
description: INodeTypeDescription = {
displayName: 'Snowflake',
name: 'snowflake',
icon: 'file:snowflake.svg',
2020-12-10 01:17:16 -08:00
group: ['input'],
version: 1,
description: 'Get, add and update data in Snowflake',
2020-12-10 01:17:16 -08:00
defaults: {
name: 'Snowflake',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'snowflake',
required: true,
},
],
properties: [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
2020-12-10 01:17:16 -08:00
options: [
{
name: 'Execute Query',
value: 'executeQuery',
description: 'Execute an SQL query',
action: 'Execute a SQL query',
2020-12-10 01:17:16 -08:00
},
{
name: 'Insert',
value: 'insert',
description: 'Insert rows in database',
action: 'Insert rows in database',
2020-12-10 01:17:16 -08:00
},
{
name: 'Update',
value: 'update',
description: 'Update rows in database',
action: 'Update rows in database',
2020-12-10 01:17:16 -08:00
},
],
default: 'insert',
},
// ----------------------------------
// executeQuery
// ----------------------------------
{
displayName: 'Query',
name: 'query',
type: 'string',
displayOptions: {
show: {
operation: ['executeQuery'],
2020-12-10 01:17:16 -08:00
},
},
default: '',
placeholder: 'SELECT id, name FROM product WHERE id < 40',
required: true,
description: 'The SQL query to execute',
2020-12-10 01:17:16 -08:00
},
// ----------------------------------
// insert
// ----------------------------------
{
displayName: 'Table',
name: 'table',
type: 'string',
displayOptions: {
show: {
operation: ['insert'],
2020-12-10 01:17:16 -08:00
},
},
default: '',
required: true,
description: 'Name of the table in which to insert data to',
2020-12-10 01:17:16 -08:00
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
operation: ['insert'],
2020-12-10 01:17:16 -08:00
},
},
default: '',
placeholder: 'id,name,description',
description:
'Comma-separated list of the properties which should used as columns for the new rows',
2020-12-10 01:17:16 -08:00
},
// ----------------------------------
// update
// ----------------------------------
{
displayName: 'Table',
name: 'table',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
2020-12-10 01:17:16 -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: ['update'],
2020-12-10 01:17:16 -08:00
},
},
default: 'id',
required: true,
// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-id
description:
'Name of the property which decides which rows in the database should be updated. Normally that would be "id".',
2020-12-10 01:17:16 -08:00
},
{
displayName: 'Columns',
name: 'columns',
type: 'string',
displayOptions: {
show: {
operation: ['update'],
2020-12-10 01:17:16 -08:00
},
},
default: '',
placeholder: 'name,description',
description:
'Comma-separated list of the properties which should used as columns for rows to update',
2020-12-10 01:17:16 -08:00
},
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const credentials = (await this.getCredentials(
'snowflake',
)) as unknown as snowflake.ConnectionOptions;
2020-12-10 01:17:16 -08:00
const returnData: IDataObject[] = [];
let responseData;
const connection = snowflake.createConnection(credentials);
await connect(connection);
const items = this.getInputData();
const operation = this.getNodeParameter('operation', 0);
2020-12-10 01:17:16 -08:00
if (operation === 'executeQuery') {
// ----------------------------------
// executeQuery
// ----------------------------------
for (let i = 0; i < items.length; i++) {
const query = this.getNodeParameter('query', i) as string;
responseData = await execute(connection, query, []);
returnData.push.apply(returnData, responseData as IDataObject[]);
}
}
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 query = `INSERT INTO ${table}(${columns.join(',')}) VALUES (${columns
.map((_column) => '?')
.join(',')})`;
2020-12-10 01:17:16 -08:00
const data = copyInputItems(items, columns);
const binds = data.map((element) => Object.values(element));
2020-12-10 01:17:16 -08:00
await execute(connection, query, binds as unknown as snowflake.InsertBinds);
returnData.push.apply(returnData, data);
}
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());
2020-12-10 01:17:16 -08:00
if (!columns.includes(updateKey)) {
columns.unshift(updateKey);
}
const query = `UPDATE ${table} SET ${columns
.map((column) => `${column} = ?`)
.join(',')} WHERE ${updateKey} = ?;`;
2020-12-10 01:17:16 -08:00
const data = copyInputItems(items, columns);
const binds = data.map((element) => Object.values(element).concat(element[updateKey]));
2020-12-10 01:17:16 -08:00
for (let i = 0; i < binds.length; i++) {
await execute(connection, query, binds[i] as unknown as snowflake.InsertBinds);
}
returnData.push.apply(returnData, data);
}
await destroy(connection);
return [this.helpers.returnJsonArray(returnData)];
}
}