- .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
Ids inference
editIds inference
editImplicit conversion
editSeveral places in the Elasticsearch API expect an instance of the Id
type to be passed.
This is a special type that you can implicitly convert to from the following types
-
Int32
-
Int64
-
String
-
Guid
Methods that take an Id
can be passed any of these types and they will be implicitly converted to an instance of Id
Id idFromInt = 1; Id idFromLong = 2L; Id idFromString = "hello-world"; Id idFromGuid = new Guid("D70BD3CF-4E38-46F3-91CA-FCBEF29B148E"); Expect(1).WhenSerializing(idFromInt); Expect(2).WhenSerializing(idFromLong); Expect("hello-world").WhenSerializing(idFromString); Expect("d70bd3cf-4e38-46f3-91ca-fcbef29b148e").WhenSerializing(idFromGuid);
Inferring Id from a type
editSometimes a method takes an object instance and the client requires an Id
from that
instance to build up a path.
There is no implicit conversion from any object to Id
, but we can call Id.From
.
Imagine your codebase has the following type that we want to index into Elasticsearch
class MyDTO { public Guid Id { get; set; } public string Name { get; set; } public string OtherName { get; set; } }
By default NEST will try to find a property called Id
on the class using reflection
and create a cached delegate based on the property getter
var dto = new MyDTO { Id = new Guid("D70BD3CF-4E38-46F3-91CA-FCBEF29B148E"), Name = "x", OtherName = "y" }; Expect("d70bd3cf-4e38-46f3-91ca-fcbef29b148e").WhenInferringIdOn(dto);
Using connection settings, you can specify a different property that NEST should use to infer Id for the document.
Here we instruct NEST to infer the Id for MyDTO
based on its Name
property
WithConnectionSettings(x => x .DefaultMappingFor<MyDTO>(m => m .IdProperty(p => p.Name) ) ).Expect("x").WhenInferringIdOn(dto);
Inference rules are cached per ConnectionSettings
instance.
Because the cache is per ConnectionSettings
instance, we can create another ConnectionSettings
instance
with different inference rules
WithConnectionSettings(x => x .DefaultMappingFor<MyDTO>(m => m .IdProperty(p => p.OtherName) ) ).Expect("y").WhenInferringIdOn(dto);
DefaultMappingFor also has a non generic overload for the more dynamic use-cases.
WithConnectionSettings(x => x .DefaultMappingFor(typeof(MyDTO), m => m .IdProperty(typeof(MyDTO).GetProperty(nameof(MyDTO.Name)).Name) ) ).Expect("x").WhenInferringIdOn(dto);
Using the ElasticsearchType attribute
editAnother way to control Id inference is to mark the type with an ElasticsearchType
attribute, setting IdProperty
to the name of the property that should be used for the document id
[ElasticsearchType(IdProperty = nameof(Name))] class MyOtherDTO { public Guid Id { get; set; } public string Name { get; set; } public string OtherName { get; set; } }
Now when we infer the id we expect it to be the value of the Name
property without doing any configuration on the ConnectionSettings
var dto = new MyOtherDTO { Id = new Guid("D70BD3CF-4E38-46F3-91CA-FCBEF29B148E"), Name = "x", OtherName = "y" }; Expect("x").WhenInferringIdOn(dto);
Using Mapping inference on ConnectionSettings
editThis attribute is cached statically/globally, however an inference rule on ConnectionSettings
for the type will
still win over the attribute.
Here we demonstrate this by creating a different ConnectionSettings
instance
that will infer the document id from the property OtherName
:
WithConnectionSettings(x => x .DefaultMappingFor<MyOtherDTO>(m => m .IdProperty(p => p.OtherName) ) ).Expect("y").WhenInferringIdOn(dto);
Disabling Id inference
editYou can configure the client to disable Id inference on a CLR type basis
WithConnectionSettings(x => x .DefaultMappingFor<MyOtherDTO>(m => m .DisableIdInference() ) ).Expect(null).WhenInferringIdOn(dto);
or globally for all types
WithConnectionSettings(x => x.DefaultDisableIdInference()) .Expect(null).WhenInferringIdOn(dto);
Once disabled globally, Id inference cannot be enabled per type
WithConnectionSettings(x => x .DefaultDisableIdInference() .DefaultMappingFor<MyOtherDTO>(m => m .DisableIdInference(disable: false) ) ).Expect(null).WhenInferringIdOn(dto);
On this page