Foundatio.Parsers.LuceneQueries 7.17.15

Prefix Reserved
dotnet add package Foundatio.Parsers.LuceneQueries --version 7.17.15
                    
NuGet\Install-Package Foundatio.Parsers.LuceneQueries -Version 7.17.15
                    
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.15" />
                    
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.15" />
                    
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.15
                    
#r "nuget: Foundatio.Parsers.LuceneQueries, 7.17.15"
                    
#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.LuceneQueries&version=7.17.15
                    
Install Foundatio.Parsers.LuceneQueries as a Cake Addin
#tool nuget:?package=Foundatio.Parsers.LuceneQueries&version=7.17.15
                    
Install Foundatio.Parsers.LuceneQueries 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. 
.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.
  • .NETStandard 2.0

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.15 101 a day ago
7.17.14 8,909 3 months ago
7.17.13 6,290 4 months ago
7.17.12 4,033 5 months ago
7.17.11 5,648 7 months ago
7.17.10 5,619 8 months ago
7.17.9 548 8 months ago
7.17.8 180 8 months ago
7.17.7 30,191 3/27/2024
7.17.6 18,289 1/5/2024
7.17.4 18,186 6/23/2023
7.17.3 37,828 1/1/2023
7.17.2 34,552 5/18/2022
7.17.1 7,858 3/10/2022
7.17.0 1,663 3/7/2022
7.16.2 10,154 1/21/2022
7.16.1 1,925 1/21/2022
7.16.0 1,857 1/20/2022
7.15.1 4,373 10/15/2021
7.15.0 2,082 10/11/2021
7.13.0 15,821 7/8/2021
7.12.0 37,172 4/13/2021
7.11.0 787 2/18/2021
7.10.3 26,904 2/1/2021
7.10.2 5,054 1/15/2021
7.10.1 755 1/15/2021
7.10.0 10,399 11/17/2020
7.9.0 4,825 9/16/2020
7.9.0-beta5 1,045 9/15/2020
7.9.0-beta4 527 9/15/2020
7.9.0-beta3 1,252 8/28/2020
7.9.0-beta2 957 8/27/2020
7.9.0-beta1 1,013 8/25/2020
7.8.0-beta9 2,718 8/3/2020
7.8.0-beta8 1,792 7/29/2020
7.8.0-beta7 1,330 7/9/2020
7.8.0-beta12 1,017 8/10/2020
7.8.0-beta11 1,102 8/6/2020
7.8.0-beta10 665 8/5/2020
7.7.0-beta6 602 7/2/2020
7.7.0-beta5 1,269 6/20/2020
7.7.0-beta4 1,081 6/14/2020
7.7.0-beta3 1,214 6/6/2020
7.7.0-beta2 1,200 5/26/2020
7.6.2 23,141 3/25/2020
7.6.1 892 3/25/2020
7.6.0 3,468 2/27/2020
7.5.4 2,868 2/13/2020
7.5.3 1,849 2/10/2020
7.5.2 2,603 1/28/2020
7.5.1 2,527 1/17/2020
7.5.0 1,565 1/16/2020
7.5.0-rc1 640 1/14/2020
7.0.497 16,801 6/27/2019
5.6.521 4,098 9/19/2019
5.6.517 958 9/19/2019
5.6.508 3,149 8/30/2019
5.6.477 9,715 4/16/2019
5.6.445 2,740 3/15/2019
5.6.443 1,738 3/14/2019
5.6.441 1,715 3/14/2019
5.6.438 6,102 2/22/2019
5.6.436 1,025 2/22/2019
5.6.429 7,319 1/30/2019
5.6.398 8,547 11/9/2018
5.6.396 1,879 11/9/2018
5.6.389 10,013 9/7/2018
5.6.386 4,338 5/9/2018
5.6.365 3,582 11/30/2017
5.0.353 6,162 9/14/2017
5.0.350 1,503 9/14/2017
5.0.348 3,204 8/17/2017
5.0.339 1,457 7/24/2017
5.0.336 2,057 6/23/2017
5.0.323 1,332 5/5/2017
5.0.302-pre 950 3/17/2017
5.0.301-pre 948 3/16/2017
5.0.300-pre 963 3/16/2017
5.0.299-pre 922 3/16/2017
5.0.295-pre 914 3/16/2017
5.0.293-pre 1,050 3/11/2017
5.0.292-pre 973 3/11/2017
5.0.274-pre 2,203 3/5/2017
5.0.273-pre 2,198 2/28/2017
5.0.271-pre 1,604 2/28/2017
5.0.270-pre 1,017 2/28/2017
5.0.268-pre 1,129 2/20/2017
5.0.266-pre 6,176 2/16/2017
5.0.263-pre 1,685 2/15/2017
5.0.261-pre 1,601 2/15/2017
5.0.260-pre 1,601 2/14/2017
5.0.259-pre 1,677 2/14/2017
5.0.258-pre 1,092 2/8/2017
5.0.255-pre 1,054 2/7/2017
5.0.254-pre 2,216 2/6/2017
5.0.253-pre 1,508 2/6/2017
5.0.252-pre 1,513 2/4/2017
5.0.251-pre 1,520 2/3/2017
5.0.250-pre 1,020 2/3/2017
5.0.248-pre 1,017 2/2/2017
5.0.246-pre 2,464 1/30/2017
5.0.245-pre 1,050 1/29/2017
5.0.244-pre 1,038 1/28/2017
5.0.243-pre 1,026 1/27/2017
5.0.242-pre 1,047 1/27/2017
5.0.241-pre 1,021 1/24/2017
5.0.239-pre 1,037 1/19/2017
5.0.238-pre 1,041 1/19/2017
5.0.237-pre 1,046 1/19/2017
5.0.235-pre 1,035 1/19/2017
5.0.234-pre 1,026 1/17/2017
5.0.233-pre 4,569 1/12/2017
5.0.232-pre 1,012 1/9/2017
5.0.230-pre 1,079 1/9/2017
5.0.229-pre 1,043 1/6/2017
5.0.226-pre 1,084 1/5/2017
5.0.224-pre 1,059 1/5/2017
5.0.223-pre 2,864 12/29/2016
5.0.222-pre 1,620 12/28/2016
5.0.220-pre 1,071 12/22/2016
5.0.219-pre 2,841 12/16/2016
5.0.216-pre 1,041 12/15/2016
5.0.214-pre 1,653 12/13/2016
5.0.213-pre 2,479 12/13/2016
5.0.212-pre 1,064 12/13/2016
5.0.211-pre 2,432 12/10/2016
5.0.209-pre 1,120 12/9/2016
5.0.205-pre 1,650 12/6/2016
5.0.203-pre 1,631 12/6/2016
5.0.202-pre 1,080 12/6/2016
5.0.199-pre 1,076 12/5/2016
5.0.198-pre 1,073 12/5/2016
5.0.197-pre 1,102 12/2/2016
5.0.196-pre 1,097 11/30/2016
5.0.193-pre 1,627 11/29/2016
5.0.190-pre 1,119 11/29/2016
5.0.189-pre 2,089 11/29/2016
5.0.186-pre 1,655 11/29/2016
5.0.185-pre 1,100 11/29/2016
5.0.183-pre 1,104 11/29/2016
5.0.182-pre 1,097 11/29/2016
5.0.181-pre 1,608 11/28/2016
5.0.180-pre 1,072 11/28/2016
5.0.177-pre 1,072 11/28/2016
5.0.175-pre 1,025 11/28/2016
5.0.174-pre 1,100 11/28/2016
5.0.173-pre 1,109 11/28/2016
5.0.171-pre 1,072 11/26/2016
5.0.170-pre 1,599 11/25/2016
5.0.169-pre 1,643 11/23/2016
5.0.167-pre 1,646 11/18/2016
5.0.166-pre 1,109 11/18/2016
5.0.159-pre 1,058 11/17/2016
2.0.153-pre 1,212 11/16/2016
2.0.150-pre 1,536 11/15/2016
2.0.149-pre 1,045 11/15/2016
2.0.148-pre 1,051 11/15/2016
2.0.140-pre 1,047 11/9/2016
2.0.137-pre 1,014 11/9/2016
2.0.135-pre 2,532 10/26/2016
2.0.105-pre 1,972 10/5/2016
2.0.104-pre 1,066 10/5/2016
2.0.103-pre 1,055 10/5/2016
2.0.101-pre 2,392 10/3/2016
2.0.100-pre 1,037 10/3/2016
2.0.99-pre 1,053 9/30/2016
2.0.98-pre 1,055 9/30/2016
2.0.95-pre 1,046 9/28/2016
2.0.94-pre 1,109 9/27/2016
1.0.318 1,390 5/4/2017
1.0.305 4,404 3/17/2017
1.0.269 4,686 2/20/2017
1.0.267 4,259 2/16/2017
1.0.264 1,420 2/16/2017
1.0.231 4,672 1/9/2017
1.0.228 2,712 1/6/2017
1.0.227 1,452 1/6/2017
1.0.210 4,256 12/9/2016
1.0.207 1,509 12/8/2016
1.0.204 2,136 12/6/2016
1.0.195 2,171 11/30/2016
1.0.192 1,515 11/29/2016
1.0.187 2,274 11/29/2016
1.0.184 1,506 11/29/2016
1.0.176 2,166 11/28/2016
1.0.168 2,758 11/18/2016
1.0.165 1,426 11/18/2016
1.0.164 1,415 11/18/2016
1.0.147 3,817 11/15/2016
1.0.143 1,426 11/10/2016
1.0.142 1,439 11/10/2016
1.0.141 1,417 11/9/2016
1.0.138 1,393 11/9/2016
1.0.136 1,588 11/9/2016
1.0.131 2,188 10/21/2016
1.0.130 1,470 10/21/2016
1.0.129 2,749 10/21/2016
1.0.128 2,142 10/21/2016
1.0.127 1,467 10/21/2016
1.0.126 1,443 10/21/2016
1.0.125 2,087 10/21/2016
1.0.124 2,158 10/20/2016
1.0.123 1,497 10/19/2016
1.0.122 1,411 10/19/2016
1.0.120 1,418 10/19/2016
1.0.119 2,135 10/18/2016
1.0.115 1,446 10/10/2016
1.0.114 1,402 10/10/2016
1.0.108 2,909 10/7/2016
1.0.102 2,197 10/3/2016
1.0.97 2,057 9/30/2016
1.0.96 1,433 9/30/2016
1.0.91 2,312 9/23/2016
1.0.87 5,425 9/20/2016
1.0.86 3,257 9/16/2016
1.0.85 1,428 9/16/2016
1.0.84 1,990 9/15/2016
1.0.82 4,456 9/13/2016
1.0.81 1,516 9/13/2016
1.0.80 2,010 9/13/2016
1.0.78 1,258 9/13/2016