Documentation

Query extends Message
in package

Generated from protobuf message <code>couchbase.search.v1.Query</code>

Table of Contents

$query  : mixed
__construct()  : mixed
Constructor.
getBooleanFieldQuery()  : BooleanFieldQuery|null
Generated from protobuf field <code>.couchbase.search.v1.BooleanFieldQuery boolean_field_query = 1;</code>
getBooleanQuery()  : BooleanQuery|null
Generated from protobuf field <code>.couchbase.search.v1.BooleanQuery boolean_query = 2;</code>
getConjunctionQuery()  : ConjunctionQuery|null
Generated from protobuf field <code>.couchbase.search.v1.ConjunctionQuery conjunction_query = 3;</code>
getDateRangeQuery()  : DateRangeQuery|null
Generated from protobuf field <code>.couchbase.search.v1.DateRangeQuery date_range_query = 4;</code>
getDisjunctionQuery()  : DisjunctionQuery|null
Generated from protobuf field <code>.couchbase.search.v1.DisjunctionQuery disjunction_query = 5;</code>
getDocIdQuery()  : DocIdQuery|null
Generated from protobuf field <code>.couchbase.search.v1.DocIdQuery doc_id_query = 6;</code>
getGeoBoundingBoxQuery()  : GeoBoundingBoxQuery|null
Generated from protobuf field <code>.couchbase.search.v1.GeoBoundingBoxQuery geo_bounding_box_query = 7;</code>
getGeoDistanceQuery()  : GeoDistanceQuery|null
Generated from protobuf field <code>.couchbase.search.v1.GeoDistanceQuery geo_distance_query = 8;</code>
getGeoPolygonQuery()  : GeoPolygonQuery|null
Generated from protobuf field <code>.couchbase.search.v1.GeoPolygonQuery geo_polygon_query = 9;</code>
getMatchAllQuery()  : MatchAllQuery|null
Generated from protobuf field <code>.couchbase.search.v1.MatchAllQuery match_all_query = 10;</code>
getMatchNoneQuery()  : MatchNoneQuery|null
Generated from protobuf field <code>.couchbase.search.v1.MatchNoneQuery match_none_query = 11;</code>
getMatchPhraseQuery()  : MatchPhraseQuery|null
Generated from protobuf field <code>.couchbase.search.v1.MatchPhraseQuery match_phrase_query = 12;</code>
getMatchQuery()  : MatchQuery|null
Generated from protobuf field <code>.couchbase.search.v1.MatchQuery match_query = 13;</code>
getNumericRangeQuery()  : NumericRangeQuery|null
Generated from protobuf field <code>.couchbase.search.v1.NumericRangeQuery numeric_range_query = 14;</code>
getPhraseQuery()  : PhraseQuery|null
Generated from protobuf field <code>.couchbase.search.v1.PhraseQuery phrase_query = 15;</code>
getPrefixQuery()  : PrefixQuery|null
Generated from protobuf field <code>.couchbase.search.v1.PrefixQuery prefix_query = 16;</code>
getQuery()  : string
getQueryStringQuery()  : QueryStringQuery|null
Generated from protobuf field <code>.couchbase.search.v1.QueryStringQuery query_string_query = 17;</code>
getRegexpQuery()  : RegexpQuery|null
Generated from protobuf field <code>.couchbase.search.v1.RegexpQuery regexp_query = 18;</code>
getTermQuery()  : TermQuery|null
Generated from protobuf field <code>.couchbase.search.v1.TermQuery term_query = 19;</code>
getTermRangeQuery()  : TermRangeQuery|null
Generated from protobuf field <code>.couchbase.search.v1.TermRangeQuery term_range_query = 20;</code>
getWildcardQuery()  : WildcardQuery|null
Generated from protobuf field <code>.couchbase.search.v1.WildcardQuery wildcard_query = 21;</code>
hasBooleanFieldQuery()  : mixed
hasBooleanQuery()  : mixed
hasConjunctionQuery()  : mixed
hasDateRangeQuery()  : mixed
hasDisjunctionQuery()  : mixed
hasDocIdQuery()  : mixed
hasGeoBoundingBoxQuery()  : mixed
hasGeoDistanceQuery()  : mixed
hasGeoPolygonQuery()  : mixed
hasMatchAllQuery()  : mixed
hasMatchNoneQuery()  : mixed
hasMatchPhraseQuery()  : mixed
hasMatchQuery()  : mixed
hasNumericRangeQuery()  : mixed
hasPhraseQuery()  : mixed
hasPrefixQuery()  : mixed
hasQueryStringQuery()  : mixed
hasRegexpQuery()  : mixed
hasTermQuery()  : mixed
hasTermRangeQuery()  : mixed
hasWildcardQuery()  : mixed
setBooleanFieldQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.BooleanFieldQuery boolean_field_query = 1;</code>
setBooleanQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.BooleanQuery boolean_query = 2;</code>
setConjunctionQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.ConjunctionQuery conjunction_query = 3;</code>
setDateRangeQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.DateRangeQuery date_range_query = 4;</code>
setDisjunctionQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.DisjunctionQuery disjunction_query = 5;</code>
setDocIdQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.DocIdQuery doc_id_query = 6;</code>
setGeoBoundingBoxQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.GeoBoundingBoxQuery geo_bounding_box_query = 7;</code>
setGeoDistanceQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.GeoDistanceQuery geo_distance_query = 8;</code>
setGeoPolygonQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.GeoPolygonQuery geo_polygon_query = 9;</code>
setMatchAllQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.MatchAllQuery match_all_query = 10;</code>
setMatchNoneQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.MatchNoneQuery match_none_query = 11;</code>
setMatchPhraseQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.MatchPhraseQuery match_phrase_query = 12;</code>
setMatchQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.MatchQuery match_query = 13;</code>
setNumericRangeQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.NumericRangeQuery numeric_range_query = 14;</code>
setPhraseQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.PhraseQuery phrase_query = 15;</code>
setPrefixQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.PrefixQuery prefix_query = 16;</code>
setQueryStringQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.QueryStringQuery query_string_query = 17;</code>
setRegexpQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.RegexpQuery regexp_query = 18;</code>
setTermQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.TermQuery term_query = 19;</code>
setTermRangeQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.TermRangeQuery term_range_query = 20;</code>
setWildcardQuery()  : $this
Generated from protobuf field <code>.couchbase.search.v1.WildcardQuery wildcard_query = 21;</code>

Properties

$query

protected mixed $query

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type \Couchbase\Protostellar\Generated\Search\V1\BooleanFieldQuery $boolean_field_query
@type \Couchbase\Protostellar\Generated\Search\V1\BooleanQuery $boolean_query
@type \Couchbase\Protostellar\Generated\Search\V1\ConjunctionQuery $conjunction_query
@type \Couchbase\Protostellar\Generated\Search\V1\DateRangeQuery $date_range_query
@type \Couchbase\Protostellar\Generated\Search\V1\DisjunctionQuery $disjunction_query
@type \Couchbase\Protostellar\Generated\Search\V1\DocIdQuery $doc_id_query
@type \Couchbase\Protostellar\Generated\Search\V1\GeoBoundingBoxQuery $geo_bounding_box_query
@type \Couchbase\Protostellar\Generated\Search\V1\GeoDistanceQuery $geo_distance_query
@type \Couchbase\Protostellar\Generated\Search\V1\GeoPolygonQuery $geo_polygon_query
@type \Couchbase\Protostellar\Generated\Search\V1\MatchAllQuery $match_all_query
@type \Couchbase\Protostellar\Generated\Search\V1\MatchNoneQuery $match_none_query
@type \Couchbase\Protostellar\Generated\Search\V1\MatchPhraseQuery $match_phrase_query
@type \Couchbase\Protostellar\Generated\Search\V1\MatchQuery $match_query
@type \Couchbase\Protostellar\Generated\Search\V1\NumericRangeQuery $numeric_range_query
@type \Couchbase\Protostellar\Generated\Search\V1\PhraseQuery $phrase_query
@type \Couchbase\Protostellar\Generated\Search\V1\PrefixQuery $prefix_query
@type \Couchbase\Protostellar\Generated\Search\V1\QueryStringQuery $query_string_query
@type \Couchbase\Protostellar\Generated\Search\V1\RegexpQuery $regexp_query
@type \Couchbase\Protostellar\Generated\Search\V1\TermQuery $term_query
@type \Couchbase\Protostellar\Generated\Search\V1\TermRangeQuery $term_range_query
@type \Couchbase\Protostellar\Generated\Search\V1\WildcardQuery $wildcard_query

}

