Foundatio.Parsers.ElasticQueries 7.17.9

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Foundatio.Parsers.ElasticQueries --version 7.17.9                
NuGet\Install-Package Foundatio.Parsers.ElasticQueries -Version 7.17.9                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Foundatio.Parsers.ElasticQueries" Version="7.17.9" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Foundatio.Parsers.ElasticQueries --version 7.17.9                
#r "nuget: Foundatio.Parsers.ElasticQueries, 7.17.9"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Foundatio.Parsers.ElasticQueries as a Cake Addin
#addin nuget:?package=Foundatio.Parsers.ElasticQueries&version=7.17.9

// Install Foundatio.Parsers.ElasticQueries as a Cake Tool
#tool nuget:?package=Foundatio.Parsers.ElasticQueries&version=7.17.9                

FoundatioFoundatio

Build status NuGet Version feedz.io Discord

A lucene style query parser that is extensible and allows additional syntax features. Also includes an Elasticsearch query_string query replacement that greatly enhances its capabilities for dynamic queries.

Getting Started (Development)

This package can be installed via the NuGet package manager. If you need help, please contact us via in-app support or open an issue. We’re always here to help if you have any questions!

  1. You will need to have Visual Studio Code installed.
  2. Open the Foundatio.Parsers.sln Visual Studio solution file.

Using LuceneQueryParser

Below is a small sampling of the things you can accomplish with LuceneQueryParser, so check it out! We use this library extensively in Exceptionless!

In the sample below we will parse a query and output it's structure using the DebugQueryVisitor and then generate the same exact query using the parse result.

using Foundatio.Parsers.LuceneQueries;
using Foundatio.Parsers.LuceneQueries.Visitors;

var parser = new LuceneQueryParser();
var result = parser.Parse("field:[1 TO 2]");
Debug.WriteLine(DebugQueryVisitor.Run(result));

Here is the parse result as shown from the DebugQueryVisitor

Group:
  Left - Term:
      TermMax: 2
      TermMin: 1
      MinInclusive: True
      MaxInclusive: True
      Field:
          Name: field

Finally, lets translate the parse result back into the original query.

var generatedQuery = GenerateQueryVisitor.Run(result);
System.Diagnostics.Debug.Assert(query == generatedQuery);

Query Syntax

Aggregation Syntax

Features

  • Lucene Query Syntax Parser
  • Field Aliases (static and dynamic)
  • Query Includes
    • Define stored queries that can be included inside other queries as macros that will be expanded
  • Validation
    • Validate query syntax
    • Restrict access to specific fields
    • Restrict the number of operations allowed
    • Restrict nesting depth
  • Elasticsearch
    • Elastic query string query replacement on steriods
    • Dynamic search and filter expressions
    • Dynamic aggregation expressions
      • Supported bucket aggregations: terms, geo grid, date histogram, numeric histogram
        • Bucket aggregations allow nesting other dynamic aggregations inside
      • Supported metric aggregations: min, max, avg, sum, stats, extended stats, cardinality, missing, percentiles
    • Dynamic sort expressions
    • Dynamic expressions can be exposed to end users to allow for custom searches, filters, sorting and aggregations
      • Enables allowing users to build custom views, charts and dashboards
      • Enables powerful APIs that allow users to do things you never thought of
    • Supports geo queries (proximity and radius)
      • mygeo:75044~75mi
        • Returns all documents that have a value in the mygeo field that is within a 75 mile radius of the 75044 zip code
    • Supports nested document mappings
    • Automatically resolves non-analyzed keyword sub-fields for sorting and aggregations
    • Aliases can be defined right on your NEST mappings
      • Supports both root and inner field name aliases

Thanks to all the people who have contributed

contributors

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Foundatio.Parsers.ElasticQueries:

Package Downloads
Foundatio.Repositories.Elasticsearch

