BaseSearchQuery

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

An abstract class that holds all the search query builder methods. Inheritors of the class can implement some shortcut methods. For instance SearchQuery.execute which can be suspendable or blocking.

Constructors

BaseSearchQuery

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

Types

Companion

object Companion

Functions

aggs

fun aggs(clear: SearchQuery.CLEAR): T

Clears the existing aggregations.

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

Adds aggregations to the existing query aggregations.

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

Adds aggregations to the existing query aggregations.

clone

fun clone(): T

Clones this search query builder.

docvalueFields

fun docvalueFields(clear: SearchQuery.CLEAR): T

fun docvalueFields(vararg fields: FieldFormat): T

ext

fun ext(clear: SearchQuery.CLEAR): T

fun ext(vararg extensions: SearchExt): T

fields

fun fields(clear: SearchQuery.CLEAR): T

fun fields(vararg fields: FieldFormat): T

filter

fun filter(clear: SearchQuery.CLEAR): T

Clears the existing filters.

fun filter(vararg filters: QueryExpression): T

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?): T

postFilter

fun postFilter(clear: SearchQuery.CLEAR): T

Clears the existing post filters.

fun postFilter(vararg filters: QueryExpression): T

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?): T

Replaces main query expression.

queryNode

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

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

requestCache

fun requestCache(requestCache: Boolean?): T

rescore

fun rescore(clear: SearchQuery.CLEAR): T

Clears the existing rescorers.

fun rescore(vararg rescores: Rescore): T

Adds rescores to the existing query rescorers.

routing

fun routing(routing: Long?): T

fun routing(routing: String?): T

scriptFields

fun scriptFields(clear: SearchQuery.CLEAR): T

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

searchParams

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

searchType

fun searchType(searchType: SearchType?): T

seqNoPrimaryTerm

fun seqNoPrimaryTerm(seqNoPrimaryTerm: Boolean?): T

size

fun size(size: Int?): T

sort

fun sort(clear: SearchQuery.CLEAR): T

Clears the existing sorts.

fun sort(vararg sorts: Sort): T

Adds sorts to the existing query sorting expressions.

fun sort(sorts: List<Sort>): T

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

source

fun source(clear: SearchQuery.CLEAR): T

Clears source filtering values that were previously set.

fun source(vararg includes: FieldOperations<*>): T

Adds includes field lists to the document source fields filtering.

fun source(enable: Boolean): T

Disables or enables document's source filtering.

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

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

stats

fun stats(stats: String?): T

storedFields

fun storedFields(clear: SearchQuery.CLEAR): T

fun storedFields(vararg fields: FieldOperations<*>): T

terminateAfter

fun terminateAfter(terminateAfter: Int?): T

trackScores

fun trackScores(trackScores: Boolean?): T

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

trackTotalHits

fun trackTotalHits(trackTotalHits: Boolean?): T

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

version

fun version(version: Boolean?): T

Inheritors

SearchQuery

Extensions

usingIndex

fun <S : BaseDocSource> BaseSearchQuery<S, *>.usingIndex(indexName: String): SearchQueryWithIndex<S>