Cloud Spanner V1 Client - Class Type (1.101.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class Type.

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

Generated from protobuf message google.spanner.v1.Type

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ code
int

Required. The TypeCode for this type.

↳ array_element_type
Type

If code == ARRAY , then array_element_type is the type of the array elements.

↳ struct_type
StructType

If code == STRUCT , then struct_type provides type information for the struct's fields.

↳ type_annotation
int

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.

↳ proto_type_fqn
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.

getCode

Required. The TypeCode for this type.

Returns
Type
Description
int

setCode

Required. The TypeCode for this type.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getArrayElementType

If code == ARRAY , then array_element_type is the type of the array elements.

Returns
Type
Description
Type |null

hasArrayElementType

clearArrayElementType

setArrayElementType

If code == ARRAY , then array_element_type is the type of the array elements.

Parameter
Name
Description
var
Returns
Type
Description
$this

getStructType

If code == STRUCT , then struct_type provides type information for the struct's fields.

Returns
Type
Description
StructType |null

hasStructType

clearStructType

setStructType

If code == STRUCT , then struct_type provides type information for the struct's fields.

Parameter
Name
Description
Returns
Type
Description
$this

getTypeAnnotation

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
Type
Description
int

setTypeAnnotation

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.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getProtoTypeFqn

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
Type
Description
string

setProtoTypeFqn

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: