Cloud Spanner V1 Client - Class PartitionReadRequest (1.81.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class PartitionReadRequest.

The request for PartitionRead

Generated from protobuf message google.spanner.v1.PartitionReadRequest

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ session string

Required. The session used to create the partitions.
↳ transaction Google\Cloud\Spanner\V1\TransactionSelector

Read only snapshot transactions are supported, read/write and single use transactions are not.
↳ table string

Required. The name of the table in the database to be read.
↳ index string

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.
↳ columns array

The columns of table to be returned for each row matching this request.
↳ key_set Google\Cloud\Spanner\V1\KeySet

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.
↳ partition_options Google\Cloud\Spanner\V1\PartitionOptions

Additional options that affect how many partitions are created.

getSession

Required. The session used to create the partitions.

Returns
Type Description
string

setSession

Required. The session used to create the partitions.

Parameter
Name Description
var string
Returns
Type Description
$this

getTransaction

Read only snapshot transactions are supported, read/write and single use transactions are not.

Returns
Type Description
Google\Cloud\Spanner\V1\TransactionSelector|null

hasTransaction

clearTransaction

setTransaction

Read only snapshot transactions are supported, read/write and single use transactions are not.

Parameter
Name Description
var Google\Cloud\Spanner\V1\TransactionSelector
Returns
Type Description
$this

getTable

Required. The name of the table in the database to be read.

Returns
Type Description
string

setTable

Required. The name of the table in the database to be read.

Parameter
Name Description
var string
Returns
Type Description
$this

getIndex

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

Returns
Type Description
string

setIndex

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

Parameter
Name Description
var string
Returns
Type Description
$this

getColumns

The columns of table to be returned for each row matching this request.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setColumns

The columns of table to be returned for each row matching this request.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getKeySet

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

Returns
Type Description
Google\Cloud\Spanner\V1\KeySet|null

hasKeySet

clearKeySet

setKeySet

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

Parameter
Name Description
var Google\Cloud\Spanner\V1\KeySet
Returns
Type Description
$this

getPartitionOptions

Additional options that affect how many partitions are created.

Returns
Type Description
Google\Cloud\Spanner\V1\PartitionOptions|null

hasPartitionOptions

clearPartitionOptions

setPartitionOptions

Additional options that affect how many partitions are created.

Parameter
Name Description
var Google\Cloud\Spanner\V1\PartitionOptions
Returns
Type Description
$this