You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add XML docs for index inference on BulkAll (#4017)
This commit adds additional XML docs to indicate that Index on BulkAllRequest<T> will be inferred from T. When a default index has not been mapped for
T on ConnectionSettings, using DefaultMappingFor<T>(m => m.IndexName("some_index")), an exception will be thrown.
Closes#3951
(cherry picked from commit 11d3ba3)
Copy file name to clipboardExpand all lines: src/Nest/Document/Multiple/BulkAll/ElasticClient-BulkAll.cs
+12-2Lines changed: 12 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,12 @@ namespace Nest
7
7
publicpartialinterfaceIElasticClient
8
8
{
9
9
/// <summary>
10
-
/// BulkAll is a generic helper that will partition any lazy stream of documents and send them to Elasticsearch as bulks concurrently
10
+
/// BulkAll is a generic helper that will partition any lazy stream of documents and send them to Elasticsearch as concurrent bulk requests.
11
+
/// <para />
12
+
/// The index to target will be inferred from <typeparamref name="T" />. If no default index has been mapped for <typeparamref name="T" />
13
+
/// using <see cref="ConnectionSettingsBase{TConnectionSettings}.DefaultMappingFor{TDocument}"/> on <see cref="Nest.ConnectionSettings"/>, an exception will be thrown.
14
+
/// Inference can be overridden using <see cref="BulkAllDescriptor{T}.Index"/>, and in addition,
15
+
/// an index can be specified for each document using <see cref="BulkAllDescriptor{T}.BufferToBulk"/>.
11
16
/// </summary>
12
17
/// <param name="documents">The lazy stream of documents</param>
/// BulkAll is a generic helper that will partition any lazy stream of documents and send them to Elasticsearch as bulks concurrently
26
+
/// BulkAll is a generic helper that will partition any lazy stream of documents and send them to Elasticsearch as concurrent bulk requests
27
+
/// <para />
28
+
/// The index to target will be inferred from <typeparamref name="T" />. If no default index has been mapped for <typeparamref name="T" />
29
+
/// using <see cref="ConnectionSettingsBase{TConnectionSettings}.DefaultMappingFor{TDocument}"/> on <see cref="Nest.ConnectionSettings"/>, an exception will be thrown.
30
+
/// Inference can be overridden using <see cref="IBulkAllRequest{T}.Index"/>, and in addition,
31
+
/// an index can be specified for each document using <see cref="IBulkAllRequest{T}.BufferToBulk"/>.
0 commit comments