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
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 | |