Foundatio.Parsers.LuceneQueries 7.17.7

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. 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 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 5,550 3/27/2024
7.17.6 10,795 1/5/2024
7.17.4 15,776 6/23/2023
7.17.3 31,306 1/1/2023
7.17.2 34,210 5/18/2022
7.17.1 7,773 3/10/2022
7.17.0 1,569 3/7/2022
7.16.2 10,057 1/21/2022
7.16.1 1,825 1/21/2022
7.16.0 1,776 1/20/2022
7.15.1 4,286 10/15/2021
7.15.0 1,945 10/11/2021
7.13.0 11,100 7/8/2021
7.12.0 35,700 4/13/2021
7.11.0 714 2/18/2021
7.10.3 26,605 2/1/2021
7.10.2 4,919 1/15/2021
7.10.1 670 1/15/2021
7.10.0 10,260 11/17/2020
7.9.0 4,665 9/16/2020
7.9.0-beta5 960 9/15/2020
7.9.0-beta4 458 9/15/2020
7.9.0-beta3 1,159 8/28/2020
7.9.0-beta2 871 8/27/2020
7.9.0-beta1 939 8/25/2020
7.8.0-beta9 2,654 8/3/2020
7.8.0-beta8 1,707 7/29/2020
7.8.0-beta7 1,211 7/9/2020
7.8.0-beta12 928 8/10/2020
7.8.0-beta11 1,016 8/6/2020
7.8.0-beta10 595 8/5/2020
7.7.0-beta6 529 7/2/2020
7.7.0-beta5 1,187 6/20/2020
7.7.0-beta4 986 6/14/2020
7.7.0-beta3 1,089 6/6/2020
7.7.0-beta2 1,093 5/26/2020
7.6.2 22,998 3/25/2020
7.6.1 816 3/25/2020
7.6.0 3,383 2/27/2020
7.5.4 2,777 2/13/2020
7.5.3 1,745 2/10/2020
7.5.2 2,509 1/28/2020
7.5.1 2,428 1/17/2020
7.5.0 1,465 1/16/2020
7.5.0-rc1 559 1/14/2020
7.0.497 16,618 6/27/2019
5.6.521 3,462 9/19/2019
5.6.517 870 9/19/2019
5.6.508 3,047 8/30/2019
5.6.477 9,382 4/16/2019
5.6.445 2,635 3/15/2019
5.6.443 1,639 3/14/2019
5.6.441 1,618 3/14/2019
5.6.438 5,965 2/22/2019
5.6.436 938 2/22/2019
5.6.429 7,001 1/30/2019
5.6.398 8,403 11/9/2018
5.6.396 1,763 11/9/2018
5.6.389 9,828 9/7/2018
5.6.386 4,103 5/9/2018
5.6.365 3,211 11/30/2017
5.0.353 5,896 9/14/2017
5.0.350 1,321 9/14/2017
5.0.348 2,980 8/17/2017
5.0.339 1,313 7/24/2017
5.0.336 1,907 6/23/2017
5.0.323 1,198 5/5/2017
5.0.302-pre 812 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 837 3/11/2017
5.0.274-pre 1,997 3/5/2017
5.0.273-pre 2,019 2/28/2017
5.0.271-pre 1,442 2/28/2017
5.0.270-pre 867 2/28/2017
5.0.268-pre 976 2/20/2017
5.0.266-pre 5,843 2/16/2017
5.0.263-pre 1,532 2/15/2017
5.0.261-pre 1,435 2/15/2017
5.0.260-pre 1,445 2/14/2017
5.0.259-pre 1,500 2/14/2017
5.0.258-pre 939 2/8/2017
5.0.255-pre 896 2/7/2017
5.0.254-pre 2,023 2/6/2017
5.0.253-pre 1,353 2/6/2017
5.0.252-pre 1,353 2/4/2017
5.0.251-pre 1,365 2/3/2017
5.0.250-pre 878 2/3/2017
5.0.248-pre 868 2/2/2017
5.0.246-pre 2,278 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 884 1/24/2017
5.0.239-pre 887 1/19/2017
5.0.238-pre 902 1/19/2017
5.0.237-pre 895 1/19/2017
5.0.235-pre 879 1/19/2017
5.0.234-pre 869 1/17/2017
5.0.233-pre 4,334 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,659 12/29/2016
5.0.222-pre 1,459 12/28/2016
5.0.220-pre 914 12/22/2016
5.0.219-pre 2,625 12/16/2016
5.0.216-pre 885 12/15/2016
5.0.214-pre 1,486 12/13/2016
5.0.213-pre 2,283 12/13/2016
5.0.212-pre 916 12/13/2016
5.0.211-pre 2,239 12/10/2016
5.0.209-pre 970 12/9/2016
5.0.205-pre 1,475 12/6/2016
5.0.203-pre 1,464 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,459 11/29/2016
5.0.190-pre 963 11/29/2016
5.0.189-pre 1,909 11/29/2016
5.0.186-pre 1,463 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,440 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,422 11/25/2016
5.0.169-pre 1,475 11/23/2016
5.0.167-pre 1,475 11/18/2016
5.0.166-pre 965 11/18/2016
5.0.159-pre 903 11/17/2016
2.0.153-pre 1,004 11/16/2016
2.0.150-pre 1,374 11/15/2016
2.0.149-pre 889 11/15/2016
2.0.148-pre 894 11/15/2016
2.0.140-pre 894 11/9/2016
2.0.137-pre 866 11/9/2016
2.0.135-pre 2,328 10/26/2016
2.0.105-pre 1,785 10/5/2016
2.0.104-pre 914 10/5/2016
2.0.103-pre 905 10/5/2016
2.0.101-pre 2,205 10/3/2016
2.0.100-pre 882 10/3/2016
2.0.99-pre 906 9/30/2016
2.0.98-pre 910 9/30/2016
2.0.95-pre 895 9/28/2016
2.0.94-pre 959 9/27/2016
1.0.318 1,229 5/4/2017
1.0.305 4,202 3/17/2017
1.0.269 4,471 2/20/2017
1.0.267 4,043 2/16/2017
1.0.264 1,265 2/16/2017
1.0.231 4,440 1/9/2017
1.0.228 2,534 1/6/2017
1.0.227 1,279 1/6/2017
1.0.210 4,044 12/9/2016
1.0.207 1,346 12/8/2016
1.0.204 1,959 12/6/2016
1.0.195 1,990 11/30/2016
1.0.192 1,353 11/29/2016
1.0.187 2,101 11/29/2016
1.0.184 1,347 11/29/2016
1.0.176 1,991 11/28/2016
1.0.168 2,581 11/18/2016
1.0.165 1,263 11/18/2016
1.0.164 1,247 11/18/2016
1.0.147 3,616 11/15/2016
1.0.143 1,268 11/10/2016
1.0.142 1,287 11/10/2016
1.0.141 1,262 11/9/2016
1.0.138 1,238 11/9/2016
1.0.136 1,436 11/9/2016
1.0.131 2,024 10/21/2016
1.0.130 1,319 10/21/2016
1.0.129 2,567 10/21/2016
1.0.128 1,969 10/21/2016
1.0.127 1,305 10/21/2016
1.0.126 1,284 10/21/2016
1.0.125 1,914 10/21/2016
1.0.124 1,986 10/20/2016
1.0.123 1,330 10/19/2016
1.0.122 1,255 10/19/2016
1.0.120 1,259 10/19/2016
1.0.119 1,969 10/18/2016
1.0.115 1,286 10/10/2016
1.0.114 1,239 10/10/2016
1.0.108 2,728 10/7/2016
1.0.102 1,971 10/3/2016
1.0.97 1,880 9/30/2016
1.0.96 1,274 9/30/2016
1.0.91 2,141 9/23/2016
1.0.87 5,178 9/20/2016
1.0.86 3,054 9/16/2016
1.0.85 1,263 9/16/2016
1.0.84 1,811 9/15/2016
1.0.82 4,216 9/13/2016
1.0.81 1,356 9/13/2016
1.0.80 1,812 9/13/2016
1.0.78 1,094 9/13/2016