Foundatio.Parsers.LuceneQueries 7.17.11

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

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

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. 
.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.11 2,875 9/27/2024
7.17.10 2,247 9/4/2024
7.17.9 506 8/31/2024
7.17.8 148 8/31/2024
7.17.7 19,434 3/27/2024
7.17.6 14,242 1/5/2024
7.17.4 17,175 6/23/2023
7.17.3 34,959 1/1/2023
7.17.2 34,419 5/18/2022
7.17.1 7,825 3/10/2022
7.17.0 1,633 3/7/2022
7.16.2 10,114 1/21/2022
7.16.1 1,885 1/21/2022
7.16.0 1,825 1/20/2022
7.15.1 4,330 10/15/2021
7.15.0 2,030 10/11/2021
7.13.0 12,954 7/8/2021
7.12.0 36,796 4/13/2021
7.11.0 748 2/18/2021
7.10.3 26,794 2/1/2021
7.10.2 5,007 1/15/2021
7.10.1 708 1/15/2021
7.10.0 10,339 11/17/2020
7.9.0 4,762 9/16/2020
7.9.0-beta5 1,009 9/15/2020
7.9.0-beta4 491 9/15/2020
7.9.0-beta3 1,216 8/28/2020
7.9.0-beta2 919 8/27/2020
7.9.0-beta1 977 8/25/2020
7.8.0-beta9 2,685 8/3/2020
7.8.0-beta8 1,750 7/29/2020
7.8.0-beta7 1,295 7/9/2020
7.8.0-beta12 982 8/10/2020
7.8.0-beta11 1,064 8/6/2020
7.8.0-beta10 629 8/5/2020
7.7.0-beta6 567 7/2/2020
7.7.0-beta5 1,233 6/20/2020
7.7.0-beta4 1,043 6/14/2020
7.7.0-beta3 1,176 6/6/2020
7.7.0-beta2 1,147 5/26/2020
7.6.2 23,068 3/25/2020
7.6.1 850 3/25/2020
7.6.0 3,424 2/27/2020
7.5.4 2,825 2/13/2020
7.5.3 1,806 2/10/2020
7.5.2 2,560 1/28/2020
7.5.1 2,484 1/17/2020
7.5.0 1,517 1/16/2020
7.5.0-rc1 599 1/14/2020
7.0.497 16,733 6/27/2019
5.6.521 3,870 9/19/2019
5.6.517 913 9/19/2019
5.6.508 3,103 8/30/2019
5.6.477 9,478 4/16/2019
5.6.445 2,689 3/15/2019
5.6.443 1,689 3/14/2019
5.6.441 1,665 3/14/2019
5.6.438 6,049 2/22/2019
5.6.436 976 2/22/2019
5.6.429 7,040 1/30/2019
5.6.398 8,482 11/9/2018
5.6.396 1,815 11/9/2018
5.6.389 9,936 9/7/2018
5.6.386 4,172 5/9/2018
5.6.365 3,405 11/30/2017
5.0.353 6,025 9/14/2017
5.0.350 1,380 9/14/2017
5.0.348 3,084 8/17/2017
5.0.339 1,340 7/24/2017
5.0.336 1,934 6/23/2017
5.0.323 1,212 5/5/2017
5.0.302-pre 835 3/17/2017
5.0.301-pre 835 3/16/2017
5.0.300-pre 859 3/16/2017
5.0.299-pre 809 3/16/2017
5.0.295-pre 800 3/16/2017
5.0.293-pre 936 3/11/2017
5.0.292-pre 859 3/11/2017
5.0.274-pre 2,073 3/5/2017
5.0.273-pre 2,085 2/28/2017
5.0.271-pre 1,490 2/28/2017
5.0.270-pre 904 2/28/2017
5.0.268-pre 1,016 2/20/2017
5.0.266-pre 6,062 2/16/2017
5.0.263-pre 1,572 2/15/2017
5.0.261-pre 1,488 2/15/2017
5.0.260-pre 1,488 2/14/2017
5.0.259-pre 1,561 2/14/2017
5.0.258-pre 979 2/8/2017
5.0.255-pre 940 2/7/2017
5.0.254-pre 2,091 2/6/2017
5.0.253-pre 1,395 2/6/2017
5.0.252-pre 1,401 2/4/2017
5.0.251-pre 1,406 2/3/2017
5.0.250-pre 905 2/3/2017
5.0.248-pre 902 2/2/2017
5.0.246-pre 2,351 1/30/2017
5.0.245-pre 937 1/29/2017
5.0.244-pre 924 1/28/2017
5.0.243-pre 912 1/27/2017
5.0.242-pre 932 1/27/2017
5.0.241-pre 906 1/24/2017
5.0.239-pre 923 1/19/2017
5.0.238-pre 926 1/19/2017
5.0.237-pre 929 1/19/2017
5.0.235-pre 921 1/19/2017
5.0.234-pre 910 1/17/2017
5.0.233-pre 4,454 1/12/2017
5.0.232-pre 898 1/9/2017
5.0.230-pre 962 1/9/2017
5.0.229-pre 929 1/6/2017
5.0.226-pre 970 1/5/2017
5.0.224-pre 946 1/5/2017
5.0.223-pre 2,750 12/29/2016
5.0.222-pre 1,505 12/28/2016
5.0.220-pre 957 12/22/2016
5.0.219-pre 2,727 12/16/2016
5.0.216-pre 927 12/15/2016
5.0.214-pre 1,536 12/13/2016
5.0.213-pre 2,365 12/13/2016
5.0.212-pre 949 12/13/2016
5.0.211-pre 2,316 12/10/2016
5.0.209-pre 1,007 12/9/2016
5.0.205-pre 1,536 12/6/2016
5.0.203-pre 1,516 12/6/2016
5.0.202-pre 966 12/6/2016
5.0.199-pre 961 12/5/2016
5.0.198-pre 959 12/5/2016
5.0.197-pre 988 12/2/2016
5.0.196-pre 982 11/30/2016
5.0.193-pre 1,513 11/29/2016
5.0.190-pre 1,004 11/29/2016
5.0.189-pre 1,975 11/29/2016
5.0.186-pre 1,526 11/29/2016
5.0.185-pre 986 11/29/2016
5.0.183-pre 990 11/29/2016
5.0.182-pre 981 11/29/2016
5.0.181-pre 1,493 11/28/2016
5.0.180-pre 958 11/28/2016
5.0.177-pre 958 11/28/2016
5.0.175-pre 911 11/28/2016
5.0.174-pre 985 11/28/2016
5.0.173-pre 994 11/28/2016
5.0.171-pre 957 11/26/2016
5.0.170-pre 1,486 11/25/2016
5.0.169-pre 1,529 11/23/2016
5.0.167-pre 1,532 11/18/2016
5.0.166-pre 995 11/18/2016
5.0.159-pre 942 11/17/2016
2.0.153-pre 1,041 11/16/2016
2.0.150-pre 1,424 11/15/2016
2.0.149-pre 933 11/15/2016
2.0.148-pre 938 11/15/2016
2.0.140-pre 931 11/9/2016
2.0.137-pre 902 11/9/2016
2.0.135-pre 2,418 10/26/2016
2.0.105-pre 1,858 10/5/2016
2.0.104-pre 954 10/5/2016
2.0.103-pre 940 10/5/2016
2.0.101-pre 2,277 10/3/2016
2.0.100-pre 923 10/3/2016
2.0.99-pre 941 9/30/2016
2.0.98-pre 942 9/30/2016
2.0.95-pre 930 9/28/2016
2.0.94-pre 995 9/27/2016
1.0.318 1,272 5/4/2017
1.0.305 4,284 3/17/2017
1.0.269 4,568 2/20/2017
1.0.267 4,139 2/16/2017
1.0.264 1,302 2/16/2017
1.0.231 4,551 1/9/2017
1.0.228 2,591 1/6/2017
1.0.227 1,330 1/6/2017
1.0.210 4,136 12/9/2016
1.0.207 1,384 12/8/2016
1.0.204 2,014 12/6/2016
1.0.195 2,052 11/30/2016
1.0.192 1,394 11/29/2016
1.0.187 2,154 11/29/2016
1.0.184 1,387 11/29/2016
1.0.176 2,047 11/28/2016
1.0.168 2,639 11/18/2016
1.0.165 1,303 11/18/2016
1.0.164 1,291 11/18/2016
1.0.147 3,693 11/15/2016
1.0.143 1,309 11/10/2016
1.0.142 1,320 11/10/2016
1.0.141 1,296 11/9/2016
1.0.138 1,272 11/9/2016
1.0.136 1,468 11/9/2016
1.0.131 2,071 10/21/2016
1.0.130 1,353 10/21/2016
1.0.129 2,631 10/21/2016
1.0.128 2,022 10/21/2016
1.0.127 1,348 10/21/2016
1.0.126 1,324 10/21/2016
1.0.125 1,968 10/21/2016
1.0.124 2,040 10/20/2016
1.0.123 1,374 10/19/2016
1.0.122 1,290 10/19/2016
1.0.120 1,298 10/19/2016
1.0.119 2,017 10/18/2016
1.0.115 1,327 10/10/2016
1.0.114 1,281 10/10/2016
1.0.108 2,791 10/7/2016
1.0.102 2,077 10/3/2016
1.0.97 1,940 9/30/2016
1.0.96 1,315 9/30/2016
1.0.91 2,194 9/23/2016
1.0.87 5,308 9/20/2016
1.0.86 3,140 9/16/2016
1.0.85 1,305 9/16/2016
1.0.84 1,871 9/15/2016
1.0.82 4,333 9/13/2016
1.0.81 1,397 9/13/2016
1.0.80 1,891 9/13/2016
1.0.78 1,131 9/13/2016