Foundatio.Parsers.LuceneQueries 7.17.17

Prefix Reserved
dotnet add package Foundatio.Parsers.LuceneQueries --version 7.17.17
                    
NuGet\Install-Package Foundatio.Parsers.LuceneQueries -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.LuceneQueries" 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.LuceneQueries" Version="7.17.17" />
                    
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.17
                    
#r "nuget: Foundatio.Parsers.LuceneQueries, 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.LuceneQueries&version=7.17.17
                    
Install Foundatio.Parsers.LuceneQueries as a Cake Addin
#tool nuget:?package=Foundatio.Parsers.LuceneQueries&version=7.17.17
                    
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.  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.
  • .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.17 1,323 14 days ago
7.17.16 1,498 17 days ago
7.17.15 247 19 days ago
7.17.14 9,397 4 months ago
7.17.13 6,867 5 months ago
7.17.12 4,034 6 months ago
7.17.11 5,848 8 months ago
7.17.10 6,122 9 months ago
7.17.9 549 9 months ago
7.17.8 181 9 months ago
7.17.7 30,862 3/27/2024
7.17.6 18,488 1/5/2024
7.17.4 18,265 6/23/2023
7.17.3 37,980 1/1/2023
7.17.2 34,560 5/18/2022
7.17.1 7,867 3/10/2022
7.17.0 1,672 3/7/2022
7.16.2 10,163 1/21/2022
7.16.1 1,934 1/21/2022
7.16.0 1,866 1/20/2022
7.15.1 4,385 10/15/2021
7.15.0 2,094 10/11/2021
7.13.0 16,395 7/8/2021
7.12.0 37,205 4/13/2021
7.11.0 798 2/18/2021
7.10.3 26,929 2/1/2021
7.10.2 5,065 1/15/2021
7.10.1 766 1/15/2021
7.10.0 10,411 11/17/2020
7.9.0 4,838 9/16/2020
7.9.0-beta5 1,056 9/15/2020
7.9.0-beta4 538 9/15/2020
7.9.0-beta3 1,263 8/28/2020
7.9.0-beta2 969 8/27/2020
7.9.0-beta1 1,024 8/25/2020
7.8.0-beta9 2,729 8/3/2020
7.8.0-beta8 1,803 7/29/2020
7.8.0-beta7 1,342 7/9/2020
7.8.0-beta12 1,028 8/10/2020
7.8.0-beta11 1,114 8/6/2020
7.8.0-beta10 676 8/5/2020
7.7.0-beta6 613 7/2/2020
7.7.0-beta5 1,280 6/20/2020
7.7.0-beta4 1,092 6/14/2020
7.7.0-beta3 1,225 6/6/2020
7.7.0-beta2 1,214 5/26/2020
7.6.2 23,156 3/25/2020
7.6.1 904 3/25/2020
7.6.0 3,480 2/27/2020
7.5.4 2,880 2/13/2020
7.5.3 1,861 2/10/2020
7.5.2 2,615 1/28/2020
7.5.1 2,539 1/17/2020
7.5.0 1,577 1/16/2020
7.5.0-rc1 651 1/14/2020
7.0.497 16,816 6/27/2019
5.6.521 4,118 9/19/2019
5.6.517 970 9/19/2019
5.6.508 3,161 8/30/2019
5.6.477 9,746 4/16/2019
5.6.445 2,752 3/15/2019
5.6.443 1,750 3/14/2019
5.6.441 1,727 3/14/2019
5.6.438 6,114 2/22/2019
5.6.436 1,037 2/22/2019
5.6.429 7,363 1/30/2019
5.6.398 8,555 11/9/2018
5.6.396 1,887 11/9/2018
5.6.389 10,022 9/7/2018
5.6.386 4,362 5/9/2018
5.6.365 3,606 11/30/2017
5.0.353 6,180 9/14/2017
5.0.350 1,521 9/14/2017
5.0.348 3,223 8/17/2017
5.0.339 1,475 7/24/2017
5.0.336 2,077 6/23/2017
5.0.323 1,350 5/5/2017
5.0.302-pre 967 3/17/2017
5.0.301-pre 966 3/16/2017
5.0.300-pre 980 3/16/2017
5.0.299-pre 939 3/16/2017
5.0.295-pre 931 3/16/2017
5.0.293-pre 1,067 3/11/2017
5.0.292-pre 990 3/11/2017
5.0.274-pre 2,222 3/5/2017
5.0.273-pre 2,215 2/28/2017
5.0.271-pre 1,621 2/28/2017
5.0.270-pre 1,035 2/28/2017
5.0.268-pre 1,147 2/20/2017
5.0.266-pre 6,193 2/16/2017
5.0.263-pre 1,702 2/15/2017
5.0.261-pre 1,618 2/15/2017
5.0.260-pre 1,618 2/14/2017
5.0.259-pre 1,694 2/14/2017
5.0.258-pre 1,109 2/8/2017
5.0.255-pre 1,071 2/7/2017
5.0.254-pre 2,233 2/6/2017
5.0.253-pre 1,525 2/6/2017
5.0.252-pre 1,530 2/4/2017
5.0.251-pre 1,537 2/3/2017
5.0.250-pre 1,037 2/3/2017
5.0.248-pre 1,034 2/2/2017
5.0.246-pre 2,481 1/30/2017
5.0.245-pre 1,067 1/29/2017
5.0.244-pre 1,055 1/28/2017
5.0.243-pre 1,043 1/27/2017
5.0.242-pre 1,065 1/27/2017
5.0.241-pre 1,039 1/24/2017
5.0.239-pre 1,054 1/19/2017
5.0.238-pre 1,058 1/19/2017
5.0.237-pre 1,063 1/19/2017
5.0.235-pre 1,052 1/19/2017
5.0.234-pre 1,043 1/17/2017
5.0.233-pre 4,595 1/12/2017
5.0.232-pre 1,029 1/9/2017
5.0.230-pre 1,096 1/9/2017
5.0.229-pre 1,060 1/6/2017
5.0.226-pre 1,102 1/5/2017
5.0.224-pre 1,076 1/5/2017
5.0.223-pre 2,881 12/29/2016
5.0.222-pre 1,637 12/28/2016
5.0.220-pre 1,088 12/22/2016
5.0.219-pre 2,859 12/16/2016
5.0.216-pre 1,058 12/15/2016
5.0.214-pre 1,670 12/13/2016
5.0.213-pre 2,496 12/13/2016
5.0.212-pre 1,081 12/13/2016
5.0.211-pre 2,449 12/10/2016
5.0.209-pre 1,137 12/9/2016
5.0.205-pre 1,667 12/6/2016
5.0.203-pre 1,648 12/6/2016
5.0.202-pre 1,097 12/6/2016
5.0.199-pre 1,093 12/5/2016
5.0.198-pre 1,091 12/5/2016
5.0.197-pre 1,119 12/2/2016
5.0.196-pre 1,114 11/30/2016
5.0.193-pre 1,644 11/29/2016
5.0.190-pre 1,136 11/29/2016
5.0.189-pre 2,106 11/29/2016
5.0.186-pre 1,672 11/29/2016
5.0.185-pre 1,117 11/29/2016
5.0.183-pre 1,121 11/29/2016
5.0.182-pre 1,114 11/29/2016
5.0.181-pre 1,625 11/28/2016
5.0.180-pre 1,089 11/28/2016
5.0.177-pre 1,089 11/28/2016
5.0.175-pre 1,042 11/28/2016
5.0.174-pre 1,118 11/28/2016
5.0.173-pre 1,126 11/28/2016
5.0.171-pre 1,089 11/26/2016
5.0.170-pre 1,616 11/25/2016
5.0.169-pre 1,660 11/23/2016
5.0.167-pre 1,663 11/18/2016
5.0.166-pre 1,127 11/18/2016
5.0.159-pre 1,075 11/17/2016
2.0.153-pre 1,235 11/16/2016
2.0.150-pre 1,553 11/15/2016
2.0.149-pre 1,062 11/15/2016
2.0.148-pre 1,068 11/15/2016
2.0.140-pre 1,064 11/9/2016
2.0.137-pre 1,031 11/9/2016
2.0.135-pre 2,549 10/26/2016
2.0.105-pre 1,989 10/5/2016
2.0.104-pre 1,084 10/5/2016
2.0.103-pre 1,072 10/5/2016
2.0.101-pre 2,409 10/3/2016
2.0.100-pre 1,054 10/3/2016
2.0.99-pre 1,070 9/30/2016
2.0.98-pre 1,072 9/30/2016
2.0.95-pre 1,063 9/28/2016
2.0.94-pre 1,126 9/27/2016
1.0.318 1,408 5/4/2017
1.0.305 4,422 3/17/2017
1.0.269 4,704 2/20/2017
1.0.267 4,278 2/16/2017
1.0.264 1,438 2/16/2017
1.0.231 4,690 1/9/2017
1.0.228 2,730 1/6/2017
1.0.227 1,470 1/6/2017
1.0.210 4,274 12/9/2016
1.0.207 1,527 12/8/2016
1.0.204 2,154 12/6/2016
1.0.195 2,189 11/30/2016
1.0.192 1,533 11/29/2016
1.0.187 2,297 11/29/2016
1.0.184 1,524 11/29/2016
1.0.176 2,185 11/28/2016
1.0.168 2,776 11/18/2016
1.0.165 1,444 11/18/2016
1.0.164 1,433 11/18/2016
1.0.147 3,835 11/15/2016
1.0.143 1,445 11/10/2016
1.0.142 1,457 11/10/2016
1.0.141 1,435 11/9/2016
1.0.138 1,411 11/9/2016
1.0.136 1,606 11/9/2016
1.0.131 2,206 10/21/2016
1.0.130 1,488 10/21/2016
1.0.129 2,767 10/21/2016
1.0.128 2,160 10/21/2016
1.0.127 1,485 10/21/2016
1.0.126 1,462 10/21/2016
1.0.125 2,105 10/21/2016
1.0.124 2,177 10/20/2016
1.0.123 1,515 10/19/2016
1.0.122 1,435 10/19/2016
1.0.120 1,436 10/19/2016
1.0.119 2,153 10/18/2016
1.0.115 1,464 10/10/2016
1.0.114 1,420 10/10/2016
1.0.108 2,927 10/7/2016
1.0.102 2,215 10/3/2016
1.0.97 2,075 9/30/2016
1.0.96 1,451 9/30/2016
1.0.91 2,330 9/23/2016
1.0.87 5,443 9/20/2016
1.0.86 3,276 9/16/2016
1.0.85 1,447 9/16/2016
1.0.84 2,008 9/15/2016
1.0.82 4,474 9/13/2016
1.0.81 1,534 9/13/2016
1.0.80 2,028 9/13/2016
1.0.78 1,283 9/13/2016