Skip to content

Commit f7108da

Browse files
committed
Update documentation
1 parent 8fd4ad6 commit f7108da

File tree

88 files changed

+1109
-127
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+1109
-127
lines changed

docs/aggregations.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@ In addition to the buckets themselves, the bucket aggregations also compute and
138138

139139
* <<significant-terms-aggregation-usage,Significant Terms Aggregation Usage>>
140140

141+
* <<significant-text-aggregation-usage,Significant Text Aggregation Usage>>
142+
141143
* <<terms-aggregation-usage,Terms Aggregation Usage>>
142144

143145
[NOTE]
@@ -187,6 +189,8 @@ include::aggregations/bucket/sampler/sampler-aggregation-usage.asciidoc[]
187189

188190
include::aggregations/bucket/significant-terms/significant-terms-aggregation-usage.asciidoc[]
189191

192+
include::aggregations/bucket/significant-text/significant-text-aggregation-usage.asciidoc[]
193+
190194
include::aggregations/bucket/terms/terms-aggregation-usage.asciidoc[]
191195

192196
[[pipeline-aggregations]]
@@ -203,6 +207,8 @@ There are many different types of pipeline aggregation, each computing different
203207

204208
* <<bucket-selector-aggregation-usage,Bucket Selector Aggregation Usage>>
205209

210+
* <<bucket-sort-aggregation-usage,Bucket Sort Aggregation Usage>>
211+
206212
* <<cumulative-sum-aggregation-usage,Cumulative Sum Aggregation Usage>>
207213

208214
* <<derivative-aggregation-usage,Derivative Aggregation Usage>>
@@ -241,6 +247,8 @@ include::aggregations/pipeline/bucket-script/bucket-script-aggregation-usage.asc
241247

242248
include::aggregations/pipeline/bucket-selector/bucket-selector-aggregation-usage.asciidoc[]
243249

250+
include::aggregations/pipeline/bucket-sort/bucket-sort-aggregation-usage.asciidoc[]
251+
244252
include::aggregations/pipeline/cumulative-sum/cumulative-sum-aggregation-usage.asciidoc[]
245253

246254
include::aggregations/pipeline/derivative/derivative-aggregation-usage.asciidoc[]

docs/aggregations/aggregation-meta-usage.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ please modify the original csharp file found at the link and submit the PR with
1717

1818
Metadata can be provided per aggregation, and will be returned in the aggregation response
1919

20+
==== Fluent DSL example
21+
2022
[source,csharp]
2123
----
2224
a => a
@@ -30,6 +32,8 @@ a => a
3032
)
3133
----
3234

35+
==== Object Initializer syntax example
36+
3337
[source,csharp]
3438
----
3539
new MinAggregation("min_last_activity", Infer.Field<Project>(p => p.LastActivity))

docs/aggregations/bucket/adjacency-matrix/adjacency-matrix-usage.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ please modify the original csharp file found at the link and submit the PR with
1515
[[adjacency-matrix-usage]]
1616
=== Adjacency Matrix Usage
1717

18+
==== Fluent DSL example
19+
1820
[source,csharp]
1921
----
2022
a => a
@@ -27,6 +29,8 @@ a => a
2729
)
2830
----
2931

32+
==== Object Initializer syntax example
33+
3034
[source,csharp]
3135
----
3236
new AdjacencyMatrixAggregation("interactions")

docs/aggregations/bucket/children/children-aggregation-usage.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ buckets on child documents.
2020

2121
Be sure to read the Elasticsearch documentation on {ref_current}/search-aggregations-bucket-children-aggregation.html[Children Aggregation]
2222

23+
==== Fluent DSL example
24+
2325
[source,csharp]
2426
----
2527
a => a
@@ -32,6 +34,8 @@ a => a
3234
)
3335
----
3436

37+
==== Object Initializer syntax example
38+
3539
[source,csharp]
3640
----
3741
new ChildrenAggregation("name_of_child_agg", typeof(CommitActivity))

docs/aggregations/bucket/date-histogram/date-histogram-aggregation-usage.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ as part of the `format` value.
2525

2626
Be sure to read the Elasticsearch documentation on {ref_current}/search-aggregations-bucket-datehistogram-aggregation.html[Date Histogram Aggregation].
2727

28+
==== Fluent DSL example
29+
2830
[source,csharp]
2931
----
3032
a => a
@@ -47,6 +49,8 @@ a => a
4749
)
4850
----
4951

52+
==== Object Initializer syntax example
53+
5054
[source,csharp]
5155
----
5256
new DateHistogramAggregation("projects_started_per_month")

docs/aggregations/bucket/date-range/date-range-aggregation-usage.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ IMPORTANT: this aggregation includes the `from` value and excludes the `to` valu
2323

2424
Be sure to read the Elasticsearch documentation on {ref_current}/search-aggregations-bucket-daterange-aggregation.html[Date Range Aggregation]
2525

26+
==== Fluent DSL example
27+
2628
[source,csharp]
2729
----
2830
a => a
@@ -40,6 +42,8 @@ a => a
4042
)
4143
----
4244

45+
==== Object Initializer syntax example
46+
4347
[source,csharp]
4448
----
4549
new DateRangeAggregation("projects_date_ranges")

docs/aggregations/bucket/filter/filter-aggregation-usage.asciidoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Often this will be used to narrow down the current aggregation context to a spec
2020

