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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class PartitionOptions (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/V1.PartitionOptions)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/V1.PartitionOptions)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/V1.PartitionOptions)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/V1.PartitionOptions)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/V1.PartitionOptions)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/V1.PartitionOptions)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/V1.PartitionOptions)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/V1.PartitionOptions)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/V1.PartitionOptions)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/V1.PartitionOptions)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/V1.PartitionOptions)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/V1.PartitionOptions)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/V1.PartitionOptions)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/V1.PartitionOptions)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/V1.PartitionOptions)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/V1.PartitionOptions)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/V1.PartitionOptions)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/V1.PartitionOptions)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/V1.PartitionOptions)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/V1.PartitionOptions)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/V1.PartitionOptions)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/V1.PartitionOptions)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/V1.PartitionOptions)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/V1.PartitionOptions)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/V1.PartitionOptions)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/V1.PartitionOptions)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/V1.PartitionOptions)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/V1.PartitionOptions)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/V1.PartitionOptions)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/V1.PartitionOptions)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/V1.PartitionOptions)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/V1.PartitionOptions)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/V1.PartitionOptions)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/V1.PartitionOptions)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/V1.PartitionOptions)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/V1.PartitionOptions)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/V1.PartitionOptions)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/V1.PartitionOptions)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/V1.PartitionOptions)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/V1.PartitionOptions)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/V1.PartitionOptions)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/V1.PartitionOptions)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/V1.PartitionOptions) \nReference documentation and code samples for the Cloud Spanner V1 Client class PartitionOptions.\n\nOptions for a PartitionQueryRequest and\nPartitionReadRequest.\n\nGenerated from protobuf message `google.spanner.v1.PartitionOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPartitionSizeBytes\n\n**Note:** This hint is currently ignored by PartitionQuery and\nPartitionRead requests.\n\nThe desired data size for each partition generated. The default for this\noption is currently 1 GiB. This is only a hint. The actual size of each\npartition may be smaller or larger than this size request.\n\n### setPartitionSizeBytes\n\n**Note:** This hint is currently ignored by PartitionQuery and\nPartitionRead requests.\n\nThe desired data size for each partition generated. The default for this\noption is currently 1 GiB. This is only a hint. The actual size of each\npartition may be smaller or larger than this size request.\n\n### getMaxPartitions\n\n**Note:** This hint is currently ignored by PartitionQuery and\nPartitionRead requests.\n\nThe desired maximum number of partitions to return. For example, this may\nbe set to the number of workers available. The default for this option\nis currently 10,000. The maximum value is currently 200,000. This is only\na hint. The actual number of partitions returned may be smaller or larger\nthan this maximum count request.\n\n### setMaxPartitions\n\n**Note:** This hint is currently ignored by PartitionQuery and\nPartitionRead requests.\n\nThe desired maximum number of partitions to return. For example, this may\nbe set to the number of workers available. The default for this option\nis currently 10,000. The maximum value is currently 200,000. This is only\na hint. The actual number of partitions returned may be smaller or larger\nthan this maximum count request."]]
