Terms Aggregation

This aggregation is a multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.

In order to use the Terms aggregation import the following:

import zio.elasticsearch.aggregation.TermsAggregation
import zio.elasticsearch.ElasticAggregation.termsAggregation

You can create a Terms aggregation using the termsAggregation method this way:

val aggregation: TermsAggregation = termsAggregation(name = "termsAggregation", field = "stringField.keyword")

You can create a type-safe Terms aggregation using the termsAggregation method this way:

// Document.stringField must be string value, because of Terms aggregation
val aggregation: TermsAggregation = termsAggregation(name = "termsAggregation", field = Document.stringField.keyword)

If you want to change the order, you can use orderBy, orderByCountAsc, orderByCountDesc, orderByKeyAsc or orderByKeyDesc method:

import zio.elasticsearch.aggregation.AggregationOrder
import zio.elasticsearch.query.sort.SortOrder.Asc

val aggregationWithOrder1: TermsAggregation = termsAggregation(name = "termsAggregation", field = Document.stringField).orderBy(AggregationOrder("otherAggregation", Asc))
val aggregationWithOrder2: TermsAggregation = termsAggregation(name = "termsAggregation", field = Document.stringField).orderByCountAsc
val aggregationWithOrder3: TermsAggregation = termsAggregation(name = "termsAggregation", field = Document.stringField).orderByCountDesc
val aggregationWithOrder4: TermsAggregation = termsAggregation(name = "termsAggregation", field = Document.stringField).orderByKeyAsc
val aggregationWithOrder5: TermsAggregation = termsAggregation(name = "termsAggregation", field = Document.stringField).orderByKeyDesc

If you want to change the size, you can use size method:

val aggregationWithSize: TermsAggregation = termsAggregation(name = "termsAggregation", field = Document.stringField).size(5)

If you want to add aggregation (on the same level), you can use withAgg method:

val multipleAggregations: MultipleAggregations = termsAggregation(name = "termsAggregation", field = Document.stringField).withAgg(maxAggregation(name = "maxAggregation", field = Document.intField))

If you want to add another sub-aggregation, you can use withSubAgg method:

val aggregationWithSubAgg: TermsAggregation = termsAggregation(name = "termsAggregation", field = Document.stringField).withSubAgg(maxAggregation(name = "maxAggregation", field = Document.intField))

You can find more information about Terms aggregation here.