SearchQuery

open class SearchQuery<S : BaseDocSource>(docSourceFactory: (<ERROR CLASS>) -> S, query: QueryExpression?, params: Params) : BaseSearchQuery<S, SearchQuery<S>>

An asynchronous version of search query.

Constructors

SearchQuery

fun <S : BaseDocSource> SearchQuery(docSourceFactory: (<ERROR CLASS>) -> S, query: QueryExpression? = null, params: Params = Params())

Types

CLEAR

object CLEAR

Companion

object Companion

Functions

aggs

fun aggs(clear: SearchQuery.CLEAR): SearchQuery<S>

Clears the existing aggregations.

fun aggs(vararg aggregations: <ERROR CLASS><String, Aggregation<*>>): SearchQuery<S>

Adds aggregations to the existing query aggregations.

fun aggs(aggregations: Map<String, Aggregation<*>>): SearchQuery<S>

Adds aggregations to the existing query aggregations.

clone

fun clone(): SearchQuery<S>

Clones this search query builder.

docvalueFields

fun docvalueFields(clear: SearchQuery.CLEAR): SearchQuery<S>

fun docvalueFields(vararg fields: FieldFormat): SearchQuery<S>

execute

suspend fun execute(index: ElasticsearchIndex): SearchQueryResult<S>

ext

fun ext(clear: SearchQuery.CLEAR): SearchQuery<S>

fun ext(vararg extensions: SearchExt): SearchQuery<S>

fields

fun fields(clear: SearchQuery.CLEAR): SearchQuery<S>

fun fields(vararg fields: FieldFormat): SearchQuery<S>

filter

fun filter(clear: SearchQuery.CLEAR): SearchQuery<S>

Clears the existing filters.

fun filter(vararg filters: QueryExpression): SearchQuery<S>

Combines all the filter expressions together and wraps the existing query using the dev.evo.elasticmagic.query.Bool query expression.

from

fun from(from: Int?): SearchQuery<S>

postFilter

fun postFilter(clear: SearchQuery.CLEAR): SearchQuery<S>

Clears the existing post filters.

fun postFilter(vararg filters: QueryExpression): SearchQuery<S>

Filter expressions in the post filter will be applied after the aggregations are calculated.

prepare

fun prepare(): PreparedSearchQuery<S>

Makes an immutable view of the search query.

query

fun query(query: QueryExpression?): SearchQuery<S>

Replaces main query expression.

queryNode

inline fun <N : QueryExpressionNode<N>> queryNode(handle: NodeHandle<N>, block: (N) -> Unit): SearchQuery<S>

Allows modifying specific query expression node using handle of the node.

requestCache

fun requestCache(requestCache: Boolean?): SearchQuery<S>

rescore

fun rescore(clear: SearchQuery.CLEAR): SearchQuery<S>

Clears the existing rescorers.

fun rescore(vararg rescores: Rescore): SearchQuery<S>

Adds rescores to the existing query rescorers.

routing

fun routing(routing: Long?): SearchQuery<S>

fun routing(routing: String?): SearchQuery<S>

scriptFields

fun scriptFields(clear: SearchQuery.CLEAR): SearchQuery<S>

fun scriptFields(vararg fields: <ERROR CLASS><String, Script>): SearchQuery<S>

searchParams

fun searchParams(vararg params: <ERROR CLASS><String, Any?>): SearchQuery<S>

searchType

fun searchType(searchType: SearchType?): SearchQuery<S>

seqNoPrimaryTerm

fun seqNoPrimaryTerm(seqNoPrimaryTerm: Boolean?): SearchQuery<S>

size

fun size(size: Int?): SearchQuery<S>

sort

fun sort(clear: SearchQuery.CLEAR): SearchQuery<S>

Clears the existing sorts.

fun sort(vararg sorts: Sort): SearchQuery<S>

Adds sorts to the existing query sorting expressions.

fun sort(sorts: List<Sort>): SearchQuery<S>

Adds sorts from a list to the existing query sorting expressions.

source

fun source(clear: SearchQuery.CLEAR): SearchQuery<S>

Clears source filtering values that were previously set.

fun source(vararg includes: FieldOperations<*>): SearchQuery<S>

Adds includes field lists to the document source fields filtering.

fun source(enable: Boolean): SearchQuery<S>

Disables or enables document's source filtering.

fun source(includes: List<FieldOperations<*>> = emptyList(), excludes: List<FieldOperations<*>> = emptyList()): SearchQuery<S>

Adds includes and excludes field lists to the document source fields filtering.

stats

fun stats(stats: String?): SearchQuery<S>

storedFields

fun storedFields(clear: SearchQuery.CLEAR): SearchQuery<S>

fun storedFields(vararg fields: FieldOperations<*>): SearchQuery<S>

terminateAfter

fun terminateAfter(terminateAfter: Int?): SearchQuery<S>

trackScores

fun trackScores(trackScores: Boolean?): SearchQuery<S>

If trackScores is true forces computing scores even when sorting on a field.

trackTotalHits

fun trackTotalHits(trackTotalHits: Boolean?): SearchQuery<S>

When trackTotalHits is true the search query will always count the total number of hits that match the query.

version

fun version(version: Boolean?): SearchQuery<S>