2121
Be sure to read the Elasticsearch documentation on {ref_current}/search-aggregations-bucket-filter-aggregation.html[Filter Aggregation]
2222

23+
==== Fluent DSL example
24+
2325
[source,csharp]
2426
----
2527
a => a
@@ -31,6 +33,8 @@ a => a
3133
)
3234
----
3335

36+
==== Object Initializer syntax example
37+
3438
[source,csharp]
3539
----
3640
new FilterAggregation("bethels_projects")
@@ -90,6 +94,8 @@ tags.Buckets.Should().NotBeEmpty();
9094
When the collection of filters is empty or all are conditionless, NEST will serialize them
9195
to an empty object.
9296

97+
==== Fluent DSL example
98+
9399
[source,csharp]
94100
----
95101
a => a
@@ -102,6 +108,8 @@ a => a
102108
)
103109
----
104110

111+
==== Object Initializer syntax example
112+
105113
[source,csharp]
106114
----
107115
new FilterAggregation("empty_filter")
@@ -123,11 +131,15 @@ new FilterAggregation("empty_filter")
123131
}
124132
----
125133

134+
==== Handling Responses
135+
126136
[source,csharp]
127137
----
128138
response.ShouldNotBeValid();
129139
----
130140

141+
==== Fluent DSL example
142+
131143
[source,csharp]
132144
----
133145
a => a
@@ -140,6 +152,8 @@ a => a
140152
)
141153
----
142154

155+
==== Object Initializer syntax example
156+
143157
[source,csharp]
144158
----
145159
new FilterAggregation(_aggName)
@@ -167,6 +181,8 @@ new FilterAggregation(_aggName)
167181
}
168182
----
169183

184+
==== Handling Responses
185+
170186
[source,csharp]
171187
----
172188
response.ShouldBeValid();

docs/aggregations/bucket/filters/filters-aggregation-usage.asciidoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ Be sure to read the Elasticsearch documentation {ref_current}/search-aggregation
2424
[float]
2525
=== Named filters
2626

27+
==== Fluent DSL example
28+
2729
[source,csharp]
2830
----
2931
a => a
@@ -41,6 +43,8 @@ a => a
4143
)
4244
----
4345

46+
==== Object Initializer syntax example
47+
4448
[source,csharp]
4549
----
4650
new FiltersAggregation("projects_by_state")
@@ -134,6 +138,8 @@ namedResult.DocCount.Should().Be(0);
134138
[float]
135139
=== Anonymous filters
136140

141+
==== Fluent DSL example
142+
137143
[source,csharp]
138144
----
139145
a => a
@@ -150,6 +156,8 @@ a => a
150156
)
151157
----
152158

159+
==== Object Initializer syntax example
160+
153161
[source,csharp]
154162
----
155163
new FiltersAggregation("projects_by_state")
@@ -235,6 +243,8 @@ results.Last().DocCount.Should().Be(0); <1>
235243
[float]
236244
=== Empty Filters
237245

246+
==== Fluent DSL example
247+
238248
[source,csharp]
239249
----
240250
a => a
@@ -243,6 +253,8 @@ a => a
243253
)
244254
----
245255

256+
==== Object Initializer syntax example
257+
246258
[source,csharp]
247259
----
248260
new FiltersAggregation("empty_filters")
@@ -263,6 +275,8 @@ new FiltersAggregation("empty_filters")
263275
}
264276
----
265277

278+
==== Handling Responses
279+
266280
[source,csharp]
267281
----
268282
response.ShouldBeValid();
@@ -272,6 +286,8 @@ response.Aggregations.Filters("empty_filters").Buckets.Should().BeEmpty();
272286
[float]
273287
=== Conditionless Filters
274288

289+
==== Fluent DSL example
290+
275291
[source,csharp]
276292
----
277293
a => a
@@ -282,6 +298,8 @@ a => a
282298
)
283299
----
284300

301+
==== Object Initializer syntax example
302+
285303
[source,csharp]
286304
----
287305
new FiltersAggregation("conditionless_filters")
@@ -305,6 +323,8 @@ new FiltersAggregation("conditionless_filters")
305323
}
306324
----
307325

326+
==== Handling Responses
327+
308328
[source,csharp]
309329
----
310330
response.ShouldBeValid();

docs/aggregations/bucket/geo-distance/geo-distance-aggregation-usage.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ please modify the original csharp file found at the link and submit the PR with
1515
[[geo-distance-aggregation-usage]]
1616
=== Geo Distance Aggregation Usage
1717

18+
==== Fluent DSL example
19+
1820
[source,csharp]
1921
----
2022
a => a
@@ -29,6 +31,8 @@ a => a
2931
)
3032
----
3133

34+
==== Object Initializer syntax example
35+
3236
[source,csharp]
3337
----
3438
new GeoDistanceAggregation("rings_around_amsterdam")

docs/aggregations/bucket/geo-hash-grid/geo-hash-grid-aggregation-usage.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ please modify the original csharp file found at the link and submit the PR with
1515
[[geo-hash-grid-aggregation-usage]]
1616
=== Geo Hash Grid Aggregation Usage
1717

18+
==== Fluent DSL example
19+
1820
[source,csharp]
1921
----
2022
a => a
@@ -26,6 +28,8 @@ a => a
2628
)
2729
----
2830

31+
==== Object Initializer syntax example
32+
2933
[source,csharp]
3034
----
3135
new GeoHashGridAggregation("my_geohash_grid")

0 commit comments

Comments
 (0)