Skip to content

Commit 7442272

Browse files
committed
bump to version 5.6.1
1 parent b3a84e2 commit 7442272

23 files changed

+18
-83
lines changed

docs/aggregations/writing-aggregations.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,6 @@ return s => s
230230
);
231231
----
232232
<1> a list of aggregation functions to apply
233-
234233
<2> Using LINQ's `Aggregate()` function to accumulate/apply all of the aggregation functions
235234

236235
[[aggs-vs-aggregations]]
@@ -278,6 +277,5 @@ var maxPerChild = childAggregation.Max("max_per_child");
278277
maxPerChild.Should().NotBeNull(); <2>
279278
----
280279
<1> Do something with the average per child. Here we just assert it's not null
281-
282280
<2> Do something with the max per child. Here we just assert it's not null
283281

docs/client-concepts/certificates/working-with-certificates.asciidoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,8 @@ public class PkiCluster : CertgenCaCluster
155155
}
156156
----
157157
<1> Set the client certificate on `ConnectionSettings`
158-
159158
<2> The path to the `.cer` file
160-
161159
<3> The path to the `.key` file
162-
163160
<4> The password for the private key
164161

165162
Or per request on `RequestConfiguration` which will take precedence over the ones defined on `ConnectionConfiguration`

docs/client-concepts/connection-pooling/exceptions/unexpected-exceptions.asciidoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,8 @@ audit = await audit.TraceUnexpectedException(
6060
);
6161
----
6262
<1> set up a cluster with 10 nodes
63-
6463
<2> where node 2 on port 9201 always throws an exception
65-
6664
<3> The first call to 9200 returns a healthy response
67-
6865
<4> ...but the second call, to 9201, returns a bad response
6966

7067
Sometimes, an unexpected exception happens further down in the pipeline. In this scenario, we
@@ -103,9 +100,7 @@ audit = await audit.TraceUnexpectedException(
103100
);
104101
----
105102
<1> calls on 9200 set up to throw a `WebException`
106-
107103
<2> calls on 9201 set up to throw an `Exception`
108-
109104
<3> Assert that the audit trail for the client call includes the bad response from 9200 and 9201
110105

111106
An unexpected hard exception on ping and sniff is something we *do* try to recover from and failover to retrying on the next node.
@@ -150,8 +145,6 @@ audit = await audit.TraceUnexpectedException(
150145
);
151146
----
152147
<1> `InnerException` is the exception that brought the request down
153-
154148
<2> The hard exception that happened on ping is still available though
155-
156149
<3> An exception can be hard to relate back to a point in time, so the exception is also available on the audit trail
157150

docs/client-concepts/connection-pooling/exceptions/unrecoverable-exceptions.asciidoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ var audit = new Auditor(() => Framework.Cluster
6868
);
6969
----
7070
<1> Always succeed on ping
71-
7271
<2> ...but always fail on calls with a 401 Bad Authentication response
7372

7473
Now, let's make a client call. We'll see that the first audit event is a successful ping
@@ -89,9 +88,7 @@ audit = await audit.TraceElasticsearchException(
8988
);
9089
----
9190
<1> First call results in a successful ping
92-
9391
<2> Second call results in a bad response
94-
9592
<3> The reason for the bad response is Bad Authentication
9693

9794
When a bad authentication response occurs, the client does not attempt to deserialize the response body returned;
@@ -125,7 +122,6 @@ audit = await audit.TraceElasticsearchException(
125122
);
126123
----
127124
<1> Always return a 401 bad response with a HTML response on client calls
128-
129125
<2> Assert that the response body bytes are null
130126

131127
Now in this example, by turning on `DisableDirectStreaming()` on `ConnectionSettings`, we see the same behaviour exhibited
@@ -158,6 +154,5 @@ audit = await audit.TraceElasticsearchException(
158154
);
159155
----
160156
<1> Response bytes are set on the response
161-
162157
<2> Assert that the response contains `"nginx/"`
163158

docs/client-concepts/connection-pooling/request-overrides/disable-sniff-ping-per-request.asciidoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,8 @@ audit = await audit.TraceCalls(
6767
);
6868
----
6969
<1> disable sniffing
70-
7170
<2> first call is a successful ping
72-
7371
<3> sniff on startup call happens here, on the second call
74-
7572
<4> No sniff on startup again
7673

7774
Now, let's disable pinging on the request
@@ -95,7 +92,6 @@ audit = await audit.TraceCall(
9592
);
9693
----
9794
<1> disable ping
98-
9995
<2> No ping after sniffing
10096

10197
Finally, let's demonstrate disabling both sniff and ping on the request
@@ -117,6 +113,5 @@ audit = await audit.TraceCall(
117113
);
118114
----
119115
<1> diable ping and sniff
120-
121116
<2> no ping or sniff before the call
122117

docs/client-concepts/connection-pooling/round-robin/skip-dead-nodes.asciidoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,7 @@ await audit.TraceCalls(
142142
);
143143
----
144144
<1> The first call goes to 9200 which succeeds
145-
146145
<2> The 2nd call does a ping on 9201 because its used for the first time. It fails so we wrap over to node 9202
147-
148146
<3> The next call goes to 9203 which fails so we should wrap over
149147

