Cloud Spanner V1 Client - Class Part (2.1.0)

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

An ssformat key is composed of a sequence of tag numbers and key column values. Part represents a single tag or key column value.

Generated from protobuf message google.spanner.v1.KeyRecipe.Part

Namespace

Google \ Cloud \ Spanner \ V1 \ KeyRecipe

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ tag`	`int` If non-zero, `tag` is the only field present in this `Part`. The part is encoded by appending `tag` to the ssformat key.
`↳ order`	`int` Whether the key column is sorted ascending or descending. Only present if `tag` is zero.
`↳ null_order`	`int` How NULLs are represented in the encoded key part. Only present if `tag` is zero.
`↳ type`	`Google\Cloud\Spanner\V1\Type` The type of the key part. Only present if `tag` is zero.
`↳ identifier`	`string` `identifier` is the name of the column or query parameter.
`↳ value`	`Google\Protobuf\Value` The constant value of the key part. It is present when query uses a constant as a part of the key.
`↳ random`	`bool` If true, the client is responsible to fill in the value randomly. It's relevant only for the INT64 type.
`↳ struct_identifiers`	`array` It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.

getTag

If non-zero, tag is the only field present in this Part. The part is encoded by appending tag to the ssformat key.

Returns
Type	Description
`int`

setTag

If non-zero, tag is the only field present in this Part. The part is encoded by appending tag to the ssformat key.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getOrder

Whether the key column is sorted ascending or descending. Only present if tag is zero.

Returns
Type	Description
`int`	Enum of type Order.

setOrder

Whether the key column is sorted ascending or descending. Only present if tag is zero.

Parameter
Name	Description
`var`	`int` Enum of type Order.

Returns
Type	Description
`$this`

getNullOrder

How NULLs are represented in the encoded key part. Only present if tag is zero.

Returns
Type	Description
`int`	Enum of type NullOrder.

setNullOrder

How NULLs are represented in the encoded key part. Only present if tag is zero.

Parameter
Name	Description
`var`	`int` Enum of type NullOrder.

Returns
Type	Description
`$this`

getType

The type of the key part. Only present if tag is zero.

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

hasType

clearType

setType

The type of the key part. Only present if tag is zero.

Parameter
Name	Description
`var`	`Google\Cloud\Spanner\V1\Type`

Returns
Type	Description
`$this`

getIdentifier

identifier is the name of the column or query parameter.

Returns
Type	Description
`string`

hasIdentifier

setIdentifier

identifier is the name of the column or query parameter.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getValue

The constant value of the key part.

It is present when query uses a constant as a part of the key.

Returns
Type	Description
`Google\Protobuf\Value\|null`

hasValue

setValue