orderBy property

String? orderBy
getter/setter pair

Order for the returned rows.

By default, Spanner returns result rows in primary key order except for PartitionRead requests. For applications that don't 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 (for example, bulk point lookups).

Optional. Possible string values are:

  • "ORDER_BY_UNSPECIFIED" : Default value. ORDER_BY_UNSPECIFIED is equivalent to ORDER_BY_PRIMARY_KEY.
  • "ORDER_BY_PRIMARY_KEY" : Read rows are returned in primary key order. In the event that this option is used in conjunction with the partition_token field, the API returns an INVALID_ARGUMENT error.
  • "ORDER_BY_NO_ORDER" : Read rows are returned in any order.

Implementation

core.String? orderBy;