IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Derivative Aggregation Usage
editDerivative Aggregation Usage
editFluent DSL example
edita => a
.DateHistogram("projects_started_per_month", dh => dh
.Field(p => p.StartedOn)
.Interval(DateInterval.Month)
.MinimumDocumentCount(0)
.Aggregations(aa => aa
.Sum("commits", sm => sm
.Field(p => p.NumberOfCommits)
)
.Derivative("commits_derivative", d => d
.BucketsPath("commits")
)
)
)
Object Initializer syntax example
editnew DateHistogramAggregation("projects_started_per_month")
{
Field = "startedOn",
Interval = DateInterval.Month,
MinimumDocumentCount = 0,
Aggregations =
new SumAggregation("commits", "numberOfCommits") &&
new DerivativeAggregation("commits_derivative", "commits")
}
Example json output.
{
"projects_started_per_month": {
"date_histogram": {
"field": "startedOn",
"interval": "month",
"min_doc_count": 0
},
"aggs": {
"commits": {
"sum": {
"field": "numberOfCommits"
}
},
"commits_derivative": {
"derivative": {
"buckets_path": "commits"
}
}
}
}
}
Handling Responses
editresponse.ShouldBeValid();
var projectsPerMonth = response.Aggregations.DateHistogram("projects_started_per_month");
projectsPerMonth.Should().NotBeNull();
projectsPerMonth.Buckets.Should().NotBeNull();
projectsPerMonth.Buckets.Count.Should().BeGreaterThan(0);
// derivative not calculated for the first bucket
foreach (var item in projectsPerMonth.Buckets.Skip(1))
{
var commitsDerivative = item.Derivative("commits_derivative");
commitsDerivative.Should().NotBeNull();
commitsDerivative.Value.Should().NotBe(null);
}