Building Requests
-This section decribes how to build requests to elasticsearch.
+This section decribes how to build requests to Elasticsearch.
Calling an API endpoint
Elasticsearch.Net maps all the Elasticsearch API endpoints to methods. The reason it can do this is because all these methods are generated from
the official client rest specification. This specification documents all
diff --git a/new_docs/build/elasticsearch-net/cluster-failover.html b/new_docs/build/elasticsearch-net/cluster-failover.html
index 27ee0cf586d..b4d2ad46d0e 100644
--- a/new_docs/build/elasticsearch-net/cluster-failover.html
+++ b/new_docs/build/elasticsearch-net/cluster-failover.html
@@ -1,5 +1,5 @@
Elasticsearch.Net
Documentation
Connection pooling & Cluster failover
-One of the major benefits of elasticsearch is that it can handle dying and respawning nodes.
+
One of the major benefits of Elasticsearch is that it can handle dying and respawning nodes.
As long as enough nodes agree that the cluster is healthy, the cluster will continue to operate.
Elasticsearch.net comes with builtin support to handle falling over to a different node when the requested node failed.
Configuring
@@ -21,7 +21,7 @@SetDeadTimeout()
SetMaxDeadTimeout()
Sets the maximum time a node may be marked dead.
DisablePings()
-By default before a previously dead node is retried a short ping will be send to the node to make sure the node will respond. +
By default before a previously dead node is retried a short ping will be sent to the node to make sure the node will respond. The reason for a separate call is that a ping will call an elasticsearch endpoint that won't stress the JVM. If a node is having issues retrying a possible heavy search operation on it might cause the request to fail later rather then asap. This setting allows you to disable these pings before retries.
SetMaxRetries(int retries)
By default an IConnectionPool itself will decide how many times to retry (usually all the registered nodes) if you wish to
diff --git a/new_docs/build/elasticsearch-net/errors.html b/new_docs/build/elasticsearch-net/errors.html
index d4759c45073..786ced35b11 100644
--- a/new_docs/build/elasticsearch-net/errors.html
+++ b/new_docs/build/elasticsearch-net/errors.html
@@ -1,5 +1,5 @@
Elasticsearch.Net
Documentation
Errors
-Elasticsearch.Net will not throw if gets a http response other then 200 from Elasticsearch. The response object's Success property will be false and .Error will contain information on the failed response.
Elasticsearch.Net will not throw if it gets an http response other then 200 from Elasticsearch. The response object's Success property will be false and .Error will contain information on the failed response.
You can throw custom exceptions if you need too by specifying a custom connectionhandler
var settings = new ConnectionConfiguration()
.SetConnectionStatusHandler(r=> {
@@ -7,6 +7,6 @@
throw new MyApplicationNotLoggedInException();
});
Exceptions
-If a request has been retried the maximum amount of times a MaxRetryException is thrown. Note that requests are only retried when elasticsearch responds with a 503 or an unspecified connection exception (i.e timeout) occured on a node.
If a request has been retried the maximum amount of times a MaxRetryException is thrown. Note that requests are only retried when elasticsearch responds with a 503 or an unspecified connection exception (i.e timeout) has occured on a node.
MaxRetryException will hold the original exception as .InnerException.
Elasticsearch.Net
Documentation
Quick Start
-Elasticsearch.Net is a low level client to talk to elasticsearch.
Elasticsearch.Net is a low level client to talk to Elasticsearch.
Installing
From the package manager console inside visual studio
PM > Install Package Elasticsearch.Net -PreRelease
diff --git a/new_docs/build/index.html b/new_docs/build/index.html
index 3b6340b21de..750cfd77263 100644
--- a/new_docs/build/index.html
+++ b/new_docs/build/index.html
@@ -1,5 +1,5 @@
Nest - Introduction Elasticsearch.Net & NEST
Documentation
Introduction
-You've reached the documentation page for Elasticsearch.Net and NEST. Two .net clients to talk with elasticsearch. So why two clients I hear you say?
+You've reached the documentation page for Elasticsearch.Net and NEST. Two .net clients to talk with Elasticsearch. So why two clients I hear you say?
Elasticsearch.Net is a very low level, dependency free, client that has no opinions how you build and represent your requests and responses. It has abstracted
enough so that all the elasticsearch API endpoints are represented as methods but not too much to get in the way of how you want to build your json/request/response objects. It also comes with builtin, configurable/overridable, cluster failover retry mechanisms. Elasticsearch is elastic so why not your client?
NEST is a high level client that has the advantage of having mapped all the request and response objects, comes with a strongly typed query DSL that maps 1 to 1 with the elasitcsearch query dsl and takes advantage of specific .net features such as covariant results. NEST internally uses, and still exposes, the low level Elasticsearch.Net client
@@ -8,9 +8,9 @@ Who's using Nest
- stackoverflow.com (and the rest of the stackexchange family).
- 7digital.com (run NEST on mono).
-- rijksmuseum.nl (elasticsearch is the only datastorage hit for each page).
+- rijksmuseum.nl (Elasticsearch is the only datastorage hit for each page).
- Kiln FogCreek's version control & code review tooling.
-They are so pleased with elasticsearch that they made a video about how pleased they are!
+They are so pleased with Elasticsearch that they made a video about how pleased they are!
Other resources
@joelabrahamsson wrote a great intro into elasticsearch on .NET
diff --git a/new_docs/build/nest/cluster/health.html b/new_docs/build/nest/cluster/health.html
index bd6c0e88fe7..3cf88afa661 100644
--- a/new_docs/build/nest/cluster/health.html
+++ b/new_docs/build/nest/cluster/health.html
@@ -1,7 +1,7 @@
Nest - Connecting 
NEST
Documentation
Health
Get cluster health simple
var r = this._client.Health(HealthLevel.Cluster);
-
Cluster health just for one (or more) index
+Cluster health for one (or more) indexes
var r = this._client.Health(new[] { Test.Default.DefaultIndex }, HealthLevel.Cluster);
Advanced options are mapped as well
var r = this._client.Health(new HealthParams
diff --git a/new_docs/build/nest/cluster/nodes-stats.html b/new_docs/build/nest/cluster/nodes-stats.html
index 47ea1939f32..0bbd35d54f4 100644
--- a/new_docs/build/nest/cluster/nodes-stats.html
+++ b/new_docs/build/nest/cluster/nodes-stats.html
@@ -1,6 +1,6 @@
Nest - Connecting NEST
Documentation
Nodes stats
var r = this._client.NodeInfo(NodesInfo.All);
var node = r.Nodes.First();
-
you can than traverse the node info objects i.e:
+You can than traverse the node info objects i.e:
node.Value.OS.Cpu.CacheSizeInBytes;
Choosing the right connection st
for calls which do not explicitly state an index name. Specifying a default index is optional but very handy.
If you want a failover client instead of passing a Uri pass an IConnectionPool see the Elasticsearch.Net documentation on cluster failover all of its implementations can also be used with NEST.
Changing the underlying connection
-By default NEST will use HTTP to chat with elasticsearch, alternative implementation of the transport layer can be injected in the constructors optional second parameter
+By default NEST will use HTTP to chat with elasticsearch, alternative implementation of the transport layer can be injected using the constructors optional second parameter
var client = new ElasticClient(settings, new ThriftConnection(settings));
-
Nest comes with a Htpp connection HttpConnection, Thrift Connection ThriftConnection
-and an in memory connection that nevers hits elasticsearch InMemoryConnection.
+
NEST comes with an Http Connection HttpConnection, Thrift Connection ThriftConnection
+and an In-Memory Connection InMemoryConnection, that nevers hits elasticsearch.
Settings
The NEST client can be configured by passing in an IConnectionSettingsValues object, this interface is a subclass of
Elasticsearch.Net's IConnectionConfigurationValues so all the settings that can be used to
@@ -24,8 +24,8 @@
Settings
var settings = new ConnectionSettings(myConnectionPool, defaultIndex: "my-application")
.PluralizeTypeNames();
AddContractJsonConverters
-Add a custom JsonConverter to the build in json serialization by passing
-in a predicate for a type. This way they will be part of the cached Json.net contract for a type.
+Add a custom JsonConverter to the built in JSON serialization by passing
+in a predicate for a type. This way they will be part of the cached Json.NET contract for a type.
settings.AddContractJsonConverters(t =>
typeof (Enum).IsAssignableFrom(t)
? new StringEnumConverter()
@@ -42,13 +42,13 @@ SetDefaultIndex
SetDefaultPropertyNameInferrer
By default NEST camelCases property names (EmailAddress => emailAddress)
that do not have an explicit propertyname either via an ElasticProperty attribute
-or because they are part of Dictionary where the keys should be treated verbatim.
+or because they are part of a Dictionary where the keys should be treated verbatim.
Here you can register a function that transforms propertynames (default
casing, pre- or suffixing)
SetDefaultTypeNameInferrer
-Allows you to override how type names should be reprented, the default will
+
Allows you to override how type names should be represented, the default will
call .ToLowerInvariant() on the type's name.
SetJsonSerializerSettingsModifier
-Allows you to update internal the json.net serializer settings to your liking.
-Do not use this to add custom json converters use AddContractJsonConverters instead.
+Allows you to update the internal Json.NET Serializer settings to your liking.
+Do not use this to add custom JSON converters use AddContractJsonConverters instead.
Nest - Connecting NEST
Documentation
Bulk
-Nest long supported bulk index and deletes (through IndexMany() and DeleteMany()) but this shielded you from all that the elasticsearch _bulk api enpoint has to offer. Now you can use Bulk() to create any bulk request you'd like. E.g if you want to do index/create/delete's in a certain order.
+NEST long supported bulk index and deletes (through IndexMany() and DeleteMany()) but this shielded you from all that the Elasticsearch _bulk api enpoint has to offer. Now you can use Bulk() to create any bulk request you'd like. E.g if you want to do index/create/delete's in a certain order.
Examples
var result = this._client.Bulk(b => b
.Index<ElasticSearchProject>(i => i.Object(new ElasticSearchProject {Id = 2}))
.Create<ElasticSearchProject>(i => i.Object(new ElasticSearchProject { Id = 3 }))
.Delete<ElasticSearchProject>(i => i.Object(new ElasticSearchProject { Id = 4 }))
);
-
Each bulk operation can also be anotated with the right behaviours:
+Each bulk operation can also be annotated with the right behaviours:
.Index<ElasticSearchProject>(i => i
.Routing(...)
.Refresh(...)
diff --git a/new_docs/build/nest/core/count.html b/new_docs/build/nest/core/count.html
index d0a094a6863..cd81861070c 100644
--- a/new_docs/build/nest/core/count.html
+++ b/new_docs/build/nest/core/count.html
@@ -2,7 +2,7 @@
The count API allows to easily execute a query and get the number of matches for that query. It can be executed across one or more indices and across one or more types. The query can either be provided using a simple query string as a parameter, or using the Query DSL defined within the request body. Here is an example:
var countResults = this._client.CountAll(q=>q.MatchAll());
Assert.True(countResults.Count > 0);
-
The above will do a count query across all indices. (The result type here is not)
+
The above will do a count query across all indices. (The result type here is not limited)
If you want to limit the scope to just the default index for the type:
var countResults = this._client.Count<ElasticSearchProject>(q=>q.MatchAll());
This does a match all count query on the default index for ElasticSearchProject, if you need to specify custom indices use:
diff --git a/new_docs/build/nest/core/delete-by-query.html b/new_docs/build/nest/core/delete-by-query.html
index bbb294de83f..3f72cf1fc53 100644
--- a/new_docs/build/nest/core/delete-by-query.html
+++ b/new_docs/build/nest/core/delete-by-query.html
@@ -6,7 +6,7 @@
.Term(f => f.Name, "elasticsearch.pm")
);
As always *Async variants are available too.
-You can also delete by query over all the indexes and types:
+You can also delete by query over all the indices and types:
this.ConnectedClient.DeleteByQuery<ElasticSearchProject>(q => q
.AllIndices()
.Term(f => f.Name, "elasticsearch.pm")
diff --git a/new_docs/build/nest/core/get.html b/new_docs/build/nest/core/get.html
index a2e33a98621..17d3df89a10 100644
--- a/new_docs/build/nest/core/get.html
+++ b/new_docs/build/nest/core/get.html
@@ -1,12 +1,12 @@
Nest - Connecting NEST
Documentation
Get a document
-gets a single document from Elasticsearch
+Gets a single document from Elasticsearch
By Id
var foundDocument = this.ConnectedClient.Get<ElasticSearchProject>(hit.Id);
-
index and type are infered but overloads exists for full control
+Index and type are infered but overloads exists for full control
var foundDocument = this.ConnectedClient.Get<ElasticSearchProject>("myalternateindex", "elasticprojs", hit.Id);
Full response
-The Get<T>() call immediatly returns T which is handy in alot of cases but sometimes you'll want to get the complete metadata object back from Elasticsearch
-using GetFull() you get a proper IGetResponse<T> back that holds the usual IsValid and ConnectionStatus properties amongst the Index, Type, Id and Version properties.
+The Get<T>() call immediatly returns T which is handy in alot of cases but sometimes you'll want to get the complete metadata object back from Elasticsearch.
+Using GetFull() you get a proper IGetResponse<T> back that holds the usual IsValid and ConnectionStatus properties amongst the Index, Type, Id and Version properties.
var result = this._client.GetFull<ElasticSearchProject>(g => g
.Index("nest_test_data")
.Type("elasticsearchprojects")
@@ -18,17 +18,17 @@ By Id
.Id(1)
);
Follows the same inferring rules as .Get(id) would.
-Infact you could even just pass an object:
+In fact you could even just pass an object:
var result = this._client.GetFull<SomeDto>(g => g
.Object(new SomeDto { AlternateId = Guid.NewGuid() })
);
-
provided SomeDto is mapped properly to use AlternateId as the alternate id field
+Provided SomeDto is mapped properly to use AlternateId as the alternate id field.
[ElasticType(IdProperty = "AlternateId")]
internal class SomeDto
{
public Guid AlternateId { get; set; }
}
-
You can also use GetFull to query just some fields of a single document
+You can also use GetFull to query just some fields of a single document
var result = this._client.GetFull<ElasticSearchProject>(g => g
.Index("nest_test_data")
.Type("elasticsearchprojects")
@@ -39,5 +39,5 @@ By Id
var name = result.Fields.FieldValue<string>(p => p.Name);
var id = result.Fields.FieldValue<int>(p => p.Id);
var doubleValue = result.Fields.FieldValue<double>(p => p.DoubleValue);
-
Remember p => p.Name can also be written as "name" and Nest does not force you to write expressions everywhere (although it is much encouraged!).
+
Remember p => p.Name can also be written as "name" and NEST does not force you to write expressions everywhere (although it is much encouraged!).
Indexing is as simple as:
var post = new Post() { Id = 12, ... }
var status = client.Index<Post>(post);
-
of course C# is smart enough to infer Post so
+
Of course C# is smart enough to infer Post so
var status = client.Index(post);
is sufficient. this will index post too /[default index]/posts/12. The typenameposts is automatically inferred from the type.
-if you need more control there are plenty of overloads, i.e:
+If you need more control there are plenty of overloads, i.e:
client.Index(post, "index", "type", "id");
Asynchronous
Indexing asynchronously is as easy as:
@@ -20,11 +20,11 @@
Instead of passing T just pass an IEnumerable<T> to IndexMany() or IndexManyAsync().
Note
For asynchronous commands there's a special connection setting which automatically semaphores threaded communication
-to ES for you:
+to Elasticsearch for you:
var elasticSettings = new ConnectionSettings("127.0.0.1.", 9200)
.SetDefaultIndex("mpdreamz")
.SetMaximumAsyncConnections(20);
-
this ensures that at most there are 20 asynchronous connections to ES others are enqueued until a slot is
+
This ensures that at most there are 20 asynchronous connections to Elasticsearch. All others are enqueued until a slot is
available.
Aditional parameters
Like the overloads just taking a T the IEnumerable<T> has alot of overloads taking in extra parameters.
diff --git a/new_docs/build/nest/core/multi-get.html b/new_docs/build/nest/core/multi-get.html
index 5139f5db24a..37a6ad8bb46 100644
--- a/new_docs/build/nest/core/multi-get.html
+++ b/new_docs/build/nest/core/multi-get.html
@@ -3,7 +3,7 @@
Examples
var ids = new [] { hit1.Id, hit2.Id };
var foundDocuments = this.ConnectedClient.MultiGet<ElasticSearchProject>(ids);
-
index and type are infered but overloads exists for full control
+Index and type are infered but overloads exists for full control.
var foundDocuments = this.ConnectedClient.MultiGet<ElasticSearchProject>("myalternateindex", "elasticprojs", ids);
Multi Get Full
The previous calls are handy if you need to get many objects of a single type and don't care about the response or the metadata of the documents. If you do, NEST has you covered as well.
@@ -17,7 +17,7 @@ Examples
var person = result.Get<Person>(100000);
var personHit = result.GetWithMetaData<Person>(100000);
Get returns T and GetWithMetaData returns a MultiGetHit<T> which also exposes the document's metadata such as _index and _version.
-Incase the document was not found then Get would return a null but GetWithMetaData still returns the a MultiGetHit<T> but with an .Exists of false this maps to the way elasticsearch returns not found objects in a multi_get call.
+In case the document was not found then Get would return a null but GetWithMetaData still returns the a MultiGetHit<T> but with an .Exists of false this maps to the way elasticsearch returns not found objects in a multi_get call.
You can even get field selections for some of the documents:
var result = this._client.MultiGetFull(a => a
.Get<ElasticSearchProject>(g => g.
@@ -36,5 +36,5 @@ Examples
var fields = result.GetFieldSelection<ElasticSearchProject>(1);
var id = fields.FieldValue<int>(p => p.Id);
var firstNames = fields.FieldValue<string[]>(p => p.Followers.First().FirstName);
-
Remember p => p.Followers.First().FirstName can be interchanged with "followers.firstName" if you prefer or need to reference a non mapped field.
+
Remember p => p.Followers.First().FirstName can be interchanged with "followers.firstName" if you prefer or need to reference a non-mapped field.
Nest - Connecting NEST
Documentation
Percolation
The percolator allows to register queries against an index, and then send percolate requests which include a doc, and getting back the queries that match on that doc out of the set of registered queries.
-The percolate is a complex but awesome elasticsearch feature be sure to read the official documentation
+Percolate is a complex but awesome Elasticsearch feature, so be sure to read the official documentation
Register a percolator
var r = c.RegisterPercolator<ElasticSearchProject>(p => p
.Name(name)
diff --git a/new_docs/build/nest/core/search.html b/new_docs/build/nest/core/search.html
index 78d8f131f5e..2cbd24eb1b8 100644
--- a/new_docs/build/nest/core/search.html
+++ b/new_docs/build/nest/core/search.html
@@ -1,5 +1,5 @@
Nest - Connecting NEST
Documentation
Search
-Search is THE call you'll probably use the most as it exposes elasticsearch's key functionality: search!
+Search is THE call you'll probably use the most as it exposes Elasticsearch's key functionality: search!
NOTE: be sure to also read how to use NEST's Query DSL
You can start a search like so,
var result = this._client.Search(s => s
@@ -9,7 +9,7 @@
.Filter(f=> ....)
);
This will get all the documents on the my-index index and my-type type.
-result is an IQueryResponse<dynamic> which has a Documents IEnumerable<dynamic> property that holds all the results. NOTE: remember in the absent of paging it will default to the first 10).
+result is an IQueryResponse<dynamic> which has a Documents IEnumerable<dynamic> property that holds all the results. NOTE: remember in the absense of paging it will default to the first 10).
Typed results
Dynamic may or may not be what you want but in general it pays to type your search responses. In alot of cases you already need to have the POCO classes for indexing anyway.
var result = this._client.Search<ElasticSearchProject>(s => s
diff --git a/new_docs/build/nest/facets/date-histogram.html b/new_docs/build/nest/facets/date-histogram.html
index 2d1c356eb81..4f73fc042ba 100644
--- a/new_docs/build/nest/facets/date-histogram.html
+++ b/new_docs/build/nest/facets/date-histogram.html
@@ -10,5 +10,5 @@
.Factor(1000)
)
);
-
See original docs for more information
+See original docs for more information.
See original docs for more information
+See original docs for more information.
See original docs for more information
+See original docs for more information.
Specify facets during search.
.Size(20)
)
);
-Nest supports all the additional properties you can set on facets
+NEST supports all the additional properties you can set on facets
var queryResults = this.ConnectedClient.Search<ElasticSearchProject>(s=>s
.From(0)
.Size(10)
@@ -46,12 +46,12 @@ Specify facets during search.
.TimeZones(Pre: "-3", Post: "-4")
)
);
-Allowing you to take advantage of all the cool facets stuff built in to elasticsearch.
+Allowing you to take advantage of all the cool facets stuff built into Elasticsearch.
Getting to your facet
If you are interested in the facet meta data (such as missing, total) you can use the following methods:
var facet = queryResults.Facet<TermFacet>(p=>p.Followers.Select(f=>f.LastName));
-this will return a TermFacet object which has an .Items property holding all the facets.
queryResult also holds a .Facets dictionary one can use to itterate over the facets returned from the query.
This will return a TermFacet object which has an .Items property holding all the facets.
queryResult also holds a .Facets dictionary one can use to iterate over the facets returned from the query.
Shortcut to facet items
To get the facet items for followers.lastName the prettiest way to get them is.
var facets = queryResults.FacetItems<FacetItem>(p=>p.Followers.Select(f=>f.LastName));
@@ -69,5 +69,5 @@ Corresponding Types
geo_distance => GeoDistanceFacet
query => QueryFacet
filter => FilterFacet
-See also each individual facet's documentation
+See also each individual facet's documentation.
See original docs for more information
+See original docs for more information.
See original docs for more information
+See original docs for more information.