Google Cloud Spanner v1 API - Class PartitionReadRequest (4.3.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 > PartitionReadRequest

Implements

IMessage PartitionReadRequest, IEquatable PartitionReadRequest, IDeepCloneable PartitionReadRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleGoogle.CloudGoogle.Cloud.SpannerV1

Assembly

Google.Cloud.Spanner.V1.dll

Constructors

PartitionReadRequest()

public PartitionReadRequest()

PartitionReadRequest(PartitionReadRequest)

public PartitionReadRequest(PartitionReadRequest other)

Parameter
Name	Description
`other`	`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
`RepeatedFieldstring`

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
`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 is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

Property Value
Type	Description
`KeySet`

PartitionOptions

public PartitionOptions PartitionOptions { get; set; }

Additional options that affect how many partitions are created.

Property Value
Type	Description
`PartitionOptions`

Session

public string Session { get; set; }

Required. The session used to create the partitions.

Property Value
Type	Description
`string`

SessionAsSessionName

public SessionName SessionAsSessionName { get; set; }

SessionName-typed view over the Session resource name property.

Property Value
Type	Description
`SessionName`

Table

public string Table { get; set; }

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

Property Value
Type	Description
`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
`TransactionSelector`