PHP Class Elastica\QueryBuilder\DSL\Query

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-queries.html
Author: Manuel Andreo Garcia ([email protected])
Inheritance: implements Elastica\QueryBuilder\DSL
Show file Open project: ruflin/elastica Class Usage Examples

Public Methods

Method Description
bool ( ) : BoolQuery bool query.
boosting ( ) : Elastica\Query\Boosting boosting query.
common_terms ( string $field, string $query, float $cutoffFrequency ) : Common common terms query.
constant_score ( null | Elastica\Query\AbstractQuery | array $filter = null ) : ConstantScore constant score query.
custom_boost_factor ( ) custom boost factor query.
custom_filters_score ( ) custom filters score query.
custom_score ( ) custom score query.
dis_max ( ) : Elastica\Query\DisMax dis max query.
exists ( string $field ) : Elastica\Query\Exists exists query.
field ( ) field query.
function_score ( ) : FunctionScore function score query.
fuzzy ( string $fieldName = null, string $value = null ) : Fuzzy fuzzy query.
fuzzy_like_this ( ) : FuzzyLikeThis fuzzy like this query.
fuzzy_like_this_field ( ) fuzzy like this field query.
geo_distance ( string $key, array | string $location, string $distance ) : Elastica\Query\GeoDistance geo distance query.
geo_shape ( ) geo shape query.
getType ( ) : string must return type for QueryBuilder usage.
has_child ( string | Query | Elastica\Query\AbstractQuery $query, string $type = null ) : HasChild has child query.
has_parent ( string | Query | Elastica\Query\AbstractQuery $query, string $type ) : Elastica\Query\HasParent has parent query.
ids ( array | string | Type $type = null, array $ids = [] ) : Ids ids query.
indices ( ) indices query.
match ( string $field = null, mixed $values = null ) : Match match query.
match_all ( ) : Elastica\Query\MatchAll match all query.
minimum_should_match ( ) minimum should match query.
more_like_this ( ) : MoreLikeThis more like this query.
multi_match ( ) : MultiMatch multi match query.
nested ( ) : Nested nested query.
percolate ( ) : Percolate type query.
prefix ( array $prefix = [] ) : Prefix prefix query.
query_string ( string $queryString = '' ) : QueryString query string query.
range ( string $fieldName = null, array $args = [] ) : Range range query.
regexp ( string $key = '', string $value = null, float $boost = 1 ) : Regexp regexp query.
simple_query_string ( string $query, array $fields = [] ) : SimpleQueryString simple_query_string query.
span_first ( ) span first query.
span_multi_term ( ) span multi term query.
span_near ( ) span near query.
span_not ( ) span not query.
span_or ( ) span or query.
span_term ( ) span term query.
template ( ) template query.
term ( array $term = [] ) : Term term query.
terms ( string $key = '', array $terms = [] ) : Terms terms query.
text ( ) text query.
top_children ( string | Elastica\Query\AbstractQuery | Query $query, string $type = null ) : Elastica\Query\TopChildren top children query.
type ( string $type = null ) : Type type query.
wildcard ( string $key = '', string $value = null, float $boost = 1 ) : Wildcard wildcard query.

Method Details

bool() public method

bool query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html
public bool ( ) : BoolQuery
return Elastica\Query\BoolQuery

boosting() public method

boosting query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-boosting-query.html
public boosting ( ) : Elastica\Query\Boosting
return Elastica\Query\Boosting

common_terms() public method

common terms query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-common-terms-query.html
public common_terms ( string $field, string $query, float $cutoffFrequency ) : Common
$field string
$query string
$cutoffFrequency float percentage in decimal form (.001 == 0.1%)
return Elastica\Query\Common

constant_score() public method

constant score query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-constant-score-query.html
public constant_score ( null | Elastica\Query\AbstractQuery | array $filter = null ) : ConstantScore
$filter null | Elastica\Query\AbstractQuery | array
return Elastica\Query\ConstantScore

custom_boost_factor() public method

custom boost factor query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/0.90/query-dsl-custom-boost-factor-query.html
public custom_boost_factor ( )

custom_filters_score() public method

custom filters score query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/0.90/query-dsl-custom-filters-score-query.html
public custom_filters_score ( )

custom_score() public method

custom score query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/0.90/query-dsl-custom-score-query.html
public custom_score ( )

dis_max() public method

dis max query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html
public dis_max ( ) : Elastica\Query\DisMax
return Elastica\Query\DisMax

exists() public method

exists query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html
public exists ( string $field ) : Elastica\Query\Exists
$field string
return Elastica\Query\Exists

