Class Part (3.60.0)

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

Attributes

Name Description
tag int
If non-zero, tag is the only field present in this Part. The part is encoded by appending tag to the ssformat key.
order google.cloud.spanner_v1.types.KeyRecipe.Part.Order
Whether the key column is sorted ascending or descending. Only present if tag is zero.
null_order google.cloud.spanner_v1.types.KeyRecipe.Part.NullOrder
How NULLs are represented in the encoded key part. Only present if tag is zero.
type_ google.cloud.spanner_v1.types.Type
The type of the key part. Only present if tag is zero.
identifier str
identifier is the name of the column or query parameter. This field is a member of oneof_ value_type.
value google.protobuf.struct_pb2.Value
The constant value of the key part. It is present when query uses a constant as a part of the key. This field is a member of oneof_ value_type.
random bool
If true, the client is responsible to fill in the value randomly. It's relevant only for the INT64 type. This field is a member of oneof_ value_type.
struct_identifiers MutableSequence[int]
It is a repeated field to support fetching key columns from nested structs, such as STRUCT query parameters.

Classes

NullOrder

NullOrder(value)

The null order of the key column. This dictates where NULL values sort in the sorted order. Note that columns which are NOT NULL can have a special encoding.

Order

Order(value)

The remaining fields encode column values.