Class KeyRecipe (3.60.0) 

KeyRecipe(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A KeyRecipe provides the metadata required to translate reads, mutations, and queries into a byte array in "sortable string format" (ssformat)that can be used with Range\ s to route requests. Note that the client must tolerate KeyRecipe\ s that appear to be invalid, since the KeyRecipe format may change over time. Requests with invalid KeyRecipe\ s should be routed to a default server.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
table_name str
A table name, matching the name from the database schema. This field is a member of oneof_ target.
index_name str
An index name, matching the name from the database schema. This field is a member of oneof_ target.
operation_uid int
The UID of a query, matching the UID from RoutingHint. This field is a member of oneof_ target.
part MutableSequence[google.cloud.spanner_v1.types.KeyRecipe.Part]
Parts are in the order they should appear in the encoded key.

Classes

Part

Part(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An ssformat key is composed of a sequence of tag numbers and key column values. Part represents a single tag or key column value.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields