WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

Elastic Docs ›Elasticsearch.Net and NEST: the .NET clients [1.x] ›Indices
« Get mapping Delete Mapping »

Put Mappingedit

The put mapping API allows to register specific mapping definition for a specific type.

Attribute based mappingedit

You can decorate your classes with ElasticProperty and ElasticType attributes to describe how they should be mapped in Elasticsearch.

[ElasticType(
    Name = "elasticsearchprojects2",
    DateDetection = true,
    NumericDetection = true,
    SearchAnalyzer = "standard",
    IndexAnalyzer = "standard",
    DynamicDateFormats = new[] { "dateOptionalTime", "yyyy/MM/dd HH:mm:ss Z||yyyy/MM/dd Z" }
)]
public class ElasticSearchProject
{
    public int Id { get; set;  }
    public string Name { get; set; }
    [ElasticProperty(OmitNorms = true, Index = FieldIndexOption.not_analyzed)]
    public string Country { get; set; }
    public string Content { get; set; }
    [ElasticProperty(Name="loc")]
    public int LOC { get; set; }
    public List<Person> Followers { get; set; }

    [ElasticProperty(Type=FieldType.geo_point)]
    public GeoLocation Origin { get; set; }
    public DateTime StartedOn { get; set; }


    //excuse the lame properties i needed some numerics !
    public long LongValue { get; set; }
    public float FloatValue { get; set; }
    public double DoubleValue { get; set; }

    [ElasticProperty(NumericType=NumericType.Long)]
    public int StupidIntIWantAsLong { get; set; }
}

You can persist this mapping by simpling calling

var response = this.ConnectedClient.Map<ElasticSearchProject>();

Whenever the client needs to infer the typename for ElasticSearchProject it will resolve nicely to "elasticsearchprojects2" now too. This gives you great control over naming without having to specify the typename on each call.

Map<T>() will also explicitly map string properties as strings with elasticsearch even if they do not have an attribute on them. It does this for all the value types (string, int, float, double, DateTime).

Code based mappingedit

You can also create mappings on the fly:

var indexDefinition = new RootObjectMapping
{
    Properties = new Dictionary<PropertyNameMarker, IElasticType>(),
    Name = indexName
};

var property = new StringMapping
{
    Index = "not_analyzed"
};

var analyzedField = new StringMapping
{
    Index = "analyzed"
};

property.Fields.Add("name_analyzed", analyzedField);
indexDefinition.Properties.Add("name", property);
this.ConnectedClient.Map<object>(x => x.InitializeUsing(indexDefinition));

Multi field Mappingedit

To create multifield type you can use following example.

var result = this._client.Map<ElasticsearchProject>(m => m
    .Properties(props => props
    .String(s => s
    .Name(p => p.Name)
    .Path(MultiFieldMappingPath.Full)
    .Index(FieldIndexOption.not_analyzed)
    .Fields(pprops => pprops
        .String(ps => ps.Name(p => p.Name.Suffix("searchable")).Index(FieldIndexOption.analyzed))
    )
    ))
);
« Get mapping Delete Mapping »