RequestOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)Common request options for various APIs.
Attributes |
|
|---|---|
| Name | Description |
priority |
google.cloud.spanner_v1.types.RequestOptions.Priority
Priority for the request. |
request_tag |
str
A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and
transaction_tag can be specified for a read or query
that belongs to a transaction. This field is ignored for
requests where it's not applicable (for example,
CommitRequest). Legal characters for request_tag
values are all printable characters (ASCII 32 - 126) and the
length of a request_tag is limited to 50 characters. Values
that exceed this limit are truncated. Any leading underscore
(\_) characters are removed from the string.
|
transaction_tag |
str
A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be
specified for a read or query that belongs to a transaction.
To enable tagging on a transaction, transaction_tag must
be set to the same value for all requests belonging to the
same transaction, including
BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].
If this request doesn't belong to any transaction,
transaction_tag is ignored. Legal characters for
transaction_tag values are all printable characters
(ASCII 32 - 126) and the length of a transaction_tag is
limited to 50 characters. Values that exceed this limit are
truncated. Any leading underscore (\_) characters are
removed from the string.
|
client_context |
google.cloud.spanner_v1.types.RequestOptions.ClientContext
Optional. Optional context that may be needed for some requests. |
Classes
ClientContext
ClientContext(mapping=None, *, ignore_unknown_fields=False, **kwargs)Container for various pieces of client-owned context attached to a request.
Priority
Priority(value)The relative priority for requests. Note that priority isn't
applicable for
BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].
The priority acts as a hint to the Cloud Spanner scheduler and doesn't guarantee priority or order of execution. For example:
- Some parts of a write operation always execute at
PRIORITY_HIGH, regardless of the specified priority. This can cause you to see an increase in high priority workload even when executing a low priority request. This can also potentially cause a priority inversion where a lower priority request is fulfilled ahead of a higher priority request. - If a transaction contains multiple operations with different priorities, Cloud Spanner doesn't guarantee to process the higher priority operations first. There might be other constraints to satisfy, such as the order of operations.