Foundatio.Parsers.LuceneQueries 7.17.7

Prefix Reserved
dotnet add package Foundatio.Parsers.LuceneQueries --version 7.17.7                
NuGet\Install-Package Foundatio.Parsers.LuceneQueries -Version 7.17.7                
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.7" />                
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.7                
#r "nuget: Foundatio.Parsers.LuceneQueries, 7.17.7"                
#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.7

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

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

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 8,560 3/27/2024
7.17.6 11,232 1/5/2024
7.17.4 16,073 6/23/2023
7.17.3 32,341 1/1/2023
7.17.2 34,225 5/18/2022
7.17.1 7,777 3/10/2022
7.17.0 1,573 3/7/2022
7.16.2 10,065 1/21/2022
7.16.1 1,829 1/21/2022
7.16.0 1,778 1/20/2022
7.15.1 4,289 10/15/2021
7.15.0 1,949 10/11/2021
7.13.0 11,412 7/8/2021
7.12.0 36,082 4/13/2021
7.11.0 718 2/18/2021
7.10.3 26,631 2/1/2021
7.10.2 4,942 1/15/2021
7.10.1 672 1/15/2021
7.10.0 10,263 11/17/2020
7.9.0 4,669 9/16/2020
7.9.0-beta5 961 9/15/2020
7.9.0-beta4 461 9/15/2020
7.9.0-beta3 1,160 8/28/2020
7.9.0-beta2 872 8/27/2020
7.9.0-beta1 940 8/25/2020
7.8.0-beta9 2,655 8/3/2020
7.8.0-beta8 1,708 7/29/2020
7.8.0-beta7 1,212 7/9/2020
7.8.0-beta12 929 8/10/2020
7.8.0-beta11 1,019 8/6/2020
7.8.0-beta10 596 8/5/2020
7.7.0-beta6 530 7/2/2020
7.7.0-beta5 1,190 6/20/2020
7.7.0-beta4 987 6/14/2020
7.7.0-beta3 1,090 6/6/2020
7.7.0-beta2 1,095 5/26/2020
7.6.2 22,999 3/25/2020
7.6.1 817 3/25/2020
7.6.0 3,384 2/27/2020
7.5.4 2,778 2/13/2020
7.5.3 1,746 2/10/2020
7.5.2 2,510 1/28/2020
7.5.1 2,429 1/17/2020
7.5.0 1,466 1/16/2020
7.5.0-rc1 560 1/14/2020
7.0.497 16,619 6/27/2019
5.6.521 3,507 9/19/2019
5.6.517 871 9/19/2019
5.6.508 3,048 8/30/2019
5.6.477 9,386 4/16/2019
5.6.445 2,636 3/15/2019
5.6.443 1,640 3/14/2019
5.6.441 1,619 3/14/2019
5.6.438 5,966 2/22/2019
5.6.436 939 2/22/2019
5.6.429 7,002 1/30/2019
5.6.398 8,409 11/9/2018
5.6.396 1,764 11/9/2018
5.6.389 9,832 9/7/2018
5.6.386 4,104 5/9/2018
5.6.365 3,220 11/30/2017
5.0.353 5,897 9/14/2017
5.0.350 1,322 9/14/2017
5.0.348 2,981 8/17/2017
5.0.339 1,314 7/24/2017
5.0.336 1,909 6/23/2017
5.0.323 1,199 5/5/2017
5.0.302-pre 813 3/17/2017
5.0.301-pre 814 3/16/2017
5.0.300-pre 836 3/16/2017
5.0.299-pre 788 3/16/2017
5.0.295-pre 779 3/16/2017
5.0.293-pre 914 3/11/2017
5.0.292-pre 838 3/11/2017
5.0.274-pre 1,998 3/5/2017
5.0.273-pre 2,020 2/28/2017
5.0.271-pre 1,443 2/28/2017
5.0.270-pre 868 2/28/2017
5.0.268-pre 977 2/20/2017
5.0.266-pre 5,844 2/16/2017
5.0.263-pre 1,533 2/15/2017
5.0.261-pre 1,437 2/15/2017
5.0.260-pre 1,446 2/14/2017
5.0.259-pre 1,501 2/14/2017
5.0.258-pre 940 2/8/2017
5.0.255-pre 897 2/7/2017
5.0.254-pre 2,024 2/6/2017
5.0.253-pre 1,354 2/6/2017
5.0.252-pre 1,354 2/4/2017
5.0.251-pre 1,366 2/3/2017
5.0.250-pre 879 2/3/2017
5.0.248-pre 869 2/2/2017
5.0.246-pre 2,279 1/30/2017
5.0.245-pre 892 1/29/2017
5.0.244-pre 895 1/28/2017
5.0.243-pre 877 1/27/2017
5.0.242-pre 898 1/27/2017
5.0.241-pre 885 1/24/2017
5.0.239-pre 888 1/19/2017
5.0.238-pre 903 1/19/2017
5.0.237-pre 896 1/19/2017
5.0.235-pre 880 1/19/2017
5.0.234-pre 870 1/17/2017
5.0.233-pre 4,335 1/12/2017
5.0.232-pre 865 1/9/2017
5.0.230-pre 927 1/9/2017
5.0.229-pre 895 1/6/2017
5.0.226-pre 928 1/5/2017
5.0.224-pre 912 1/5/2017
5.0.223-pre 2,665 12/29/2016
5.0.222-pre 1,460 12/28/2016
5.0.220-pre 915 12/22/2016
5.0.219-pre 2,634 12/16/2016
5.0.216-pre 886 12/15/2016
5.0.214-pre 1,487 12/13/2016
5.0.213-pre 2,284 12/13/2016
5.0.212-pre 917 12/13/2016
5.0.211-pre 2,240 12/10/2016
5.0.209-pre 971 12/9/2016
5.0.205-pre 1,476 12/6/2016
5.0.203-pre 1,465 12/6/2016
5.0.202-pre 933 12/6/2016
5.0.199-pre 925 12/5/2016
5.0.198-pre 930 12/5/2016
5.0.197-pre 957 12/2/2016
5.0.196-pre 945 11/30/2016
5.0.193-pre 1,460 11/29/2016
5.0.190-pre 964 11/29/2016
5.0.189-pre 1,910 11/29/2016
5.0.186-pre 1,464 11/29/2016
5.0.185-pre 949 11/29/2016
5.0.183-pre 947 11/29/2016
5.0.182-pre 941 11/29/2016
5.0.181-pre 1,441 11/28/2016
5.0.180-pre 920 11/28/2016
5.0.177-pre 922 11/28/2016
5.0.175-pre 876 11/28/2016
5.0.174-pre 952 11/28/2016
5.0.173-pre 962 11/28/2016
5.0.171-pre 921 11/26/2016
5.0.170-pre 1,423 11/25/2016
5.0.169-pre 1,476 11/23/2016
5.0.167-pre 1,476 11/18/2016
5.0.166-pre 966 11/18/2016
5.0.159-pre 904 11/17/2016
2.0.153-pre 1,005 11/16/2016
2.0.150-pre 1,375 11/15/2016
2.0.149-pre 890 11/15/2016
2.0.148-pre 895 11/15/2016
2.0.140-pre 895 11/9/2016
2.0.137-pre 867 11/9/2016
2.0.135-pre 2,344 10/26/2016
2.0.105-pre 1,788 10/5/2016
2.0.104-pre 915 10/5/2016
2.0.103-pre 906 10/5/2016
2.0.101-pre 2,206 10/3/2016
2.0.100-pre 883 10/3/2016
2.0.99-pre 907 9/30/2016
2.0.98-pre 911 9/30/2016
2.0.95-pre 896 9/28/2016
2.0.94-pre 960 9/27/2016
1.0.318 1,230 5/4/2017
1.0.305 4,203 3/17/2017
1.0.269 4,472 2/20/2017
1.0.267 4,044 2/16/2017
1.0.264 1,266 2/16/2017
1.0.231 4,441 1/9/2017
1.0.228 2,535 1/6/2017
1.0.227 1,280 1/6/2017
1.0.210 4,045 12/9/2016
1.0.207 1,347 12/8/2016
1.0.204 1,960 12/6/2016
1.0.195 1,991 11/30/2016
1.0.192 1,354 11/29/2016
1.0.187 2,102 11/29/2016
1.0.184 1,348 11/29/2016
1.0.176 1,992 11/28/2016
1.0.168 2,582 11/18/2016
1.0.165 1,264 11/18/2016
1.0.164 1,248 11/18/2016
1.0.147 3,617 11/15/2016
1.0.143 1,269 11/10/2016
1.0.142 1,288 11/10/2016
1.0.141 1,263 11/9/2016
1.0.138 1,239 11/9/2016
1.0.136 1,437 11/9/2016
1.0.131 2,025 10/21/2016
1.0.130 1,320 10/21/2016
1.0.129 2,568 10/21/2016
1.0.128 1,970 10/21/2016
1.0.127 1,306 10/21/2016
1.0.126 1,287 10/21/2016
1.0.125 1,915 10/21/2016
1.0.124 1,993 10/20/2016
1.0.123 1,331 10/19/2016
1.0.122 1,256 10/19/2016
1.0.120 1,260 10/19/2016
1.0.119 1,977 10/18/2016
1.0.115 1,287 10/10/2016
1.0.114 1,240 10/10/2016
1.0.108 2,729 10/7/2016
1.0.102 1,973 10/3/2016
1.0.97 1,881 9/30/2016
1.0.96 1,275 9/30/2016
1.0.91 2,142 9/23/2016
1.0.87 5,179 9/20/2016
1.0.86 3,055 9/16/2016
1.0.85 1,264 9/16/2016
1.0.84 1,812 9/15/2016
1.0.82 4,217 9/13/2016
1.0.81 1,357 9/13/2016
1.0.80 1,814 9/13/2016
1.0.78 1,097 9/13/2016