Reference documentation and code samples for the Google Cloud Dms V1 Client class ColumnEntity.
Column is not used as an independent entity, it is retrieved as part of a Table entity.
Generated from protobuf message google.cloud.clouddms.v1.ColumnEntity
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Column name. |
↳ data_type |
string
Column data type. |
↳ charset |
string
Charset override - instead of table level charset. |
↳ collation |
string
Collation override - instead of table level collation. |
↳ length |
int|string
Column length - e.g. varchar (50). |
↳ precision |
int
Column precision - when relevant. |
↳ scale |
int
Column scale - when relevant. |
↳ fractional_seconds_precision |
int
Column fractional second precision - used for timestamp based datatypes. |
↳ array |
bool
Is the column of array type. |
↳ array_length |
int
If the column is array, of which length. |
↳ nullable |
bool
Is the column nullable. |
↳ auto_generated |
bool
Is the column auto-generated/identity. |
↳ udt |
bool
Is the column a UDT. |
↳ custom_features |
Google\Protobuf\Struct
Custom engine specific features. |
↳ set_values |
array
Specifies the list of values allowed in the column. Only used for set data type. |
↳ comment |
string
Comment associated with the column. |
↳ ordinal_position |
int
Column order in the table. |
↳ default_value |
string
Default value of the column. |
getName
Column name.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Column name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataType
Column data type.
| Returns | |
|---|---|
| Type | Description |
string | |
setDataType
Column data type.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCharset
Charset override - instead of table level charset.
| Returns | |
|---|---|
| Type | Description |
string | |
setCharset
Charset override - instead of table level charset.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCollation
Collation override - instead of table level collation.
| Returns | |
|---|---|
| Type | Description |
string | |
setCollation
Collation override - instead of table level collation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLength
Column length - e.g. varchar (50).
| Returns | |
|---|---|
| Type | Description |
int|string | |
setLength
Column length - e.g. varchar (50).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrecision
Column precision - when relevant.
| Returns | |
|---|---|
| Type | Description |
int | |
setPrecision
Column precision - when relevant.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getScale
Column scale - when relevant.
| Returns | |
|---|---|
| Type | Description |
int | |
setScale
Column scale - when relevant.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFractionalSecondsPrecision
Column fractional second precision - used for timestamp based datatypes.
| Returns | |
|---|---|
| Type | Description |
int | |
setFractionalSecondsPrecision
Column fractional second precision - used for timestamp based datatypes.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getArray
Is the column of array type.
| Returns | |
|---|---|
| Type | Description |
bool | |
setArray
Is the column of array type.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getArrayLength
If the column is array, of which length.
| Returns | |
|---|---|
| Type | Description |
int | |
setArrayLength
If the column is array, of which length.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNullable
Is the column nullable.
| Returns | |
|---|---|
| Type | Description |
bool | |
setNullable
Is the column nullable.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAutoGenerated
Is the column auto-generated/identity.
| Returns | |
|---|---|
| Type | Description |
bool | |
setAutoGenerated
Is the column auto-generated/identity.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUdt
Is the column a UDT.
| Returns | |
|---|---|
| Type | Description |
bool | |
setUdt
Is the column a UDT.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCustomFeatures
Custom engine specific features.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasCustomFeatures
clearCustomFeatures
setCustomFeatures
Custom engine specific features.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSetValues
Specifies the list of values allowed in the column.
Only used for set data type.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSetValues
Specifies the list of values allowed in the column.
Only used for set data type.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getComment
Comment associated with the column.
| Returns | |
|---|---|
| Type | Description |
string | |
setComment
Comment associated with the column.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrdinalPosition
Column order in the table.
| Returns | |
|---|---|
| Type | Description |
int | |
setOrdinalPosition
Column order in the table.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDefaultValue
Default value of the column.
| Returns | |
|---|---|
| Type | Description |
string | |
setDefaultValue
Default value of the column.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |