aggs_bucket_missing.go

package aggretastic

// MissingAggregation is a field data based single bucket aggregation,
// that creates a bucket of all documents in the current document set context
// that are missing a field value (effectively, missing a field or having
// the configured NULL value set). This aggregator will often be used in
// conjunction with other field data bucket aggregators (such as ranges)
// to return information for all the documents that could not be placed
// in any of the other buckets due to missing field data values.
// See: https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-aggregations-bucket-missing-aggregation.html
type MissingAggregation struct {
	*tree

	field string
	meta  map[string]interface{}
}

func NewMissingAggregation() *MissingAggregation {
	a := &MissingAggregation{}
	a.tree = nilAggregationTree(a)

	return a
}

func (a *MissingAggregation) Field(field string) *MissingAggregation {
	a.field = field
	return a
}

func (a *MissingAggregation) SubAggregation(name string, subAggregation Aggregation) *MissingAggregation {
	a.subAggregations[name] = subAggregation
	return a
}

// Meta sets the meta data to be included in the aggregation response.
func (a *MissingAggregation) Meta(metaData map[string]interface{}) *MissingAggregation {
	a.meta = metaData
	return a
}

func (a *MissingAggregation) Source() (interface{}, error) {
	// Example:
	//	{
	//    "aggs" : {
	//      "products_without_a_price" : {
	//        "missing" : { "field" : "price" }
	//      }
	//    }
	//	}
	// This method returns only the { "missing" : { ... } } part.

	source := make(map[string]interface{})
	opts := make(map[string]interface{})
	source["missing"] = opts

	if a.field != "" {
		opts["field"] = a.field
	}

	// AggregationBuilder (SubAggregations)
	if len(a.subAggregations) > 0 {
		aggsMap := make(map[string]interface{})
		source["aggregations"] = aggsMap
		for name, aggregate := range a.subAggregations {
			src, err := aggregate.Source()
			if err != nil {
				return nil, err
			}
			aggsMap[name] = src
		}
	}

	// Add Meta data if available
	if len(a.meta) > 0 {
		source["meta"] = a.meta
	}

	return source, nil
}