- .NET Clients: other versions:
- Introduction
- Installation
- Breaking changes
- API Conventions
- Elasticsearch.Net - Low level client
- NEST - High level client
- Troubleshooting
- Search
- Query DSL
- Full text queries
- Term level queries
- Exists Query Usage
- Fuzzy Date Query Usage
- Fuzzy Numeric Query Usage
- Fuzzy Query Usage
- Ids Query Usage
- Prefix Query Usage
- Date Range Query Usage
- Long Range Query Usage
- Numeric Range Query Usage
- Term Range Query Usage
- Regexp Query Usage
- Term Query Usage
- Terms Set Query Usage
- Terms List Query Usage
- Terms Lookup Query Usage
- Terms Query Usage
- Wildcard Query Usage
- Compound queries
- Joining queries
- Geo queries
- Specialized queries
- Span queries
- NEST specific queries
- Aggregations
- Metric Aggregations
- Average Aggregation Usage
- Boxplot Aggregation Usage
- Cardinality Aggregation Usage
- Extended Stats Aggregation Usage
- Geo Bounds Aggregation Usage
- Geo Centroid Aggregation Usage
- Geo Line Aggregation Usage
- Max Aggregation Usage
- Median Absolute Deviation Aggregation Usage
- Min Aggregation Usage
- Percentile Ranks Aggregation Usage
- Percentiles Aggregation Usage
- Rate Aggregation Usage
- Scripted Metric Aggregation Usage
- Stats Aggregation Usage
- String Stats Aggregation Usage
- Sum Aggregation Usage
- T Test Aggregation Usage
- Top Hits Aggregation Usage
- Top Metrics Aggregation Usage
- Value Count Aggregation Usage
- Weighted Average Aggregation Usage
- Bucket Aggregations
- Adjacency Matrix Usage
- Auto Date Histogram Aggregation Usage
- Children Aggregation Usage
- Composite Aggregation Usage
- Date Histogram Aggregation Usage
- Date Range Aggregation Usage
- Diversified Sampler Aggregation Usage
- Filter Aggregation Usage
- Filters Aggregation Usage
- Geo Distance Aggregation Usage
- Geo Hash Grid Aggregation Usage
- Geo Tile Grid Aggregation Usage
- Global Aggregation Usage
- Histogram Aggregation Usage
- Ip Range Aggregation Usage
- Missing Aggregation Usage
- Multi Terms Aggregation Usage
- Nested Aggregation Usage
- Parent Aggregation Usage
- Range Aggregation Usage
- Rare Terms Aggregation Usage
- Reverse Nested Aggregation Usage
- Sampler Aggregation Usage
- Significant Terms Aggregation Usage
- Significant Text Aggregation Usage
- Terms Aggregation Usage
- Variable Width Histogram Usage
- Pipeline Aggregations
- Average Bucket Aggregation Usage
- Bucket Script Aggregation Usage
- Bucket Selector Aggregation Usage
- Bucket Sort Aggregation Usage
- Cumulative Cardinality Aggregation Usage
- Cumulative Sum Aggregation Usage
- Derivative Aggregation Usage
- Extended Stats Bucket Aggregation Usage
- Max Bucket Aggregation Usage
- Min Bucket Aggregation Usage
- Moving Average Ewma Aggregation Usage
- Moving Average Holt Linear Aggregation Usage
- Moving Average Holt Winters Aggregation Usage
- Moving Average Linear Aggregation Usage
- Moving Average Simple Aggregation Usage
- Moving Function Aggregation Usage
- Moving Percentiles Aggregation Usage
- Normalize Aggregation Usage
- Percentiles Bucket Aggregation Usage
- Serial Differencing Aggregation Usage
- Stats Bucket Aggregation Usage
- Sum Bucket Aggregation Usage
- Matrix Aggregations
- Metric Aggregations
Verbatim and Strict Query Usage
editVerbatim and Strict Query Usage
editVerbatim Query Usage
editAn individual query can be marked as verbatim in order take effect; a verbatim query will be serialized and sent in the request to Elasticsearch, bypassing NEST’s conditionless checks.
Fluent DSL example
editq .Bool(b => b .Must(qt => qt .Term(t => t .Verbatim() .Field(p => p.Description) .Value("") ), qt => qt .Term(t => t .Field(p => p.Name) .Value("foo") ) ) )
Object Initializer syntax example
editnew TermQuery { IsVerbatim = true, Field = "description", Value = "" } && new TermQuery { Field = "name", Value = "foo" }
Example json output.
{ "bool": { "must": [ { "term": { "description": { "value": "" } } }, { "term": { "name": { "value": "foo" } } } ] } }
A compound query can also be marked as verbatim, demonstrated here with a bool
query.
Fluent DSL example
editq .Bool(b => b .Verbatim() )
Object Initializer syntax example
editnew BoolQuery { IsVerbatim = true, }
Example json output.
{ "bool": {} }
A single verbatim query will be serialized as-is
Fluent DSL example
editq .Term(t => t .Verbatim() .Field(p => p.Description) .Value("") )
Object Initializer syntax example
editnew TermQuery { IsVerbatim = true, Field = "description", Value = "" }
Example json output.
{ "term": { "description": { "value": "" } } }
Leaf queries within a compound query marked as verbatim will also be serialized as-is
Fluent DSL example
editq .Bool(b => b .Filter(f => !f .Term(t => t .Verbatim() .Field(p => p.Name) .Value("") ) && f .Exists(e => e .Field(p => p.NumberOfCommits) ) ) )
Object Initializer syntax example
editnew BoolQuery { Filter = new QueryContainer[] { !new TermQuery { IsVerbatim = true, Field = "name", Value = "" } && new ExistsQuery { Field = "numberOfCommits" } } }
Example json output.
{ "bool": { "filter": [ { "bool": { "must": [ { "exists": { "field": "numberOfCommits" } } ], "must_not": [ { "term": { "name": { "value": "" } } } ] } } ] } }
Strict Query Usage
editA query can be marked as strict meaning that if it is determined to be conditionless, it will throw an
exception. The following example demonstrates this by trying to send an empty string as the value for
a term
query marked as strict
On this page