Foundatio.Parsers.ElasticQueries 7.17.17

Prefix Reserved
dotnet add package Foundatio.Parsers.ElasticQueries --version 7.17.17
                    
NuGet\Install-Package Foundatio.Parsers.ElasticQueries -Version 7.17.17
                    
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.17" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Foundatio.Parsers.ElasticQueries" Version="7.17.17" />
                    
Directory.Packages.props
<PackageReference Include="Foundatio.Parsers.ElasticQueries" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Foundatio.Parsers.ElasticQueries --version 7.17.17
                    
#r "nuget: Foundatio.Parsers.ElasticQueries, 7.17.17"
                    
#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.
#addin nuget:?package=Foundatio.Parsers.ElasticQueries&version=7.17.17
                    
Install Foundatio.Parsers.ElasticQueries as a Cake Addin
#tool nuget:?package=Foundatio.Parsers.ElasticQueries&version=7.17.17
                    
Install Foundatio.Parsers.ElasticQueries as a Cake Tool

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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.17 220 5/15/2025
7.17.16 1,041 5/12/2025
7.17.15 265 5/9/2025
7.17.14 876 1/31/2025
7.17.13 5,080 1/13/2025
7.17.12 693 11/26/2024
7.17.11 794 9/27/2024
7.17.10 5,340 9/4/2024
7.17.9 382 8/31/2024
7.17.8 123 8/31/2024
7.17.7 13,343 3/27/2024
7.17.6 4,998 1/5/2024
7.17.4 10,679 6/23/2023
7.17.3 25,920 1/1/2023
7.17.2 26,055 5/18/2022
7.17.1 4,333 3/10/2022
7.17.0 1,354 3/7/2022
7.16.2 1,899 1/21/2022
7.16.1 1,566 1/21/2022
7.16.0 1,525 1/20/2022
7.15.1 1,738 10/15/2021
7.15.0 1,854 10/11/2021
7.13.0 15,362 7/8/2021
7.12.0 3,709 4/13/2021
7.11.0 554 2/18/2021
7.10.3 22,965 2/1/2021
7.10.2 4,831 1/15/2021
7.10.1 586 1/15/2021
7.10.0 5,247 11/17/2020
7.9.0 4,635 9/16/2020
7.9.0-beta5 978 9/15/2020
7.9.0-beta4 470 9/15/2020
7.9.0-beta3 1,223 8/28/2020
7.9.0-beta2 891 8/27/2020
7.9.0-beta1 952 8/25/2020
7.8.0-beta9 401 8/3/2020
7.8.0-beta8 1,000 7/29/2020
7.8.0-beta7 1,187 7/9/2020
7.8.0-beta12 947 8/10/2020
7.8.0-beta11 1,033 8/6/2020
7.8.0-beta10 585 8/5/2020
7.7.0-beta6 436 7/2/2020
7.7.0-beta5 1,187 6/20/2020
7.7.0-beta4 985 6/14/2020
7.7.0-beta3 1,135 6/6/2020
7.7.0-beta2 1,112 5/26/2020
7.6.2 21,728 3/25/2020
7.6.1 688 3/25/2020
7.6.0 3,305 2/27/2020
7.5.4 2,734 2/13/2020
7.5.3 1,601 2/10/2020
7.5.2 2,393 1/28/2020
7.5.1 2,376 1/17/2020
7.5.0 1,361 1/16/2020
7.5.0-rc1 539 1/14/2020
7.0.497 12,638 6/27/2019
5.6.521 3,914 9/19/2019
5.6.517 736 9/19/2019
5.6.508 2,891 8/30/2019
5.6.477 8,934 4/16/2019
5.6.445 2,232 3/15/2019
5.6.443 1,519 3/14/2019
5.6.441 1,495 3/14/2019
5.6.438 2,562 2/22/2019
5.6.436 785 2/22/2019
5.6.429 1,190 1/30/2019
5.6.398 8,305 11/9/2018
5.6.396 1,580 11/9/2018
5.6.389 5,742 9/7/2018
5.6.386 4,038 5/9/2018
5.6.365 3,353 11/30/2017
5.0.353 5,841 9/14/2017
5.0.350 1,261 9/14/2017
5.0.348 2,964 8/17/2017
5.0.339 1,341 7/24/2017
5.0.336 2,092 6/23/2017
5.0.323 1,405 5/5/2017
5.0.302-pre 987 3/17/2017
5.0.301-pre 992 3/16/2017
5.0.300-pre 1,014 3/16/2017
5.0.299-pre 973 3/16/2017
5.0.295-pre 982 3/16/2017
5.0.293-pre 1,193 3/11/2017
5.0.292-pre 1,059 3/11/2017
5.0.274-pre 2,139 3/5/2017
5.0.273-pre 2,134 2/28/2017
5.0.271-pre 1,584 2/28/2017
5.0.270-pre 992 2/28/2017
5.0.268-pre 1,084 2/20/2017
5.0.266-pre 6,035 2/16/2017
5.0.263-pre 1,601 2/15/2017
5.0.261-pre 1,526 2/15/2017
5.0.260-pre 1,567 2/14/2017
5.0.259-pre 1,586 2/14/2017
5.0.258-pre 999 2/8/2017
5.0.255-pre 1,000 2/7/2017
5.0.254-pre 2,162 2/6/2017
5.0.253-pre 1,443 2/6/2017
5.0.252-pre 1,445 2/4/2017
5.0.251-pre 1,471 2/3/2017
5.0.250-pre 1,013 2/3/2017
5.0.248-pre 954 2/2/2017
5.0.246-pre 2,418 1/30/2017
5.0.245-pre 1,005 1/29/2017
5.0.244-pre 990 1/28/2017
5.0.243-pre 1,000 1/27/2017
5.0.242-pre 1,006 1/27/2017
5.0.241-pre 964 1/24/2017
5.0.239-pre 988 1/19/2017
5.0.238-pre 973 1/19/2017
5.0.237-pre 971 1/19/2017
5.0.235-pre 970 1/19/2017
5.0.234-pre 989 1/17/2017
5.0.233-pre 4,361 1/12/2017
5.0.232-pre 969 1/9/2017
5.0.230-pre 1,015 1/9/2017
5.0.229-pre 996 1/6/2017
5.0.226-pre 1,028 1/5/2017
5.0.224-pre 998 1/5/2017
5.0.223-pre 2,722 12/29/2016
5.0.222-pre 1,582 12/28/2016
5.0.220-pre 982 12/22/2016
5.0.219-pre 2,790 12/16/2016
5.0.216-pre 995 12/15/2016
5.0.214-pre 1,569 12/13/2016
5.0.213-pre 2,406 12/13/2016
5.0.212-pre 1,029 12/13/2016
5.0.211-pre 2,394 12/10/2016
5.0.209-pre 1,073 12/9/2016
5.0.205-pre 1,516 12/6/2016
5.0.203-pre 1,520 12/6/2016
5.0.202-pre 1,022 12/6/2016
5.0.199-pre 1,010 12/5/2016
5.0.198-pre 994 12/5/2016
5.0.197-pre 1,034 12/2/2016
5.0.196-pre 1,029 11/30/2016
5.0.193-pre 1,534 11/29/2016
5.0.190-pre 1,043 11/29/2016
5.0.189-pre 2,021 11/29/2016
5.0.186-pre 1,577 11/29/2016
5.0.185-pre 1,047 11/29/2016
5.0.183-pre 1,047 11/29/2016
5.0.182-pre 1,030 11/29/2016
5.0.181-pre 1,567 11/28/2016
5.0.180-pre 1,013 11/28/2016
5.0.177-pre 1,026 11/28/2016
5.0.175-pre 982 11/28/2016
5.0.174-pre 1,059 11/28/2016
5.0.173-pre 1,017 11/28/2016
5.0.171-pre 966 11/26/2016
5.0.170-pre 1,494 11/25/2016
5.0.169-pre 1,542 11/23/2016
5.0.167-pre 1,601 11/18/2016
5.0.166-pre 1,039 11/18/2016
5.0.159-pre 998 11/17/2016
2.0.153-pre 1,210 11/16/2016
2.0.150-pre 1,515 11/15/2016
2.0.149-pre 1,013 11/15/2016
2.0.148-pre 999 11/15/2016
2.0.140-pre 1,007 11/9/2016
2.0.137-pre 977 11/9/2016
2.0.135-pre 2,442 10/26/2016
2.0.105-pre 1,902 10/5/2016
2.0.104-pre 972 10/5/2016
2.0.103-pre 994 10/5/2016
2.0.101-pre 2,338 10/3/2016
2.0.100-pre 972 10/3/2016
2.0.99-pre 990 9/30/2016
2.0.98-pre 954 9/30/2016
2.0.95-pre 990 9/28/2016
2.0.94-pre 1,045 9/27/2016
1.0.318 1,186 5/4/2017
1.0.305 4,138 3/17/2017
1.0.269 4,425 2/20/2017
1.0.267 3,933 2/16/2017
1.0.264 1,216 2/16/2017
1.0.231 4,365 1/9/2017
1.0.228 2,453 1/6/2017
1.0.227 1,223 1/6/2017
1.0.210 4,006 12/9/2016
1.0.207 1,261 12/8/2016
1.0.204 1,857 12/6/2016
1.0.195 1,959 11/30/2016
1.0.192 1,289 11/29/2016
1.0.187 1,994 11/29/2016
1.0.184 1,280 11/29/2016
1.0.176 1,962 11/28/2016
1.0.168 2,530 11/18/2016
1.0.165 1,269 11/18/2016
1.0.164 1,302 11/18/2016
1.0.147 3,484 11/15/2016
1.0.143 1,219 11/10/2016
1.0.142 1,207 11/10/2016
1.0.141 1,219 11/9/2016
1.0.138 1,193 11/9/2016
1.0.136 1,321 11/9/2016
1.0.131 1,920 10/21/2016
1.0.130 1,229 10/21/2016
1.0.129 2,478 10/21/2016
1.0.128 1,877 10/21/2016
1.0.127 1,225 10/21/2016
1.0.126 1,216 10/21/2016
1.0.125 1,836 10/21/2016
1.0.124 1,877 10/20/2016
1.0.123 1,243 10/19/2016
1.0.122 1,216 10/19/2016
1.0.120 1,199 10/19/2016
1.0.119 1,931 10/18/2016
1.0.115 1,250 10/10/2016
1.0.114 1,198 10/10/2016
1.0.108 2,658 10/7/2016
1.0.102 1,981 10/3/2016
1.0.97 1,846 9/30/2016
1.0.96 1,236 9/30/2016
1.0.91 2,025 9/23/2016
1.0.87 5,254 9/20/2016
1.0.86 2,993 9/16/2016
1.0.85 1,216 9/16/2016
1.0.84 1,753 9/15/2016
1.0.82 4,064 9/13/2016
1.0.81 1,311 9/13/2016
1.0.80 1,804 9/13/2016
1.0.78 1,243 9/13/2016