BoolQuery

zio.elasticsearch.query.BoolQuery
sealed trait BoolQuery[S] extends ElasticQuery[S]

Attributes

Graph
Supertypes
trait ElasticQuery[S]
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def filter[S1 <: S : Schema](queries: ElasticQuery[S1]*): BoolQuery[S1]

Adds specified filter queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents. Unlike must the score of the query will be ignored.

Adds specified filter queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents. Unlike must the score of the query will be ignored.

Type parameters

S1

the type of the sub-queries, for which an implicit zio.schema.Schema is required

Value parameters

queries

the filter queries to be added

Attributes

Returns

an instance of the zio.elasticsearch.query.BoolQuery with filter queries added.

def filter(queries: ElasticQuery[Any]*): BoolQuery[S]

Adds specified filter queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents. Unlike must the score of the query will be ignored.

Adds specified filter queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents. Unlike must the score of the query will be ignored.

Value parameters

queries

the filter queries to be added

Attributes

Returns

an instance of the zio.elasticsearch.query.BoolQuery with filter queries added.

def must[S1 <: S : Schema](queries: ElasticQuery[S1]*): BoolQuery[S1]

Adds specified must queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents and will contribute to the score.

Adds specified must queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents and will contribute to the score.

Type parameters

S1

the type of the sub-queries, for which an implicit zio.schema.Schema is required

Value parameters

queries

the must queries to be added

Attributes

Returns

an instance of the zio.elasticsearch.query.BoolQuery with must queries added.

def must(queries: ElasticQuery[Any]*): BoolQuery[S]

Adds specified must queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents and will contribute to the score.

Adds specified must queries to the zio.elasticsearch.query.BoolQuery. These queries must appear in matching documents and will contribute to the score.

Value parameters

queries

the must queries to be added

Attributes

Returns

an instance of the zio.elasticsearch.query.BoolQuery with must queries added.

def mustNot[S1 <: S : Schema](queries: ElasticQuery[S1]*): BoolQuery[S1]

Adds specified must not queries to the zio.elasticsearch.query.BoolQuery. These queries must not appear in matching documents.

Adds specified must not queries to the zio.elasticsearch.query.BoolQuery. These queries must not appear in matching documents.

Type parameters

S1

the type of the sub-queries, for which an implicit zio.schema.Schema is required

Value parameters

queries

the must not queries to be added

Attributes

Returns

an instance of the zio.elasticsearch.query.BoolQuery with must not queries added.

def mustNot(queries: ElasticQuery[Any]*): BoolQuery[S]

Adds specified must not queries to the zio.elasticsearch.query.BoolQuery. These queries must not appear in matching documents.

Adds specified must not queries to the zio.elasticsearch.query.BoolQuery. These queries must not appear in matching documents.

Value parameters

queries

the must not queries to be added

Attributes

Returns

an instance of the zio.elasticsearch.query.BoolQuery with must not queries added.

def should[S1 <: S : Schema](queries: ElasticQuery[S1]*): BoolQuery[S1]

Adds specified should queries to the zio.elasticsearch.query.BoolQuery. These queries should appear in matching documents.

Adds specified should queries to the zio.elasticsearch.query.BoolQuery. These queries should appear in matching documents.

Type parameters

S1

the type of the sub-queries, for which an implicit zio.schema.Schema is required

Value parameters

queries

the should queries to be added

Attributes

Returns

an instance of the zio.elasticsearch.query.BoolQuery with should queries added.

def should(queries: ElasticQuery[Any]*): BoolQuery[S]

Adds specified should queries to the zio.elasticsearch.query.BoolQuery. These queries should appear in matching documents.

Adds specified should queries to the zio.elasticsearch.query.BoolQuery. These queries should appear in matching documents.

Value parameters

queries

the should queries to be added

Attributes

Returns

an instance of the zio.elasticsearch.query.BoolQuery with should queries added.

Inherited and Abstract methods

def boost(value: Double): BoolQuery[S]

Sets the boost parameter for this zio.elasticsearch.query.ElasticQuery. The boost value is a positive multiplier applied to the score of documents matching the query. A value greater than 1 increases the relevance score of matching documents, while a value less than 1 decreases it. The default boost value is 1.

Sets the boost parameter for this zio.elasticsearch.query.ElasticQuery. The boost value is a positive multiplier applied to the score of documents matching the query. A value greater than 1 increases the relevance score of matching documents, while a value less than 1 decreases it. The default boost value is 1.

Value parameters

value

a non-negative real number to set boost parameter to

Attributes

Returns

a new instance of the zio.elasticsearch.query.ElasticQuery with the boost value set.

Inherited from:
HasBoost (hidden)
def minimumShouldMatch(value: Int): BoolQuery[S]

Sets the minimumShouldMatch parameter for this zio.elasticsearch.ElasticQuery. The minimumShouldMatch value is the number of should clauses returned documents must match. If the zio.elasticsearch.query.BoolQuery includes at least one should clause and no must/filter clauses, the default value is 1. Otherwise, the default value is 0.

Sets the minimumShouldMatch parameter for this zio.elasticsearch.ElasticQuery. The minimumShouldMatch value is the number of should clauses returned documents must match. If the zio.elasticsearch.query.BoolQuery includes at least one should clause and no must/filter clauses, the default value is 1. Otherwise, the default value is 0.

Value parameters

value

a number to set minimumShouldMatch parameter to

Attributes

Returns

a new instance of the zio.elasticsearch.ElasticQuery with the minimumShouldMatch value set.

Inherited from:
HasMinimumShouldMatch (hidden)