function_score() public method

function score query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html
public function_score ( ) : FunctionScore
return Elastica\Query\FunctionScore

fuzzy() public method

fuzzy query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html
public fuzzy ( string $fieldName = null, string $value = null ) : Fuzzy
$fieldName string Field name
$value string String to search for
return Elastica\Query\Fuzzy

fuzzy_like_this() public method

fuzzy like this query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-flt-query.html
public fuzzy_like_this ( ) : FuzzyLikeThis
return FuzzyLikeThis

fuzzy_like_this_field() public method

fuzzy like this field query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-flt-field-query.html
public fuzzy_like_this_field ( )

geo_distance() public method

geo distance query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html
public geo_distance ( string $key, array | string $location, string $distance ) : Elastica\Query\GeoDistance
$key string
$location array | string
$distance string
return Elastica\Query\GeoDistance

getType() public method

must return type for QueryBuilder usage.
public getType ( ) : string
return string

has_child() public method

has child query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-child-query.html
public has_child ( string | Query | Elastica\Query\AbstractQuery $query, string $type = null ) : HasChild
$query string | Elastica\Query | Elastica\Query\AbstractQuery
$type string Parent document type
return Elastica\Query\HasChild

has_parent() public method

has parent query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html
public has_parent ( string | Query | Elastica\Query\AbstractQuery $query, string $type ) : Elastica\Query\HasParent
$query string | Elastica\Query | Elastica\Query\AbstractQuery
$type string Parent document type
return Elastica\Query\HasParent

ids() public method

ids query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html
public ids ( array | string | Type $type = null, array $ids = [] ) : Ids
$type array | string | Elastica\Type
$ids array
return Elastica\Query\Ids

match() public method

match query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html
public match ( string $field = null, mixed $values = null ) : Match
$field string
$values mixed
return Elastica\Query\Match

match_all() public method

match all query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html
public match_all ( ) : Elastica\Query\MatchAll
return Elastica\Query\MatchAll

minimum_should_match() public method

minimum should match query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html
public minimum_should_match ( )

more_like_this() public method

more like this query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html
public more_like_this ( ) : MoreLikeThis
return Elastica\Query\MoreLikeThis

multi_match() public method

multi match query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html
public multi_match ( ) : MultiMatch
return Elastica\Query\MultiMatch

nested() public method

nested query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html
public nested ( ) : Nested
return Elastica\Query\Nested

percolate() public method

type query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-percolate-query.html
public percolate ( ) : Percolate
return Elastica\Query\Percolate

prefix() public method

prefix query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html
public prefix ( array $prefix = [] ) : Prefix
$prefix array Prefix array
return Elastica\Query\Prefix

query_string() public method

query string query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html
public query_string ( string $queryString = '' ) : QueryString
$queryString string OPTIONAL Query string for object
return Elastica\Query\QueryString

range() public method

range query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html
public range ( string $fieldName = null, array $args = [] ) : Range
$fieldName string
$args array
return Elastica\Query\Range

regexp() public method

regexp query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html
public regexp ( string $key = '', string $value = null, float $boost = 1 ) : Regexp
$key string
$value string
$boost float
return Elastica\Query\Regexp

simple_query_string() public method

simple_query_string query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html
public simple_query_string ( string $query, array $fields = [] ) : SimpleQueryString
$query string
$fields array
return Elastica\Query\SimpleQueryString

span_multi_term() public method

span multi term query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html
public span_multi_term ( )

term() public method

term query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html
public term ( array $term = [] ) : Term
$term array
return Elastica\Query\Term

terms() public method

terms query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html
public terms ( string $key = '', array $terms = [] ) : Terms
$key string
$terms array
return Elastica\Query\Terms

text() public method

text query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/0.90/query-dsl-text-query.html
public text ( )

top_children() public method

top children query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-top-children-query.html
public top_children ( string | Elastica\Query\AbstractQuery | Query $query, string $type = null ) : Elastica\Query\TopChildren
$query string | Elastica\Query\AbstractQuery | Elastica\Query
$type string
return Elastica\Query\TopChildren

type() public method

type query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-type-query.html
public type ( string $type = null ) : Type
$type string Type name
return Elastica\Query\Type

wildcard() public method

wildcard query.
See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html
public wildcard ( string $key = '', string $value = null, float $boost = 1 ) : Wildcard
$key string OPTIONAL Wildcard key
$value string OPTIONAL Wildcard value
$boost float OPTIONAL Boost value (default = 1)
return Elastica\Query\Wildcard