Return values
mixed —

getBooleanFieldQuery()

Generated from protobuf field <code>.couchbase.search.v1.BooleanFieldQuery boolean_field_query = 1;</code>

public getBooleanFieldQuery() : BooleanFieldQuery|null
Return values
BooleanFieldQuery|null —

getBooleanQuery()

Generated from protobuf field <code>.couchbase.search.v1.BooleanQuery boolean_query = 2;</code>

public getBooleanQuery() : BooleanQuery|null
Return values
BooleanQuery|null —

getConjunctionQuery()

Generated from protobuf field <code>.couchbase.search.v1.ConjunctionQuery conjunction_query = 3;</code>

public getConjunctionQuery() : ConjunctionQuery|null
Return values
ConjunctionQuery|null —

getDateRangeQuery()

Generated from protobuf field <code>.couchbase.search.v1.DateRangeQuery date_range_query = 4;</code>

public getDateRangeQuery() : DateRangeQuery|null
Return values
DateRangeQuery|null —

getDisjunctionQuery()

Generated from protobuf field <code>.couchbase.search.v1.DisjunctionQuery disjunction_query = 5;</code>

public getDisjunctionQuery() : DisjunctionQuery|null
Return values
DisjunctionQuery|null —

getDocIdQuery()

Generated from protobuf field <code>.couchbase.search.v1.DocIdQuery doc_id_query = 6;</code>

public getDocIdQuery() : DocIdQuery|null
Return values
DocIdQuery|null —

getGeoBoundingBoxQuery()

Generated from protobuf field <code>.couchbase.search.v1.GeoBoundingBoxQuery geo_bounding_box_query = 7;</code>

public getGeoBoundingBoxQuery() : GeoBoundingBoxQuery|null
Return values
GeoBoundingBoxQuery|null —

getGeoDistanceQuery()

Generated from protobuf field <code>.couchbase.search.v1.GeoDistanceQuery geo_distance_query = 8;</code>

public getGeoDistanceQuery() : GeoDistanceQuery|null
Return values
GeoDistanceQuery|null —

getGeoPolygonQuery()

Generated from protobuf field <code>.couchbase.search.v1.GeoPolygonQuery geo_polygon_query = 9;</code>

public getGeoPolygonQuery() : GeoPolygonQuery|null
Return values
GeoPolygonQuery|null —

getMatchAllQuery()

Generated from protobuf field <code>.couchbase.search.v1.MatchAllQuery match_all_query = 10;</code>

public getMatchAllQuery() : MatchAllQuery|null
Return values
MatchAllQuery|null —

getMatchNoneQuery()

Generated from protobuf field <code>.couchbase.search.v1.MatchNoneQuery match_none_query = 11;</code>

public getMatchNoneQuery() : MatchNoneQuery|null
Return values
MatchNoneQuery|null —

getMatchPhraseQuery()

Generated from protobuf field <code>.couchbase.search.v1.MatchPhraseQuery match_phrase_query = 12;</code>

public getMatchPhraseQuery() : MatchPhraseQuery|null
Return values
MatchPhraseQuery|null —

getMatchQuery()

Generated from protobuf field <code>.couchbase.search.v1.MatchQuery match_query = 13;</code>

public getMatchQuery() : MatchQuery|null
Return values
MatchQuery|null —

getNumericRangeQuery()

Generated from protobuf field <code>.couchbase.search.v1.NumericRangeQuery numeric_range_query = 14;</code>

public getNumericRangeQuery() : NumericRangeQuery|null
Return values
NumericRangeQuery|null —

getPhraseQuery()

Generated from protobuf field <code>.couchbase.search.v1.PhraseQuery phrase_query = 15;</code>

public getPhraseQuery() : PhraseQuery|null
Return values
PhraseQuery|null —

getPrefixQuery()

Generated from protobuf field <code>.couchbase.search.v1.PrefixQuery prefix_query = 16;</code>

public getPrefixQuery() : PrefixQuery|null
Return values
PrefixQuery|null —

getQuery()

public getQuery() : string
Return values
string —

getQueryStringQuery()

Generated from protobuf field <code>.couchbase.search.v1.QueryStringQuery query_string_query = 17;</code>

public getQueryStringQuery() : QueryStringQuery|null
Return values
QueryStringQuery|null —

