New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
A newer version is available. For the latest information, see the current release documentation.
« Average Bucket Aggregation Usage Bucket Selector Aggregation Usage »
Elastic Docs ›Elasticsearch .NET Clients [7.17] ›Aggregations ›Pipeline Aggregations

Bucket Script Aggregation Usage

edit

Bucket Script Aggregation Usage

edit

Fluent DSL example

edit
a => a
.DateHistogram("projects_started_per_month", dh => dh
    .Field(p => p.StartedOn)
    .Interval(DateInterval.Month)
    .MinimumDocumentCount(1)
    .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.Source("params.stableCommits / params.totalCommits * 100"))
        )
    )
)

Object Initializer syntax example

edit
new DateHistogramAggregation("projects_started_per_month")
{
    Field = "startedOn",
    Interval = DateInterval.Month,
    MinimumDocumentCount = 1,
    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("params.stableCommits / params.totalCommits * 100")
        }
}

Example json output.

{
  "projects_started_per_month": {
    "date_histogram": {
      "field": "startedOn",
      "interval": "month",
      "min_doc_count": 1
    },
    "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": {
            "source": "params.stableCommits / params.totalCommits * 100"
          }
        }
      }
    }
  }
}

Handling Responses

edit
response.ShouldBeValid();

var projectsPerMonth = response.Aggregations.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 »

On this page

Was this helpful?
Feedback