public sealed class PartitionReadRequest : IMessage<PartitionReadRequest>, IEquatable<PartitionReadRequest>, IDeepCloneable<PartitionReadRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud Spanner v1 API class PartitionReadRequest.
The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead]
If non-empty, the name of an index on
[table][google.spanner.v1.PartitionReadRequest.table]. This index is used
instead of the table primary key when interpreting
[key_set][google.spanner.v1.PartitionReadRequest.key_set] and sorting
result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set]
for further information.
Required. key_set identifies the rows to be yielded. key_set names the
primary keys of the rows in
[table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless
[index][google.spanner.v1.PartitionReadRequest.index] is present. If
[index][google.spanner.v1.PartitionReadRequest.index] is present, then
[key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names
index keys in [index][google.spanner.v1.PartitionReadRequest.index].
It is not an error for the key_set to name rows that do not
exist in the database. Read yields nothing for nonexistent rows.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003ePartitionReadRequest\u003c/code\u003e class is used to define a request for partitioning data in Google Cloud Spanner, specifically for reading operations.\u003c/p\u003e\n"],["\u003cp\u003eThis API class supports read-only snapshot transactions, but does not allow read/write or single-use transactions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePartitionReadRequest\u003c/code\u003e class allows users to specify a \u003ccode\u003eKeySet\u003c/code\u003e to identify the rows and columns to be returned from a specific table, or it can be specified based on an index if one is provided.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the \u003ccode\u003ePartitionReadRequest\u003c/code\u003e class is \u003ccode\u003e5.0.0-beta05\u003c/code\u003e, and many other versions, from \u003ccode\u003e3.5.0\u003c/code\u003e up to \u003ccode\u003e5.0.0-beta04\u003c/code\u003e, are also available for use.\u003c/p\u003e\n"],["\u003cp\u003eThis class inherits from \u003ccode\u003eobject\u003c/code\u003e and implements multiple interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and provides constructors and properties to configure read operations, such as defining columns, indexes, and session details.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Spanner v1 API - Class PartitionReadRequest (5.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [5.1.0 (latest)](/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [5.0.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/5.0.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [4.6.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/4.6.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [4.5.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/4.5.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [4.4.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/4.4.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [4.3.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/4.3.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [4.2.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/4.2.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [4.1.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/4.1.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [4.0.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/4.0.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.15.1](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.15.1/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.14.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.13.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.12.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.11.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.10.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.9.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.8.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.7.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.6.0/Google.Cloud.Spanner.V1.PartitionReadRequest)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Spanner.V1/3.5.0/Google.Cloud.Spanner.V1.PartitionReadRequest) \n\n public sealed class PartitionReadRequest : IMessage\u003cPartitionReadRequest\u003e, IEquatable\u003cPartitionReadRequest\u003e, IDeepCloneable\u003cPartitionReadRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Spanner v1 API class PartitionReadRequest.\n\nThe request for \\[PartitionRead\\]\\[google.spanner.v1.Spanner.PartitionRead\\] \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e PartitionReadRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PartitionReadRequest](/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.PartitionReadRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PartitionReadRequest](/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.PartitionReadRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PartitionReadRequest](/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.PartitionReadRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Spanner.V1](/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Spanner.V1.dll\n\nConstructors\n------------\n\n### PartitionReadRequest()\n\n public PartitionReadRequest()\n\n### PartitionReadRequest(PartitionReadRequest)\n\n public PartitionReadRequest(PartitionReadRequest other)\n\nProperties\n----------\n\n### Columns\n\n public RepeatedField\u003cstring\u003e Columns { get; }\n\nThe columns of \\[table\\]\\[google.spanner.v1.PartitionReadRequest.table\\] to be\nreturned for each row matching this request.\n\n### Index\n\n public string Index { get; set; }\n\nIf non-empty, the name of an index on\n\\[table\\]\\[google.spanner.v1.PartitionReadRequest.table\\]. This index is used\ninstead of the table primary key when interpreting\n\\[key_set\\]\\[google.spanner.v1.PartitionReadRequest.key_set\\] and sorting\nresult rows. See \\[key_set\\]\\[google.spanner.v1.PartitionReadRequest.key_set\\]\nfor further information.\n\n### KeySet\n\n public KeySet KeySet { get; set; }\n\nRequired. `key_set` identifies the rows to be yielded. `key_set` names the\nprimary keys of the rows in\n\\[table\\]\\[google.spanner.v1.PartitionReadRequest.table\\] to be yielded, unless\n\\[index\\]\\[google.spanner.v1.PartitionReadRequest.index\\] is present. If\n\\[index\\]\\[google.spanner.v1.PartitionReadRequest.index\\] is present, then\n\\[key_set\\]\\[google.spanner.v1.PartitionReadRequest.key_set\\] instead names\nindex keys in \\[index\\]\\[google.spanner.v1.PartitionReadRequest.index\\].\n\nIt is not an error for the `key_set` to name rows that do not\nexist in the database. Read yields nothing for nonexistent rows.\n\n### PartitionOptions\n\n public PartitionOptions PartitionOptions { get; set; }\n\nAdditional options that affect how many partitions are created.\n\n### Session\n\n public string Session { get; set; }\n\nRequired. The session used to create the partitions.\n\n### SessionAsSessionName\n\n public SessionName SessionAsSessionName { get; set; }\n\n[SessionName](/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SessionName)-typed view over the [Session](/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.PartitionReadRequest#Google_Cloud_Spanner_V1_PartitionReadRequest_Session) resource name property.\n\n### Table\n\n public string Table { get; set; }\n\nRequired. The name of the table in the database to be read.\n\n### Transaction\n\n public TransactionSelector Transaction { get; set; }\n\nRead only snapshot transactions are supported, read/write and single use\ntransactions are not."]]
