Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::Type (v1.3.0)

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

Type indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#array_element_type

def array_element_type() -> ::Google::Cloud::Spanner::V1::Type

Returns

(::Google::Cloud::Spanner::V1::Type) — If code == ARRAY, then array_element_type is the type of the array elements.

#array_element_type=

def array_element_type=(value) -> ::Google::Cloud::Spanner::V1::Type

Parameter

value (::Google::Cloud::Spanner::V1::Type) — If code == ARRAY, then array_element_type is the type of the array elements.

Returns

(::Google::Cloud::Spanner::V1::Type) — If code == ARRAY, then array_element_type is the type of the array elements.

#code

def code() -> ::Google::Cloud::Spanner::V1::TypeCode

Returns

(::Google::Cloud::Spanner::V1::TypeCode) — Required. The TypeCode for this type.

#code=

def code=(value) -> ::Google::Cloud::Spanner::V1::TypeCode

Parameter

value (::Google::Cloud::Spanner::V1::TypeCode) — Required. The TypeCode for this type.

Returns

(::Google::Cloud::Spanner::V1::TypeCode) — Required. The TypeCode for this type.

#proto_type_fqn

def proto_type_fqn() -> ::String

Returns

(::String) — If code == PROTO or code == ENUM, then proto_type_fqn is the fully qualified name of the proto type representing the proto/enum definition.

#proto_type_fqn=

def proto_type_fqn=(value) -> ::String

Parameter

value (::String) — If code == PROTO or code == ENUM, then proto_type_fqn is the fully qualified name of the proto type representing the proto/enum definition.

Returns

(::String) — If code == PROTO or code == ENUM, then proto_type_fqn is the fully qualified name of the proto type representing the proto/enum definition.

#struct_type

def struct_type() -> ::Google::Cloud::Spanner::V1::StructType

Returns

(::Google::Cloud::Spanner::V1::StructType) — If code == STRUCT, then struct_type provides type information for the struct's fields.

#struct_type=

def struct_type=(value) -> ::Google::Cloud::Spanner::V1::StructType

Parameter

value (::Google::Cloud::Spanner::V1::StructType) — If code == STRUCT, then struct_type provides type information for the struct's fields.

Returns

(::Google::Cloud::Spanner::V1::StructType) — If code == STRUCT, then struct_type provides type information for the struct's fields.

#type_annotation

def type_annotation() -> ::Google::Cloud::Spanner::V1::TypeAnnotationCode

Returns

(::Google::Cloud::Spanner::V1::TypeAnnotationCode) — The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.

#type_annotation=

def type_annotation=(value) -> ::Google::Cloud::Spanner::V1::TypeAnnotationCode

Parameter

value (::Google::Cloud::Spanner::V1::TypeAnnotationCode) — The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.

Returns

(::Google::Cloud::Spanner::V1::TypeAnnotationCode) — The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.