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.

› › ›

Document paths

edit

Document paths

edit

Many APIs in Elasticsearch describe a path to a document. In NEST, besides generating a constructor that takes and Index, Type and Id separately, we also generate a constructor that allows you to describe the path to your document more succinctly using a an instance of the DocumentPath<T> type.

Creating new instances

edit

here we create a new document path based on Project with the id 1

IDocumentPath path = new DocumentPath<Project>(1);
Expect("project").WhenSerializing(path.Index);
Expect("project").WhenSerializing(path.Type);
Expect(1).WhenSerializing(path.Id);

You can still override the inferred index and type name

path = new DocumentPath<Project>(1).Type("project1");
Expect("project1").WhenSerializing(path.Type);

path = new DocumentPath<Project>(1).Index("project1");
Expect("project1").WhenSerializing(path.Index);

and there is also a static way to describe such paths

path = DocumentPath<Project>.Id(1);
Expect("project").WhenSerializing(path.Index);
Expect("project").WhenSerializing(path.Type);
Expect(1).WhenSerializing(path.Id);

Creating from a document type instance

edit

if you have an instance of your document you can use it as well generate document paths

var project = new Project { Name = "hello-world" };

here we create a new document path based on the instance of Project, project

IDocumentPath path = new DocumentPath<Project>(project);
Expect("project").WhenSerializing(path.Index);
Expect("project").WhenSerializing(path.Type);
Expect("hello-world").WhenSerializing(path.Id);

You can still override the inferred index and type name

path = new DocumentPath<Project>(project).Type("project1");
Expect("project1").WhenSerializing(path.Type);

path = new DocumentPath<Project>(project).Index("project1");
Expect("project1").WhenSerializing(path.Index);

and again, there is also a static way to describe such paths

path = DocumentPath<Project>.Id(project);
Expect("project").WhenSerializing(path.Index);
Expect("project").WhenSerializing(path.Type);
Expect("hello-world").WhenSerializing(path.Id);

DocumentPath<Project> p = project;

An example with requests

edit

var project = new Project { Name = "hello-world" };

we can see an example of how DocumentPath helps your describe your requests more tersely

var request = new IndexRequest<Project>(2) { Document = project };
request = new IndexRequest<Project>(project) { };

when comparing with the full blown constructor and passing document manually, DocumentPath<T>'s benefits become apparent. Compare the following request that doesn’t use DocumentPath<T> with the former examples

request = new IndexRequest<Project>(IndexName.From<Project>(), TypeName.From<Project>(), 2)
{
    Document = project
};

« Conventions Features inference »