Generic Repository implementations for Elasticsearch.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
7.17.11 55 9/27/2024
7.17.10 715 9/4/2024
7.17.9 334 8/31/2024
7.17.8 90 8/31/2024
7.17.7 6,996 3/27/2024
7.17.6 4,267 1/5/2024
7.17.4 10,643 6/23/2023
7.17.3 24,334 1/1/2023
7.17.2 25,988 5/18/2022
7.17.1 4,283 3/10/2022
7.17.0 1,309 3/7/2022
7.16.2 1,844 1/21/2022
7.16.1 1,519 1/21/2022
7.16.0 1,479 1/20/2022
7.15.1 1,689 10/15/2021
7.15.0 1,786 10/11/2021
7.13.0 11,301 7/8/2021
7.12.0 3,655 4/13/2021
7.11.0 495 2/18/2021
7.10.3 22,763 2/1/2021
7.10.2 4,767 1/15/2021
7.10.1 532 1/15/2021
7.10.0 5,172 11/17/2020
7.9.0 4,556 9/16/2020
7.9.0-beta5 927 9/15/2020
7.9.0-beta4 418 9/15/2020
7.9.0-beta3 1,172 8/28/2020
7.9.0-beta2 841 8/27/2020
7.9.0-beta1 903 8/25/2020
7.8.0-beta9 344 8/3/2020
7.8.0-beta8 940 7/29/2020
7.8.0-beta7 1,135 7/9/2020
7.8.0-beta12 897 8/10/2020
7.8.0-beta11 983 8/6/2020
7.8.0-beta10 535 8/5/2020
7.7.0-beta6 386 7/2/2020
7.7.0-beta5 1,137 6/20/2020
7.7.0-beta4 934 6/14/2020
7.7.0-beta3 1,083 6/6/2020
7.7.0-beta2 1,038 5/26/2020
7.6.2 21,612 3/25/2020
7.6.1 619 3/25/2020
7.6.0 3,241 2/27/2020
7.5.4 2,669 2/13/2020
7.5.3 1,540 2/10/2020
7.5.2 2,330 1/28/2020
7.5.1 2,314 1/17/2020
7.5.0 1,298 1/16/2020
7.5.0-rc1 482 1/14/2020
7.0.497 12,566 6/27/2019
5.6.521 3,555 9/19/2019
5.6.517 670 9/19/2019
5.6.508 2,825 8/30/2019
5.6.477 8,860 4/16/2019
5.6.445 2,162 3/15/2019
5.6.443 1,452 3/14/2019
5.6.441 1,425 3/14/2019
5.6.438 2,469 2/22/2019
5.6.436 717 2/22/2019
5.6.429 1,067 1/30/2019
5.6.398 8,217 11/9/2018
5.6.396 1,497 11/9/2018
5.6.389 5,625 9/7/2018
5.6.386 3,804 5/9/2018
5.6.365 3,062 11/30/2017
5.0.353 5,663 9/14/2017
5.0.350 1,102 9/14/2017
5.0.348 2,807 8/17/2017
5.0.339 1,187 7/24/2017
5.0.336 1,926 6/23/2017
5.0.323 1,250 5/5/2017
5.0.302-pre 836 3/17/2017
5.0.301-pre 841 3/16/2017
5.0.300-pre 865 3/16/2017
5.0.299-pre 825 3/16/2017
5.0.295-pre 834 3/16/2017
5.0.293-pre 1,045 3/11/2017
5.0.292-pre 907 3/11/2017
5.0.274-pre 1,973 3/5/2017
5.0.273-pre 1,973 2/28/2017
5.0.271-pre 1,435 2/28/2017
5.0.270-pre 844 2/28/2017
5.0.268-pre 936 2/20/2017
5.0.266-pre 5,820 2/16/2017
5.0.263-pre 1,452 2/15/2017
5.0.261-pre 1,378 2/15/2017
5.0.260-pre 1,416 2/14/2017
5.0.259-pre 1,437 2/14/2017
5.0.258-pre 851 2/8/2017
5.0.255-pre 845 2/7/2017
5.0.254-pre 1,993 2/6/2017
5.0.253-pre 1,293 2/6/2017
5.0.252-pre 1,299 2/4/2017
5.0.251-pre 1,321 2/3/2017
5.0.250-pre 864 2/3/2017
5.0.248-pre 805 2/2/2017
5.0.246-pre 2,270 1/30/2017
5.0.245-pre 846 1/29/2017
5.0.244-pre 843 1/28/2017
5.0.243-pre 850 1/27/2017
5.0.242-pre 856 1/27/2017
5.0.241-pre 815 1/24/2017
5.0.239-pre 839 1/19/2017
5.0.238-pre 823 1/19/2017
5.0.237-pre 822 1/19/2017
5.0.235-pre 818 1/19/2017
5.0.234-pre 838 1/17/2017
5.0.233-pre 4,200 1/12/2017
5.0.232-pre 819 1/9/2017
5.0.230-pre 866 1/9/2017
5.0.229-pre 847 1/6/2017
5.0.226-pre 876 1/5/2017
5.0.224-pre 848 1/5/2017
5.0.223-pre 2,573 12/29/2016
5.0.222-pre 1,425 12/28/2016
5.0.220-pre 833 12/22/2016
5.0.219-pre 2,641 12/16/2016
5.0.216-pre 844 12/15/2016
5.0.214-pre 1,420 12/13/2016
5.0.213-pre 2,257 12/13/2016
5.0.212-pre 880 12/13/2016
5.0.211-pre 2,244 12/10/2016
5.0.209-pre 922 12/9/2016
5.0.205-pre 1,350 12/6/2016
5.0.203-pre 1,371 12/6/2016
5.0.202-pre 871 12/6/2016
5.0.199-pre 860 12/5/2016
5.0.198-pre 844 12/5/2016
5.0.197-pre 884 12/2/2016
5.0.196-pre 880 11/30/2016
5.0.193-pre 1,378 11/29/2016
5.0.190-pre 894 11/29/2016
5.0.189-pre 1,871 11/29/2016
5.0.186-pre 1,414 11/29/2016
5.0.185-pre 898 11/29/2016
5.0.183-pre 899 11/29/2016
5.0.182-pre 882 11/29/2016
5.0.181-pre 1,416 11/28/2016
5.0.180-pre 863 11/28/2016
5.0.177-pre 875 11/28/2016
5.0.175-pre 832 11/28/2016
5.0.174-pre 909 11/28/2016
5.0.173-pre 868 11/28/2016
5.0.171-pre 816 11/26/2016
5.0.170-pre 1,344 11/25/2016
5.0.169-pre 1,392 11/23/2016
5.0.167-pre 1,452 11/18/2016
5.0.166-pre 890 11/18/2016
5.0.159-pre 848 11/17/2016
2.0.153-pre 985 11/16/2016
2.0.150-pre 1,367 11/15/2016
2.0.149-pre 862 11/15/2016
2.0.148-pre 851 11/15/2016
2.0.140-pre 857 11/9/2016
2.0.137-pre 828 11/9/2016
2.0.135-pre 2,294 10/26/2016
2.0.105-pre 1,730 10/5/2016
2.0.104-pre 825 10/5/2016
2.0.103-pre 844 10/5/2016
2.0.101-pre 2,191 10/3/2016
2.0.100-pre 824 10/3/2016
2.0.99-pre 839 9/30/2016
2.0.98-pre 806 9/30/2016
2.0.95-pre 839 9/28/2016
2.0.94-pre 891 9/27/2016
1.0.318 1,029 5/4/2017
1.0.305 3,980 3/17/2017
1.0.269 4,271 2/20/2017
1.0.267 3,767 2/16/2017
1.0.264 1,061 2/16/2017
1.0.231 4,209 1/9/2017
1.0.228 2,290 1/6/2017
1.0.227 1,066 1/6/2017
1.0.210 3,849 12/9/2016
1.0.207 1,098 12/8/2016
1.0.204 1,695 12/6/2016
1.0.195 1,797 11/30/2016
1.0.192 1,134 11/29/2016
1.0.187 1,837 11/29/2016
1.0.184 1,125 11/29/2016
1.0.176 1,805 11/28/2016
1.0.168 2,373 11/18/2016
1.0.165 1,109 11/18/2016
1.0.164 1,143 11/18/2016
1.0.147 3,328 11/15/2016
1.0.143 1,065 11/10/2016
1.0.142 1,052 11/10/2016
1.0.141 1,061 11/9/2016
1.0.138 1,039 11/9/2016
1.0.136 1,166 11/9/2016
1.0.131 1,763 10/21/2016
1.0.130 1,076 10/21/2016
1.0.129 2,323 10/21/2016
1.0.128 1,721 10/21/2016
1.0.127 1,068 10/21/2016
1.0.126 1,059 10/21/2016
1.0.125 1,682 10/21/2016
1.0.124 1,722 10/20/2016
1.0.123 1,087 10/19/2016
1.0.122 1,057 10/19/2016
1.0.120 1,046 10/19/2016
1.0.119 1,776 10/18/2016
1.0.115 1,093 10/10/2016
1.0.114 1,040 10/10/2016
1.0.108 2,505 10/7/2016
1.0.102 1,824 10/3/2016
1.0.97 1,690 9/30/2016
1.0.96 1,068 9/30/2016
1.0.91 1,872 9/23/2016
1.0.87 5,092 9/20/2016
1.0.86 2,839 9/16/2016
1.0.85 1,061 9/16/2016
1.0.84 1,595 9/15/2016
1.0.82 3,909 9/13/2016
1.0.81 1,156 9/13/2016
1.0.80 1,647 9/13/2016
1.0.78 1,083 9/13/2016