ReadRequest class

The request for Read and StreamingRead.

Constructors

ReadRequest({List<String>? columns, bool? dataBoostEnabled, DirectedReadOptions? directedReadOptions, String? index, KeySet? keySet, String? limit, String? lockHint, String? orderBy, String? partitionToken, RequestOptions? requestOptions, String? resumeToken, String? table, TransactionSelector? transaction})

ReadRequest.fromJson(Map json_)

Properties

columns ↔ List<String>?

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

getter/setter pair

dataBoostEnabled ↔ bool?

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.

getter/setter pair

directedReadOptions ↔ DirectedReadOptions?

Directed read options for this request.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

index ↔ String?

If non-empty, the name of an index on table.

getter/setter pair

keySet ↔ KeySet?

key_set identifies the rows to be yielded.

getter/setter pair

limit ↔ String?

If greater than zero, only the first limit rows are yielded.

getter/setter pair

lockHint ↔ String?

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

getter/setter pair

orderBy ↔ String?

Order for the returned rows.

getter/setter pair

partitionToken ↔ String?

If present, results are restricted to the specified partition previously created using PartitionRead.

getter/setter pair

partitionTokenAsBytes ↔ List<int>

getter/setter pair

requestOptions ↔ RequestOptions?

Common options for this request.

getter/setter pair

resumeToken ↔ String?

If this request is resuming a previously interrupted read, resume_token should be copied from the last PartialResultSet yielded before the interruption.

getter/setter pair

resumeTokenAsBytes ↔ List<int>

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

table ↔ String?

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

getter/setter pair

transaction ↔ TransactionSelector?

The transaction to use.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited