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 \ V1Methods
__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 |
↳ struct_type |
StructType
If code == STRUCT, then |
↳ 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 |
getCode
Required. The TypeCode for this type.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type TypeCode. |
setCode
Required. The TypeCode for this type.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type TypeCode. |
| 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 |
Type
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStructType
| Returns | |
|---|---|
| Type | Description |
StructType|null |
|
hasStructType
clearStructType
setStructType
| Parameter | |
|---|---|
| Name | Description |
var |
StructType
|
| 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 |
Enum of type TypeAnnotationCode. |
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
Enum of type TypeAnnotationCode. |
| 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 |
|