Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FoundatioFx/Foundatio.Parsers
A lucene style query parser that is extensible and allows modifying the query.
https://github.com/FoundatioFx/Foundatio.Parsers
aggregation aliases c-sharp elasticsearch foundatio lucene macros parse parsers peg pegasus query
Last synced: about 2 months ago
JSON representation
A lucene style query parser that is extensible and allows modifying the query.
- Host: GitHub
- URL: https://github.com/FoundatioFx/Foundatio.Parsers
- Owner: FoundatioFx
- License: apache-2.0
- Created: 2015-01-01T17:42:21.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T16:04:55.000Z (about 2 months ago)
- Last Synced: 2024-12-02T20:50:11.811Z (about 2 months ago)
- Topics: aggregation, aliases, c-sharp, elasticsearch, foundatio, lucene, macros, parse, parsers, peg, pegasus, query
- Language: C#
- Homepage: https://www.nuget.org/packages/Foundatio.Parsers.LuceneQueries/
- Size: 1.28 MB
- Stars: 66
- Watchers: 12
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://github.com/FoundatioFx/Foundatio.Parsers/actions)
[](https://www.nuget.org/packages/Foundatio.Parsers.LuceneQueries/)
[](https://f.feedz.io/foundatio/foundatio/packages/Foundatio.Parsers.LuceneQueries/latest/download)
[](https://discord.gg/6HxgFCx)
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](https://www.nuget.org/packages/Foundatio.Parsers.LuceneQueries/) can be installed via the [NuGet package manager](https://docs.nuget.org/consume/Package-Manager-Dialog). If you need help, please contact us via in-app support or [open an issue](https://github.com/exceptionless/Foundatio.Parsers/issues/new). We’re always here to help if you have any questions!
1. You will need to have [Visual Studio Code](https://code.visualstudio.com) 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](https://github.com/exceptionless/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.
```csharp
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.
```csharp
var generatedQuery = GenerateQueryVisitor.Run(result);
System.Diagnostics.Debug.Assert(query == generatedQuery);
```
## [Query Syntax](docs/query.md)
## [Aggregation Syntax](docs/aggregations.md)
## Features
- Lucene Query Syntax Parser
- Parsers fairly standardized syntax from [Lucene](https://lucene.apache.org/core/2_9_4/queryparsersyntax.html) and [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html).
- Visitors for extensibility
- 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
[](https://github.com/FoundatioFx/Foundatio.Parsers/graphs/contributors)