exists_query.go

package es

type existsType Object

// Exists creates a new es.existsType object to check if a field exists.
//
// This function initializes an es.existsType object that specifies a query to check
// if a particular field exists in the documents. The key parameter represents
// the name of the field to check for existence.
//
// Example usage:
//
//	e := es.Exists("title")
//	// e now contains an es.existsType object that checks for the existence of the "title" field.
//
// Parameters:
//   - key: A string representing the name of the field to check for existence.
//
// Returns:
//
//	An es.existsType object that includes the "exists" query for the specified field.
func Exists(key string) existsType {
	return existsType{
		"exists": Object{
			"field": key,
		},
	}
}

// Boost sets the "boost" parameter in an es.existsType query.
//
// This method allows you to specify a boost factor for the exists query,
// which influences the relevance score of matching documents. A higher
// boost value increases the importance of the query in the overall score,
// resulting in higher scores for documents that satisfy the exists condition.
//
// Example usage:
//
//	e := es.Exists().Boost(2.0)
//	// e now includes a "boost" parameter set to 2.0.
//
// Parameters:
//   - boost: A float64 value representing the boost factor for the exists
//     query.
//
// Returns:
//
//	The updated es.existsType object with the "boost" parameter set.
func (e existsType) Boost(boost float64) existsType {
	return e.putInTheField("boost", boost)
}

// ExistsFunc creates an es.existsType object based on a condition evaluated by a function.
//
// This function conditionally creates an es.existsType object if the provided function
// returns true for the given key. If the function returns false, it returns nil
// instead of creating an es.existsType object.
//
// Example usage:
//
//	e := es.ExistsFunc("title", func(key string) bool {
//	    return key != ""
//	})
//	// e is either an es.existsType object or nil based on the condition.
//
// Parameters:
//   - key: A string representing the name of the field to check for existence.
//   - f: A function that takes a key and returns a boolean indicating whether
//     to create the es.existsType object.
//
// Returns:
//
//	An es.existsType object if the condition is true; otherwise, nil.
func ExistsFunc(key string, f func(key string) bool) existsType {
	if !f(key) {
		return nil
	}
	return Exists(key)
}

// ExistsIf creates an es.existsType object based on a boolean condition.
//
// This function creates an es.existsType object if the provided condition is true.
// If the condition is false, it returns nil instead of creating an es.existsType object.
//
// Example usage:
//
//	e := es.ExistsIf("title", true)
//	// e is an es.existsType object if the condition is true; otherwise, it is nil.
//
// Parameters:
//   - key: A string representing the name of the field to check for existence.
//   - condition: A boolean value that determines whether to create the es.existsType object.
//
// Returns:
//
//	An es.existsType object if the condition is true; otherwise, nil.
func ExistsIf(key string, condition bool) existsType {
	if !condition {
		return nil
	}
	return Exists(key)
}

func (e existsType) putInTheField(key string, value any) existsType {
	if exists, ok := e["exists"].(Object); ok {
		exists[key] = value
	}
	return e
}