Cloud Spanner V1 Client - Class PartitionOptions (1.88.0)

Version latest

• 1.88.0 (latest)
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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

Options for a PartitionQueryRequest and PartitionReadRequest.

Generated from protobuf message google.spanner.v1.PartitionOptions

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ partition_size_bytes	int|string Note: This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request.
↳ max_partitions	int|string Note: This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request.

getPartitionSizeBytes

Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request.

Returns
Type	Description
int|string

setPartitionSizeBytes

Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getMaxPartitions

Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request.

Returns
Type	Description
int|string

setMaxPartitions

Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this