├── LICENSE ├── MANIFEST.in ├── README.md ├── build └── lib │ └── elasticsearchquerygenerator │ └── elasticsearchquerygenerator.py ├── dist ├── elasticsearchquerygenerator-1.0.0-py3-none-any.whl └── elasticsearchquerygenerator-1.1.0-py3-none-any.whl ├── elasticsearchquerygenerator.egg-info ├── PKG-INFO ├── SOURCES.txt ├── dependency_links.txt └── top_level.txt ├── elasticsearchquerygenerator └── elasticsearchquerygenerator.py └── setup.py /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2020 Soumil Nitin Shah 2 | 3 | GNU GENERAL PUBLIC LICENSE 4 | Version 3, 29 June 2007 5 | 6 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 7 | 8 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 9 | 10 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 11 | 12 | 13 | Preamble 14 | 15 | The GNU General Public License is a free, copyleft license for 16 | software and other kinds of works. 17 | 18 | The licenses for most software and other practical works are designed 19 | to take away your freedom to share and change the works. By contrast, 20 | the GNU General Public License is intended to guarantee your freedom to 21 | share and change all versions of a program--to make sure it remains free 22 | software for all its users. We, the Free Software Foundation, use the 23 | GNU General Public License for most of our software; it applies also to 24 | any other work released this way by its authors. You can apply it to 25 | your programs, too. 26 | 27 | When we speak of free software, we are referring to freedom, not 28 | price. Our General Public Licenses are designed to make sure that you 29 | have the freedom to distribute copies of free software (and charge for 30 | them if you wish), that you receive source code or can get it if you 31 | want it, that you can change the software or use pieces of it in new 32 | free programs, and that you know you can do these things. 33 | 34 | To protect your rights, we need to prevent others from denying you 35 | these rights or asking you to surrender the rights. Therefore, you have 36 | certain responsibilities if you distribute copies of the software, or if 37 | you modify it: responsibilities to respect the freedom of others. 38 | 39 | For example, if you distribute copies of such a program, whether 40 | gratis or for a fee, you must pass on to the recipients the same 41 | freedoms that you received. You must make sure that they, too, receive 42 | or can get the source code. And you must show them these terms so they 43 | know their rights. 44 | 45 | Developers that use the GNU GPL protect your rights with two steps: 46 | (1) assert copyright on the software, and (2) offer you this License 47 | giving you legal permission to copy, distribute and/or modify it. 48 | 49 | For the developers' and authors' protection, the GPL clearly explains 50 | that there is no warranty for this free software. For both users' and 51 | authors' sake, the GPL requires that modified versions be marked as 52 | changed, so that their problems will not be attributed erroneously to 53 | authors of previous versions. 54 | 55 | Some devices are designed to deny users access to install or run 56 | modified versions of the software inside them, although the manufacturer 57 | can do so. This is fundamentally incompatible with the aim of 58 | protecting users' freedom to change the software. The systematic 59 | pattern of such abuse occurs in the area of products for individuals to 60 | use, which is precisely where it is most unacceptable. Therefore, we 61 | have designed this version of the GPL to prohibit the practice for those 62 | products. If such problems arise substantially in other domains, we 63 | stand ready to extend this provision to those domains in future versions 64 | of the GPL, as needed to protect the freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish to 69 | avoid the special danger that patents applied to a free program could 70 | make it effectively proprietary. To prevent this, the GPL assures that 71 | patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | TERMS AND CONDITIONS 77 | 78 | 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds of 83 | works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of an 91 | exact copy. The resulting work is called a "modified version" of the 92 | earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user through 106 | a computer network, with no transfer of a copy, is not conveying. 107 | 108 | An interactive user interface displays "Appropriate Legal Notices" 109 | to the extent that it includes a convenient and prominently visible 110 | feature that (1) displays an appropriate copyright notice, and (2) 111 | tells the user that there is no warranty for the work (except to the 112 | extent that warranties are provided), that licensees may convey the 113 | work under this License, and how to view a copy of this License. If 114 | the interface presents a list of user commands or options, such as a 115 | menu, a prominent item in the list meets this criterion. 116 | 117 | 1. Source Code. 118 | 119 | The "source code" for a work means the preferred form of the work 120 | for making modifications to it. "Object code" means any non-source 121 | form of a work. 122 | 123 | A "Standard Interface" means an interface that either is an official 124 | standard defined by a recognized standards body, or, in the case of 125 | interfaces specified for a particular programming language, one that 126 | is widely used among developers working in that language. 127 | 128 | The "System Libraries" of an executable work include anything, other 129 | than the work as a whole, that (a) is included in the normal form of 130 | packaging a Major Component, but which is not part of that Major 131 | Component, and (b) serves only to enable use of the work with that 132 | Major Component, or to implement a Standard Interface for which an 133 | implementation is available to the public in source code form. A 134 | "Major Component", in this context, means a major essential component 135 | (kernel, window system, and so on) of the specific operating system 136 | (if any) on which the executable work runs, or a compiler used to 137 | produce the work, or an object code interpreter used to run it. 138 | 139 | The "Corresponding Source" for a work in object code form means all 140 | the source code needed to generate, install, and (for an executable 141 | work) run the object code and to modify the work, including scripts to 142 | control those activities. However, it does not include the work's 143 | System Libraries, or general-purpose tools or generally available free 144 | programs which are used unmodified in performing those activities but 145 | which are not part of the work. For example, Corresponding Source 146 | includes interface definition files associated with source files for 147 | the work, and the source code for shared libraries and dynamically 148 | linked subprograms that the work is specifically designed to require, 149 | such as by intimate data communication or control flow between those 150 | subprograms and other parts of the work. 151 | 152 | The Corresponding Source need not include anything that users 153 | can regenerate automatically from other parts of the Corresponding 154 | Source. 155 | 156 | The Corresponding Source for a work in source code form is that 157 | same work. 158 | 159 | 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not 170 | convey, without conditions so long as your license otherwise remains 171 | in force. You may convey covered works to others for the sole purpose 172 | of having them make modifications exclusively for you, or provide you 173 | with facilities for running those works, provided that you comply with 174 | the terms of this License in conveying all material for which you do 175 | not control copyright. Those thus making or running the covered works 176 | for you must do so exclusively on your behalf, under your direction 177 | and control, on terms that prohibit them from making any copies of 178 | your copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under 181 | the conditions stated below. Sublicensing is not allowed; section 10 182 | makes it unnecessary. 183 | 184 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such circumvention 194 | is effected by exercising rights under this License with respect to 195 | the covered work, and you disclaim any intention to limit operation or 196 | modification of the work as a means of enforcing, against the work's 197 | users, your or third parties' legal rights to forbid circumvention of 198 | technological measures. 199 | 200 | 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these conditions: 218 | 219 | a) The work must carry prominent notices stating that you modified 220 | it, and giving a relevant date. 221 | 222 | b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under section 224 | 7. This requirement modifies the requirement in section 4 to 225 | "keep intact all notices". 226 | 227 | c) You must license the entire work, as a whole, under this 228 | License to anyone who comes into possession of a copy. This 229 | License will therefore apply, along with any applicable section 7 230 | additional terms, to the whole of the work, and all its parts, 231 | regardless of how they are packaged. This License gives no 232 | permission to license the work in any other way, but it does not 233 | invalidate such permission if you have separately received it. 234 | 235 | d) If the work has interactive user interfaces, each must display 236 | Appropriate Legal Notices; however, if the Program has interactive 237 | interfaces that do not display Appropriate Legal Notices, your 238 | work need not make them do so. 239 | 240 | A compilation of a covered work with other separate and independent 241 | works, which are not by their nature extensions of the covered work, 242 | and which are not combined with it such as to form a larger program, 243 | in or on a volume of a storage or distribution medium, is called an 244 | "aggregate" if the compilation and its resulting copyright are not 245 | used to limit the access or legal rights of the compilation's users 246 | beyond what the individual works permit. Inclusion of a covered work 247 | in an aggregate does not cause this License to apply to the other 248 | parts of the aggregate. 249 | 250 | 6. Conveying Non-Source Forms. 251 | 252 | You may convey a covered work in object code form under the terms 253 | of sections 4 and 5, provided that you also convey the 254 | machine-readable Corresponding Source under the terms of this License, 255 | in one of these ways: 256 | 257 | a) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by the 259 | Corresponding Source fixed on a durable physical medium 260 | customarily used for software interchange. 261 | 262 | b) Convey the object code in, or embodied in, a physical product 263 | (including a physical distribution medium), accompanied by a 264 | written offer, valid for at least three years and valid for as 265 | long as you offer spare parts or customer support for that product 266 | model, to give anyone who possesses the object code either (1) a 267 | copy of the Corresponding Source for all the software in the 268 | product that is covered by this License, on a durable physical 269 | medium customarily used for software interchange, for a price no 270 | more than your reasonable cost of physically performing this 271 | conveying of source, or (2) access to copy the 272 | Corresponding Source from a network server at no charge. 273 | 274 | c) Convey individual copies of the object code with a copy of the 275 | written offer to provide the Corresponding Source. This 276 | alternative is allowed only occasionally and noncommercially, and 277 | only if you received the object code with such an offer, in accord 278 | with subsection 6b. 279 | 280 | d) Convey the object code by offering access from a designated 281 | place (gratis or for a charge), and offer equivalent access to the 282 | Corresponding Source in the same way through the same place at no 283 | further charge. You need not require recipients to copy the 284 | Corresponding Source along with the object code. If the place to 285 | copy the object code is a network server, the Corresponding Source 286 | may be on a different server (operated by you or a third party) 287 | that supports equivalent copying facilities, provided you maintain 288 | clear directions next to the object code saying where to find the 289 | Corresponding Source. Regardless of what server hosts the 290 | Corresponding Source, you remain obligated to ensure that it is 291 | available for as long as needed to satisfy these requirements. 292 | 293 | e) Convey the object code using peer-to-peer transmission, provided 294 | you inform other peers where the object code and Corresponding 295 | Source of the work are being offered to the general public at no 296 | charge under subsection 6d. 297 | 298 | A separable portion of the object code, whose source code is excluded 299 | from the Corresponding Source as a System Library, need not be 300 | included in conveying the object code work. 301 | 302 | A "User Product" is either (1) a "consumer product", which means any 303 | tangible personal property which is normally used for personal, family, 304 | or household purposes, or (2) anything designed or sold for incorporation 305 | into a dwelling. In determining whether a product is a consumer product, 306 | doubtful cases shall be resolved in favor of coverage. For a particular 307 | product received by a particular user, "normally used" refers to a 308 | typical or common use of that class of product, regardless of the status 309 | of the particular user or of the way in which the particular user 310 | actually uses, or expects or is expected to use, the product. A product 311 | is a consumer product regardless of whether the product has substantial 312 | commercial, industrial or non-consumer uses, unless such uses represent 313 | the only significant mode of use of the product. 314 | 315 | "Installation Information" for a User Product means any methods, 316 | procedures, authorization keys, or other information required to install 317 | and execute modified versions of a covered work in that User Product from 318 | a modified version of its Corresponding Source. The information must 319 | suffice to ensure that the continued functioning of the modified object 320 | code is in no case prevented or interfered with solely because 321 | modification has been made. 322 | 323 | If you convey an object code work under this section in, or with, or 324 | specifically for use in, a User Product, and the conveying occurs as 325 | part of a transaction in which the right of possession and use of the 326 | User Product is transferred to the recipient in perpetuity or for a 327 | fixed term (regardless of how the transaction is characterized), the 328 | Corresponding Source conveyed under this section must be accompanied 329 | by the Installation Information. But this requirement does not apply 330 | if neither you nor any third party retains the ability to install 331 | modified object code on the User Product (for example, the work has 332 | been installed in ROM). 333 | 334 | The requirement to provide Installation Information does not include a 335 | requirement to continue to provide support service, warranty, or updates 336 | for a work that has been modified or installed by the recipient, or for 337 | the User Product in which it has been modified or installed. Access to a 338 | network may be denied when the modification itself materially and 339 | adversely affects the operation of the network or violates the rules and 340 | protocols for communication across the network. 341 | 342 | Corresponding Source conveyed, and Installation Information provided, 343 | in accord with this section must be in a format that is publicly 344 | documented (and with an implementation available to the public in 345 | source code form), and must require no special password or key for 346 | unpacking, reading or copying. 347 | 348 | 7. Additional Terms. 349 | 350 | "Additional permissions" are terms that supplement the terms of this 351 | License by making exceptions from one or more of its conditions. 352 | Additional permissions that are applicable to the entire Program shall 353 | be treated as though they were included in this License, to the extent 354 | that they are valid under applicable law. If additional permissions 355 | apply only to part of the Program, that part may be used separately 356 | under those permissions, but the entire Program remains governed by 357 | this License without regard to the additional permissions. 358 | 359 | When you convey a copy of a covered work, you may at your option 360 | remove any additional permissions from that copy, or from any part of 361 | it. (Additional permissions may be written to require their own 362 | removal in certain cases when you modify the work.) You may place 363 | additional permissions on material, added by you to a covered work, 364 | for which you have or can give appropriate copyright permission. 365 | 366 | Notwithstanding any other provision of this License, for material you 367 | add to a covered work, you may (if authorized by the copyright holders of 368 | that material) supplement the terms of this License with terms: 369 | 370 | a) Disclaiming warranty or limiting liability differently from the 371 | terms of sections 15 and 16 of this License; or 372 | 373 | b) Requiring preservation of specified reasonable legal notices or 374 | author attributions in that material or in the Appropriate Legal 375 | Notices displayed by works containing it; or 376 | 377 | c) Prohibiting misrepresentation of the origin of that material, or 378 | requiring that modified versions of such material be marked in 379 | reasonable ways as different from the original version; or 380 | 381 | d) Limiting the use for publicity purposes of names of licensors or 382 | authors of the material; or 383 | 384 | e) Declining to grant rights under trademark law for use of some 385 | trade names, trademarks, or service marks; or 386 | 387 | f) Requiring indemnification of licensors and authors of that 388 | material by anyone who conveys the material (or modified versions of 389 | it) with contractual assumptions of liability to the recipient, for 390 | any liability that these contractual assumptions directly impose on 391 | those licensors and authors. 392 | 393 | All other non-permissive additional terms are considered "further 394 | restrictions" within the meaning of section 10. If the Program as you 395 | received it, or any part of it, contains a notice stating that it is 396 | governed by this License along with a term that is a further 397 | restriction, you may remove that term. If a license document contains 398 | a further restriction but permits relicensing or conveying under this 399 | License, you may add to a covered work material governed by the terms 400 | of that license document, provided that the further restriction does 401 | not survive such relicensing or conveying. 402 | 403 | If you add terms to a covered work in accord with this section, you 404 | must place, in the relevant source files, a statement of the 405 | additional terms that apply to those files, or a notice indicating 406 | where to find the applicable terms. 407 | 408 | Additional terms, permissive or non-permissive, may be stated in the 409 | form of a separately written license, or stated as exceptions; 410 | the above requirements apply either way. 411 | 412 | 8. Termination. 413 | 414 | You may not propagate or modify a covered work except as expressly 415 | provided under this License. Any attempt otherwise to propagate or 416 | modify it is void, and will automatically terminate your rights under 417 | this License (including any patent licenses granted under the third 418 | paragraph of section 11). 419 | 420 | However, if you cease all violation of this License, then your 421 | license from a particular copyright holder is reinstated (a) 422 | provisionally, unless and until the copyright holder explicitly and 423 | finally terminates your license, and (b) permanently, if the copyright 424 | holder fails to notify you of the violation by some reasonable means 425 | prior to 60 days after the cessation. 426 | 427 | Moreover, your license from a particular copyright holder is 428 | reinstated permanently if the copyright holder notifies you of the 429 | violation by some reasonable means, this is the first time you have 430 | received notice of violation of this License (for any work) from that 431 | copyright holder, and you cure the violation prior to 30 days after 432 | your receipt of the notice. 433 | 434 | Termination of your rights under this section does not terminate the 435 | licenses of parties who have received copies or rights from you under 436 | this License. If your rights have been terminated and not permanently 437 | reinstated, you do not qualify to receive new licenses for the same 438 | material under section 10. 439 | 440 | 9. Acceptance Not Required for Having Copies. 441 | 442 | You are not required to accept this License in order to receive or 443 | run a copy of the Program. Ancillary propagation of a covered work 444 | occurring solely as a consequence of using peer-to-peer transmission 445 | to receive a copy likewise does not require acceptance. However, 446 | nothing other than this License grants you permission to propagate or 447 | modify any covered work. These actions infringe copyright if you do 448 | not accept this License. Therefore, by modifying or propagating a 449 | covered work, you indicate your acceptance of this License to do so. 450 | 451 | 10. Automatic Licensing of Downstream Recipients. 452 | 453 | Each time you convey a covered work, the recipient automatically 454 | receives a license from the original licensors, to run, modify and 455 | propagate that work, subject to this License. You are not responsible 456 | for enforcing compliance by third parties with this License. 457 | 458 | An "entity transaction" is a transaction transferring control of an 459 | organization, or substantially all assets of one, or subdividing an 460 | organization, or merging organizations. If propagation of a covered 461 | work results from an entity transaction, each party to that 462 | transaction who receives a copy of the work also receives whatever 463 | licenses to the work the party's predecessor in interest had or could 464 | give under the previous paragraph, plus a right to possession of the 465 | Corresponding Source of the work from the predecessor in interest, if 466 | the predecessor has it or can get it with reasonable efforts. 467 | 468 | You may not impose any further restrictions on the exercise of the 469 | rights granted or affirmed under this License. For example, you may 470 | not impose a license fee, royalty, or other charge for exercise of 471 | rights granted under this License, and you may not initiate litigation 472 | (including a cross-claim or counterclaim in a lawsuit) alleging that 473 | any patent claim is infringed by making, using, selling, offering for 474 | sale, or importing the Program or any portion of it. 475 | 476 | 11. Patents. 477 | 478 | A "contributor" is a copyright holder who authorizes use under this 479 | License of the Program or a work on which the Program is based. The 480 | work thus licensed is called the contributor's "contributor version". 481 | 482 | A contributor's "essential patent claims" are all patent claims 483 | owned or controlled by the contributor, whether already acquired or 484 | hereafter acquired, that would be infringed by some manner, permitted 485 | by this License, of making, using, or selling its contributor version, 486 | but do not include claims that would be infringed only as a 487 | consequence of further modification of the contributor version. For 488 | purposes of this definition, "control" includes the right to grant 489 | patent sublicenses in a manner consistent with the requirements of 490 | this License. 491 | 492 | Each contributor grants you a non-exclusive, worldwide, royalty-free 493 | patent license under the contributor's essential patent claims, to 494 | make, use, sell, offer for sale, import and otherwise run, modify and 495 | propagate the contents of its contributor version. 496 | 497 | In the following three paragraphs, a "patent license" is any express 498 | agreement or commitment, however denominated, not to enforce a patent 499 | (such as an express permission to practice a patent or covenant not to 500 | sue for patent infringement). To "grant" such a patent license to a 501 | party means to make such an agreement or commitment not to enforce a 502 | patent against the party. 503 | 504 | If you convey a covered work, knowingly relying on a patent license, 505 | and the Corresponding Source of the work is not available for anyone 506 | to copy, free of charge and under the terms of this License, through a 507 | publicly available network server or other readily accessible means, 508 | then you must either (1) cause the Corresponding Source to be so 509 | available, or (2) arrange to deprive yourself of the benefit of the 510 | patent license for this particular work, or (3) arrange, in a manner 511 | consistent with the requirements of this License, to extend the patent 512 | license to downstream recipients. "Knowingly relying" means you have 513 | actual knowledge that, but for the patent license, your conveying the 514 | covered work in a country, or your recipient's use of the covered work 515 | in a country, would infringe one or more identifiable patents in that 516 | country that you have reason to believe are valid. 517 | 518 | If, pursuant to or in connection with a single transaction or 519 | arrangement, you convey, or propagate by procuring conveyance of, a 520 | covered work, and grant a patent license to some of the parties 521 | receiving the covered work authorizing them to use, propagate, modify 522 | or convey a specific copy of the covered work, then the patent license 523 | you grant is automatically extended to all recipients of the covered 524 | work and works based on it. 525 | 526 | A patent license is "discriminatory" if it does not include within 527 | the scope of its coverage, prohibits the exercise of, or is 528 | conditioned on the non-exercise of one or more of the rights that are 529 | specifically granted under this License. You may not convey a covered 530 | work if you are a party to an arrangement with a third party that is 531 | in the business of distributing software, under which you make payment 532 | to the third party based on the extent of your activity of conveying 533 | the work, and under which the third party grants, to any of the 534 | parties who would receive the covered work from you, a discriminatory 535 | patent license (a) in connection with copies of the covered work 536 | conveyed by you (or copies made from those copies), or (b) primarily 537 | for and in connection with specific products or compilations that 538 | contain the covered work, unless you entered into that arrangement, 539 | or that patent license was granted, prior to 28 March 2007. 540 | 541 | Nothing in this License shall be construed as excluding or limiting 542 | any implied license or other defenses to infringement that may 543 | otherwise be available to you under applicable patent law. 544 | 545 | 12. No Surrender of Others' Freedom. 546 | 547 | If conditions are imposed on you (whether by court order, agreement or 548 | otherwise) that contradict the conditions of this License, they do not 549 | excuse you from the conditions of this License. If you cannot convey a 550 | covered work so as to satisfy simultaneously your obligations under this 551 | License and any other pertinent obligations, then as a consequence you may 552 | not convey it at all. For example, if you agree to terms that obligate you 553 | to collect a royalty for further conveying from those to whom you convey 554 | the Program, the only way you could satisfy both those terms and this 555 | License would be to refrain entirely from conveying the Program. 556 | 557 | 13. Use with the GNU Affero General Public License. 558 | 559 | Notwithstanding any other provision of this License, you have 560 | permission to link or combine any covered work with a work licensed 561 | under version 3 of the GNU Affero General Public License into a single 562 | combined work, and to convey the resulting work. The terms of this 563 | License will continue to apply to the part which is the covered work, 564 | but the special requirements of the GNU Affero General Public License, 565 | section 13, concerning interaction through a network will apply to the 566 | combination as such. 567 | 568 | 14. Revised Versions of this License. 569 | 570 | The Free Software Foundation may publish revised and/or new versions of 571 | the GNU General Public License from time to time. Such new versions will 572 | be similar in spirit to the present version, but may differ in detail to 573 | address new problems or concerns. 574 | 575 | Each version is given a distinguishing version number. If the 576 | Program specifies that a certain numbered version of the GNU General 577 | Public License "or any later version" applies to it, you have the 578 | option of following the terms and conditions either of that numbered 579 | version or of any later version published by the Free Software 580 | Foundation. If the Program does not specify a version number of the 581 | GNU General Public License, you may choose any version ever published 582 | by the Free Software Foundation. 583 | 584 | If the Program specifies that a proxy can decide which future 585 | versions of the GNU General Public License can be used, that proxy's 586 | public statement of acceptance of a version permanently authorizes you 587 | to choose that version for the Program. 588 | 589 | Later license versions may give you additional or different 590 | permissions. However, no additional obligations are imposed on any 591 | author or copyright holder as a result of your choosing to follow a 592 | later version. 593 | 594 | 15. Disclaimer of Warranty. 595 | 596 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 597 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 598 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 599 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 600 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 601 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 602 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 603 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 604 | 605 | 16. Limitation of Liability. 606 | 607 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 608 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 609 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 610 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 611 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 612 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 613 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 614 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 615 | SUCH DAMAGES. 616 | 617 | 17. Interpretation of Sections 15 and 16. 618 | 619 | If the disclaimer of warranty and limitation of liability provided 620 | above cannot be given local legal effect according to their terms, 621 | reviewing courts shall apply local law that most closely approximates 622 | an absolute waiver of all civil liability in connection with the 623 | Program, unless a warranty or assumption of liability accompanies a 624 | copy of the Program in return for a fee. 625 | 626 | END OF TERMS AND CONDITIONS 627 | 628 | How to Apply These Terms to Your New Programs 629 | 630 | If you develop a new program, and you want it to be of the greatest 631 | possible use to the public, the best way to achieve this is to make it 632 | free software which everyone can redistribute and change under these terms. 633 | 634 | To do so, attach the following notices to the program. It is safest 635 | to attach them to the start of each source file to most effectively 636 | state the exclusion of warranty; and each file should have at least 637 | the "copyright" line and a pointer to where the full notice is found. 638 | 639 | 640 | Copyright (C) 641 | 642 | This program is free software: you can redistribute it and/or modify 643 | it under the terms of the GNU General Public License as published by 644 | the Free Software Foundation, either version 3 of the License, or 645 | (at your option) any later version. 646 | 647 | This program is distributed in the hope that it will be useful, 648 | but WITHOUT ANY WARRANTY; without even the implied warranty of 649 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 650 | GNU General Public License for more details. 651 | 652 | You should have received a copy of the GNU General Public License 653 | along with this program. If not, see . 654 | 655 | Also add information on how to contact you by electronic and paper mail. 656 | 657 | If the program does terminal interaction, make it output a short 658 | notice like this when it starts in an interactive mode: 659 | 660 | Copyright (C) 661 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 662 | This is free software, and you are welcome to redistribute it 663 | under certain conditions; type `show c' for details. 664 | 665 | The hypothetical commands `show w' and `show c' should show the appropriate 666 | parts of the General Public License. Of course, your program's commands 667 | might be different; for a GUI interface, you would use an "about box". 668 | 669 | You should also get your employer (if you work as a programmer) or school, 670 | if any, to sign a "copyright disclaimer" for the program, if necessary. 671 | For more information on this, and how to apply and follow the GNU GPL, see 672 | . 673 | 674 | The GNU General Public License does not permit incorporating your program 675 | into proprietary programs. If your program is a subroutine library, you 676 | may consider it more useful to permit linking proprietary applications with 677 | the library. If this is what you want to do, use the GNU Lesser General 678 | Public License instead of this License. But first, please read 679 | . 680 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md LICENSE -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ---------------------------------------- 2 | [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)] 3 | --------------------------- 4 | 5 | 6 | # Elastic Search Query Generator 7 | 8 | #### what is Elastic Search Query Generator ? 9 | * While i was working with Elastic Search i found it very difficult to write complex queries as most of query are deep Nested 10 | * Thats the reason i decided to make a helper class that can generate complex Elastic Search query in Seconds 11 | * Library can be used to generate complex aggregation Query , Geo location Query (AND | OR | NOT ) any set of combination is possible 12 | * in addition to all mentioned above you can also generate auto complete query in matter of seconds 13 | * please see examples below on how to use this module. 14 | * if you have any questions or suggestion please drop me an email at shahsoumil519@gmail.com 15 | 16 | 17 | * Learn More : https://www.youtube.com/watch?v=C-JKcMM6IXE&t=2548s 18 | 19 | ## documentation : 20 | * UML Diagram 21 | 22 | 23 | ![Capture](https://user-images.githubusercontent.com/39345855/96332462-17e19100-1032-11eb-930e-8deb98f94675.JPG) 24 | 25 | * Constructor: 26 | * Size: How Many Documents should the Query Return 27 | * BucketName: is optional pass a name for Aggregation 28 | * Source: Basically what fields you want to return takes a List Argument source= [“f1”, “f2”, …..] 29 | * Min_score: used for filtering large documents average threshold is set to 0.5 30 | 31 | * Field: 32 | * This is column or field you would like to search 33 | 34 | * Boost: 35 | * If you want to Boost certain field pass a integer value 36 | 37 | 38 | * Operation 39 | * There are four main operation you can pass 40 | * Should ( OR Operation) 41 | * Must (AND operation) 42 | * Filter (FILTER Result ) 43 | * Must_not (NOT Operation ) 44 | * Analyzer: 45 | * you can specify various analyzer such as stop etc 46 | 47 | ## Installation 48 | 49 | ```bash 50 | pip install elasticsearchquerygenerator 51 | ``` 52 | ## Usage 53 | 54 | 55 | ```python 56 | from elasticsearchquerygenerator.elasticsearchquerygenerator import ElasticSearchQuery 57 | import json 58 | 59 | def main(): 60 | helper = ElasticSearchQuery(size=100, BucketName="MyBuckets") 61 | 62 | # match phrase 63 | query=helper.match_phrase(field="myfeild", value="myvalue", operation='must') 64 | 65 | # terms 66 | query=helper.terms(field="myfeild", value="myvalue", operation='must') 67 | 68 | # Feild Exists 69 | query = helper.exists(field='comp feild', operation="must") 70 | 71 | #Match 72 | query=helper.match(field="MMMMM", value="myvalue", operation='must') 73 | 74 | # Geo Queires 75 | query = helper.add_geoqueries(radius="100", lat="22", lon="33") 76 | 77 | # Aggreation 78 | helper.add_aggreation(aggregate_name="FirstName", field="field1",type='terms',sort='desc', size=3) 79 | helper.add_aggreation(aggregate_name="SecondName", field="field2",type='terms',sort='desc', size=3) 80 | helper.add_aggreation(aggregate_name="ThirdName", field="field3",type='terms',sort='desc', size=3) 81 | query = helper.complete_aggreation() 82 | query = helper.query_string(default_field="DEFAULT",query="X OR Y",operation='must') 83 | 84 | query = helper.add_geo_aggreation(field="AAAA", lat="22", lon="43",aggregate_name="my_distance") 85 | 86 | print(json.dumps(query, indent=3)) 87 | 88 | 89 | if __name__ == "__main__": 90 | main() 91 | 92 | 93 | ``` 94 | ```json 95 | { 96 | "_source": [], 97 | "size": 100, 98 | "min_score": 0.5, 99 | "query": { 100 | "bool": { 101 | "must": [ 102 | { 103 | "match_phrase": { 104 | "myfeild": { 105 | "query": "myvalue" 106 | } 107 | } 108 | }, 109 | { 110 | "match_phrase": { 111 | "myfeild": { 112 | "query": "myvalue" 113 | } 114 | } 115 | }, 116 | { 117 | "term": { 118 | "myfeild": "myvalue" 119 | } 120 | }, 121 | { 122 | "exists": { 123 | "field": "comp feild" 124 | } 125 | }, 126 | { 127 | "match": { 128 | "MMMMM": { 129 | "query": "myvalue" 130 | } 131 | } 132 | }, 133 | { 134 | "match": { 135 | "MMMMM": { 136 | "query": "myvalue" 137 | } 138 | } 139 | }, 140 | { 141 | "query_string": { 142 | "default_field": "DEFAULT", 143 | "query": "X OR Y" 144 | } 145 | } 146 | ], 147 | "filter": [ 148 | { 149 | "geo_distance": { 150 | "distance": "100mi", 151 | "null": { 152 | "lat": "22", 153 | "lon": "33" 154 | } 155 | } 156 | } 157 | ], 158 | "should": [], 159 | "must_not": [] 160 | } 161 | }, 162 | "aggs": { 163 | "FirstName": { 164 | "terms": { 165 | "field": "field1", 166 | "order": { 167 | "_count": "desc" 168 | }, 169 | "size": 3 170 | } 171 | }, 172 | "SecondName": { 173 | "terms": { 174 | "field": "field2", 175 | "order": { 176 | "_count": "desc" 177 | }, 178 | "size": 3 179 | } 180 | }, 181 | "ThirdName": { 182 | "terms": { 183 | "field": "field3", 184 | "order": { 185 | "_count": "desc" 186 | }, 187 | "size": 3 188 | } 189 | }, 190 | "my_distance": { 191 | "geo_distance": { 192 | "field": "AAAA", 193 | "origin": "22,43", 194 | "unit": "mi", 195 | "ranges": [ 196 | { 197 | "to": 0 198 | }, 199 | { 200 | "from": 0, 201 | "to": 25 202 | }, 203 | { 204 | "from": 25, 205 | "to": 50 206 | }, 207 | { 208 | "from": 50, 209 | "to": 75 210 | }, 211 | { 212 | "from": 75, 213 | "to": 100 214 | }, 215 | { 216 | "from": 100 217 | } 218 | ] 219 | } 220 | } 221 | } 222 | } 223 | 224 | ``` 225 | 226 | 227 | ### Example 2 228 | 229 | ```python 230 | from elasticsearchquerygenerator.elasticsearchquerygenerator import ElasticSearchQuery 231 | import json 232 | 233 | def autocomplete(): 234 | helper = ElasticSearchQuery(size=0, BucketName="MyBuckets") 235 | query = helper.autocomplete_1(field="title",value="n", size=25,sort='desc') 236 | print(json.dumps(query, indent=3)) 237 | 238 | 239 | if __name__ == "__main__": 240 | main(autocomplete 241 | 242 | ``` 243 | ```json 244 | { 245 | "_source": [], 246 | "size": 0, 247 | "min_score": 0.5, 248 | "query": { 249 | "bool": { 250 | "must": [ 251 | { 252 | "match_phrase_prefix": { 253 | "title": { 254 | "query": "n" 255 | } 256 | } 257 | } 258 | ], 259 | "filter": [], 260 | "should": [], 261 | "must_not": [] 262 | } 263 | }, 264 | "aggs": { 265 | "auto_complete": { 266 | "terms": { 267 | "field": "title", 268 | "order": { 269 | "_count": "desc" 270 | }, 271 | "size": 25 272 | } 273 | } 274 | } 275 | } 276 | ``` 277 | 278 | 279 | ##### i would be adding more examples and making it better and better 280 | 281 | ## Authors 282 | 283 | ## Soumil Nitin Shah 284 | 285 | * Excellent experience of building scalable and high-performance Software Applications combining distinctive skill sets in Internet of Things (IoT), Machine Learning and Full Stack Web Development in Python. 286 | 287 | Bachelor in Electronic Engineering | 288 | Masters in Electrical Engineering | 289 | Master in Computer Engineering | 290 | 291 | * Website : https://soumilshah.herokuapp.com 292 | * Github: https://github.com/soumilshah1995 293 | * Linkedin: https://www.linkedin.com/in/shah-soumil/ 294 | * Blog: https://soumilshah1995.blogspot.com/ 295 | * Youtube : https://www.youtube.com/channel/UC_eOodxvwS_H7x2uLQa-svw?view_as=subscriber 296 | * Facebook Page : https://www.facebook.com/soumilshah1995/ 297 | * Email : shahsoumil519@gmail.com 298 | 299 | 300 | [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.me/soumilshah1995) 301 | 302 | ## License 303 | 304 | This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details 305 | 306 | 307 | -------------------------------------------------------------------------------- /build/lib/elasticsearchquerygenerator/elasticsearchquerygenerator.py: -------------------------------------------------------------------------------- 1 | __AUTHOR__ = "Soumil Nitin Shah" 2 | __EMAIL__ = "shahsoumil519@gmail.com" 3 | 4 | 5 | try: 6 | import os 7 | import sys 8 | import json 9 | print("Import : {} OK ".format(__file__)) 10 | except Exception as e: 11 | print("Some modules are missing {} ".format(e)) 12 | 13 | 14 | class ElasticSearchQuery(object): 15 | 16 | def __init__(self, size=10, BucketName=None, source=[], min_score=0.5): 17 | 18 | """Constructor """ 19 | 20 | self.size = size 21 | self.BucketName = BucketName 22 | self.min_score = min_score 23 | self.source = source 24 | self.baseQuery = { 25 | "_source":source, 26 | "size":self.size, 27 | "min_score": self.min_score, 28 | "query": { 29 | "bool": { 30 | "must": [], 31 | "filter": [], 32 | "should": [], 33 | "must_not": [] 34 | } 35 | } 36 | } 37 | self.GeoBaseQuery = { 38 | "_source":self.source, 39 | "size":self.size, 40 | "query": { 41 | "bool" : { 42 | "must":{ "match_all":{}}, 43 | "should":[], 44 | "filter": {} 45 | } 46 | } 47 | } 48 | self.aggtem = [] 49 | self.base_higghlight = { 50 | "pre_tags":[ 51 | "" 52 | ], 53 | "post_tags":[ 54 | "" 55 | ], 56 | "tags_schema":"styled", 57 | "fields":{ 58 | 59 | } 60 | } 61 | 62 | def match(self,field=None, value=None, boost=None, operation='should',analyzer=None): 63 | 64 | _ = { 65 | "match": { 66 | field: { 67 | "query": value 68 | } 69 | } 70 | } 71 | if boost is None: 72 | self.baseQuery["query"]["bool"][operation].append(_) 73 | 74 | if boost is not None: 75 | _["match"][field]["boost"] = boost 76 | 77 | if analyzer is not None: 78 | _["match"][field]["analyzer"] = analyzer 79 | 80 | self.baseQuery["query"]["bool"][operation].append(_) 81 | 82 | return self.baseQuery 83 | 84 | def match_phrase(self, field=None, value=None, boost=None, operation='should',analyzer=None): 85 | _ = { 86 | "match_phrase": { 87 | field: { 88 | "query": value 89 | } 90 | } 91 | } 92 | 93 | if boost is None: 94 | self.baseQuery["query"]["bool"][operation].append(_) 95 | 96 | if boost is not None: 97 | _["match_phrase"][field]["boost"] = boost 98 | 99 | if analyzer is not None: 100 | _["match_phrase"][field]["analyzer"] = analyzer 101 | 102 | self.baseQuery["query"]["bool"][operation].append(_) 103 | 104 | return self.baseQuery 105 | 106 | def terms(self,field=None, value=None, boost=None, operation='should'): 107 | 108 | _ = {"term" :{ 109 | field : value 110 | } 111 | } 112 | self.baseQuery["query"]["bool"][operation].append(_) 113 | 114 | def add_aggreation(self, aggregate_name=None, 115 | field=None, 116 | type='terms', 117 | sort='desc', 118 | size = 10): 119 | 120 | _ = { 121 | aggregate_name:{ 122 | type: { 123 | "field": field, 124 | "order" : 125 | {"_count" : 126 | sort 127 | }, 128 | "size": size 129 | 130 | } 131 | } 132 | } 133 | self.aggtem.append(_) 134 | 135 | def complete_aggreation(self): 136 | _ = { 137 | "aggs":{ 138 | 139 | } 140 | } 141 | for item in self.aggtem: 142 | for key,value in item.items(): 143 | _["aggs"][key] = value 144 | self.baseQuery["aggs"] = _["aggs"] 145 | return self.baseQuery 146 | 147 | def add_geoqueries(self, radius=None, lat=None, lon=None, field=None, operation='filter'): 148 | radius = str(radius) + "mi" 149 | _ = { 150 | "geo_distance" : { 151 | "distance": radius, 152 | field : { 153 | "lat": lat, 154 | "lon": lon 155 | } 156 | }} 157 | self.baseQuery["query"]["bool"][operation].append(_) 158 | return self.baseQuery 159 | 160 | def wildcard(self,field=None, value=None, boost=None, operation=None): 161 | _ = { 162 | "wildcard":{ 163 | field:{ 164 | "value":value 165 | 166 | } 167 | } 168 | } 169 | if boost is None: 170 | self.baseQuery["query"]["bool"][operation].append(_) 171 | return self.baseQuery 172 | else: 173 | _["wildcard"][field]["boost"] = boost 174 | self.baseQuery["query"]["bool"][operation].append(_) 175 | return self.baseQuery 176 | 177 | def exists(self,field=None, operation="must"): 178 | 179 | _ = { 180 | "exists": { 181 | "field": field 182 | } 183 | } 184 | self.baseQuery["query"]["bool"][operation].append(_) 185 | return self.baseQuery 186 | 187 | def query_string(self, default_field=None, query=None, operation="should"): 188 | _ = { 189 | "query_string":{ 190 | "default_field": default_field, 191 | "query":"{}".format(query) 192 | } 193 | } 194 | self.baseQuery["query"]["bool"][operation].append(_) 195 | return self.baseQuery 196 | 197 | def add_geo_aggreation(self, field=None,lat=None, lon=None, aggregate_name='distance'): 198 | self.baseQuery.get("aggs")[aggregate_name] = { 199 | "geo_distance" : { 200 | "field" : field, 201 | "origin" : "{},{}".format(lat, lon), 202 | "unit" : "mi", 203 | "ranges" : [ 204 | { "to" : 0 }, 205 | { "from" : 0, "to" : 25 }, 206 | { "from" : 25, "to" : 50 }, 207 | { "from" : 50, "to" : 75 }, 208 | { "from" : 75, "to" : 100 }, 209 | { "from" : 100 } 210 | ] 211 | }} 212 | return self.baseQuery 213 | 214 | def match_phrase_prefix(self, field=None, value=None, boost=None, operation='should',analyzer=None): 215 | _ = { 216 | "match_phrase_prefix": { 217 | field: { 218 | "query": value 219 | } 220 | } 221 | } 222 | 223 | if boost is not None: 224 | _["match_phrase_prefix"][field]["boost"] = boost 225 | if analyzer is not None: 226 | _["match_phrase_prefix"][field]["analyzer"] = analyzer 227 | self.baseQuery["query"]["bool"][operation].append(_) 228 | return self.baseQuery 229 | 230 | def autocomplete_1(self, field=None,size=25, value=None, sort='des', operation='must'): 231 | query = self.match_phrase_prefix(field=field,value=value, operation=operation) 232 | query =self.add_aggreation(field=field, size=size, sort=sort,aggregate_name='auto_complete' ) 233 | query = self.complete_aggreation() 234 | return query 235 | 236 | -------------------------------------------------------------------------------- /dist/elasticsearchquerygenerator-1.0.0-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/soumilshah1995/elasticsearchquerygenerator/d68550c69f6bea99d5ed88a5bfb1772354ce6ecf/dist/elasticsearchquerygenerator-1.0.0-py3-none-any.whl -------------------------------------------------------------------------------- /dist/elasticsearchquerygenerator-1.1.0-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/soumilshah1995/elasticsearchquerygenerator/d68550c69f6bea99d5ed88a5bfb1772354ce6ecf/dist/elasticsearchquerygenerator-1.1.0-py3-none-any.whl -------------------------------------------------------------------------------- /elasticsearchquerygenerator.egg-info/PKG-INFO: -------------------------------------------------------------------------------- 1 | Metadata-Version: 2.1 2 | Name: elasticsearchquerygenerator 3 | Version: 1.1.0 4 | Summary: 5 | Create Complex Elastic Search Query in Seconds 6 | Please see documentation for more details 7 | 8 | Home-page: https://github.com/soumilshah1995/elasticsearchquerygenerator.git 9 | Author: Soumil Nitin Shah 10 | Author-email: soushah@my.bridgeport.edu 11 | License: MIT 12 | Description: ---------------------------------------- 13 | [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)] 14 | --------------------------- 15 | 16 | 17 | # Elastic Search Query Generator 18 | 19 | #### what is Elastic Search Query Generator ? 20 | * While i was working with Elastic Search i found it very difficult to write complex queries as most of query are deep Nested 21 | * Thats the reason i decided to make a helper class that can generate complex Elastic Search query in Seconds 22 | * Library can be used to generate complex aggregation Query , Geo location Query (AND | OR | NOT ) any set of combination is possible 23 | * in addition to all mentioned above you can also generate auto complete query in matter of seconds 24 | * please see examples below on how to use this module. 25 | * if you have any questions or suggestion please drop me an email at shahsoumil519@gmail.com 26 | 27 | 28 | 29 | 30 | ## Installation 31 | 32 | ```bash 33 | pip install elasticsearchquerygenerator 34 | ``` 35 | ## Usage 36 | 37 | 38 | ```python 39 | from elasticsearchquerygenerator.elasticsearchquerygenerator import ElasticSearchQuery 40 | import json 41 | 42 | def main(): 43 | helper = ElasticSearchQuery(size=100, BucketName="MyBuckets") 44 | 45 | # match phrase 46 | query=helper.match_phrase(field="myfeild", value="myvalue", operation='must') 47 | 48 | # terms 49 | query=helper.terms(field="myfeild", value="myvalue", operation='must') 50 | 51 | # Feild Exists 52 | query = helper.exists(field='comp feild', operation="must") 53 | 54 | #Match 55 | query=helper.match(field="MMMMM", value="myvalue", operation='must') 56 | 57 | # Geo Queires 58 | query = helper.add_geoqueries(radius="100", lat="22", lon="33") 59 | 60 | # Aggreation 61 | helper.add_aggreation(aggregate_name="FirstName", field="field1",type='terms',sort='desc', size=3) 62 | helper.add_aggreation(aggregate_name="SecondName", field="field2",type='terms',sort='desc', size=3) 63 | helper.add_aggreation(aggregate_name="ThirdName", field="field3",type='terms',sort='desc', size=3) 64 | query = helper.complete_aggreation() 65 | query = helper.query_string(default_field="DEFAULT",query="X OR Y",operation='must') 66 | 67 | query = helper.add_geo_aggreation(field="AAAA", lat="22", lon="43",aggregate_name="my_distance") 68 | 69 | print(json.dumps(query, indent=3)) 70 | 71 | 72 | if __name__ == "__main__": 73 | main() 74 | 75 | 76 | ``` 77 | ```json 78 | { 79 | "_source": [], 80 | "size": 100, 81 | "min_score": 0.5, 82 | "query": { 83 | "bool": { 84 | "must": [ 85 | { 86 | "match_phrase": { 87 | "myfeild": { 88 | "query": "myvalue" 89 | } 90 | } 91 | }, 92 | { 93 | "match_phrase": { 94 | "myfeild": { 95 | "query": "myvalue" 96 | } 97 | } 98 | }, 99 | { 100 | "term": { 101 | "myfeild": "myvalue" 102 | } 103 | }, 104 | { 105 | "exists": { 106 | "field": "comp feild" 107 | } 108 | }, 109 | { 110 | "match": { 111 | "MMMMM": { 112 | "query": "myvalue" 113 | } 114 | } 115 | }, 116 | { 117 | "match": { 118 | "MMMMM": { 119 | "query": "myvalue" 120 | } 121 | } 122 | }, 123 | { 124 | "query_string": { 125 | "default_field": "DEFAULT", 126 | "query": "X OR Y" 127 | } 128 | } 129 | ], 130 | "filter": [ 131 | { 132 | "geo_distance": { 133 | "distance": "100mi", 134 | "null": { 135 | "lat": "22", 136 | "lon": "33" 137 | } 138 | } 139 | } 140 | ], 141 | "should": [], 142 | "must_not": [] 143 | } 144 | }, 145 | "aggs": { 146 | "FirstName": { 147 | "terms": { 148 | "field": "field1", 149 | "order": { 150 | "_count": "desc" 151 | }, 152 | "size": 3 153 | } 154 | }, 155 | "SecondName": { 156 | "terms": { 157 | "field": "field2", 158 | "order": { 159 | "_count": "desc" 160 | }, 161 | "size": 3 162 | } 163 | }, 164 | "ThirdName": { 165 | "terms": { 166 | "field": "field3", 167 | "order": { 168 | "_count": "desc" 169 | }, 170 | "size": 3 171 | } 172 | }, 173 | "my_distance": { 174 | "geo_distance": { 175 | "field": "AAAA", 176 | "origin": "22,43", 177 | "unit": "mi", 178 | "ranges": [ 179 | { 180 | "to": 0 181 | }, 182 | { 183 | "from": 0, 184 | "to": 25 185 | }, 186 | { 187 | "from": 25, 188 | "to": 50 189 | }, 190 | { 191 | "from": 50, 192 | "to": 75 193 | }, 194 | { 195 | "from": 75, 196 | "to": 100 197 | }, 198 | { 199 | "from": 100 200 | } 201 | ] 202 | } 203 | } 204 | } 205 | } 206 | 207 | ``` 208 | 209 | 210 | ### Example 2 211 | 212 | ```python 213 | from elasticsearchquerygenerator.elasticsearchquerygenerator import ElasticSearchQuery 214 | import json 215 | 216 | def autocomplete(): 217 | helper = ElasticSearchQuery(size=0, BucketName="MyBuckets") 218 | query = helper.autocomplete_1(field="title",value="n", size=25,sort='desc') 219 | print(json.dumps(query, indent=3)) 220 | 221 | 222 | if __name__ == "__main__": 223 | main(autocomplete 224 | 225 | ``` 226 | 227 | ##### i would be adding more examples and making it better and better 228 | 229 | ## Authors 230 | 231 | ## Soumil Nitin Shah 232 | 233 | * Excellent experience of building scalable and high-performance Software Applications combining distinctive skill sets in Internet of Things (IoT), Machine Learning and Full Stack Web Development in Python. 234 | 235 | Bachelor in Electronic Engineering | 236 | Masters in Electrical Engineering | 237 | Master in Computer Engineering | 238 | 239 | * Website : https://soumilshah.herokuapp.com 240 | * Github: https://github.com/soumilshah1995 241 | * Linkedin: https://www.linkedin.com/in/shah-soumil/ 242 | * Blog: https://soumilshah1995.blogspot.com/ 243 | * Youtube : https://www.youtube.com/channel/UC_eOodxvwS_H7x2uLQa-svw?view_as=subscriber 244 | * Facebook Page : https://www.facebook.com/soumilshah1995/ 245 | * Email : shahsoumil519@gmail.com 246 | 247 | 248 | [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.me/soumilshah1995) 249 | 250 | ## License 251 | 252 | This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details 253 | 254 | 255 | 256 | Platform: UNKNOWN 257 | Classifier: License :: OSI Approved :: MIT License 258 | Classifier: Programming Language :: Python :: 3 259 | Classifier: Programming Language :: Python :: 3.7 260 | Description-Content-Type: text/markdown 261 | -------------------------------------------------------------------------------- /elasticsearchquerygenerator.egg-info/SOURCES.txt: -------------------------------------------------------------------------------- 1 | LICENSE 2 | MANIFEST.in 3 | README.md 4 | setup.py 5 | elasticsearchquerygenerator/elasticsearchquerygenerator.py 6 | elasticsearchquerygenerator.egg-info/PKG-INFO 7 | elasticsearchquerygenerator.egg-info/SOURCES.txt 8 | elasticsearchquerygenerator.egg-info/dependency_links.txt 9 | elasticsearchquerygenerator.egg-info/top_level.txt -------------------------------------------------------------------------------- /elasticsearchquerygenerator.egg-info/dependency_links.txt: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /elasticsearchquerygenerator.egg-info/top_level.txt: -------------------------------------------------------------------------------- 1 | elasticsearchquerygenerator 2 | -------------------------------------------------------------------------------- /elasticsearchquerygenerator/elasticsearchquerygenerator.py: -------------------------------------------------------------------------------- 1 | __AUTHOR__ = "Soumil Nitin Shah" 2 | __EMAIL__ = "shahsoumil519@gmail.com" 3 | 4 | 5 | try: 6 | import os 7 | import sys 8 | import json 9 | print("Import : {} OK ".format(__file__)) 10 | except Exception as e: 11 | print("Some modules are missing {} ".format(e)) 12 | 13 | 14 | class ElasticSearchQuery(object): 15 | 16 | def __init__(self, size=10, BucketName=None, source=[], min_score=0.5): 17 | 18 | """Constructor """ 19 | 20 | self.size = size 21 | self.BucketName = BucketName 22 | self.min_score = min_score 23 | self.source = source 24 | self.baseQuery = { 25 | "_source":source, 26 | "size":self.size, 27 | "min_score": self.min_score, 28 | "query": { 29 | "bool": { 30 | "must": [], 31 | "filter": [], 32 | "should": [], 33 | "must_not": [] 34 | } 35 | } 36 | } 37 | self.GeoBaseQuery = { 38 | "_source":self.source, 39 | "size":self.size, 40 | "query": { 41 | "bool" : { 42 | "must":{ "match_all":{}}, 43 | "should":[], 44 | "filter": {} 45 | } 46 | } 47 | } 48 | self.aggtem = [] 49 | self.base_higghlight = { 50 | "pre_tags":[ 51 | "" 52 | ], 53 | "post_tags":[ 54 | "" 55 | ], 56 | "tags_schema":"styled", 57 | "fields":{ 58 | 59 | } 60 | } 61 | 62 | def match(self,field=None, value=None, boost=None, operation='should',analyzer=None): 63 | 64 | _ = { 65 | "match": { 66 | field: { 67 | "query": value 68 | } 69 | } 70 | } 71 | if boost is None: 72 | self.baseQuery["query"]["bool"][operation].append(_) 73 | 74 | if boost is not None: 75 | _["match"][field]["boost"] = boost 76 | 77 | if analyzer is not None: 78 | _["match"][field]["analyzer"] = analyzer 79 | 80 | #self.baseQuery["query"]["bool"][operation].append(_) 81 | 82 | return self.baseQuery 83 | 84 | def match_phrase(self, field=None, value=None, boost=None, operation='should',analyzer=None): 85 | _ = { 86 | "match_phrase": { 87 | field: { 88 | "query": value 89 | } 90 | } 91 | } 92 | 93 | if boost is None: 94 | self.baseQuery["query"]["bool"][operation].append(_) 95 | 96 | if boost is not None: 97 | _["match_phrase"][field]["boost"] = boost 98 | 99 | if analyzer is not None: 100 | _["match_phrase"][field]["analyzer"] = analyzer 101 | 102 | #self.baseQuery["query"]["bool"][operation].append(_) 103 | 104 | return self.baseQuery 105 | 106 | def terms(self,field=None, value=None, boost=None, operation='should'): 107 | 108 | _ = {"term" :{ 109 | field : value 110 | } 111 | } 112 | self.baseQuery["query"]["bool"][operation].append(_) 113 | return self.baseQuery 114 | 115 | def add_aggreation(self, aggregate_name=None, 116 | field=None, 117 | type='terms', 118 | sort='desc', 119 | size = 10): 120 | 121 | _ = { 122 | aggregate_name:{ 123 | type: { 124 | "field": field, 125 | "order" : 126 | {"_count" : 127 | sort 128 | }, 129 | "size": size 130 | 131 | } 132 | } 133 | } 134 | self.aggtem.append(_) 135 | 136 | def complete_aggreation(self): 137 | _ = { 138 | "aggs":{ 139 | 140 | } 141 | } 142 | for item in self.aggtem: 143 | for key,value in item.items(): 144 | _["aggs"][key] = value 145 | self.baseQuery["aggs"] = _["aggs"] 146 | return self.baseQuery 147 | 148 | def add_geoqueries(self, radius=None, lat=None, lon=None, field=None, operation='filter'): 149 | radius = str(radius) + "mi" 150 | _ = { 151 | "geo_distance" : { 152 | "distance": radius, 153 | field : { 154 | "lat": lat, 155 | "lon": lon 156 | } 157 | }} 158 | self.baseQuery["query"]["bool"][operation].append(_) 159 | return self.baseQuery 160 | 161 | def wildcard(self,field=None, value=None, boost=None, operation=None): 162 | _ = { 163 | "wildcard":{ 164 | field:{ 165 | "value":value 166 | 167 | } 168 | } 169 | } 170 | if boost is None: 171 | self.baseQuery["query"]["bool"][operation].append(_) 172 | return self.baseQuery 173 | else: 174 | _["wildcard"][field]["boost"] = boost 175 | self.baseQuery["query"]["bool"][operation].append(_) 176 | return self.baseQuery 177 | 178 | def exists(self,field=None, operation="must"): 179 | 180 | _ = { 181 | "exists": { 182 | "field": field 183 | } 184 | } 185 | self.baseQuery["query"]["bool"][operation].append(_) 186 | return self.baseQuery 187 | 188 | def query_string(self, default_field=None, query=None, operation="should"): 189 | _ = { 190 | "query_string":{ 191 | "default_field": default_field, 192 | "query":"{}".format(query) 193 | } 194 | } 195 | self.baseQuery["query"]["bool"][operation].append(_) 196 | return self.baseQuery 197 | 198 | def add_geo_aggreation(self, field=None,lat=None, lon=None, aggregate_name='distance'): 199 | self.baseQuery.get("aggs")[aggregate_name] = { 200 | "geo_distance" : { 201 | "field" : field, 202 | "origin" : "{},{}".format(lat, lon), 203 | "unit" : "mi", 204 | "ranges" : [ 205 | { "to" : 0 }, 206 | { "from" : 0, "to" : 25 }, 207 | { "from" : 25, "to" : 50 }, 208 | { "from" : 50, "to" : 75 }, 209 | { "from" : 75, "to" : 100 }, 210 | { "from" : 100 } 211 | ] 212 | }} 213 | return self.baseQuery 214 | 215 | def match_phrase_prefix(self, field=None, value=None, boost=None, operation='should',analyzer=None): 216 | _ = { 217 | "match_phrase_prefix": { 218 | field: { 219 | "query": value 220 | } 221 | } 222 | } 223 | 224 | if boost is not None: 225 | _["match_phrase_prefix"][field]["boost"] = boost 226 | if analyzer is not None: 227 | _["match_phrase_prefix"][field]["analyzer"] = analyzer 228 | self.baseQuery["query"]["bool"][operation].append(_) 229 | return self.baseQuery 230 | 231 | def autocomplete_1(self, field=None,size=25, value=None, sort='des', operation='must'): 232 | query = self.match_phrase_prefix(field=field,value=value, operation=operation) 233 | query =self.add_aggreation(field=field, size=size, sort=sort,aggregate_name='auto_complete' ) 234 | query = self.complete_aggreation() 235 | return query 236 | 237 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | 4 | def readme(): 5 | with open('README.md') as f: 6 | README = f.read() 7 | return README 8 | 9 | 10 | setup( 11 | name="elasticsearchquerygenerator", 12 | version="1.1.0", 13 | description=""" 14 | Create Complex Elastic Search Query in Seconds 15 | Please see documentation for more details 16 | """, 17 | long_description=readme(), 18 | long_description_content_type="text/markdown", 19 | url="https://github.com/soumilshah1995/elasticsearchquerygenerator.git", 20 | author="Soumil Nitin Shah", 21 | author_email="soushah@my.bridgeport.edu", 22 | license="MIT", 23 | classifiers=[ 24 | "License :: OSI Approved :: MIT License", 25 | "Programming Language :: Python :: 3", 26 | "Programming Language :: Python :: 3.7", 27 | ], 28 | packages=["elasticsearchquerygenerator"], 29 | include_package_data=True, 30 | install_requires=[] 31 | ) --------------------------------------------------------------------------------