null_value.go

package mapping

// WithNullValue is a mapping with the null_value parameter
//
// A null value cannot be indexed or searched. When a field is set to null, (or
// an empty array or an array of null values) it is treated as though that field
// has no values.
//
// The null_value parameter allows you to replace explicit null values with the
// specified value so that it can be indexed and searched
//
// The null_value needs to be the same data type as the field. For instance, a
// long field cannot have a string null_value.
//
// https://www.elastic.co/guide/en/elasticsearch/reference/current/null-value.html
type WithNullValue interface {
	// NullValue parameter allows you to replace explicit null values with the
	// specified value so that it can be indexed and searched
	NullValue() interface{}
	// SetNullValue sets the NullValue value to v
	SetNullValue(v interface{})
}

// NullValueParam is a mixin that adds the null_value parameter
//
// A null value cannot be indexed or searched. When a field is set to null, (or
// an empty array or an array of null values) it is treated as though that field
// has no values.
//
// The null_value parameter allows you to replace explicit null values with the
// specified value so that it can be indexed and searched
//
// The null_value needs to be the same data type as the field. For instance, a
// long field cannot have a string null_value.
//
// https://www.elastic.co/guide/en/elasticsearch/reference/current/null-value.html
type NullValueParam struct {
	NullValueValue interface{} `bson:"null_value,omitempty" json:"null_value,omitempty"`
}

// NullValue parameter allows you to replace explicit null values with the
// specified value so that it can be indexed and searched
func (nv NullValueParam) NullValue() interface{} {
	return nv.NullValueValue
}

// SetNullValue sets the NullValue value to v
func (nv *NullValueParam) SetNullValue(v interface{}) {
	if nv.NullValue() != v {
		nv.NullValueValue = v
	}
}