ElasticQuery
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
ElasticQuery.type
Members list
Value members
Concrete methods
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that contains the specified value in the specified field.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that contains the specified value in the specified field.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query in the pattern that represents
contains
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that contains the specified value in the specified field.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that contains the specified value in the specified field.
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query in the pattern that represents
contains
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.ExistsQuery, that checks existence of the field, using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.ExistsQuery, that checks existence of the field, using the specified parameters.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.ExistsQuery that represents the exists query to be performed.
Constructs an instance of zio.elasticsearch.query.ExistsQuery, that checks existence of the field, using the specified parameters.
Constructs an instance of zio.elasticsearch.query.ExistsQuery, that checks existence of the field, using the specified parameters.
Value parameters
- field
-
the field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.ExistsQuery that represents the exists query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Type parameters
- S
-
document for which field query is executed. An implicit
Schema
instance must be in scope
Value parameters
- queries
-
a list of queries to add to
filter
inside of theBool
query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Value parameters
- queries
-
a list of queries to add to
filter
inside of theBool
query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
Constructs a type-safe instance of zio.elasticsearch.query.FunctionScore query with one or multiple zio.elasticsearch.query.FunctionScoreFunction.
Constructs a type-safe instance of zio.elasticsearch.query.FunctionScore query with one or multiple zio.elasticsearch.query.FunctionScoreFunction.
Value parameters
- functions
-
zio.elasticsearch.query.FunctionScoreFunction functions that will be part of zio.elasticsearch.query.FunctionScore query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScore that represents the Function Score Query with functions that are used to calculate score for result.
Constructs an instance of zio.elasticsearch.query.FunctionScore query with one or multiple zio.elasticsearch.query.FunctionScoreFunction.
Constructs an instance of zio.elasticsearch.query.FunctionScore query with one or multiple zio.elasticsearch.query.FunctionScoreFunction.
Value parameters
- functions
-
zio.elasticsearch.query.FunctionScoreFunction functions that will be part of zio.elasticsearch.query.FunctionScore query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.FunctionScore that represents the Function Score Query with functions that are used to calculate score for result.
Constructs a type-safe instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Type parameters
- S
-
the type of document on which the query is defined
Value parameters
- distance
-
the distance within which values should be matched
- field
-
the type-safe GeoPoint field for which the query is specified
- point
-
the geo-point from which the distance should be measured
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distance
query to be performed.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Value parameters
- distance
-
the distance within which values should be matched
- field
-
the field for which the query is specified
- point
-
the geo-point from which the distance should be measured
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distance
query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Type parameters
- S
-
the type of document on which the query is defined
Value parameters
- distance
-
the distance within which values should be matched
- field
-
the type-safe field for which the query is specified
- point
-
the geo-point from which the distance should be measured, defined as geo-hash
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distance
query to be performed.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.GeoDistanceQuery using the specified parameters.
Value parameters
- distance
-
the distance within which values should be matched
- field
-
the field for which the query is specified
- point
-
the geo-point from which the distance should be measured, defined as geo-hash
Attributes
- Returns
-
an instance of zio.elasticsearch.query.GeoDistanceQuery that represents the
geo_distance
query to be performed.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Type parameters
- S
-
document for which field query is executed
Value parameters
- childType
-
a name of the child relationship mapped for the join field
- query
-
the type-safe ElasticQuery object representing query you wish to run on child documents of the child
type
field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.HasChildQuery that represents the
has child query
to be performed.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasChildQuery using the specified parameters.
Value parameters
- childType
-
a name of the child relationship mapped for the join field
- query
-
the ElasticQuery object representing query you wish to run on child documents of the child
type
field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.HasChildQuery that represents the
has child query
to be performed.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Type parameters
- S
-
document for which field query is executed
Value parameters
- parentType
-
a name of the parent relationship mapped for the join field
- query
-
the type-safe ElasticQuery object representing query you wish to run on parent documents of the
parent_type
field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.HasParentQuery that represents the has parent query to be performed.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Constructs an instance of zio.elasticsearch.query.HasParentQuery using the specified parameters.
Value parameters
- parentType
-
a name of the parent relationship mapped for the join field
- query
-
the ElasticQuery object representing query you wish to run on parent documents of the
parent_type
field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.HasParentQuery that represents the has parent query to be performed.
Constructs an instance of zio.elasticsearch.query.IdsQuery using the specified parameters. zio.elasticsearch.query.IdsQuery is used for matching documents containing a value that matches a provided pattern value.
Constructs an instance of zio.elasticsearch.query.IdsQuery using the specified parameters. zio.elasticsearch.query.IdsQuery is used for matching documents containing a value that matches a provided pattern value.
Value parameters
- value
-
value that will be used for the query
- values
-
array of optional values that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.IdsQuery that represents the ids query to be performed.
Constructs an instance of zio.elasticsearch.query.MatchAllQuery used for matching all documents.
Constructs an instance of zio.elasticsearch.query.MatchAllQuery used for matching all documents.
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchAllQuery that represents the match all query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters. zio.elasticsearch.query.MatchPhraseQuery analyzes the text and creates a phrase query out of the analyzed text.
Constructs a type-safe instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters. zio.elasticsearch.query.MatchPhraseQuery analyzes the text and creates a phrase query out of the analyzed text.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchPhraseQuery that represents the match phrase query to be performed.
Constructs an instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters. zio.elasticsearch.query.MatchPhraseQuery analyzes the text and creates a phrase query out of the analyzed text.
Constructs an instance of zio.elasticsearch.query.MatchPhraseQuery using the specified parameters. zio.elasticsearch.query.MatchPhraseQuery analyzes the text and creates a phrase query out of the analyzed text.
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchPhraseQuery that represents the match phrase query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.MatchQuery using the specified parameters. zio.elasticsearch.query.MatchQuery is used for matching a provided text, number, date or boolean value.
Constructs a type-safe instance of zio.elasticsearch.query.MatchQuery using the specified parameters. zio.elasticsearch.query.MatchQuery is used for matching a provided text, number, date or boolean value.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be in scope for this type
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchQuery that represents the match query to be performed.
Constructs an instance of zio.elasticsearch.query.MatchQuery using the specified parameters. zio.elasticsearch.query.MatchQuery is used for matching a provided text, number, date or boolean value.
Constructs an instance of zio.elasticsearch.query.MatchQuery using the specified parameters. zio.elasticsearch.query.MatchQuery is used for matching a provided text, number, date or boolean value.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be in scope for this type
Value parameters
- field
-
the field for which query is specified for
- value
-
the value to be matched, represented by an instance of type
A
Attributes
- Returns
-
an instance of zio.elasticsearch.query.MatchQuery that represents the match query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Type parameters
- S
-
document for which field query is executed. An implicit
Schema
instance must be in scope
Value parameters
- queries
-
a list of queries to add to
must
inside of theBool
query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must satisfy the criteria using the specified parameters.
Value parameters
- queries
-
a list of queries to add to
must
inside of theBool
query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must satisfy the criteria.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must not satisfy the criteria using the specified parameters.
Constructs a type-safe instance of zio.elasticsearch.query.BoolQuery with queries that must not satisfy the criteria using the specified parameters.
Type parameters
- S
-
document for which field query is executed. An implicit
Schema
instance must be in scope
Value parameters
- queries
-
a list of queries to add to
mustNot
inside of theBool
query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must not satisfy the criteria.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must not satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that must not satisfy the criteria using the specified parameters.
Value parameters
- queries
-
a list of queries to add to
mustNot
inside of theBool
query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that must not satisfy the criteria.
Constructs a type-safe instance of zio.elasticsearch.query.NestedQuery using the specified parameters. zio.elasticsearch.query.NestedQuery wraps another query to search nested fields.
Constructs a type-safe instance of zio.elasticsearch.query.NestedQuery using the specified parameters. zio.elasticsearch.query.NestedQuery wraps another query to search nested fields.
Type parameters
- A
-
the type of the value that will be used for the query
- S
-
document for which field query is executed
Value parameters
- path
-
the type-safe path to the field for which query is specified for
- query
-
the ElasticQuery object representing the query to execute on nested objects.
Attributes
- Returns
-
an instance of zio.elasticsearch.query.NestedQuery that represents the nested query to be performed.
Constructs an instance of zio.elasticsearch.query.NestedQuery using the specified parameters. zio.elasticsearch.query.NestedQuery wraps another query to search nested fields.
Constructs an instance of zio.elasticsearch.query.NestedQuery using the specified parameters. zio.elasticsearch.query.NestedQuery wraps another query to search nested fields.
Value parameters
- path
-
the path to the field for which query is specified for
- query
-
the ElasticQuery object representing the query to execute on nested objects.
Attributes
- Returns
-
an instance of zio.elasticsearch.query.NestedQuery that represents the nested query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.PrefixQuery using the specified parameters. zio.elasticsearch.query.PrefixQuery is used for matching documents that contain a specific prefix in a provided field.
Constructs a type-safe instance of zio.elasticsearch.query.PrefixQuery using the specified parameters. zio.elasticsearch.query.PrefixQuery is used for matching documents that contain a specific prefix in a provided field.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.PrefixQuery that represents the prefix query to be performed.
Constructs an instance of zio.elasticsearch.query.PrefixQuery using the specified parameters. zio.elasticsearch.query.PrefixQuery is used for matching documents that contain a specific prefix in a provided field.
Constructs an instance of zio.elasticsearch.query.PrefixQuery using the specified parameters. zio.elasticsearch.query.PrefixQuery is used for matching documents that contain a specific prefix in a provided field.
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.PrefixQuery that represents the prefix query to be performed.
Constructs a type-safe unbounded instance of zio.elasticsearch.query.RangeQuery using the specified parameters.
Constructs a type-safe unbounded instance of zio.elasticsearch.query.RangeQuery using the specified parameters.
Type parameters
- A
-
the type of the value that will be used for the query
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.RangeQuery that represents the range query to be performed.
Constructs an unbounded instance of zio.elasticsearch.query.RangeQuery using the specified parameters.
Constructs an unbounded instance of zio.elasticsearch.query.RangeQuery using the specified parameters.
Value parameters
- field
-
the field for which query is specified for
Attributes
- Returns
-
an instance of zio.elasticsearch.query.RangeQuery that represents the range query to be performed.
Constructs an instance of zio.elasticsearch.query.ScriptQuery with the provided script.
Constructs an instance of zio.elasticsearch.query.ScriptQuery with the provided script.
Value parameters
- script
-
the script that is used by the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.ScriptQuery that represents the script query to be performed.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that should satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that should satisfy the criteria using the specified parameters.
Type parameters
- S
-
document for which field query is executed. An implicit
Schema
instance must be in scope
Value parameters
- queries
-
a list of queries to add to
should
inside of theBool
query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that should satisfy the criteria.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that should satisfy the criteria using the specified parameters.
Constructs an instance of zio.elasticsearch.query.BoolQuery with queries that should satisfy the criteria using the specified parameters.
Value parameters
- queries
-
a list of queries to add to
should
inside of theBool
query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.BoolQuery that represents the bool query with queries that should satisfy the criteria.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that starts with the specified value in the specified field.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that starts with the specified value in the specified field.
Type parameters
- S
-
document for which field query is executed in the pattern that represents
startsWith
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that starts with the specified value in the specified field.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that starts with the specified value in the specified field.
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query in the pattern that represents
startsWith
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.TermQuery using the specified parameters. zio.elasticsearch.query.TermQuery is used for matching documents that contain an exact term in a provided field.
Constructs a type-safe instance of zio.elasticsearch.query.TermQuery using the specified parameters. zio.elasticsearch.query.TermQuery is used for matching documents that contain an exact term in a provided field.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be in scope for this type
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermQuery that represents the term query to be performed.
Constructs an instance of zio.elasticsearch.query.TermQuery using the specified parameters. zio.elasticsearch.query.TermQuery is used for matching documents that contain an exact term in a provided field.
Constructs an instance of zio.elasticsearch.query.TermQuery using the specified parameters. zio.elasticsearch.query.TermQuery is used for matching documents that contain an exact term in a provided field.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be in scope for this type
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermQuery that represents the term query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.TermsQuery using the specified parameters. zio.elasticsearch.query.TermsQuery is used for matching documents that contain one or more term in a provided field. The terms query is the same as zio.elasticsearch.query.TermQuery, except you can search for multiple values.
Constructs a type-safe instance of zio.elasticsearch.query.TermsQuery using the specified parameters. zio.elasticsearch.query.TermsQuery is used for matching documents that contain one or more term in a provided field. The terms query is the same as zio.elasticsearch.query.TermQuery, except you can search for multiple values.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be in scope for this type
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- values
-
a list of terms that should be find in the provided field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermsQuery that represents the term query to be performed.
Constructs an instance of zio.elasticsearch.query.TermsQuery using the specified parameters. zio.elasticsearch.query.TermsQuery is used for matching documents that contain one or more term in a provided field. The terms query is the same as zio.elasticsearch.query.TermQuery, except you can search for multiple values.
Constructs an instance of zio.elasticsearch.query.TermsQuery using the specified parameters. zio.elasticsearch.query.TermsQuery is used for matching documents that contain one or more term in a provided field. The terms query is the same as zio.elasticsearch.query.TermQuery, except you can search for multiple values.
Type parameters
- A
-
the type of value to be matched. A JSON decoder must be in scope for this type
Value parameters
- field
-
the field for which query is specified for
- values
-
a list of terms that should be find in the provided field
Attributes
- Returns
-
an instance of zio.elasticsearch.query.TermsQuery that represents the term query to be performed.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that matches a provided pattern value.
Constructs a type-safe instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that matches a provided pattern value.
Type parameters
- S
-
document for which field query is executed
Value parameters
- field
-
the type-safe field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that matches a provided pattern value.
Constructs an instance of zio.elasticsearch.query.WildcardQuery using the specified parameters. zio.elasticsearch.query.WildcardQuery is used for matching documents containing a value that matches a provided pattern value.
Value parameters
- field
-
the field for which query is specified for
- value
-
text value that will be used for the query
Attributes
- Returns
-
an instance of zio.elasticsearch.query.WildcardQuery that represents the wildcard query to be performed.