150148
A cluster with 2 nodes where the second node fails on ping
@@ -194,6 +192,5 @@ await audit.TraceCalls(
194192
);
195193
----
196194
<1> All the calls fail
197-
198195
<2> After all our registered nodes are marked dead we want to sample a single dead node each time to quickly see if the cluster is back up. We do not want to retry all 4 nodes
199196

docs/client-concepts/connection-pooling/sniffing/role-detection.asciidoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,6 @@ var audit = new Auditor(() => Framework.Cluster
140140
};
141141
----
142142
<1> Before the sniff, assert we only see three master only nodes
143-
144143
<2> After the sniff, assert we now know about the existence of 20 nodes.
145144

146145
After the sniff has happened on 9200 before the first API call, assert that the subsequent API
@@ -221,9 +220,7 @@ var audit = new Auditor(() => Framework.Cluster
221220
};
222221
----
223222
<1> for testing simplicity, disable pings
224-
225223
<2> We only want to execute API calls to nodes in rack_one
226-
227224
<3> After sniffing on startup, assert that the pool of nodes that the client will execute API calls against only contains the three nodes that are in `rack_one`
228225

229226
With the cluster set up, assert that the sniff happens on 9200 before the first API call
@@ -300,8 +297,6 @@ await audit.TraceUnexpectedElasticsearchException(new ClientCall
300297
});
301298
----
302299
<1> The audit trail indicates a sniff for the very first time on startup
303-
304300
<2> The sniff succeeds because the node predicate is ignored when sniffing
305-
306301
<3> when trying to do an actual API call however, the predicate prevents any nodes from being attempted
307302

docs/client-concepts/connection/configuration-options.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -174,37 +174,37 @@ The following is a list of available connection configuration options on `Connec
174174

175175
Specify how field names are inferred from POCO property names.
176176
+
177-
By default, NEST camel cases property names e.g. EmailAddress POCO property => "emailAddress" Elasticsearch document field name
177+
By default, NEST camel cases property names e.g. EmailAddress POCO property => "emailAddress" Elasticsearch document field name
178178

179179
`DefaultIndex`::
180180

181181
The default index to use when no index is specified.
182182

183183
`DefaultTypeNameInferrer`::
184184

185-
Specify how type names are inferred from POCO types. By default, type names are inferred by calling `ToLowerInvariant` on the type's name.
185+
Specify how type names are inferred from POCO types. By default, type names are inferred by calling `ToLowerInvariant` on the type's name.
186186

187187
`MapDefaultTypeIndices`::
188188

189-
Specify the default index names for a given POCO type. Takes precedence over the global `DefaultIndex`
189+
Specify the default index names for a given POCO type. Takes precedence over the global `DefaultIndex` Removed in 6.x.
190190

191191
`MapDefaultTypeNames`::
192192

193-
Specify the default type names for a given POCO type. Takes precedence over the global `DefaultTypeNameInferrer`
193+
Specify the default type names for a given POCO type. Takes precedence over the global `DefaultTypeNameInferrer` Removed in 6.x.
194194

195195
`MapIdPropertyFor`::
196196

197-
Specify which property on a given POCO should be used to infer the id of the document when indexed in Elasticsearch. The type of the document.
197+
Specify which property on a given POCO should be used to infer the id of the document when indexed in Elasticsearch. The type of the document. Removed in 6.x.
198198

199199
`MapPropertiesFor`::
200200

201-
Specify how the properties are mapped for a given POCO type. The type of the document.
201+
Specify how the properties are mapped for a given POCO type. The type of the document. Removed in 6.x.
202202

203203
`PluralizeTypeNames`::
204204

205205
Pluralize type names when inferring from POCO type names.
206206
+
207-
This calls `DefaultTypeNameInferrer` with an implementation that will pluralize type names. This used to be the default prior to Nest 0.90
207+
This calls `DefaultTypeNameInferrer` with an implementation that will pluralize type names. This used to be the default prior to Nest 0.90
208208

209209
:xml-docs: Nest:ConnectionSettingsBase`1
210210

docs/client-concepts/high-level/analysis/writing-analyzers.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ var createIndexResponse = client.CreateIndex("my-index", c => c
106106
);
107107
----
108108
<1> Pre-defined list of English stopwords within Elasticsearch
109-
110109
<2> Use the `standard_english` analyzer configured
111110

112111
[source,javascript]
@@ -274,7 +273,6 @@ var createIndexResponse = client.CreateIndex("questions", c => c
274273
);
275274
----
276275
<1> Use an analyzer at index time that strips HTML tags
277-
278276
<2> Use an analyzer at search time that does not strip HTML tags
279277

280278
With this in place, the text of a question body will be analyzed with the `index_question` analyzer

docs/client-concepts/high-level/getting-started.asciidoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,6 @@ var indexResponse = client.Index(person); <1>
109109
var asyncIndexResponse = await client.IndexAsync(person); <2>
110110
----
111111
<1> synchronous method that returns an `IIndexResponse`
112-
113112
<2> asynchronous method that returns a `Task<IIndexResponse>` that can be awaited
114113

115114
NOTE: All methods available within NEST are exposed as both synchronous and asynchronous versions,

0 commit comments

Comments
 (0)