⚡ Implement index operations

packages/nodes-base/nodes/ElasticSearch/ElasticSearch.node.ts

@@ -11,6 +11,7 @@ import {
 
 import {
 	elasticSearchApiRequest,
+	// handleListing,
 } from './GenericFunctions';
 
 import {
@@ -35,6 +36,12 @@ export class ElasticSearch implements INodeType {
 		},
 		inputs: ['main'],
 		outputs: ['main'],
+		credentials: [
+			{
+				name: 'elasticSearchApi',
+				required: true,
+			},
+		],
 		properties: [
 			{
 				displayName: 'Resource',
@@ -77,16 +84,20 @@ export class ElasticSearch implements INodeType {
 				//                                document
 				// **********************************************************************
 
+				// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html
+
 				if (operation === 'get') {
 
 					// ----------------------------------------
 					//              document: get
 					// ----------------------------------------
 
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
+
 					const indexId = this.getNodeParameter('indexId', i);
 					const documentId = this.getNodeParameter('documentId', i);
 
-					const qs: IDataObject = {};
+					const qs = {} as IDataObject;
 					const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
 
 					if (Object.keys(additionalFields).length) {
@@ -94,7 +105,7 @@ export class ElasticSearch implements INodeType {
 					}
 
 					const endpoint = `/${indexId}/_doc/${documentId}`;
-					responseData = await elasticSearchApiRequest.call(this, 'GET', endpoint);
+					responseData = await elasticSearchApiRequest.call(this, 'GET', endpoint, {}, qs);
 
 				} else if (operation === 'delete') {
 
@@ -102,10 +113,12 @@ export class ElasticSearch implements INodeType {
 					//             document: delete
 					// ----------------------------------------
 
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
+
 					const indexId = this.getNodeParameter('indexId', i);
 					const documentId = this.getNodeParameter('documentId', i);
 
-					const qs: IDataObject = {};
+					const qs = {} as IDataObject;
 					const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
 
 					if (Object.keys(additionalFields).length) {
@@ -113,7 +126,7 @@ export class ElasticSearch implements INodeType {
 					}
 
 					const endpoint = `/${indexId}/_doc/${documentId}`;
-					responseData = await elasticSearchApiRequest.call(this, 'DELETE', endpoint);
+					responseData = await elasticSearchApiRequest.call(this, 'DELETE', endpoint, {}, qs);
 
 				} else if (operation === 'getAll') {
 
@@ -121,7 +134,9 @@ export class ElasticSearch implements INodeType {
 					//             document: getAll
 					// ----------------------------------------
 
-					const body: IDataObject = {};
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
+
+					const body = {} as IDataObject;
 					const filters = this.getNodeParameter('filters', i) as IDataObject;
 
 					if (Object.keys(filters).length) {
@@ -130,14 +145,14 @@ export class ElasticSearch implements INodeType {
 
 					const indexId = this.getNodeParameter('indexId', i);
 
-					const qs: IDataObject = {};
+					const qs = {} as IDataObject;
 					const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
 
 					if (Object.keys(additionalFields).length) {
 						Object.assign(qs, additionalFields);
 					}
 
-					// responseData = await handleListing.call(this, i, 'GET', `/${indexId}/_mget`, body);
+					// responseData = await handleListing.call(this, i, 'GET', `/${indexId}/_mget`, body, qs);
 
 				} else if (operation === 'update') {
 
@@ -145,9 +160,11 @@ export class ElasticSearch implements INodeType {
 					//             document: update
 					// ----------------------------------------
 
-					const body: IDataObject = {
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
+
+					const body = {
 						script: this.getNodeParameter('script', i),
-					};
+					} as IDataObject;
 
 					const indexId = this.getNodeParameter('indexId', i);
 					const documentId = this.getNodeParameter('documentId', i);
@@ -161,14 +178,16 @@ export class ElasticSearch implements INodeType {
 					//             document: index
 					// ----------------------------------------
 
-					const body: IDataObject = {
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
+
+					const body = {
 						field: this.getNodeParameter('field', i),
-					};
+					} as IDataObject;
 
 					const indexId = this.getNodeParameter('indexId', i);
 					const documentId = this.getNodeParameter('documentId', i);
 
-					const qs: IDataObject = {};
+					const qs = {} as IDataObject;
 					const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
 
 					if (Object.keys(additionalFields).length) {
@@ -176,7 +195,7 @@ export class ElasticSearch implements INodeType {
 					}
 
 					const endpoint = `/${indexId}/_doc/${documentId}`;
-					responseData = await elasticSearchApiRequest.call(this, 'PUT', endpoint, body);
+					responseData = await elasticSearchApiRequest.call(this, 'PUT', endpoint, body, qs);
 
 				}
 
@@ -186,22 +205,29 @@ export class ElasticSearch implements INodeType {
 				//                                 index
 				// **********************************************************************
 
-				if (operation === 'get') {
+				// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices.html
+
+				if (operation === 'create') {
 
 					// ----------------------------------------
-					//                index: get
+					//              index: create
 					// ----------------------------------------
 
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
+
 					const indexId = this.getNodeParameter('indexId', i);
 
-					const qs: IDataObject = {};
+					const body = {} as IDataObject;
+					const qs = {} as IDataObject;
 					const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
 
 					if (Object.keys(additionalFields).length) {
-						Object.assign(qs, additionalFields);
+						const { aliases, mappings, settings, ...rest } = additionalFields;
+						Object.assign(body, aliases, mappings, settings);
+						Object.assign(qs, rest);
 					}
 
-					responseData = await elasticSearchApiRequest.call(this, 'GET', `/${indexId}`);
+					responseData = await elasticSearchApiRequest.call(this, 'PUT', `/${indexId}`);
 
 				} else if (operation === 'delete') {
 
@@ -209,26 +235,30 @@ export class ElasticSearch implements INodeType {
 					//              index: delete
 					// ----------------------------------------
 
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html
+
 					const indexId = this.getNodeParameter('indexId', i);
 
-					const qs: IDataObject = {};
+					responseData = await elasticSearchApiRequest.call(this, 'DELETE', `/${indexId}`);
+
+				} else if (operation === 'get') {
+
+					// ----------------------------------------
+					//              index: get
+					// ----------------------------------------
+
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
+
+					const indexId = this.getNodeParameter('indexId', i);
+
+					const qs = {} as IDataObject;
 					const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
 
 					if (Object.keys(additionalFields).length) {
 						Object.assign(qs, additionalFields);
 					}
 
-					responseData = await elasticSearchApiRequest.call(this, 'DELETE', `/${indexId}`);
+					responseData = await elasticSearchApiRequest.call(this, 'GET', `/${indexId}`, {}, qs);
-
-				} else if (operation === 'create') {
-
-					// ----------------------------------------
-					//              index: create
-					// ----------------------------------------
-
-					const indexId = this.getNodeParameter('indexId', i);
-
-					responseData = await elasticSearchApiRequest.call(this, 'PUT', `/${indexId}`);
 
 				} else if (operation === 'getAll') {
 
@@ -236,17 +266,17 @@ export class ElasticSearch implements INodeType {
 					//              index: getAll
 					// ----------------------------------------
 
-					const qs: IDataObject = {
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
-						allow_no_indices: this.getNodeParameter('allow_no_indices', i),
-						expand_wildcards: this.getNodeParameter('expand_wildcards', i),
-						flat_settings: this.getNodeParameter('flat_settings', i),
-						ignore_unavailable: this.getNodeParameter('ignore_unavailable', i),
-						include_defaults: this.getNodeParameter('include_defaults', i),
-						local: this.getNodeParameter('local', i),
-						master_timeout: this.getNodeParameter('master_timeout', i),
-					};
 
-					// responseData = await handleListing.call(this, i, 'GET', '/_all', {}, qs);
+					responseData = await elasticSearchApiRequest.call(this, 'GET', '/_aliases');
+					responseData = Object.keys(responseData).map(i => ({ indexId: i }));
+
+					const returnAll = this.getNodeParameter('returnAll', i) as boolean;
+
+					if (!returnAll) {
+						const limit = this.getNodeParameter('limit', i) as number;
+						responseData = responseData.slice(0, limit);
+					}
 
 				} else if (operation === 'search') {
 
@@ -254,9 +284,19 @@ export class ElasticSearch implements INodeType {
 					//              index: search
 					// ----------------------------------------
 
+					// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html
+
 					const indexId = this.getNodeParameter('indexId', i);
 
-					const qs: IDataObject = {};
+					const body = {} as IDataObject;
+					const qs = {} as IDataObject;
+					const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
+
+					if (Object.keys(additionalFields).length) {
+						const { query, ...rest } = additionalFields;
+						Object.assign(body, query);
+						Object.assign(qs, rest);
+					}
 
 					responseData = await elasticSearchApiRequest.call(this, 'GET', `/${indexId}/_search`, {}, qs);
 

packages/nodes-base/nodes/ElasticSearch/GenericFunctions.ts

@@ -17,12 +17,16 @@ import {
 
 export async function elasticSearchApiRequest(
 	this: IExecuteFunctions,
-	method: string,
+	method: 'GET' | 'PUT' | 'POST' | 'DELETE',
 	endpoint: string,
 	body: IDataObject = {},
 	qs: IDataObject = {},
 ) {
-	const { username, password, baseUrl } = this.getCredentials('elasticSearchApi') as ElasticSearchApiCredentials;
+	const {
+		username,
+		password,
+		baseUrl,
+	} = this.getCredentials('elasticSearchApi') as ElasticSearchApiCredentials;
 
 	const token = Buffer.from(`${username}:${password}`).toString('base64');
 

packages/nodes-base/nodes/ElasticSearch/descriptions/DocumentDescription.ts

@@ -36,52 +36,12 @@ export const documentOperations = [
 				value: 'update',
 			},
 		],
-		default: 'get',
+		default: 'delete',
 		description: 'Operation to perform',
 	},
 ] as INodeProperties[];
 
 export const documentFields = [
-	// ----------------------------------------
-	//              document: get
-	// ----------------------------------------
-	{
-		displayName: 'Index ID',
-		name: 'indexId',
-		description: 'ID of the document to retrieve.',
-		type: 'string',
-		required: true,
-		default: '',
-		displayOptions: {
-			show: {
-				resource: [
-					'document',
-				],
-				operation: [
-					'get',
-				],
-			},
-		},
-	},
-	{
-		displayName: 'Document ID',
-		name: 'documentId',
-		description: 'ID of the document to retrieve.',
-		type: 'string',
-		required: true,
-		default: '',
-		displayOptions: {
-			show: {
-				resource: [
-					'document',
-				],
-				operation: [
-					'get',
-				],
-			},
-		},
-	},
-
 	// ----------------------------------------
 	//             document: delete
 	// ----------------------------------------
@@ -122,6 +82,46 @@ export const documentFields = [
 		},
 	},
 
+	// ----------------------------------------
+	//              document: get
+	// ----------------------------------------
+	{
+		displayName: 'Index ID',
+		name: 'indexId',
+		description: 'ID of the document to retrieve.',
+		type: 'string',
+		required: true,
+		default: '',
+		displayOptions: {
+			show: {
+				resource: [
+					'document',
+				],
+				operation: [
+					'get',
+				],
+			},
+		},
+	},
+	{
+		displayName: 'Document ID',
+		name: 'documentId',
+		description: 'ID of the document to retrieve.',
+		type: 'string',
+		required: true,
+		default: '',
+		displayOptions: {
+			show: {
+				resource: [
+					'document',
+				],
+				operation: [
+					'get',
+				],
+			},
+		},
+	},
+
 	// ----------------------------------------
 	//             document: getAll
 	// ----------------------------------------
@@ -210,64 +210,6 @@ export const documentFields = [
 		},
 	},
 
-	// ----------------------------------------
-	//             document: update
-	// ----------------------------------------
-	{
-		displayName: 'Index ID',
-		name: 'indexId',
-		description: 'ID of the document to update.',
-		type: 'string',
-		required: true,
-		default: '',
-		displayOptions: {
-			show: {
-				resource: [
-					'document',
-				],
-				operation: [
-					'update',
-				],
-			},
-		},
-	},
-	{
-		displayName: 'Document ID',
-		name: 'documentId',
-		description: 'ID of the document to update.',
-		type: 'string',
-		required: true,
-		default: '',
-		displayOptions: {
-			show: {
-				resource: [
-					'document',
-				],
-				operation: [
-					'update',
-				],
-			},
-		},
-	},
-	{
-		displayName: 'Script',
-		name: 'script',
-		description: 'Script to update the document. See the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-using.html">guide to writing scripts</a>.',
-		type: 'string',
-		required: true,
-		default: '',
-		displayOptions: {
-			show: {
-				resource: [
-					'document',
-				],
-				operation: [
-					'update',
-				],
-			},
-		},
-	},
-
 	// ----------------------------------------
 	//             document: index
 	// ----------------------------------------
@@ -325,4 +267,62 @@ export const documentFields = [
 			},
 		},
 	},
+
+	// ----------------------------------------
+	//             document: update
+	// ----------------------------------------
+	{
+		displayName: 'Index ID',
+		name: 'indexId',
+		description: 'ID of the document to update.',
+		type: 'string',
+		required: true,
+		default: '',
+		displayOptions: {
+			show: {
+				resource: [
+					'document',
+				],
+				operation: [
+					'update',
+				],
+			},
+		},
+	},
+	{
+		displayName: 'Document ID',
+		name: 'documentId',
+		description: 'ID of the document to update.',
+		type: 'string',
+		required: true,
+		default: '',
+		displayOptions: {
+			show: {
+				resource: [
+					'document',
+				],
+				operation: [
+					'update',
+				],
+			},
+		},
+	},
+	{
+		displayName: 'Script',
+		name: 'script',
+		description: 'Script to update the document. See the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-using.html" target="_blank"> ElasticSearch guide to writing scripts</a>.',
+		type: 'string',
+		required: true,
+		default: '',
+		displayOptions: {
+			show: {
+				resource: [
+					'document',
+				],
+				operation: [
+					'update',
+				],
+			},
+		},
+	},
 ] as INodeProperties[];

packages/nodes-base/nodes/ElasticSearch/descriptions/placeholders.ts

@@ -0,0 +1,36 @@
+export const indexSettings = `{
+  "settings": {
+    "index": {
+      "number_of_shards": 3,
+      "number_of_replicas": 2
+    }
+  }
+}`;
+
+export const mappings = `{
+  "mappings": {
+    "properties": {
+      "field1": { "type": "text" }
+    }
+  }
+}`;
+
+export const aliases = `{
+  "aliases": {
+    "alias_1": {},
+    "alias_2": {
+      "filter": {
+        "term": { "user.id": "kimchy" }
+      },
+      "routing": "shard-1"
+    }
+  }
+}`;
+
+export const query = `{
+  "query": {
+    "term": {
+      "user.id": "john"
+    }
+  }
+}`;