Skip to content

Commit 900ab2b

Browse files
committed
Update documentation
1 parent 78774ef commit 900ab2b

File tree

8 files changed

+53
-18
lines changed

8 files changed

+53
-18
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[[filter-aggregation-usage]]
88
== Filter Aggregation Usage
99

10-
Defines a single bucket of all the documents in the current document set context that match a specified filter.
10+
Defines a single bucket of all the documents in the current document set context that match a specified filter.
1111
Often this will be used to narrow down the current aggregation context to a specific set of documents.
1212

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

docs/asciidoc/aggregations/pipeline/moving-average/moving-average-ewma-aggregation-usage.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ new SearchRequest<Project>()
4545
{
4646
Field = "startedOn",
4747
Interval = DateInterval.Month,
48-
Aggregations =
48+
Aggregations =
4949
new SumAggregation("commits", "numberOfCommits") &&
5050
new MovingAverageAggregation("commits_moving_avg", "commits")
5151
{

docs/asciidoc/aggregations/pipeline/moving-average/moving-average-holt-linear-aggregation-usage.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ new SearchRequest<Project>()
4646
{
4747
Field = "startedOn",
4848
Interval = DateInterval.Month,
49-
Aggregations =
49+
Aggregations =
5050
new SumAggregation("commits", "numberOfCommits") &&
5151
new MovingAverageAggregation("commits_moving_avg", "commits")
5252
{

docs/asciidoc/aggregations/pipeline/moving-average/moving-average-holt-winters-aggregation-usage.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ new SearchRequest<Project>()
5151
{
5252
Field = "startedOn",
5353
Interval = DateInterval.Month,
54-
Aggregations =
54+
Aggregations =
5555
new SumAggregation("commits", "numberOfCommits") &&
5656
new MovingAverageAggregation("commits_moving_avg", "commits")
5757
{

docs/asciidoc/aggregations/pipeline/moving-average/moving-average-linear-aggregation-usage.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ new SearchRequest<Project>()
4444
{
4545
Field = "startedOn",
4646
Interval = DateInterval.Month,
47-
Aggregations =
47+
Aggregations =
4848
new SumAggregation("commits", "numberOfCommits") &&
4949
new MovingAverageAggregation("commits_moving_avg", "commits")
5050
{

docs/asciidoc/aggregations/pipeline/moving-average/moving-average-simple-aggregation-usage.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ new SearchRequest<Project>()
4545
{
4646
Field = "startedOn",
4747
Interval = DateInterval.Month,
48-
Aggregations =
48+
Aggregations =
4949
new SumAggregation("commits", "numberOfCommits") &&
5050
new MovingAverageAggregation("commits_moving_avg", "commits")
5151
{

docs/asciidoc/query-dsl/specialized/script/script-query-usage.asciidoc

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
[[script-query-usage]]
88
== Script Query Usage
99

10+
A query allowing to define {ref_current}/modules-scripting.html[scripts] as queries.
11+
12+
See the Elasticsearch documentation on {ref_current}/query-dsl-script-query.html[script query] for more details.
13+
1014
=== Fluent DSL Example
1115

1216
[source,csharp]
@@ -16,7 +20,7 @@ q
1620
.Name("named_query")
1721
.Boost(1.1)
1822
.Inline(_templateString)
19-
.Params(p=>p.Add("param1", 1))
23+
.Params(p => p.Add("param1", 50))
2024
)
2125
----
2226

@@ -31,7 +35,7 @@ new ScriptQuery
3135
Inline = _templateString,
3236
Params = new Dictionary<string, object>
3337
{
34-
{ "param1", 1 }
38+
{ "param1", 50 }
3539
}
3640
}
3741
----
@@ -44,12 +48,20 @@ new ScriptQuery
4448
"_name": "named_query",
4549
"boost": 1.1,
4650
"script": {
47-
"inline": "doc['num1'].value > param1",
51+
"inline": "doc['numberOfCommits'].value > param1",
4852
"params": {
49-
"param1": 1
53+
"param1": 50
5054
}
5155
}
5256
}
5357
}
5458
----
5559

60+
=== Handling Responses
61+
62+
[source,csharp]
63+
----
64+
response.IsValid.Should().BeTrue();
65+
response.Documents.Count().Should().BeGreaterThan(0);
66+
----
67+

src/Tests/QueryDsl/Specialized/Script/ScriptQueryUsageTests.cs

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
1-
using System.Collections.Generic;
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Linq;
4+
using System.Threading.Tasks;
5+
using FluentAssertions;
26
using Nest;
7+
using Tests.Framework;
38
using Tests.Framework.Integration;
49
using Tests.Framework.MockData;
10+
using Xunit;
511

612
namespace Tests.QueryDsl.Specialized.Script
713
{
8-
public class ScriptUsageTests : QueryDslUsageTestsBase
14+
/**
15+
* A query allowing to define {ref_current}/modules-scripting.html[scripts] as queries.
16+
*
17+
* See the Elasticsearch documentation on {ref_current}/query-dsl-script-query.html[script query] for more details.
18+
*/
19+
[Collection(IntegrationContext.ReadOnly)]
20+
public class ScriptQueryUsageTests : QueryDslUsageTestsBase
921
{
10-
public ScriptUsageTests(ReadOnlyCluster i, EndpointUsage usage) : base(i, usage) { }
22+
public ScriptQueryUsageTests(ReadOnlyCluster i, EndpointUsage usage) : base(i, usage) { }
1123

12-
private static readonly string _templateString = "doc['num1'].value > param1";
24+
private static readonly string _templateString = "doc['numberOfCommits'].value > param1";
25+
26+
protected override bool ForceInMemory => false;
1327

1428
protected override object QueryJson => new
1529
{
@@ -19,8 +33,8 @@ public ScriptUsageTests(ReadOnlyCluster i, EndpointUsage usage) : base(i, usage)
1933
boost = 1.1,
2034
script = new
2135
{
22-
inline = "doc['num1'].value > param1",
23-
@params = new { param1 = 1 }
36+
inline = "doc['numberOfCommits'].value > param1",
37+
@params = new { param1 = 50 }
2438
}
2539
}
2640
};
@@ -32,7 +46,7 @@ public ScriptUsageTests(ReadOnlyCluster i, EndpointUsage usage) : base(i, usage)
3246
Inline = _templateString,
3347
Params = new Dictionary<string, object>
3448
{
35-
{ "param1", 1 }
49+
{ "param1", 50 }
3650
}
3751
};
3852

@@ -41,9 +55,18 @@ protected override QueryContainer QueryFluent(QueryContainerDescriptor<Project>
4155
.Name("named_query")
4256
.Boost(1.1)
4357
.Inline(_templateString)
44-
.Params(p=>p.Add("param1", 1))
58+
.Params(p => p.Add("param1", 50))
4559
);
4660

61+
protected void ExpectResponse(ISearchResponse<Project> response)
62+
{
63+
response.IsValid.Should().BeTrue();
64+
response.Documents.Count().Should().BeGreaterThan(0);
65+
}
66+
67+
[I]
68+
protected async Task ReturnsExpectedResponse() => await this.AssertOnAllResponses(ExpectResponse);
69+
4770
protected override ConditionlessWhen ConditionlessWhen => new ConditionlessWhen<IScriptQuery>(a => a.Script)
4871
{
4972
q => {

0 commit comments

Comments
 (0)