Documentation

QueryRequest extends Message
in package

Generated from protobuf message <code>couchbase.query.v1.QueryRequest</code>

Table of Contents

$bucket_name  : mixed
Generated from protobuf field <code>optional string bucket_name = 1;</code>
$client_context_id  : mixed
Generated from protobuf field <code>optional string client_context_id = 7;</code>
$flex_index  : mixed
Generated from protobuf field <code>optional bool flex_index = 11;</code>
$prepared  : mixed
Generated from protobuf field <code>optional bool prepared = 5;</code>
$preserve_expiry  : mixed
Generated from protobuf field <code>optional bool preserve_expiry = 12;</code>
$profile_mode  : mixed
Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ProfileMode profile_mode = 14;</code>
$read_only  : mixed
Generated from protobuf field <code>optional bool read_only = 4;</code>
$scan_consistency  : mixed
Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ScanConsistency scan_consistency = 8;</code>
$scope_name  : mixed
Generated from protobuf field <code>optional string scope_name = 2;</code>
$statement  : mixed
Generated from protobuf field <code>string statement = 3;</code>
$tuning_options  : mixed
Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.TuningOptions tuning_options = 6;</code>
$consistent_with  : mixed
Generated from protobuf field <code>repeated .couchbase.kv.v1.MutationToken consistent_with = 13;</code>
$named_parameters  : mixed
Generated from protobuf field <code>map<string, bytes> named_parameters = 10;</code>
$positional_parameters  : mixed
Generated from protobuf field <code>repeated bytes positional_parameters = 9;</code>
__construct()  : mixed
Constructor.
clearBucketName()  : mixed
clearClientContextId()  : mixed
clearFlexIndex()  : mixed
clearPrepared()  : mixed
clearPreserveExpiry()  : mixed
clearProfileMode()  : mixed
clearReadOnly()  : mixed
clearScanConsistency()  : mixed
clearScopeName()  : mixed
clearTuningOptions()  : mixed
getBucketName()  : string
Generated from protobuf field <code>optional string bucket_name = 1;</code>
getClientContextId()  : string
Generated from protobuf field <code>optional string client_context_id = 7;</code>
getConsistentWith()  : RepeatedField
Generated from protobuf field <code>repeated .couchbase.kv.v1.MutationToken consistent_with = 13;</code>
getFlexIndex()  : bool
Generated from protobuf field <code>optional bool flex_index = 11;</code>
getNamedParameters()  : MapField
Generated from protobuf field <code>map<string, bytes> named_parameters = 10;</code>
getPositionalParameters()  : RepeatedField
Generated from protobuf field <code>repeated bytes positional_parameters = 9;</code>
getPrepared()  : bool
Generated from protobuf field <code>optional bool prepared = 5;</code>
getPreserveExpiry()  : bool
Generated from protobuf field <code>optional bool preserve_expiry = 12;</code>
getProfileMode()  : int
Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ProfileMode profile_mode = 14;</code>
getReadOnly()  : bool
Generated from protobuf field <code>optional bool read_only = 4;</code>
getScanConsistency()  : int
Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ScanConsistency scan_consistency = 8;</code>
getScopeName()  : string
Generated from protobuf field <code>optional string scope_name = 2;</code>
getStatement()  : string
Generated from protobuf field <code>string statement = 3;</code>
getTuningOptions()  : TuningOptions|null
Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.TuningOptions tuning_options = 6;</code>
hasBucketName()  : mixed
hasClientContextId()  : mixed
hasFlexIndex()  : mixed
hasPrepared()  : mixed
hasPreserveExpiry()  : mixed
hasProfileMode()  : mixed
hasReadOnly()  : mixed
hasScanConsistency()  : mixed
hasScopeName()  : mixed
hasTuningOptions()  : mixed
setBucketName()  : $this
Generated from protobuf field <code>optional string bucket_name = 1;</code>
setClientContextId()  : $this
Generated from protobuf field <code>optional string client_context_id = 7;</code>
setConsistentWith()  : $this
Generated from protobuf field <code>repeated .couchbase.kv.v1.MutationToken consistent_with = 13;</code>
setFlexIndex()  : $this
Generated from protobuf field <code>optional bool flex_index = 11;</code>
setNamedParameters()  : $this
Generated from protobuf field <code>map<string, bytes> named_parameters = 10;</code>
setPositionalParameters()  : $this
Generated from protobuf field <code>repeated bytes positional_parameters = 9;</code>
setPrepared()  : $this
Generated from protobuf field <code>optional bool prepared = 5;</code>
setPreserveExpiry()  : $this
Generated from protobuf field <code>optional bool preserve_expiry = 12;</code>
setProfileMode()  : $this
Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ProfileMode profile_mode = 14;</code>
setReadOnly()  : $this
Generated from protobuf field <code>optional bool read_only = 4;</code>
setScanConsistency()  : $this
Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ScanConsistency scan_consistency = 8;</code>
setScopeName()  : $this
Generated from protobuf field <code>optional string scope_name = 2;</code>
setStatement()  : $this
Generated from protobuf field <code>string statement = 3;</code>
setTuningOptions()  : $this
Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.TuningOptions tuning_options = 6;</code>

