├── .env.example ├── .gitignore ├── package.json ├── config.js ├── helpers.js ├── index.js ├── README.rst ├── search.js ├── aggregate.js └── LICENSE /.env.example: -------------------------------------------------------------------------------- 1 | SERVICE_URI='Add your Service URI here' -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .env 2 | package-lock.json 3 | node_modules 4 | full_format_recipes.json -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "opensearch-nodejs-dive-in", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "search.js", 6 | "devDependencies": { 7 | "prettier": "2.4.1" 8 | }, 9 | "dependencies": { 10 | "@opensearch-project/opensearch": "^2.0.0", 11 | "dotenv": "^10.0.0" 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /config.js: -------------------------------------------------------------------------------- 1 | require("dotenv").config(); 2 | const { Client } = require("@opensearch-project/opensearch"); 3 | 4 | // full_format_recipes.json taken from 5 | // https://www.kaggle.com/hugodarwood/epirecipes?select=full_format_recipes.json 6 | module.exports.recipes = require("./full_format_recipes.json"); 7 | 8 | 9 | /** 10 | * Client performs requests on our behalf 11 | * Additionally, when creating a client you can also specify `ssl configuration`, `bearer token`, `CA fingerprint` and other authentication details depending on protocols you use. 12 | */ 13 | module.exports.client = new Client({ 14 | node: process.env.SERVICE_URI, 15 | }); 16 | 17 | module.exports.indexName = "recipes"; 18 | 19 | -------------------------------------------------------------------------------- /helpers.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Logging result body, used in callbacks. 3 | */ 4 | module.exports.logBody = (error, result) => { 5 | if (error) { 6 | console.error(error); 7 | } else { 8 | console.log(result.body); 9 | } 10 | }; 11 | 12 | /** 13 | * Parsing and logging list of titles from the result, used in callbacks. 14 | */ 15 | module.exports.logTitles = (error, result) => { 16 | if (error) { 17 | console.error(error); 18 | } else { 19 | const hits = result.body.hits.hits; 20 | console.log(hits.map((hit) => hit._source.title)); 21 | } 22 | }; 23 | 24 | module.exports.logAggs = (field, error, result) => { 25 | if (error) { 26 | console.error(error); 27 | } else { 28 | console.log(result.body.aggregations[field]); 29 | } 30 | }; 31 | 32 | module.exports.logResultBody = (error, result) => { 33 | if (error) { 34 | console.error(error); 35 | } else { 36 | console.log(result.body); 37 | } 38 | }; -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const { client, indexName, recipes } = require("./config"); 2 | const { logBody } = require("./helpers"); 3 | 4 | /** 5 | * Indexing data from json file with recipes. 6 | * Format: action \n document \n action \n document ... 7 | * run-func index injectData 8 | */ 9 | module.exports.injectData = () => { 10 | console.log(`Ingesting data: ${recipes.length} recipes`); 11 | const body = recipes.flatMap(doc => [ 12 | { index: { _index: indexName } }, 13 | doc, 14 | ]); 15 | 16 | client.bulk({ refresh: true, body }, logBody); 17 | }; 18 | 19 | /** 20 | * Getting list of indices 21 | * run-func index getIndices 22 | */ 23 | module.exports.getIndices = () => { 24 | console.log(`Getting existing indices:`); 25 | client.cat.indices({ format: "json" }, logBody); 26 | }; 27 | 28 | /** 29 | * Retrieving mapping for the index. 30 | * run-func index getMapping 31 | */ 32 | module.exports.getMapping = () => { 33 | console.log(`Retrieving mapping for the index with name ${indexName}`); 34 | 35 | client.indices.getMapping({ index: indexName }, (error, result) => { 36 | if (error) { 37 | console.error(error); 38 | } else { 39 | console.log(result.body.recipes.mappings.properties); 40 | } 41 | }); 42 | }; 43 | 44 | /** 45 | * Deleting the index 46 | * run-func index delete 47 | */ 48 | module.exports.delete = (index) => { 49 | client.indices.delete( 50 | { 51 | index: index || indexName, 52 | }, 53 | logBody 54 | ); 55 | }; 56 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Hands-on material for session on how to start working with OpenSearch® and NodeJS 2 | ================================================================================== 3 | 4 | Additional written guidance can be also found in articles `how to write search queries with OpenSearch and NodeJS `_ and `how to use aggregations with OpenSearch and NodeJS `_. 5 | 6 | Prerequisites 7 | ------------- 8 | 9 | To run examples from this repository you'll need: 10 | 11 | 1. An OpenSearch cluster. You can `set it up manually `_ or you can use a fully managed service, such as `Aiven for OpenSearch `_. 12 | 2. NodeJS and npm. If you don’t have NodeJS or npm installed, follow `these instructions `_. 13 | 3. Curiosity and patience 😉 14 | 15 | Running locally 16 | --------------- 17 | 18 | 1. Clone the repository and install the dependencies:: 19 | 20 | npm install 21 | 22 | 2. Copy .env.example, rename to .env and there the service_uri of your OpenSearch cluster. 23 | 24 | 3. Download full_format_recipes from `Kaggle `_. Unzip and copy the JSON file to the root folder of this project. 25 | 26 | 4. Install ``run-func`` to run javascript methods from command line with more convenience:: 27 | 28 | npm i -g run-func 29 | 30 | You're all set! Retrieve the list of available indices by running in your terminal 31 | 32 | :: 33 | 34 | run-func index getIndices 35 | 36 | 37 | How to use 38 | ---------- 39 | 40 | 1. Make sure that you have `full_format_recipes.json` at the root level of the repository and run command to inject data:: 41 | 42 | run-func index injectData 43 | 44 | Wait till the data is indexed. Can take 15-20 seconds. 45 | 46 | 2. Check `search.js` and `aggregate.js` for examples you can run. Every method contains a terminal command sample that you can try. 47 | 48 | :: 49 | 50 | run-func search match title "garlic onion cake" 51 | 52 | :: 53 | 54 | run-func aggregate field rating 55 | 56 | 57 | Structure of this repository 58 | ---------------------------- 59 | 60 | `index.js` - working with index, injecting data 61 | 62 | `search.js` - examples of different types of search queries 63 | 64 | `aggregate.js` - examples of different types of aggregation queries 65 | 66 | `config.js` and `helpers.js` contain operations required to connect to the cluster and log responses. 67 | 68 | 69 | License 70 | ------- 71 | 72 | This work is licensed under the Apache License, Version 2.0. Full license text is available in the LICENSE file and at http://www.apache.org/licenses/LICENSE-2.0.txt 73 | 74 | 75 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /search.js: -------------------------------------------------------------------------------- 1 | const { client, indexName: index } = require("./config"); 2 | const { logTitles } = require("./helpers"); 3 | 4 | /** 5 | * Finding matches sorted by relevance (full-text query) 6 | * run-func search match title "soups with beer and garlic" 7 | * run-func search match title "pizza salad and cheese" 8 | */ 9 | module.exports.match = (field, query) => { 10 | const body = { 11 | query: { 12 | match: { 13 | [field]: { 14 | query, 15 | }, 16 | }, 17 | }, 18 | }; 19 | client.search( 20 | { 21 | index, 22 | body, 23 | }, 24 | logTitles 25 | ); 26 | }; 27 | 28 | /** 29 | * Matching a phrase (full-text query) 30 | * run-func search phrase title 'pasta with cheese' 31 | * run-func search phrase title 'milk chocolate cake' 32 | */ 33 | module.exports.phrase = (field, query, slop) => { 34 | const body = { 35 | query: { 36 | match_phrase: { 37 | [field]: { 38 | query, 39 | slop 40 | }, 41 | }, 42 | }, 43 | }; 44 | client.search( 45 | { 46 | index, 47 | body, 48 | }, 49 | logTitles 50 | ); 51 | }; 52 | 53 | /** 54 | * Using special operators within a query string and a size parameter (full-text query) 55 | * run-func search queryString title '+(dessert | cake) -garlic (mango | caramel | cinnamon)' 56 | * run-func search queryString title '+(salad | soup) -broccoli (tomato | apple)' 57 | */ 58 | module.exports.queryString = (field, query) => { 59 | const body = { 60 | query: { 61 | query_string: { 62 | default_field: field, 63 | query, 64 | }, 65 | }, 66 | }; 67 | client.search( 68 | { 69 | index, 70 | body 71 | }, 72 | logTitles 73 | ); 74 | }; 75 | 76 | /** 77 | * Searching for exact matches of a value in a field (term-level query) 78 | * run-func search term sodium 0 79 | */ 80 | module.exports.term = (field, value) => { 81 | const body = { 82 | query: { 83 | term: { 84 | [field]: value, 85 | }, 86 | }, 87 | }; 88 | client.search( 89 | { 90 | index, 91 | body, 92 | }, 93 | logTitles 94 | ); 95 | }; 96 | 97 | /** 98 | * Searching for a range of values in a field (term-level query) 99 | * gt (greater than) 100 | * gte (greater than or equal to) 101 | * lt (less than) 102 | * lte (less than or equal to) 103 | * run-func search range sodium 0 100 104 | */ 105 | module.exports.range = (field, gte, lte) => { 106 | const body = { 107 | query: { 108 | range: { 109 | [field]: { 110 | gte, 111 | lte, 112 | }, 113 | }, 114 | }, 115 | }; 116 | client.search( 117 | { 118 | index, 119 | body, 120 | }, 121 | logTitles 122 | ); 123 | }; 124 | 125 | 126 | /** 127 | * Combining several queries together (boolean query) 128 | * run-func search boolean 129 | */ 130 | module.exports.boolean = () => { 131 | const body = { 132 | query: { 133 | bool: { 134 | filter: [{ range: { rating: { gte: 4 } } }], 135 | must: [ 136 | { match: { categories: "Quick & Easy" } }, 137 | { match: { title: "beer" } }, 138 | ], 139 | should: [ 140 | { match: { categories: "Cocktails" } }, 141 | ], 142 | must_not: { match: { ingredients: "garlic" } } 143 | }, 144 | }, 145 | }; 146 | client.search( 147 | { 148 | index, 149 | body, 150 | }, 151 | logTitles 152 | ); 153 | }; -------------------------------------------------------------------------------- /aggregate.js: -------------------------------------------------------------------------------- 1 | const { client, indexName: index } = require("./config"); 2 | const { logAggs } = require("./helpers"); 3 | 4 | /** 5 | * Get metric aggregations for the field 6 | * Examples: stats, extended_stats, percentiles, terms 7 | * run-func aggregate metric avg rating 8 | */ 9 | module.exports.metric = (metric, field) => { 10 | const body = { 11 | aggs: { 12 | [`aggs-for-${field}`]: { //aggs name 13 | [metric]: { // aggregation type 14 | field, 15 | }, 16 | }, 17 | }, 18 | // try mixing with search queries! 19 | // query: { 20 | // match: { 21 | // [matchField]: matchValue 22 | // } 23 | // }, 24 | }; 25 | client.search( 26 | { 27 | index, 28 | body, 29 | size: 0, // we're not interested in `hits` 30 | }, 31 | logAggs.bind(this, `aggs-for-${field}`) 32 | ); 33 | }; 34 | 35 | /** 36 | * Histogram with interval 37 | * run-func aggregate histogram rating 1 38 | */ 39 | module.exports.histogram = (field, interval) => { 40 | const body = { 41 | aggs: { 42 | [`aggs-for-${field}`]: { 43 | histogram: { // aggregation type 44 | field, 45 | interval, 46 | }, 47 | }, 48 | }, 49 | }; 50 | client.search( 51 | { 52 | index, 53 | body, 54 | size: 0, 55 | }, 56 | logAggs.bind(this, `aggs-for-${field}`) 57 | ); 58 | }; 59 | 60 | /** 61 | * Date histogram with interval 62 | * run-func aggregate dateHistogram date year 63 | */ 64 | module.exports.dateHistogram = (field, interval) => { 65 | const body = { 66 | aggs: { 67 | [`aggs-for-${field}`]: { 68 | date_histogram: { 69 | field, 70 | interval, 71 | }, 72 | }, 73 | }, 74 | }; 75 | client.search( 76 | { 77 | index, 78 | body, 79 | size: 0, 80 | }, 81 | logAggs.bind(this, `aggs-for-${field}`) 82 | ); 83 | }; 84 | 85 | /** 86 | * Date histogram with number of buckets 87 | * run-func aggregate autoDateHistogram date 3 88 | */ 89 | module.exports.autoDateHistogram = (field, buckets) => { 90 | const body = { 91 | aggs: { 92 | [`aggs-for-${field}`]: { 93 | auto_date_histogram: { 94 | field, 95 | buckets, 96 | }, 97 | }, 98 | }, 99 | }; 100 | client.search( 101 | { 102 | index, 103 | body, 104 | size: 0, 105 | }, 106 | logAggs.bind(this, `aggs-for-${field}`) 107 | ); 108 | }; 109 | 110 | 111 | /** 112 | * Calculating the moving average of number of added recipes across years 113 | * run-func aggregate movingAverage 114 | */ 115 | module.exports.movingAverage = () => { 116 | const body = { 117 | aggs: { 118 | recipes_per_year: { // 1. date histogram 119 | date_histogram: { 120 | field: "date", 121 | interval: "year", 122 | }, 123 | aggs: { 124 | recipes_count: { // 2. metric aggregation to count new recipes 125 | value_count: { // aggregate by number of documents with field 'date' 126 | field: "date" 127 | }, 128 | }, 129 | moving_average: { 130 | moving_fn: { // 3. glue the aggregations 131 | script: "MovingFunctions.unweightedAvg(values)", // 4. a built-in function 132 | shift: 1, // 5. take into account the existing year as part of the window 133 | window: 3, // 6. set size of the moving window 134 | buckets_path: "recipes_count", 135 | gap_policy: "insert_zeros", // account for years where no recipes were 136 | // added and replace null value with zeros 137 | }, 138 | }, 139 | }, 140 | }, 141 | }, 142 | }; 143 | client.search( 144 | { 145 | index, 146 | body, 147 | size: 0, 148 | }, 149 | (error, result) => { 150 | if (error) { 151 | console.error(error); 152 | } else { 153 | console.log(result.body.aggregations["recipes_per_year"].buckets); 154 | } 155 | } 156 | ); 157 | }; -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. --------------------------------------------------------------------------------