Foundatio.Parsers.LuceneQueries 7.17.18

Prefix Reserved
dotnet add package Foundatio.Parsers.LuceneQueries --version 7.17.18
                    
NuGet\Install-Package Foundatio.Parsers.LuceneQueries -Version 7.17.18
                    
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.LuceneQueries" Version="7.17.18" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Foundatio.Parsers.LuceneQueries" Version="7.17.18" />
                    
Directory.Packages.props
<PackageReference Include="Foundatio.Parsers.LuceneQueries" />
                    
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.LuceneQueries --version 7.17.18
                    
#r "nuget: Foundatio.Parsers.LuceneQueries, 7.17.18"
                    
#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.
#:package Foundatio.Parsers.LuceneQueries@7.17.18
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Foundatio.Parsers.LuceneQueries&version=7.17.18
                    
Install as a Cake Addin
#tool nuget:?package=Foundatio.Parsers.LuceneQueries&version=7.17.18
                    
Install 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.slnx 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 is compatible.  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 (2)

Showing the top 2 NuGet packages that depend on Foundatio.Parsers.LuceneQueries:

Package Downloads
Foundatio.Parsers.ElasticQueries

A lucene style query parser that is extensible and allows additional syntax features.

Foundatio.Parsers.SqlQueries

A lucene style query parser that is extensible and allows additional syntax features.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
7.17.18 3,346 8/20/2025
7.17.17 12,101 5/15/2025
7.17.16 5,978 5/12/2025
7.17.15 568 5/9/2025
7.17.14 10,990 1/31/2025
7.17.13 6,999 1/13/2025
7.17.12 4,090 11/26/2024
7.17.11 6,742 9/27/2024
7.17.10 7,424 9/4/2024
7.17.9 603 8/31/2024
7.17.8 236 8/31/2024
7.17.7 33,973 3/27/2024
7.17.6 19,485 1/5/2024
7.17.4 19,126 6/23/2023
7.17.3 38,219 1/1/2023
7.17.2 34,642 5/18/2022
7.17.1 7,920 3/10/2022
7.17.0 1,725 3/7/2022
7.16.2 10,222 1/21/2022
7.16.1 1,992 1/21/2022
7.16.0 1,919 1/20/2022
7.15.1 4,450 10/15/2021
7.15.0 2,202 10/11/2021
7.13.0 19,340 7/8/2021
7.12.0 37,388 4/13/2021
7.11.0 852 2/18/2021
7.10.3 27,038 2/1/2021
7.10.2 5,122 1/15/2021
7.10.1 827 1/15/2021
7.10.0 10,474 11/17/2020
7.9.0 4,895 9/16/2020
7.9.0-beta5 1,112 9/15/2020
7.9.0-beta4 594 9/15/2020
7.9.0-beta3 1,320 8/28/2020
7.9.0-beta2 1,023 8/27/2020
7.9.0-beta1 1,079 8/25/2020
7.8.0-beta9 2,790 8/3/2020
7.8.0-beta8 1,867 7/29/2020
7.8.0-beta7 1,397 7/9/2020
7.8.0-beta12 1,088 8/10/2020
7.8.0-beta11 1,169 8/6/2020
7.8.0-beta10 730 8/5/2020
7.7.0-beta6 672 7/2/2020
7.7.0-beta5 1,336 6/20/2020
7.7.0-beta4 1,146 6/14/2020
7.7.0-beta3 1,285 6/6/2020
7.7.0-beta2 1,275 5/26/2020
7.6.2 23,228 3/25/2020
7.6.1 969 3/25/2020
7.6.0 3,542 2/27/2020
7.5.4 2,944 2/13/2020
7.5.3 1,923 2/10/2020
7.5.2 2,683 1/28/2020
7.5.1 2,601 1/17/2020
7.5.0 1,644 1/16/2020
7.5.0-rc1 717 1/14/2020
7.0.497 16,888 6/27/2019
5.6.521 4,228 9/19/2019
5.6.517 1,031 9/19/2019
5.6.508 3,227 8/30/2019
5.6.477 9,843 4/16/2019
5.6.445 2,818 3/15/2019
5.6.443 1,816 3/14/2019
5.6.441 1,794 3/14/2019
5.6.438 6,198 2/22/2019
5.6.436 1,106 2/22/2019
5.6.429 8,227 1/30/2019
5.6.398 8,631 11/9/2018
5.6.396 1,963 11/9/2018
5.6.389 10,154 9/7/2018
5.6.386 4,545 5/9/2018
5.6.365 3,794 11/30/2017
5.0.353 6,307 9/14/2017
5.0.350 1,646 9/14/2017
5.0.348 3,351 8/17/2017
5.0.339 1,605 7/24/2017
5.0.336 2,208 6/23/2017
5.0.323 1,478 5/5/2017
5.0.302-pre 1,092 3/17/2017
5.0.301-pre 1,096 3/16/2017
5.0.300-pre 1,105 3/16/2017
5.0.299-pre 1,064 3/16/2017
5.0.295-pre 1,057 3/16/2017
5.0.293-pre 1,195 3/11/2017
5.0.292-pre 1,120 3/11/2017
5.0.274-pre 2,348 3/5/2017
5.0.273-pre 2,339 2/28/2017
5.0.271-pre 1,747 2/28/2017
5.0.270-pre 1,159 2/28/2017
5.0.268-pre 1,278 2/20/2017
5.0.266-pre 6,337 2/16/2017
5.0.263-pre 1,830 2/15/2017
5.0.261-pre 1,759 2/15/2017
5.0.260-pre 1,742 2/14/2017
5.0.259-pre 1,821 2/14/2017
5.0.258-pre 1,238 2/8/2017
5.0.255-pre 1,195 2/7/2017
5.0.254-pre 2,358 2/6/2017
5.0.253-pre 1,652 2/6/2017
5.0.252-pre 1,654 2/4/2017
5.0.251-pre 1,660 2/3/2017
5.0.250-pre 1,161 2/3/2017
5.0.248-pre 1,161 2/2/2017
5.0.246-pre 2,613 1/30/2017
5.0.245-pre 1,199 1/29/2017
5.0.244-pre 1,189 1/28/2017
5.0.243-pre 1,173 1/27/2017
5.0.242-pre 1,197 1/27/2017
5.0.241-pre 1,166 1/24/2017
5.0.239-pre 1,178 1/19/2017
5.0.238-pre 1,185 1/19/2017
5.0.237-pre 1,189 1/19/2017
5.0.235-pre 1,180 1/19/2017
5.0.234-pre 1,171 1/17/2017
5.0.233-pre 4,722 1/12/2017
5.0.232-pre 1,155 1/9/2017
5.0.230-pre 1,219 1/9/2017
5.0.229-pre 1,187 1/6/2017
5.0.226-pre 1,228 1/5/2017
5.0.224-pre 1,203 1/5/2017
5.0.223-pre 3,008 12/29/2016
5.0.222-pre 1,761 12/28/2016
5.0.220-pre 1,211 12/22/2016
5.0.219-pre 2,988 12/16/2016
5.0.216-pre 1,187 12/15/2016
5.0.214-pre 1,795 12/13/2016
5.0.213-pre 2,623 12/13/2016
5.0.212-pre 1,206 12/13/2016
5.0.211-pre 2,578 12/10/2016
5.0.209-pre 1,264 12/9/2016
5.0.205-pre 1,791 12/6/2016
5.0.203-pre 1,772 12/6/2016
5.0.202-pre 1,221 12/6/2016
5.0.199-pre 1,219 12/5/2016
5.0.198-pre 1,216 12/5/2016
5.0.197-pre 1,246 12/2/2016
5.0.196-pre 1,239 11/30/2016
5.0.193-pre 1,768 11/29/2016
5.0.190-pre 1,264 11/29/2016
5.0.189-pre 2,230 11/29/2016
5.0.186-pre 1,800 11/29/2016
5.0.185-pre 1,243 11/29/2016
5.0.183-pre 1,246 11/29/2016
5.0.182-pre 1,242 11/29/2016
5.0.181-pre 1,751 11/28/2016
5.0.180-pre 1,214 11/28/2016
5.0.177-pre 1,214 11/28/2016
5.0.175-pre 1,165 11/28/2016
5.0.174-pre 1,245 11/28/2016
5.0.173-pre 1,252 11/28/2016
5.0.171-pre 1,213 11/26/2016
5.0.170-pre 1,741 11/25/2016
5.0.169-pre 1,783 11/23/2016
5.0.167-pre 1,787 11/18/2016
5.0.166-pre 1,253 11/18/2016
5.0.159-pre 1,200 11/17/2016
2.0.153-pre 1,416 11/16/2016
2.0.150-pre 1,678 11/15/2016
2.0.149-pre 1,188 11/15/2016
2.0.148-pre 1,192 11/15/2016
2.0.140-pre 1,193 11/9/2016
2.0.137-pre 1,157 11/9/2016
2.0.135-pre 2,678 10/26/2016
2.0.105-pre 2,113 10/5/2016
2.0.104-pre 1,210 10/5/2016
2.0.103-pre 1,197 10/5/2016
2.0.101-pre 2,533 10/3/2016
2.0.100-pre 1,180 10/3/2016
2.0.99-pre 1,196 9/30/2016
2.0.98-pre 1,195 9/30/2016
2.0.95-pre 1,191 9/28/2016
2.0.94-pre 1,254 9/27/2016
1.0.318 1,531 5/4/2017
1.0.305 4,551 3/17/2017
1.0.269 4,836 2/20/2017
1.0.267 4,409 2/16/2017
1.0.264 1,566 2/16/2017
1.0.231 4,818 1/9/2017
1.0.228 2,858 1/6/2017
1.0.227 1,602 1/6/2017
1.0.210 4,401 12/9/2016
1.0.207 1,657 12/8/2016
1.0.204 2,284 12/6/2016
1.0.195 2,316 11/30/2016
1.0.192 1,661 11/29/2016
1.0.187 2,428 11/29/2016
1.0.184 1,653 11/29/2016
1.0.176 2,316 11/28/2016
1.0.168 2,906 11/18/2016
1.0.165 1,570 11/18/2016
1.0.164 1,559 11/18/2016
1.0.147 3,962 11/15/2016
1.0.143 1,572 11/10/2016
1.0.142 1,583 11/10/2016
1.0.141 1,563 11/9/2016
1.0.138 1,539 11/9/2016
1.0.136 1,734 11/9/2016
1.0.131 2,333 10/21/2016
1.0.130 1,616 10/21/2016
1.0.129 2,895 10/21/2016
1.0.128 2,289 10/21/2016
1.0.127 1,614 10/21/2016
1.0.126 1,593 10/21/2016
1.0.125 2,233 10/21/2016
1.0.124 2,309 10/20/2016
1.0.123 1,641 10/19/2016
1.0.122 1,561 10/19/2016
1.0.120 1,566 10/19/2016
1.0.119 2,285 10/18/2016
1.0.115 1,590 10/10/2016
1.0.114 1,547 10/10/2016
1.0.108 3,053 10/7/2016
1.0.102 2,342 10/3/2016
1.0.97 2,213 9/30/2016
1.0.96 1,581 9/30/2016
1.0.91 2,457 9/23/2016
1.0.87 5,572 9/20/2016
1.0.86 3,405 9/16/2016
1.0.85 1,578 9/16/2016
1.0.84 2,139 9/15/2016
1.0.82 4,607 9/13/2016
1.0.81 1,669 9/13/2016
1.0.80 2,154 9/13/2016
1.0.78 1,426 9/13/2016