Class CombinedFieldsQueryDescriptor<T>

The combined_fields query supports searching multiple text fields as if their contents had been indexed into one combined field. The query analyzes the provided text before performing a search, and it scores documents using a term-centric approach that treats the matched fields as a single field.

All queried fields must have the same search analyzer. Only text fields are supported.

Inheritance
object
DescriptorBase<CombinedFieldsQueryDescriptor<T>, ICombinedFieldsQuery>
QueryDescriptorBase<CombinedFieldsQueryDescriptor<T>, ICombinedFieldsQuery>
CombinedFieldsQueryDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
[DataContract]
public class CombinedFieldsQueryDescriptor<T> : QueryDescriptorBase<CombinedFieldsQueryDescriptor<T>, ICombinedFieldsQuery>, IDescriptor, ICombinedFieldsQuery, IQuery where T : class
Type Parameters
Name Description
T

Properties

| Edit this page View Source

Conditionless

Whether the query is conditionless. A conditionless query is not serialized as part of the request sent to OpenSearch.

Declaration
protected override bool Conditionless { get; }
Property Value
Type Description
bool
Overrides

Methods

| Edit this page View Source

Fields(Fields)

The list of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all share the same search analyzer.

Declaration
public CombinedFieldsQueryDescriptor<T> Fields(Fields fields)
Parameters
Type Name Description
Fields fields
Returns
Type Description
CombinedFieldsQueryDescriptor<T>
| Edit this page View Source

Fields(Func<FieldsDescriptor<T>, IPromise<Fields>>)

The list of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all share the same search analyzer.

Declaration
public CombinedFieldsQueryDescriptor<T> Fields(Func<FieldsDescriptor<T>, IPromise<Fields>> fields)
Parameters
Type Name Description
Func<FieldsDescriptor<T>, IPromise<Fields>> fields
Returns
Type Description
CombinedFieldsQueryDescriptor<T>
| Edit this page View Source

MinimumShouldMatch(MinimumShouldMatch)

A value controlling how many "should" clauses in the resulting boolean query should match. It can be an absolute value, a percentage or a combination of both.

Declaration
public CombinedFieldsQueryDescriptor<T> MinimumShouldMatch(MinimumShouldMatch minimumShouldMatch)
Parameters
Type Name Description
MinimumShouldMatch minimumShouldMatch
Returns
Type Description
CombinedFieldsQueryDescriptor<T>
| Edit this page View Source

Operator(Operator?)

The operator used to combine the analyzed terms of the query value. The default operator is Or.

Declaration
public CombinedFieldsQueryDescriptor<T> Operator(Operator? op)
Parameters
Type Name Description
Operator? op
Returns
Type Description
CombinedFieldsQueryDescriptor<T>
| Edit this page View Source

Query(string)

The text to search for in the provided Fields. The combined_fields query analyzes the provided text before performing a search.

Declaration
public CombinedFieldsQueryDescriptor<T> Query(string query)
Parameters
Type Name Description
string query
Returns
Type Description
CombinedFieldsQueryDescriptor<T>

Implements

Extension Methods