Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::KeyRecipe (v1.12.0)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::KeyRecipe.

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 Ranges to route requests. Note that the client must tolerate KeyRecipes that appear to be invalid, since the KeyRecipe format may change over time. Requests with invalid KeyRecipes should be routed to a default server.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#index_name

def index_name() -> ::String
Returns
  • (::String) — An index name, matching the name from the database schema.

    Note: The following fields are mutually exclusive: index_name, table_name, operation_uid. If a field in that set is populated, all other fields in the set will automatically be cleared.

#index_name=

def index_name=(value) -> ::String
Parameter
  • value (::String) — An index name, matching the name from the database schema.

    Note: The following fields are mutually exclusive: index_name, table_name, operation_uid. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — An index name, matching the name from the database schema.

    Note: The following fields are mutually exclusive: index_name, table_name, operation_uid. If a field in that set is populated, all other fields in the set will automatically be cleared.

#operation_uid

def operation_uid() -> ::Integer
Returns
  • (::Integer) — The UID of a query, matching the UID from RoutingHint.

    Note: The following fields are mutually exclusive: operation_uid, table_name, index_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#operation_uid=

def operation_uid=(value) -> ::Integer
Parameter
  • value (::Integer) — The UID of a query, matching the UID from RoutingHint.

    Note: The following fields are mutually exclusive: operation_uid, table_name, index_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Integer) — The UID of a query, matching the UID from RoutingHint.

    Note: The following fields are mutually exclusive: operation_uid, table_name, index_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#part

def part() -> ::Array<::Google::Cloud::Spanner::V1::KeyRecipe::Part>
Returns

#part=

def part=(value) -> ::Array<::Google::Cloud::Spanner::V1::KeyRecipe::Part>
Parameter
Returns

#table_name

def table_name() -> ::String
Returns
  • (::String) — A table name, matching the name from the database schema.

    Note: The following fields are mutually exclusive: table_name, index_name, operation_uid. If a field in that set is populated, all other fields in the set will automatically be cleared.

#table_name=

def table_name=(value) -> ::String
Parameter
  • value (::String) — A table name, matching the name from the database schema.

    Note: The following fields are mutually exclusive: table_name, index_name, operation_uid. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — A table name, matching the name from the database schema.

    Note: The following fields are mutually exclusive: table_name, index_name, operation_uid. If a field in that set is populated, all other fields in the set will automatically be cleared.