exceptionless/Foundatio.Parsers.ElasticQueriesv7.18.0-beta4
✓ Verified.NET 8.0.NET 10.0
A lucene style query parser that is extensible and allows additional syntax features.
Get Started
$ dotnet add package Foundatio.Parsers.ElasticQueriesReadme
A lucene style query parser that is extensible and allows additional syntax features.
$ dotnet add package Foundatio.Parsers.ElasticQueries
An extensible Lucene-style query parser with support for Elasticsearch and SQL/Entity Framework Core. Build dynamic search APIs, custom dashboards, and powerful query interfaces.
# Core Lucene parser
dotnet add package Foundatio.Parsers.LuceneQueries
# Elasticsearch integration
dotnet add package Foundatio.Parsers.ElasticQueries
# SQL/EF Core integration
dotnet add package Foundatio.Parsers.SqlQueriesusing Foundatio.Parsers.LuceneQueries;
using Foundatio.Parsers.LuceneQueries.Visitors;
var parser = new LuceneQueryParser();
var result = parser.Parse("field:[1 TO 2]");
// Debug the AST structure
Console.WriteLine(DebugQueryVisitor.Run(result));Output from DebugQueryVisitor:
Group:
Left - Term:
TermMax: 2
TermMin: 1
MinInclusive: True
MaxInclusive: True
Field:
Name: field
Regenerate the original query:
string query = GenerateQueryVisitor.Run(result);
// Output: "field:[1 TO 2]"using Foundatio.Parsers.ElasticQueries;
var parser = new ElasticQueryParser(c => c
.UseMappings(client, "my-index")
.UseFieldMap(new Dictionary<string, string> {
{ "user", "data.user.identity" }
}));
// Build NEST QueryContainer
var query = await parser.BuildQueryAsync("user:john AND status:active");
// Build aggregations
var aggs = await parser.BuildAggregationsAsync("terms:(status min:created max:created)");
// Build sort
var sort = await parser.BuildSortAsync("-created +name");using Foundatio.Parsers.SqlQueries;
var parser = new SqlQueryParser(c => c
.SetDefaultFields(new[] { "Name", "Description" }));
var context = parser.GetContext(db.Products.EntityType);
string dynamicLinq = await parser.ToDynamicLinqAsync("status:active AND price:>100", context);
var results = await db.Products
.Where(parser.ParsingConfig, dynamicLinq)
.ToListAsync();field:value, field:"quoted phrase"field:[1 TO 10], field:>100, field:>=2024-01-01AND, OR, NOT, +, -field:val*, field:va?ue_exists_:field, _missing_:fieldcreated:[now-7d TO now]location:75044~75mimin, max, avg, sum, stats, cardinality, percentilesterms, date, histogram, geogrid, missingterms:(category min:price max:price)Map user-friendly names to actual field paths:
var parser = new ElasticQueryParser(c => c
.UseFieldMap(new Dictionary<string, string> {
{ "user", "data.user.identity" },
{ "created", "metadata.createdAt" }
}));Define reusable query macros:
var parser = new ElasticQueryParser(c => c
.UseIncludes(new Dictionary<string, string> {
{ "active", "status:active AND deleted:false" },
{ "recent", "created:[now-7d TO now]" }
}));
// Expands @include:active inline
var query = await parser.BuildQueryAsync("@include:active AND category:electronics");Validate and restrict queries:
var parser = new ElasticQueryParser(c => c
.SetValidationOptions(new QueryValidationOptions {
AllowedFields = { "status", "name", "created" },
AllowLeadingWildcards = false,
AllowedMaxNodeDepth = 10
}));
var result = await parser.ValidateQueryAsync(userQuery);
if (!result.IsValid)
return BadRequest(result.Message);Extend with custom query transformations:
public class CustomVisitor : ChainableQueryVisitor
{
public override async Task VisitAsync(TermNode node, IQueryVisitorContext context)
{
// Custom transformation logic
await base.VisitAsync(node, context);
}
}
var parser = new ElasticQueryParser(c => c
.AddVisitor(new CustomVisitor(), priority: 100));Foundatio.Parsers.slnx in Visual Studio or VS Codedotnet builddotnet test