getRegexpQuery()

Generated from protobuf field <code>.couchbase.search.v1.RegexpQuery regexp_query = 18;</code>

public getRegexpQuery() : RegexpQuery|null
Return values
RegexpQuery|null —

getTermQuery()

Generated from protobuf field <code>.couchbase.search.v1.TermQuery term_query = 19;</code>

public getTermQuery() : TermQuery|null
Return values
TermQuery|null —

getTermRangeQuery()

Generated from protobuf field <code>.couchbase.search.v1.TermRangeQuery term_range_query = 20;</code>

public getTermRangeQuery() : TermRangeQuery|null
Return values
TermRangeQuery|null —

getWildcardQuery()

Generated from protobuf field <code>.couchbase.search.v1.WildcardQuery wildcard_query = 21;</code>

public getWildcardQuery() : WildcardQuery|null
Return values
WildcardQuery|null —

hasBooleanFieldQuery()

public hasBooleanFieldQuery() : mixed
Return values
mixed —

hasBooleanQuery()

public hasBooleanQuery() : mixed
Return values
mixed —

hasConjunctionQuery()

public hasConjunctionQuery() : mixed
Return values
mixed —

hasDateRangeQuery()

public hasDateRangeQuery() : mixed
Return values
mixed —

hasDisjunctionQuery()

public hasDisjunctionQuery() : mixed
Return values
mixed —

hasDocIdQuery()

public hasDocIdQuery() : mixed
Return values
mixed —

hasGeoBoundingBoxQuery()

public hasGeoBoundingBoxQuery() : mixed
Return values
mixed —

hasGeoDistanceQuery()

public hasGeoDistanceQuery() : mixed
Return values
mixed —

hasGeoPolygonQuery()

public hasGeoPolygonQuery() : mixed
Return values
mixed —

hasMatchAllQuery()

public hasMatchAllQuery() : mixed
Return values
mixed —

hasMatchNoneQuery()

public hasMatchNoneQuery() : mixed
Return values
mixed —

hasMatchPhraseQuery()

public hasMatchPhraseQuery() : mixed
Return values
mixed —

hasMatchQuery()

public hasMatchQuery() : mixed
Return values
mixed —

hasNumericRangeQuery()

public hasNumericRangeQuery() : mixed
Return values
mixed —

hasPhraseQuery()

public hasPhraseQuery() : mixed
Return values
mixed —

hasPrefixQuery()

public hasPrefixQuery() : mixed
Return values
mixed —

hasQueryStringQuery()

public hasQueryStringQuery() : mixed
Return values
mixed —

hasRegexpQuery()

public hasRegexpQuery() : mixed
Return values
mixed —

hasTermQuery()

public hasTermQuery() : mixed
Return values
mixed —

hasTermRangeQuery()

public hasTermRangeQuery() : mixed
Return values
mixed —

hasWildcardQuery()

public hasWildcardQuery() : mixed
Return values
mixed —

setBooleanFieldQuery()

Generated from protobuf field <code>.couchbase.search.v1.BooleanFieldQuery boolean_field_query = 1;</code>

public setBooleanFieldQuery(BooleanFieldQuery $var) : $this
Parameters
$var : BooleanFieldQuery
Return values
$this —

setBooleanQuery()

Generated from protobuf field <code>.couchbase.search.v1.BooleanQuery boolean_query = 2;</code>

public setBooleanQuery(BooleanQuery $var) : $this
Parameters
$var : BooleanQuery
Return values
$this —

setConjunctionQuery()

Generated from protobuf field <code>.couchbase.search.v1.ConjunctionQuery conjunction_query = 3;</code>

public setConjunctionQuery(ConjunctionQuery $var) : $this
Parameters
$var : ConjunctionQuery
Return values
$this —

setDateRangeQuery()

Generated from protobuf field <code>.couchbase.search.v1.DateRangeQuery date_range_query = 4;</code>

public setDateRangeQuery(DateRangeQuery $var) : $this
Parameters
$var : DateRangeQuery
Return values
$this —

setDisjunctionQuery()

Generated from protobuf field <code>.couchbase.search.v1.DisjunctionQuery disjunction_query = 5;</code>

public setDisjunctionQuery(DisjunctionQuery $var) : $this
Parameters
$var : DisjunctionQuery
Return values
$this —

setDocIdQuery()

