Foundatio.Parsers.LuceneQueries 7.17.2

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Foundatio.Parsers.LuceneQueries --version 7.17.2
NuGet\Install-Package Foundatio.Parsers.LuceneQueries -Version 7.17.2
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.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Foundatio.Parsers.LuceneQueries --version 7.17.2
#r "nuget: Foundatio.Parsers.LuceneQueries, 7.17.2"
#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.
// Install Foundatio.Parsers.LuceneQueries as a Cake Addin
#addin nuget:?package=Foundatio.Parsers.LuceneQueries&version=7.17.2

// Install Foundatio.Parsers.LuceneQueries as a Cake Tool
#tool nuget:?package=Foundatio.Parsers.LuceneQueries&version=7.17.2

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);

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. 
.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 (1)

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

Package Downloads
Foundatio.Parsers.ElasticQueries The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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.7 64 3/27/2024
7.17.6 7,620 1/5/2024
7.17.4 12,100 6/23/2023
7.17.3 27,774 1/1/2023
7.17.2 34,041 5/18/2022
7.17.1 7,740 3/10/2022
7.17.0 1,530 3/7/2022
7.16.2 10,040 1/21/2022
7.16.1 1,792 1/21/2022
7.16.0 1,749 1/20/2022
7.15.1 4,274 10/15/2021
7.15.0 1,906 10/11/2021
7.13.0 9,936 7/8/2021
7.12.0 34,465 4/13/2021
7.11.0 711 2/18/2021
7.10.3 26,534 2/1/2021
7.10.2 4,858 1/15/2021
7.10.1 668 1/15/2021
7.10.0 10,173 11/17/2020
7.9.0 4,579 9/16/2020
7.9.0-beta5 933 9/15/2020
7.9.0-beta4 458 9/15/2020
7.9.0-beta3 1,117 8/28/2020
7.9.0-beta2 839 8/27/2020
7.9.0-beta1 912 8/25/2020
7.8.0-beta9 2,652 8/3/2020
7.8.0-beta8 1,674 7/29/2020
7.8.0-beta7 1,185 7/9/2020
7.8.0-beta12 896 8/10/2020
7.8.0-beta11 985 8/6/2020
7.8.0-beta10 594 8/5/2020
7.7.0-beta6 520 7/2/2020
7.7.0-beta5 1,158 6/20/2020
7.7.0-beta4 954 6/14/2020
7.7.0-beta3 1,064 6/6/2020
7.7.0-beta2 1,067 5/26/2020
7.6.2 22,955 3/25/2020
7.6.1 812 3/25/2020
7.6.0 3,360 2/27/2020
7.5.4 2,743 2/13/2020
7.5.3 1,696 2/10/2020
7.5.2 2,496 1/28/2020
7.5.1 2,398 1/17/2020
7.5.0 1,427 1/16/2020
7.5.0-rc1 555 1/14/2020
7.0.497 16,462 6/27/2019
5.6.521 3,291 9/19/2019
5.6.517 867 9/19/2019
5.6.508 2,997 8/30/2019
5.6.477 9,316 4/16/2019
5.6.445 2,593 3/15/2019
5.6.443 1,613 3/14/2019
5.6.441 1,587 3/14/2019
5.6.438 5,909 2/22/2019
5.6.436 937 2/22/2019
5.6.429 6,997 1/30/2019
5.6.398 8,331 11/9/2018
5.6.396 1,721 11/9/2018
5.6.389 9,715 9/7/2018
5.6.386 4,026 5/9/2018
5.6.365 3,174 11/30/2017
5.0.353 5,773 9/14/2017
5.0.350 1,318 9/14/2017
5.0.348 2,915 8/17/2017
5.0.339 1,309 7/24/2017
5.0.336 1,898 6/23/2017
5.0.323 1,194 5/5/2017
5.0.302-pre 811 3/17/2017
5.0.301-pre 807 3/16/2017
5.0.300-pre 835 3/16/2017
5.0.299-pre 787 3/16/2017
5.0.295-pre 778 3/16/2017
5.0.293-pre 913 3/11/2017
5.0.292-pre 835 3/11/2017
5.0.274-pre 1,936 3/5/2017
5.0.273-pre 1,969 2/28/2017
5.0.271-pre 1,425 2/28/2017
5.0.270-pre 867 2/28/2017
5.0.268-pre 976 2/20/2017
5.0.266-pre 5,603 2/16/2017
5.0.263-pre 1,508 2/15/2017
5.0.261-pre 1,406 2/15/2017
5.0.260-pre 1,415 2/14/2017
5.0.259-pre 1,472 2/14/2017
5.0.258-pre 939 2/8/2017
5.0.255-pre 896 2/7/2017
5.0.254-pre 1,945 2/6/2017
5.0.253-pre 1,318 2/6/2017
5.0.252-pre 1,323 2/4/2017
5.0.251-pre 1,336 2/3/2017
5.0.250-pre 878 2/3/2017
5.0.248-pre 868 2/2/2017
5.0.246-pre 2,198 1/30/2017
5.0.245-pre 891 1/29/2017
5.0.244-pre 894 1/28/2017
5.0.243-pre 876 1/27/2017
5.0.242-pre 897 1/27/2017
5.0.241-pre 882 1/24/2017
5.0.239-pre 887 1/19/2017
5.0.238-pre 902 1/19/2017
5.0.237-pre 893 1/19/2017
5.0.235-pre 879 1/19/2017
5.0.234-pre 869 1/17/2017
5.0.233-pre 4,137 1/12/2017
5.0.232-pre 864 1/9/2017
5.0.230-pre 926 1/9/2017
5.0.229-pre 894 1/6/2017
5.0.226-pre 927 1/5/2017
5.0.224-pre 911 1/5/2017
5.0.223-pre 2,549 12/29/2016
5.0.222-pre 1,432 12/28/2016
5.0.220-pre 914 12/22/2016
5.0.219-pre 2,502 12/16/2016
5.0.216-pre 885 12/15/2016
5.0.214-pre 1,442 12/13/2016
5.0.213-pre 2,200 12/13/2016
5.0.212-pre 916 12/13/2016
5.0.211-pre 2,137 12/10/2016
5.0.209-pre 970 12/9/2016
5.0.205-pre 1,444 12/6/2016
5.0.203-pre 1,434 12/6/2016
5.0.202-pre 932 12/6/2016
5.0.199-pre 924 12/5/2016
5.0.198-pre 929 12/5/2016
5.0.197-pre 956 12/2/2016
5.0.196-pre 944 11/30/2016
5.0.193-pre 1,428 11/29/2016
5.0.190-pre 963 11/29/2016
5.0.189-pre 1,854 11/29/2016
5.0.186-pre 1,439 11/29/2016
5.0.185-pre 948 11/29/2016
5.0.183-pre 946 11/29/2016
5.0.182-pre 940 11/29/2016
5.0.181-pre 1,408 11/28/2016
5.0.180-pre 919 11/28/2016
5.0.177-pre 921 11/28/2016
5.0.175-pre 875 11/28/2016
5.0.174-pre 945 11/28/2016
5.0.173-pre 961 11/28/2016
5.0.171-pre 920 11/26/2016
5.0.170-pre 1,406 11/25/2016
5.0.169-pre 1,444 11/23/2016
5.0.167-pre 1,436 11/18/2016
5.0.166-pre 965 11/18/2016
5.0.159-pre 903 11/17/2016
2.0.153-pre 1,002 11/16/2016
2.0.150-pre 1,350 11/15/2016
2.0.149-pre 889 11/15/2016
2.0.148-pre 894 11/15/2016
2.0.140-pre 888 11/9/2016
2.0.137-pre 866 11/9/2016
2.0.135-pre 2,257 10/26/2016
2.0.105-pre 1,725 10/5/2016
2.0.104-pre 912 10/5/2016
2.0.103-pre 903 10/5/2016
2.0.101-pre 2,134 10/3/2016
2.0.100-pre 880 10/3/2016
2.0.99-pre 904 9/30/2016
2.0.98-pre 908 9/30/2016
2.0.95-pre 893 9/28/2016
2.0.94-pre 957 9/27/2016
1.0.318 1,225 5/4/2017
1.0.305 4,071 3/17/2017
1.0.269 4,331 2/20/2017
1.0.267 3,950 2/16/2017
1.0.264 1,262 2/16/2017
1.0.231 4,319 1/9/2017
1.0.228 2,475 1/6/2017
1.0.227 1,276 1/6/2017
1.0.210 3,945 12/9/2016
1.0.207 1,343 12/8/2016
1.0.204 1,919 12/6/2016
1.0.195 1,974 11/30/2016
1.0.192 1,350 11/29/2016
1.0.187 2,062 11/29/2016
1.0.184 1,344 11/29/2016
1.0.176 1,957 11/28/2016
1.0.168 2,516 11/18/2016
1.0.165 1,260 11/18/2016
1.0.164 1,244 11/18/2016
1.0.147 3,512 11/15/2016
1.0.143 1,265 11/10/2016
1.0.142 1,284 11/10/2016
1.0.141 1,259 11/9/2016
1.0.138 1,235 11/9/2016
1.0.136 1,433 11/9/2016
1.0.131 2,007 10/21/2016
1.0.130 1,316 10/21/2016
1.0.129 2,517 10/21/2016
1.0.128 1,950 10/21/2016
1.0.127 1,300 10/21/2016
1.0.126 1,281 10/21/2016
1.0.125 1,897 10/21/2016
1.0.124 1,962 10/20/2016
1.0.123 1,327 10/19/2016
1.0.122 1,253 10/19/2016
1.0.120 1,256 10/19/2016
1.0.119 1,950 10/18/2016
1.0.115 1,281 10/10/2016
1.0.114 1,234 10/10/2016
1.0.108 2,663 10/7/2016
1.0.102 1,933 10/3/2016
1.0.97 1,860 9/30/2016
1.0.96 1,269 9/30/2016
1.0.91 2,118 9/23/2016
1.0.87 5,038 9/20/2016
1.0.86 2,925 9/16/2016
1.0.85 1,260 9/16/2016
1.0.84 1,799 9/15/2016
1.0.82 4,071 9/13/2016
1.0.81 1,352 9/13/2016
1.0.80 1,770 9/13/2016
1.0.78 1,086 9/13/2016