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 7,485 8/20/2025
7.17.17 13,050 5/15/2025
7.17.16 6,310 5/12/2025
7.17.15 663 5/9/2025
7.17.14 11,695 1/31/2025
7.17.13 7,054 1/13/2025
7.17.12 4,163 11/26/2024
7.17.11 7,064 9/27/2024
7.17.10 7,626 9/4/2024
7.17.9 688 8/31/2024
7.17.8 302 8/31/2024
7.17.7 34,637 3/27/2024
7.17.6 20,038 1/5/2024
7.17.4 19,530 6/23/2023
7.17.3 38,371 1/1/2023
7.17.2 34,717 5/18/2022
7.17.1 7,997 3/10/2022
7.17.0 1,784 3/7/2022
7.16.2 10,281 1/21/2022
7.16.1 2,061 1/21/2022
7.16.0 1,972 1/20/2022
7.15.1 4,524 10/15/2021
7.15.0 2,285 10/11/2021
7.13.0 20,173 7/8/2021
7.12.0 37,532 4/13/2021
7.11.0 906 2/18/2021
7.10.3 27,134 2/1/2021
7.10.2 5,253 1/15/2021
7.10.1 871 1/15/2021
7.10.0 10,589 11/17/2020
7.9.0 5,027 9/16/2020
7.9.0-beta5 1,172 9/15/2020
7.9.0-beta4 637 9/15/2020
7.9.0-beta3 1,369 8/28/2020
7.9.0-beta2 1,093 8/27/2020
7.9.0-beta1 1,161 8/25/2020
7.8.0-beta9 2,842 8/3/2020
7.8.0-beta8 1,942 7/29/2020
7.8.0-beta7 1,470 7/9/2020
7.8.0-beta12 1,161 8/10/2020
7.8.0-beta11 1,259 8/6/2020
7.8.0-beta10 774 8/5/2020
7.7.0-beta6 712 7/2/2020
7.7.0-beta5 1,400 6/20/2020
7.7.0-beta4 1,216 6/14/2020
7.7.0-beta3 1,357 6/6/2020
7.7.0-beta2 1,345 5/26/2020
7.6.2 23,302 3/25/2020
7.6.1 1,029 3/25/2020
7.6.0 3,615 2/27/2020
7.5.4 3,033 2/13/2020
7.5.3 2,006 2/10/2020
7.5.2 2,752 1/28/2020
7.5.1 2,674 1/17/2020
7.5.0 1,727 1/16/2020
7.5.0-rc1 751 1/14/2020
7.0.497 17,081 6/27/2019
5.6.521 4,325 9/19/2019
5.6.517 1,087 9/19/2019
5.6.508 3,324 8/30/2019
5.6.477 9,966 4/16/2019
5.6.445 2,904 3/15/2019
5.6.443 1,894 3/14/2019
5.6.441 1,910 3/14/2019
5.6.438 6,282 2/22/2019
5.6.436 1,143 2/22/2019
5.6.429 8,466 1/30/2019
5.6.398 8,728 11/9/2018
5.6.396 2,037 11/9/2018
5.6.389 11,033 9/7/2018
5.6.386 4,675 5/9/2018
5.6.365 3,930 11/30/2017
5.0.353 6,567 9/14/2017
5.0.350 1,720 9/14/2017
5.0.348 3,539 8/17/2017
5.0.339 1,648 7/24/2017
5.0.336 2,242 6/23/2017
5.0.323 1,523 5/5/2017
5.0.302-pre 1,136 3/17/2017
5.0.301-pre 1,129 3/16/2017
5.0.300-pre 1,135 3/16/2017
5.0.299-pre 1,108 3/16/2017
5.0.295-pre 1,102 3/16/2017
5.0.293-pre 1,227 3/11/2017
5.0.292-pre 1,161 3/11/2017
5.0.274-pre 2,455 3/5/2017
5.0.273-pre 2,472 2/28/2017
5.0.271-pre 1,829 2/28/2017
5.0.270-pre 1,218 2/28/2017
5.0.268-pre 1,341 2/20/2017
5.0.266-pre 6,712 2/16/2017
5.0.263-pre 1,934 2/15/2017
5.0.261-pre 1,873 2/15/2017
5.0.260-pre 1,839 2/14/2017
5.0.259-pre 1,933 2/14/2017
5.0.258-pre 1,299 2/8/2017
5.0.255-pre 1,256 2/7/2017
5.0.254-pre 2,504 2/6/2017
5.0.253-pre 1,753 2/6/2017
5.0.252-pre 1,728 2/4/2017
5.0.251-pre 1,752 2/3/2017
5.0.250-pre 1,214 2/3/2017
5.0.248-pre 1,233 2/2/2017
5.0.246-pre 2,765 1/30/2017
5.0.245-pre 1,263 1/29/2017
5.0.244-pre 1,252 1/28/2017
5.0.243-pre 1,230 1/27/2017
5.0.242-pre 1,257 1/27/2017
5.0.241-pre 1,228 1/24/2017
5.0.239-pre 1,223 1/19/2017
5.0.238-pre 1,233 1/19/2017
5.0.237-pre 1,231 1/19/2017
5.0.235-pre 1,236 1/19/2017
5.0.234-pre 1,234 1/17/2017
5.0.233-pre 4,985 1/12/2017
5.0.232-pre 1,217 1/9/2017
5.0.230-pre 1,265 1/9/2017
5.0.229-pre 1,242 1/6/2017
5.0.226-pre 1,298 1/5/2017
5.0.224-pre 1,266 1/5/2017
5.0.223-pre 3,162 12/29/2016
5.0.222-pre 1,843 12/28/2016
5.0.220-pre 1,265 12/22/2016
5.0.219-pre 3,116 12/16/2016
5.0.216-pre 1,217 12/15/2016
5.0.214-pre 1,900 12/13/2016
5.0.213-pre 2,760 12/13/2016
5.0.212-pre 1,268 12/13/2016
5.0.211-pre 2,715 12/10/2016
5.0.209-pre 1,304 12/9/2016
5.0.205-pre 1,911 12/6/2016
5.0.203-pre 1,866 12/6/2016
5.0.202-pre 1,292 12/6/2016
5.0.199-pre 1,262 12/5/2016
5.0.198-pre 1,275 12/5/2016
5.0.197-pre 1,309 12/2/2016
5.0.196-pre 1,294 11/30/2016
5.0.193-pre 1,867 11/29/2016
5.0.190-pre 1,329 11/29/2016
5.0.189-pre 2,362 11/29/2016
5.0.186-pre 1,910 11/29/2016
5.0.185-pre 1,294 11/29/2016
5.0.183-pre 1,319 11/29/2016
5.0.182-pre 1,313 11/29/2016
5.0.181-pre 1,839 11/28/2016
5.0.180-pre 1,256 11/28/2016
5.0.177-pre 1,258 11/28/2016
5.0.175-pre 1,219 11/28/2016
5.0.174-pre 1,297 11/28/2016
5.0.173-pre 1,305 11/28/2016
5.0.171-pre 1,278 11/26/2016
5.0.170-pre 1,851 11/25/2016
5.0.169-pre 1,854 11/23/2016
5.0.167-pre 1,874 11/18/2016
5.0.166-pre 1,316 11/18/2016
5.0.159-pre 1,262 11/17/2016
2.0.153-pre 1,487 11/16/2016
2.0.150-pre 1,731 11/15/2016
2.0.149-pre 1,232 11/15/2016
2.0.148-pre 1,246 11/15/2016
2.0.140-pre 1,258 11/9/2016
2.0.137-pre 1,215 11/9/2016
2.0.135-pre 2,801 10/26/2016
2.0.105-pre 2,218 10/5/2016
2.0.104-pre 1,271 10/5/2016
2.0.103-pre 1,249 10/5/2016
2.0.101-pre 2,708 10/3/2016
2.0.100-pre 1,233 10/3/2016
2.0.99-pre 1,244 9/30/2016
2.0.98-pre 1,265 9/30/2016
2.0.95-pre 1,251 9/28/2016
2.0.94-pre 1,314 9/27/2016
1.0.318 1,590 5/4/2017
1.0.305 4,809 3/17/2017
1.0.269 5,064 2/20/2017
1.0.267 4,602 2/16/2017
1.0.264 1,626 2/16/2017
1.0.231 4,964 1/9/2017
1.0.228 2,963 1/6/2017
1.0.227 1,650 1/6/2017
1.0.210 4,540 12/9/2016
1.0.207 1,716 12/8/2016
1.0.204 2,369 12/6/2016
1.0.195 2,387 11/30/2016
1.0.192 1,727 11/29/2016
1.0.187 2,512 11/29/2016
1.0.184 1,723 11/29/2016
1.0.176 2,382 11/28/2016
1.0.168 3,000 11/18/2016
1.0.165 1,635 11/18/2016
1.0.164 1,614 11/18/2016
1.0.147 4,067 11/15/2016
1.0.143 1,636 11/10/2016
1.0.142 1,637 11/10/2016
1.0.141 1,626 11/9/2016
1.0.138 1,585 11/9/2016
1.0.136 1,802 11/9/2016
1.0.131 2,417 10/21/2016
1.0.130 1,670 10/21/2016
1.0.129 2,998 10/21/2016
1.0.128 2,352 10/21/2016
1.0.127 1,677 10/21/2016
1.0.126 1,661 10/21/2016
1.0.125 2,321 10/21/2016
1.0.124 2,392 10/20/2016
1.0.123 1,696 10/19/2016
1.0.122 1,617 10/19/2016
1.0.120 1,629 10/19/2016
1.0.119 2,372 10/18/2016
1.0.115 1,658 10/10/2016
1.0.114 1,603 10/10/2016
1.0.108 3,148 10/7/2016
1.0.102 2,411 10/3/2016
1.0.97 2,298 9/30/2016
1.0.96 1,626 9/30/2016
1.0.91 2,534 9/23/2016
1.0.87 5,743 9/20/2016
1.0.86 3,524 9/16/2016
1.0.85 1,649 9/16/2016
1.0.84 2,221 9/15/2016
1.0.82 4,781 9/13/2016
1.0.81 1,724 9/13/2016
1.0.80 2,222 9/13/2016
1.0.78 1,471 9/13/2016