Generated from protobuf field <code>.couchbase.search.v1.DocIdQuery doc_id_query = 6;</code>

public setDocIdQuery(DocIdQuery $var) : $this
Parameters
$var : DocIdQuery
Return values
$this —

setGeoBoundingBoxQuery()

Generated from protobuf field <code>.couchbase.search.v1.GeoBoundingBoxQuery geo_bounding_box_query = 7;</code>

public setGeoBoundingBoxQuery(GeoBoundingBoxQuery $var) : $this
Parameters
$var : GeoBoundingBoxQuery
Return values
$this —

setGeoDistanceQuery()

Generated from protobuf field <code>.couchbase.search.v1.GeoDistanceQuery geo_distance_query = 8;</code>

public setGeoDistanceQuery(GeoDistanceQuery $var) : $this
Parameters
$var : GeoDistanceQuery
Return values
$this —

setGeoPolygonQuery()

Generated from protobuf field <code>.couchbase.search.v1.GeoPolygonQuery geo_polygon_query = 9;</code>

public setGeoPolygonQuery(GeoPolygonQuery $var) : $this
Parameters
$var : GeoPolygonQuery
Return values
$this —

setMatchAllQuery()

Generated from protobuf field <code>.couchbase.search.v1.MatchAllQuery match_all_query = 10;</code>

public setMatchAllQuery(MatchAllQuery $var) : $this
Parameters
$var : MatchAllQuery
Return values
$this —

setMatchNoneQuery()

Generated from protobuf field <code>.couchbase.search.v1.MatchNoneQuery match_none_query = 11;</code>

public setMatchNoneQuery(MatchNoneQuery $var) : $this
Parameters
$var : MatchNoneQuery
Return values
$this —

setMatchPhraseQuery()

Generated from protobuf field <code>.couchbase.search.v1.MatchPhraseQuery match_phrase_query = 12;</code>

public setMatchPhraseQuery(MatchPhraseQuery $var) : $this
Parameters
$var : MatchPhraseQuery
Return values
$this —

setMatchQuery()

Generated from protobuf field <code>.couchbase.search.v1.MatchQuery match_query = 13;</code>

public setMatchQuery(MatchQuery $var) : $this
Parameters
$var : MatchQuery
Return values
$this —

setNumericRangeQuery()

Generated from protobuf field <code>.couchbase.search.v1.NumericRangeQuery numeric_range_query = 14;</code>

public setNumericRangeQuery(NumericRangeQuery $var) : $this
Parameters
$var : NumericRangeQuery
Return values
$this —

setPhraseQuery()

Generated from protobuf field <code>.couchbase.search.v1.PhraseQuery phrase_query = 15;</code>

public setPhraseQuery(PhraseQuery $var) : $this
Parameters
$var : PhraseQuery
Return values
$this —

setPrefixQuery()

Generated from protobuf field <code>.couchbase.search.v1.PrefixQuery prefix_query = 16;</code>

public setPrefixQuery(PrefixQuery $var) : $this
Parameters
$var : PrefixQuery
Return values
$this —

setQueryStringQuery()

Generated from protobuf field <code>.couchbase.search.v1.QueryStringQuery query_string_query = 17;</code>

public setQueryStringQuery(QueryStringQuery $var) : $this
Parameters
$var : QueryStringQuery
Return values
$this —

setRegexpQuery()

Generated from protobuf field <code>.couchbase.search.v1.RegexpQuery regexp_query = 18;</code>

public setRegexpQuery(RegexpQuery $var) : $this
Parameters
$var : RegexpQuery
Return values
$this —

setTermQuery()

Generated from protobuf field <code>.couchbase.search.v1.TermQuery term_query = 19;</code>

public setTermQuery(TermQuery $var) : $this
Parameters
$var : TermQuery
Return values
$this —

setTermRangeQuery()

Generated from protobuf field <code>.couchbase.search.v1.TermRangeQuery term_range_query = 20;</code>

public setTermRangeQuery(TermRangeQuery $var) : $this
Parameters
$var : TermRangeQuery
Return values
$this —

setWildcardQuery()

Generated from protobuf field <code>.couchbase.search.v1.WildcardQuery wildcard_query = 21;</code>

public setWildcardQuery(WildcardQuery $var) : $this
Parameters
$var : WildcardQuery
Return values
$this — 

        

        
    




    

    

                

    

        

            
Search results