Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::PartitionOptions.
Options for a PartitionQueryRequest and
PartitionReadRequest.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#max_partitions
defmax_partitions()->::Integer
Returns
(::Integer) — 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.
#max_partitions=
defmax_partitions=(value)->::Integer
Parameter
value (::Integer) — 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
(::Integer) — 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.
#partition_size_bytes
defpartition_size_bytes()->::Integer
Returns
(::Integer) — 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.
#partition_size_bytes=
defpartition_size_bytes=(value)->::Integer
Parameter
value (::Integer) — 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
(::Integer) — 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.
[[["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 API - Class Google::Cloud::Spanner::V1::PartitionOptions (v1.10.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.10.0 (latest)](/ruby/docs/reference/google-cloud-spanner-v1/latest/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.9.1](/ruby/docs/reference/google-cloud-spanner-v1/1.9.1/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.8.0](/ruby/docs/reference/google-cloud-spanner-v1/1.8.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.7.1](/ruby/docs/reference/google-cloud-spanner-v1/1.7.1/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.6.0](/ruby/docs/reference/google-cloud-spanner-v1/1.6.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.5.0](/ruby/docs/reference/google-cloud-spanner-v1/1.5.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.4.0](/ruby/docs/reference/google-cloud-spanner-v1/1.4.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.3.0](/ruby/docs/reference/google-cloud-spanner-v1/1.3.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.2.0](/ruby/docs/reference/google-cloud-spanner-v1/1.2.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.1.0](/ruby/docs/reference/google-cloud-spanner-v1/1.1.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [1.0.2](/ruby/docs/reference/google-cloud-spanner-v1/1.0.2/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.27.0](/ruby/docs/reference/google-cloud-spanner-v1/0.27.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.26.0](/ruby/docs/reference/google-cloud-spanner-v1/0.26.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.25.0](/ruby/docs/reference/google-cloud-spanner-v1/0.25.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.24.0](/ruby/docs/reference/google-cloud-spanner-v1/0.24.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.23.0](/ruby/docs/reference/google-cloud-spanner-v1/0.23.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.22.2](/ruby/docs/reference/google-cloud-spanner-v1/0.22.2/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.21.0](/ruby/docs/reference/google-cloud-spanner-v1/0.21.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.20.1](/ruby/docs/reference/google-cloud-spanner-v1/0.20.1/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.19.0](/ruby/docs/reference/google-cloud-spanner-v1/0.19.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.18.0](/ruby/docs/reference/google-cloud-spanner-v1/0.18.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.17.0](/ruby/docs/reference/google-cloud-spanner-v1/0.17.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.16.0](/ruby/docs/reference/google-cloud-spanner-v1/0.16.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.15.1](/ruby/docs/reference/google-cloud-spanner-v1/0.15.1/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.14.1](/ruby/docs/reference/google-cloud-spanner-v1/0.14.1/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.13.0](/ruby/docs/reference/google-cloud-spanner-v1/0.13.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.12.0](/ruby/docs/reference/google-cloud-spanner-v1/0.12.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.11.0](/ruby/docs/reference/google-cloud-spanner-v1/0.11.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.10.0](/ruby/docs/reference/google-cloud-spanner-v1/0.10.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.9.0](/ruby/docs/reference/google-cloud-spanner-v1/0.9.0/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.8.1](/ruby/docs/reference/google-cloud-spanner-v1/0.8.1/Google-Cloud-Spanner-V1-PartitionOptions)\n- [0.7.4](/ruby/docs/reference/google-cloud-spanner-v1/0.7.4/Google-Cloud-Spanner-V1-PartitionOptions) \nReference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::PartitionOptions.\n\nOptions for a PartitionQueryRequest and\nPartitionReadRequest. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #max_partitions\n\n def max_partitions() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests.\n\n\n The desired maximum number of partitions to return. For example, this may\n be set to the number of workers available. The default for this option\n is currently 10,000. The maximum value is currently 200,000. This is only\n a hint. The actual number of partitions returned may be smaller or larger\n than this maximum count request.\n\n### #max_partitions=\n\n def max_partitions=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests.\n\n\n The desired maximum number of partitions to return. For example, this may\n be set to the number of workers available. The default for this option\n is currently 10,000. The maximum value is currently 200,000. This is only\n a hint. The actual number of partitions returned may be smaller or larger\nthan this maximum count request. \n**Returns**\n\n- (::Integer) --- **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests.\n\n\n The desired maximum number of partitions to return. For example, this may\n be set to the number of workers available. The default for this option\n is currently 10,000. The maximum value is currently 200,000. This is only\n a hint. The actual number of partitions returned may be smaller or larger\n than this maximum count request.\n\n### #partition_size_bytes\n\n def partition_size_bytes() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests.\n\n\n The desired data size for each partition generated. The default for this\n option is currently 1 GiB. This is only a hint. The actual size of each\n partition may be smaller or larger than this size request.\n\n### #partition_size_bytes=\n\n def partition_size_bytes=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests.\n\n\n The desired data size for each partition generated. The default for this\n option 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**Returns**\n\n- (::Integer) --- **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests.\n\n\n The desired data size for each partition generated. The default for this\n option is currently 1 GiB. This is only a hint. The actual size of each\n partition may be smaller or larger than this size request."]]
