Foundatio.Parsers.LuceneQueries 7.17.2

.NET Standard 2.0
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.
dotnet add package Foundatio.Parsers.LuceneQueries --version 7.17.2
<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, C# scripting and .NET Interactive. 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 Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
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.2 2,618 5/18/2022
7.17.1 3,415 3/10/2022
7.17.0 170 3/7/2022
7.16.2 4,368 1/21/2022
7.16.1 164 1/21/2022
7.16.0 169 1/20/2022
7.15.1 3,765 10/15/2021
7.15.0 947 10/11/2021
7.13.0 2,808 7/8/2021
7.12.0 13,983 4/13/2021
7.11.0 349 2/18/2021
7.10.3 23,736 2/1/2021
7.10.2 3,114 1/15/2021
7.10.1 350 1/15/2021
7.10.0 6,955 11/17/2020
7.9.0 2,334 9/16/2020
7.9.0-beta5 451 9/15/2020
7.9.0-beta4 366 9/15/2020
7.9.0-beta3 654 8/28/2020
7.9.0-beta2 373 8/27/2020
7.9.0-beta1 440 8/25/2020
7.8.0-beta9 2,537 8/3/2020
7.8.0-beta8 1,175 7/29/2020
7.8.0-beta7 686 7/9/2020
7.8.0-beta12 431 8/10/2020
7.8.0-beta11 451 8/6/2020
7.8.0-beta10 502 8/5/2020
7.7.0-beta6 435 7/2/2020
7.7.0-beta5 654 6/20/2020
7.7.0-beta4 456 6/14/2020
7.7.0-beta3 516 6/6/2020
7.7.0-beta2 502 5/26/2020
7.6.2 22,008 3/25/2020
7.6.1 475 3/25/2020
7.6.0 2,527 2/27/2020
7.5.4 1,808 2/13/2020
7.5.3 827 2/10/2020
7.5.2 1,578 1/28/2020
7.5.1 1,478 1/17/2020
7.5.0 577 1/16/2020
7.5.0-rc1 477 1/14/2020
7.0.497 13,180 6/27/2019
5.6.521 2,078 9/19/2019
5.6.517 496 9/19/2019
5.6.508 1,620 8/30/2019
5.6.477 7,809 4/16/2019
5.6.445 1,652 3/15/2019
5.6.443 656 3/14/2019
5.6.441 632 3/14/2019
5.6.438 4,502 2/22/2019
5.6.436 568 2/22/2019
5.6.429 6,634 1/30/2019
5.6.398 7,073 11/9/2018
5.6.396 842 11/9/2018
5.6.389 4,405 9/7/2018
5.6.386 2,473 5/9/2018
5.6.365 2,039 11/30/2017
5.0.353 2,779 9/14/2017
5.0.350 896 9/14/2017
5.0.348 1,400 8/17/2017
5.0.339 1,014 7/24/2017
5.0.336 1,627 6/23/2017
5.0.323 929 5/5/2017
5.0.302-pre 724 3/17/2017
5.0.301-pre 717 3/16/2017
5.0.300-pre 747 3/16/2017
5.0.299-pre 700 3/16/2017
5.0.295-pre 692 3/16/2017
5.0.293-pre 808 3/11/2017
5.0.292-pre 735 3/11/2017
5.0.274-pre 1,025 3/5/2017
5.0.273-pre 1,065 2/28/2017
5.0.271-pre 917 2/28/2017
5.0.270-pre 753 2/28/2017
5.0.268-pre 851 2/20/2017
5.0.266-pre 1,987 2/16/2017
5.0.263-pre 957 2/15/2017
5.0.261-pre 889 2/15/2017
5.0.260-pre 853 2/14/2017
5.0.259-pre 932 2/14/2017
5.0.258-pre 808 2/8/2017
5.0.255-pre 779 2/7/2017
5.0.254-pre 1,055 2/6/2017
5.0.253-pre 834 2/6/2017
5.0.252-pre 833 2/4/2017
5.0.251-pre 841 2/3/2017
5.0.250-pre 762 2/3/2017
5.0.248-pre 763 2/2/2017
5.0.246-pre 1,056 1/30/2017
5.0.245-pre 784 1/29/2017
5.0.244-pre 775 1/28/2017
5.0.243-pre 766 1/27/2017
5.0.242-pre 773 1/27/2017
5.0.241-pre 771 1/24/2017
5.0.239-pre 784 1/19/2017
5.0.238-pre 782 1/19/2017
5.0.237-pre 788 1/19/2017
5.0.235-pre 763 1/19/2017
5.0.234-pre 763 1/17/2017
5.0.233-pre 1,482 1/12/2017
5.0.232-pre 750 1/9/2017
5.0.230-pre 823 1/9/2017
5.0.229-pre 781 1/6/2017
5.0.226-pre 804 1/5/2017
5.0.224-pre 797 1/5/2017
5.0.223-pre 1,155 12/29/2016
5.0.222-pre 893 12/28/2016
5.0.220-pre 795 12/22/2016
5.0.219-pre 1,160 12/16/2016
5.0.216-pre 767 12/15/2016
5.0.214-pre 900 12/13/2016
5.0.213-pre 1,083 12/13/2016
5.0.212-pre 809 12/13/2016
5.0.211-pre 1,094 12/10/2016
5.0.209-pre 849 12/9/2016
5.0.205-pre 935 12/6/2016
5.0.203-pre 907 12/6/2016
5.0.202-pre 805 12/6/2016
5.0.199-pre 811 12/5/2016
5.0.198-pre 806 12/5/2016
5.0.197-pre 843 12/2/2016
5.0.196-pre 834 11/30/2016
5.0.193-pre 895 11/29/2016
5.0.190-pre 842 11/29/2016
5.0.189-pre 1,016 11/29/2016
5.0.186-pre 928 11/29/2016
5.0.185-pre 844 11/29/2016
5.0.183-pre 832 11/29/2016
5.0.182-pre 830 11/29/2016
5.0.181-pre 910 11/28/2016
5.0.180-pre 801 11/28/2016
5.0.177-pre 819 11/28/2016
5.0.175-pre 772 11/28/2016
5.0.174-pre 824 11/28/2016
5.0.173-pre 842 11/28/2016
5.0.171-pre 806 11/26/2016
5.0.170-pre 916 11/25/2016
5.0.169-pre 893 11/23/2016
5.0.167-pre 913 11/18/2016
5.0.166-pre 854 11/18/2016
5.0.159-pre 801 11/17/2016
2.0.153-pre 874 11/16/2016
2.0.150-pre 846 11/15/2016
2.0.149-pre 773 11/15/2016
2.0.148-pre 786 11/15/2016
2.0.140-pre 776 11/9/2016
2.0.137-pre 755 11/9/2016
2.0.135-pre 1,108 10/26/2016
2.0.105-pre 928 10/5/2016
2.0.104-pre 804 10/5/2016
2.0.103-pre 785 10/5/2016
2.0.101-pre 1,021 10/3/2016
2.0.100-pre 769 10/3/2016
2.0.99-pre 769 9/30/2016
2.0.98-pre 787 9/30/2016
2.0.95-pre 764 9/28/2016
2.0.94-pre 851 9/27/2016
1.0.318 830 5/4/2017
1.0.305 1,910 3/17/2017
1.0.269 1,829 2/20/2017
1.0.267 1,711 2/16/2017
1.0.264 863 2/16/2017
1.0.231 1,691 1/9/2017
1.0.228 1,138 1/6/2017
1.0.227 887 1/6/2017
1.0.210 1,504 12/9/2016
1.0.207 923 12/8/2016
1.0.204 1,035 12/6/2016
1.0.195 1,065 11/30/2016
1.0.192 939 11/29/2016
1.0.187 1,114 11/29/2016
1.0.184 949 11/29/2016
1.0.176 1,039 11/28/2016
1.0.168 1,170 11/18/2016
1.0.165 883 11/18/2016
1.0.164 884 11/18/2016
1.0.147 1,426 11/15/2016
1.0.143 875 11/10/2016
1.0.142 894 11/10/2016
1.0.141 876 11/9/2016
1.0.138 850 11/9/2016
1.0.136 1,035 11/9/2016
1.0.131 1,143 10/21/2016
1.0.130 905 10/21/2016
1.0.129 1,155 10/21/2016
1.0.128 1,020 10/21/2016
1.0.127 895 10/21/2016
1.0.126 870 10/21/2016
1.0.125 1,019 10/21/2016
1.0.124 1,020 10/20/2016
1.0.123 891 10/19/2016
1.0.122 863 10/19/2016
1.0.120 877 10/19/2016
1.0.119 1,012 10/18/2016
1.0.115 886 10/10/2016
1.0.114 874 10/10/2016
1.0.108 1,311 10/7/2016
1.0.102 1,049 10/3/2016
1.0.97 1,002 9/30/2016
1.0.96 884 9/30/2016
1.0.91 1,143 9/23/2016
1.0.87 1,987 9/20/2016
1.0.86 1,283 9/16/2016
1.0.85 871 9/16/2016
1.0.84 969 9/15/2016
1.0.82 1,569 9/13/2016
1.0.81 949 9/13/2016
1.0.80 932 9/13/2016
1.0.78 808 9/13/2016