Class ReadRequest

The request for Read and StreamingRead.

Inheritance
object
ReadRequest
Implements
Inherited Members
Namespace: Google.Apis.Spanner.v1.Data
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class ReadRequest : IDirectResponseSchema

Properties

Columns

Required. The columns of table to be returned for each row matching this request.

Declaration
[JsonProperty("columns")]
public virtual IList<string> Columns { get; set; }
Property Value
Type Description
IList<string>

DataBoostEnabled

If this is for a partitioned read and this field is set to true, the request is executed with Spanner Data Boost independent compute resources. If the field is set to true but the request does not set partition_token, the API returns an INVALID_ARGUMENT error.

Declaration
[JsonProperty("dataBoostEnabled")]
public virtual bool? DataBoostEnabled { get; set; }
Property Value
Type Description
bool?

DirectedReadOptions

Directed read options for this request.

Declaration
[JsonProperty("directedReadOptions")]
public virtual DirectedReadOptions DirectedReadOptions { get; set; }
Property Value
Type Description
DirectedReadOptions

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Index

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

Declaration
[JsonProperty("index")]
public virtual string Index { get; set; }
Property Value
Type Description
string

KeySet

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. 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.

Declaration
[JsonProperty("keySet")]
public virtual KeySet KeySet { get; set; }
Property Value
Type Description
KeySet

Limit

If greater than zero, only the first limit rows are yielded. If limit is zero, the default is no limit. A limit cannot be specified if partition_token is set.

Declaration
[JsonProperty("limit")]
public virtual long? Limit { get; set; }
Property Value
Type Description
long?

LockHint

Optional. Lock Hint for the request, it can only be used with read-write transactions.

Declaration
[JsonProperty("lockHint")]
public virtual string LockHint { get; set; }
Property Value
Type Description
string

OrderBy

Optional. Order for the returned rows. By default, Spanner will return result rows in primary key order except for PartitionRead requests. For applications that do not require rows to be returned in primary key (ORDER_BY_PRIMARY_KEY) order, setting ORDER_BY_NO_ORDER option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (e.g. bulk point lookups).

Declaration
[JsonProperty("orderBy")]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PartitionToken

If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.

Declaration
[JsonProperty("partitionToken")]
public virtual string PartitionToken { get; set; }
Property Value
Type Description
string

RequestOptions

Common options for this request.

Declaration
[JsonProperty("requestOptions")]
public virtual RequestOptions RequestOptions { get; set; }
Property Value
Type Description
RequestOptions

ResumeToken

If this request is resuming a previously interrupted read, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.

Declaration
[JsonProperty("resumeToken")]
public virtual string ResumeToken { get; set; }
Property Value
Type Description
string

Table

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

Declaration
[JsonProperty("table")]
public virtual string Table { get; set; }
Property Value
Type Description
string

Transaction

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

Declaration
[JsonProperty("transaction")]
public virtual TransactionSelector Transaction { get; set; }
Property Value
Type Description
TransactionSelector

Implements