Cloud Spanner V1 Client - Class Type (1.62.1)

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
NameDescription
data array

Optional. Data for populating the Message object.

↳ code int

Required. The TypeCode for this type.

↳ array_element_type Google\Cloud\Spanner\V1\Type

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

↳ struct_type Google\Cloud\Spanner\V1\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.

getCode

Required. The TypeCode for this type.

Returns
TypeDescription
int

setCode

Required. The TypeCode for this type.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getArrayElementType

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

Returns
TypeDescription
Google\Cloud\Spanner\V1\Type|null

hasArrayElementType

clearArrayElementType

setArrayElementType

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

Parameter
NameDescription
var Google\Cloud\Spanner\V1\Type
Returns
TypeDescription
$this

getStructType

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

Returns
TypeDescription
Google\Cloud\Spanner\V1\StructType|null

hasStructType

clearStructType

setStructType

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

Parameter
NameDescription
var Google\Cloud\Spanner\V1\StructType
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this