Reference documentation and code samples for the Cloud Spanner V1 Client class OrderBy.
An option to control the order in which rows are returned from a read.
Protobuf type google.spanner.v1.ReadRequest.OrderBy
Namespace
Google \ Cloud \ Spanner \ V1 \ ReadRequestMethods
static::name
| Parameter | |
|---|---|
| Name | Description |
value |
mixed
|
static::value
| Parameter | |
|---|---|
| Name | Description |
name |
mixed
|
Constants
ORDER_BY_UNSPECIFIED
Value: 0Default value.
ORDER_BY_UNSPECIFIED is equivalent to ORDER_BY_PRIMARY_KEY.
Generated from protobuf enum ORDER_BY_UNSPECIFIED = 0;
ORDER_BY_PRIMARY_KEY
Value: 1Read 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.
Generated from protobuf enum ORDER_BY_PRIMARY_KEY = 1;
ORDER_BY_NO_ORDER
Value: 2Read rows are returned in any order.
Generated from protobuf enum ORDER_BY_NO_ORDER = 2;