Properties

$bucket_name

Generated from protobuf field <code>optional string bucket_name = 1;</code>

protected mixed $bucket_name = null

$client_context_id

Generated from protobuf field <code>optional string client_context_id = 7;</code>

protected mixed $client_context_id = null

$flex_index

Generated from protobuf field <code>optional bool flex_index = 11;</code>

protected mixed $flex_index = null

$prepared

Generated from protobuf field <code>optional bool prepared = 5;</code>

protected mixed $prepared = null

$preserve_expiry

Generated from protobuf field <code>optional bool preserve_expiry = 12;</code>

protected mixed $preserve_expiry = null

$profile_mode

Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ProfileMode profile_mode = 14;</code>

protected mixed $profile_mode = null

$read_only

Generated from protobuf field <code>optional bool read_only = 4;</code>

protected mixed $read_only = null

$scan_consistency

Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ScanConsistency scan_consistency = 8;</code>

protected mixed $scan_consistency = null

$scope_name

Generated from protobuf field <code>optional string scope_name = 2;</code>

protected mixed $scope_name = null

$statement

Generated from protobuf field <code>string statement = 3;</code>

protected mixed $statement = ''

$tuning_options

Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.TuningOptions tuning_options = 6;</code>

protected mixed $tuning_options = null

$consistent_with

Generated from protobuf field <code>repeated .couchbase.kv.v1.MutationToken consistent_with = 13;</code>

private mixed $consistent_with

$named_parameters

Generated from protobuf field <code>map<string, bytes> named_parameters = 10;</code>

private mixed $named_parameters

$positional_parameters

Generated from protobuf field <code>repeated bytes positional_parameters = 9;</code>

private mixed $positional_parameters

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 string $bucket_name
@type string $scope_name
@type string $statement
@type bool $read_only
@type bool $prepared
@type \Couchbase\Protostellar\Generated\Query\V1\QueryRequest\TuningOptions $tuning_options
@type string $client_context_id
@type int $scan_consistency
@type array<string>|\Google\Protobuf\Internal\RepeatedField $positional_parameters
@type array|\Google\Protobuf\Internal\MapField $named_parameters
@type bool $flex_index
@type bool $preserve_expiry
@type array<\Couchbase\Protostellar\Generated\KV\V1\MutationToken>|\Google\Protobuf\Internal\RepeatedField $consistent_with
@type int $profile_mode

}

Return values
mixed —

clearBucketName()

public clearBucketName() : mixed
Return values
mixed —

clearClientContextId()

public clearClientContextId() : mixed
Return values
mixed —

clearFlexIndex()

public clearFlexIndex() : mixed
Return values
mixed —

clearPrepared()

public clearPrepared() : mixed
Return values
mixed —

clearPreserveExpiry()

public clearPreserveExpiry() : mixed
Return values
mixed —

clearProfileMode()

public clearProfileMode() : mixed
Return values
mixed —

clearReadOnly()

public clearReadOnly() : mixed
Return values
mixed —

clearScanConsistency()

public clearScanConsistency() : mixed
Return values
mixed —

clearScopeName()

public clearScopeName() : mixed
Return values
mixed —

clearTuningOptions()

public clearTuningOptions() : mixed
Return values
mixed —

getBucketName()

Generated from protobuf field <code>optional string bucket_name = 1;</code>

public getBucketName() : string
Return values
string —

getClientContextId()

Generated from protobuf field <code>optional string client_context_id = 7;</code>

public getClientContextId() : string
Return values
string —

getConsistentWith()

Generated from protobuf field <code>repeated .couchbase.kv.v1.MutationToken consistent_with = 13;</code>

public getConsistentWith() : RepeatedField
Return values
RepeatedField —

getFlexIndex()

Generated from protobuf field <code>optional bool flex_index = 11;</code>

public getFlexIndex() : bool
Return values
bool —

getNamedParameters()

Generated from protobuf field <code>map<string, bytes> named_parameters = 10;</code>

public getNamedParameters() : MapField
Return values
MapField —

getPositionalParameters()

Generated from protobuf field <code>repeated bytes positional_parameters = 9;</code>

