Skip to content

Commit 43ac721

Browse files
committed
Merge pull request #749 from ericberens/develop
MInor Doc Updates
2 parents c129153 + 80e2dbb commit 43ac721

9 files changed

+28
-28
lines changed

Diff for: new_docs/contents/.DS_Store

-6 KB
Binary file not shown.

Diff for: new_docs/contents/breaking-changes.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
template: layout.jade
3-
title: Breaking changes
3+
title: Breaking Changes
44
menusection: concepts
55
menuitem: breaking-changes
66
---
77

8-
#Breaking changes
8+
#Breaking Changes
99

1010
## Elasticsearch 1.0
1111

1212
Elasticsearch 1.0 comes with it's own set of breaking changes which [are all documented in the elasticsearch documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/breaking-changes.html). This page describes breaking changes NEST introduces in its 1.0 release and to an extend how you should handle Elasticsearch 1.0 changes in your exisiting code base using NEST prior to NEST 1.0.
1313

1414
## NEST 1.0
1515

16-
### Strong named packages
16+
### Strong Named Packages
1717

1818
Prior to 1.0 NEST came with a `NEST` and `NEST.Signed` nuget package. In 1.0 there is one package called `NEST` which is a signed strong named assembly. We follow the example of JSON.NET and only change our `AssemblyVersion` on major releases only update the `AssemblyFileVersion` for every release. This way you get most of the benefits of unsigned assemblies while still providing support for developers who's business guidelines mandates the usage of signed assemblies.
1919

@@ -38,7 +38,7 @@ to `PutMappingDescriptor<T>`
3838

3939
IResponse.Error.Exception no longer exists, it is inlined to IResponse.OriginalException. The Error property did not hold any information that was not available on IResponse.ConnectionStatus.
4040

41-
### Response shortcuts
41+
### Response Shortcuts
4242

4343
Prior to 1.0 some calls directly returned a bool or value instead of the full envelopped Elasticsearch response.
4444

@@ -63,7 +63,7 @@ Or in a separate put mapping call:
6363

6464
var response = this._client.Map<ElasticsearchProject>(m=>m.MapFromAttributes()......);
6565

66-
#### Alias helpers
66+
#### Alias Helpers
6767

6868
NEST 0.12.0 had some alias helpers, `SwapAlias()`, `GetIndicesPointingToAlias()` these have been removed in favor of just `Alias()` and `GetAliases()`. Especially the later could benefit from some extension methods that make the common use cases a bit easier to program with. These did not make the beta release.
6969

Diff for: new_docs/contents/elasticsearch-net/building-requests.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menuitem: esnet-building-requests
99

1010
This section decribes how to build requests to Elasticsearch.
1111

12-
## Calling an API endpoint
12+
## Calling an API Endpoint
1313

