# Google Cloud Spanner v1 API - Class PartitionReadRequest (5.13.0-beta07)

5.13.0-beta07 5.13.0-beta06 5.12.0 (latest) 5.11.0 5.10.0 5.9.0 5.8.0 5.7.0 5.6.0 5.5.0 5.4.0 5.3.0 5.2.0 5.1.0 5.0.0 4.6.0 4.5.0 4.4.0 4.3.0 4.2.0 4.1.0 4.0.0 3.15.1 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0

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

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> PartitionReadRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PartitionReadRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.PartitionReadRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PartitionReadRequest](https://docs.cloud.google.com/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](https://docs.cloud.google.com/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)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Spanner.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1)

## Assembly

Google.Cloud.Spanner.V1.dll

## Constructors

### PartitionReadRequest()

    public PartitionReadRequest()

### PartitionReadRequest(PartitionReadRequest)

    public PartitionReadRequest(PartitionReadRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.PartitionReadRequest` |

## Properties

### Columns

    public RepeatedField<string> Columns { get; }

The columns of \[table\]\[google.spanner.v1.PartitionReadRequest.table\] to be
returned for each row matching this request.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Index

    public string Index { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### KeySet

    public KeySet KeySet { get; set; }

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 isn't an error for the `key_set` to name rows that don't
exist in the database. Read yields nothing for nonexistent rows.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.KeySet` |   |

### PartitionOptions

    public PartitionOptions PartitionOptions { get; set; }

Additional options that affect how many partitions are created.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.PartitionOptions` |   |

### Session

    public string Session { get; set; }

Required. The session used to create the partitions.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### SessionAsSessionName

    public SessionName SessionAsSessionName { get; set; }

[SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SessionName)-typed view over the [Session](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.PartitionReadRequest#Google_Cloud_Spanner_V1_PartitionReadRequest_Session) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.SessionName` |   |

### Table

    public string Table { get; set; }

Required. The name of the table in the database to be read.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Transaction

    public TransactionSelector Transaction { get; set; }

Read only snapshot transactions are supported, read/write and single use
transactions are not.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.V1/latest/Google.Cloud.Spanner.V1.TransactionSelector` |   |