WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Average Bucket Aggregation Usage Bucket Selector Aggregation Usage »

› › ›

Bucket Script Aggregation Usage

edit

Bucket Script Aggregation Usage

edit

Fluent DSL example

edit

s => s
.Size(0)
.Aggregations(a => a
    .DateHistogram("projects_started_per_month", dh => dh
        .Field(p => p.StartedOn)
        .Interval(DateInterval.Month)
        .Aggregations(aa => aa
            .Sum("commits", sm => sm
                .Field(p => p.NumberOfCommits)
            )
            .Filter("stable_state", f => f
                .Filter(ff => ff
                    .Term(p => p.State, "Stable")
                )
                .Aggregations(aaa => aaa
                    .Sum("commits", sm => sm
                        .Field(p => p.NumberOfCommits)
                    )
                )
            )
            .BucketScript("stable_percentage", bs => bs
                .BucketsPath(bp => bp
                    .Add("totalCommits", "commits")
                    .Add("stableCommits", "stable_state>commits")
                )
                .Script(ss => ss.Inline("stableCommits / totalCommits * 100").Lang("groovy"))
            )
        )
    )
)

Object Initializer syntax example

edit

new SearchRequest<Project>()
{
    Size = 0,
    Aggregations = new DateHistogramAggregation("projects_started_per_month")
    {
        Field = "startedOn",
        Interval = DateInterval.Month,
        Aggregations =
            new SumAggregation("commits", "numberOfCommits") &&
            new FilterAggregation("stable_state")
            {
                Filter = new TermQuery
                {
                    Field = "state",
                    Value = "Stable"
                },
                Aggregations = new SumAggregation("commits", "numberOfCommits")
            } &&
            new BucketScriptAggregation("stable_percentage", new MultiBucketsPath
            {
                { "totalCommits", "commits" },
                { "stableCommits", "stable_state>commits" }
            })
            {
                Script = new InlineScript("stableCommits / totalCommits * 100") { Lang = "groovy" }
            }
    }
}

Example json output.

{
  "size": 0,
  "aggs": {
    "projects_started_per_month": {
      "date_histogram": {
        "field": "startedOn",
        "interval": "month"
      },
      "aggs": {
        "commits": {
          "sum": {
            "field": "numberOfCommits"
          }
        },
        "stable_state": {
          "filter": {
            "term": {
              "state": {
                "value": "Stable"
              }
            }
          },
          "aggs": {
            "commits": {
              "sum": {
                "field": "numberOfCommits"
              }
            }
          }
        },
        "stable_percentage": {
          "bucket_script": {
            "buckets_path": {
              "totalCommits": "commits",
              "stableCommits": "stable_state>commits"
            },
            "script": {
              "inline": "stableCommits / totalCommits * 100",
              "lang": "groovy"
            }
          }
        }
      }
    }
  }
}

Handling Responses

edit

response.ShouldBeValid();

var projectsPerMonth = response.Aggs.DateHistogram("projects_started_per_month");
projectsPerMonth.Should().NotBeNull();
projectsPerMonth.Buckets.Should().NotBeNull();
projectsPerMonth.Buckets.Count.Should().BeGreaterThan(0);

foreach (var item in projectsPerMonth.Buckets)
{
    var stablePercentage = item.BucketScript("stable_percentage");
    stablePercentage.Should().NotBeNull();
    stablePercentage.Value.Should().HaveValue();
}

« Average Bucket Aggregation Usage Bucket Selector Aggregation Usage »