1414
`Elasticsearch.Net` maps **all** the `Elasticsearch` API endpoints to methods. The reason it can do this is because all these methods are generated from
1515
[the official client rest specification](https://github.com/elasticsearch/elasticsearch/tree/master/rest-api-spec/api). This specification documents all
@@ -32,7 +32,7 @@ Unknown querystring parameters can still be added:
3232

3333
The querystring parameter is always optional.
3434

35-
## Providing request body
35+
## Providing Request Body
3636

3737
Some endpoints need a request body this can be passed in a couple of ways.
3838

Diff for: new_docs/contents/elasticsearch-net/errors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
template: layout.jade
3-
title: Quick Start
3+
title: Errors
44
menusection:
55
menuitem: esnet-errors
66
---

Diff for: new_docs/contents/elasticsearch-net/handling-responses.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
template: layout.jade
3-
title: Handling responses
3+
title: Handling Responses
44
menusection:
55
menuitem: esnet-handling-responses
66
---
77

8-
# Handling responses
8+
# Handling Responses
99

1010
Describes how to handle the the response objects from `Elasticsearch.Net`
1111

@@ -34,7 +34,7 @@ A `byte[]` representation of the response from elasticsearch, only set when `Exp
3434
#### Response
3535
The deserialized `T` object representing the response.
3636

37-
## Typed API calls
37+
## Typed API Calls
3838

3939
`Elasticsearch.Net` does not provide typed objects representing the responses this is up to the developer to map.
4040

Diff for: new_docs/contents/nest/handling-responses.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
template: layout.jade
3-
title: Connecting
3+
title: Handling Responses
44
menusection: concepts
55
menuitem: handling-responses
66
---
77

88

9-
# Handling responses
9+
# Handling Responses
1010

1111

1212
All the return objects from API calls in NEST client implement:

Diff for: new_docs/contents/nest/index-type-inference.markdown

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
template: layout.jade
3-
title: Connecting
3+
title: Type/Index Inference
44
menusection: concepts
55
menuitem: index-type-inference
66
---
@@ -40,11 +40,11 @@ As noted in the [quick start](/nest/quick-start.html) you can always pass **expl
4040
.Ttl("1m")
4141
);
4242

43-
This will index the document using `/another-index/another-type/1-should-not-be-the-id?refresh=true&&ttl=1m` as the url.
43+
This will index the document using `/another-index/another-type/1-should-not-be-the-id?refresh=true&ttl=1m` as the url.
4444

4545
There are a couple of places within NEST where inference comes in to play
4646

47-
## Index name inference
47+
## Index Name Inference
4848

4949
Whenever an explicit index name is not provided NEST will look to see if the type has it's own default index name on the connection settings.
5050

@@ -56,12 +56,12 @@ Whenever an explicit index name is not provided NEST will look to see if the typ
5656
// searches in /my-type-index/mytype/_search
5757
client.Search<MyType>()
5858

59-
// searches in /my-default-index/mytype/_search
59+
// searches in /my-default-index/person/_search
6060
client.Search<Person>()
6161

6262
`MyType` defaults to `my-type-index` because it is explicitly configured but `Person` will default to the global fallback `my-default-index`.
6363

64-
## Type name inference
64+
## Type Name Inference
6565

6666
Whenever NEST needs a type name but is not given one explicitly it will use the given CLR type to infer it's Elasticsearch type name.
6767

@@ -90,7 +90,7 @@ Prior to NEST 1.0 typenames were by default lowercased AND pluralized, if you wa
9090

9191
settings.PluralizeTypeNames();
9292

93-
## Property name inference
93+
## Property Name Inference
9494
In many places `NEST` allows you to pass property names and JSON paths as C# expressions i.e
9595

9696
.Query(q=>q.Term(p=>p.Followers.First().FirstName, "martijn"))
@@ -107,7 +107,7 @@ This will leave property names untouched.
107107

108108
Properties marked with `[ElasticAttibute(Name="")]` or `[JsonProperty(Name="")]` will pass the configured name verbatim.
109109

110-
## Id inference
110+
## Id Inference
111111

112112
Whenever an object is passed that needs to specify an id (i.e index, bulk operations) the object is inspected to see if it has an `Id` property and if so, that value will be used.
113113

Diff for: new_docs/contents/nest/searching.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
template: layout.jade
3-
title: Connecting
3+
title: Searching
44
menusection: concepts
55
menuitem: searching
66
---

Diff for: new_docs/contents/nest/writing-queries.markdown

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
template: layout.jade
3-
title: Connecting
3+
title: Writing Queries
44
menusection: concepts
55
menuitem: writing-queries
66
---
@@ -14,7 +14,7 @@ One of the most important things to grasp when using Nest is how to write querie
1414
///EXAMPLE HERE
1515
);
1616

17-
## Raw strings
17+
## Raw Strings
1818
Although not preferred by me personally, many folks like to build their own JSON strings and just pass that along.
1919

2020
.QueryRaw("\"match_all\" : { }")
@@ -25,7 +25,7 @@ Nest does not modify this in anyway and just writes this straight into the JSON
2525
## Query DSL
2626
The preferred way to write queries, since it gives you alot of cool features.
2727

28-
### Lambda expressions
28+
### Lambda Expressions
2929
.Query(q=>q
3030
.Term(p=>p.Name, "NEST")
3131
)
@@ -44,7 +44,7 @@ Of course if you need to pass the property name as string NEST will allow you to
4444
.Term("followers.firstName", "martijn")
4545
)
4646

47-
### Static query/filter generator.
47+
### Static Query/Filter Generator
4848
Sometimes you'll need to resuse a filter or query often. To aid with this you can also write queries like this:
4949

5050
var termQuery = Query<ElasticSearchProject>
@@ -61,7 +61,7 @@ Sometimes you'll need to resuse a filter or query often. To aid with this you ca
6161

6262
Similarly `Filter<T>.[Filter]()` methods exist for filters.
6363

64-
### Boolean queries
64+
### Boolean Queries
6565
As can be seen in the previous example writing out boolean queries can turn into a really tedious and verbose effort. Luckily NEST supports bitwise operators and so we can rewrite the previous as such:
6666

6767
.Query(q=>q.MatchAll() && termQuery)
@@ -96,7 +96,7 @@ You can mix and match this to any level of complexity until it satisfies your qu
9696

9797
Will query all php clients except 'Elastica` or where the name equals `NEST`.
9898

99-
#### Clean output support
99+
#### Clean Output Support
100100
Normally writing three boolean must clauses looks like this (psuedo code)
101101

102102
must
@@ -114,7 +114,7 @@ A naive implemenation of the bitwise operators would make all the queries sent t
114114

115115
This degrades rather rapidly and makes inspecting generated queries quite a chore. NEST does it's best to detect these cases and will always write them in the first, cleaner form.
116116

117-
## Conditionless queries
117+
## Conditionless Queries
118118

119119
Writing complex boolean queries is one thing, but more often then not you'll want to make decisions on how to query based on user input.
120120

0 commit comments

Comments
 (0)