public getPositionalParameters() : RepeatedField
Return values
RepeatedField —

getPrepared()

Generated from protobuf field <code>optional bool prepared = 5;</code>

public getPrepared() : bool
Return values
bool —

getPreserveExpiry()

Generated from protobuf field <code>optional bool preserve_expiry = 12;</code>

public getPreserveExpiry() : bool
Return values
bool —

getProfileMode()

Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ProfileMode profile_mode = 14;</code>

public getProfileMode() : int
Return values
int —

getReadOnly()

Generated from protobuf field <code>optional bool read_only = 4;</code>

public getReadOnly() : bool
Return values
bool —

getScanConsistency()

Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ScanConsistency scan_consistency = 8;</code>

public getScanConsistency() : int
Return values
int —

getScopeName()

Generated from protobuf field <code>optional string scope_name = 2;</code>

public getScopeName() : string
Return values
string —

getStatement()

Generated from protobuf field <code>string statement = 3;</code>

public getStatement() : string
Return values
string —

getTuningOptions()

Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.TuningOptions tuning_options = 6;</code>

public getTuningOptions() : TuningOptions|null
Return values
TuningOptions|null —

hasBucketName()

public hasBucketName() : mixed
Return values
mixed —

hasClientContextId()

public hasClientContextId() : mixed
Return values
mixed —

hasFlexIndex()

public hasFlexIndex() : mixed
Return values
mixed —

hasPrepared()

public hasPrepared() : mixed
Return values
mixed —

hasPreserveExpiry()

public hasPreserveExpiry() : mixed
Return values
mixed —

hasProfileMode()

public hasProfileMode() : mixed
Return values
mixed —

hasReadOnly()

public hasReadOnly() : mixed
Return values
mixed —

hasScanConsistency()

public hasScanConsistency() : mixed
Return values
mixed —

hasScopeName()

public hasScopeName() : mixed
Return values
mixed —

hasTuningOptions()

public hasTuningOptions() : mixed
Return values
mixed —

setBucketName()

Generated from protobuf field <code>optional string bucket_name = 1;</code>

public setBucketName(string $var) : $this
Parameters
$var : string
Return values
$this —

setClientContextId()

Generated from protobuf field <code>optional string client_context_id = 7;</code>

public setClientContextId(string $var) : $this
Parameters
$var : string
Return values
$this —

setConsistentWith()

Generated from protobuf field <code>repeated .couchbase.kv.v1.MutationToken consistent_with = 13;</code>

public setConsistentWith(array<string|int, MutationToken>|RepeatedField $var) : $this
Parameters
$var : array<string|int, MutationToken>|RepeatedField
Return values
$this —

setFlexIndex()

Generated from protobuf field <code>optional bool flex_index = 11;</code>

public setFlexIndex(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setNamedParameters()

Generated from protobuf field <code>map<string, bytes> named_parameters = 10;</code>

public setNamedParameters(array<string|int, mixed>|MapField $var) : $this
Parameters
$var : array<string|int, mixed>|MapField
Return values
$this —

setPositionalParameters()

Generated from protobuf field <code>repeated bytes positional_parameters = 9;</code>

public setPositionalParameters(array<string|int, string>|RepeatedField $var) : $this
Parameters
$var : array<string|int, string>|RepeatedField
Return values
$this —

setPrepared()

Generated from protobuf field <code>optional bool prepared = 5;</code>

public setPrepared(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setPreserveExpiry()

Generated from protobuf field <code>optional bool preserve_expiry = 12;</code>

public setPreserveExpiry(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setProfileMode()

Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ProfileMode profile_mode = 14;</code>

public setProfileMode(int $var) : $this
Parameters
$var : int
Return values
$this —

setReadOnly()

Generated from protobuf field <code>optional bool read_only = 4;</code>

public setReadOnly(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setScanConsistency()

Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.ScanConsistency scan_consistency = 8;</code>

public setScanConsistency(int $var) : $this
Parameters
$var : int
Return values
$this —

setScopeName()

Generated from protobuf field <code>optional string scope_name = 2;</code>

public setScopeName(string $var) : $this
Parameters
$var : string
Return values
$this —

setStatement()

Generated from protobuf field <code>string statement = 3;</code>

public setStatement(string $var) : $this
Parameters
$var : string
Return values
$this —

setTuningOptions()

Generated from protobuf field <code>optional .couchbase.query.v1.QueryRequest.TuningOptions tuning_options = 6;</code>

public setTuningOptions(TuningOptions $var) : $this
Parameters
$var : TuningOptions
Return values
$this — 

        

        
    




    

    

                

    

        

            
Search results