Google Cloud Dms V1 Client - Class ColumnEntity (1.2.1)

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

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setName

Column name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDataType

Column data type.

Returns
TypeDescription
string

setDataType

Column data type.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCharset

Charset override - instead of table level charset.

Returns
TypeDescription
string

setCharset

Charset override - instead of table level charset.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCollation

Collation override - instead of table level collation.

Returns
TypeDescription
string

setCollation

Collation override - instead of table level collation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLength

Column length - e.g. varchar (50).

Returns
TypeDescription
int|string

setLength

Column length - e.g. varchar (50).

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getPrecision

Column precision - when relevant.

Returns
TypeDescription
int

setPrecision

Column precision - when relevant.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getScale

Column scale - when relevant.

Returns
TypeDescription
int

setScale

Column scale - when relevant.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFractionalSecondsPrecision

Column fractional second precision - used for timestamp based datatypes.

Returns
TypeDescription
int

setFractionalSecondsPrecision

Column fractional second precision - used for timestamp based datatypes.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getArray

Is the column of array type.

Returns
TypeDescription
bool

setArray

Is the column of array type.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getArrayLength

If the column is array, of which length.

Returns
TypeDescription
int

setArrayLength

If the column is array, of which length.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getNullable

Is the column nullable.

Returns
TypeDescription
bool

setNullable

Is the column nullable.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAutoGenerated

Is the column auto-generated/identity.

Returns
TypeDescription
bool

setAutoGenerated

Is the column auto-generated/identity.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getUdt

Is the column a UDT.

Returns
TypeDescription
bool

setUdt

Is the column a UDT.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getCustomFeatures

Custom engine specific features.

Returns
TypeDescription
Google\Protobuf\Struct|null

hasCustomFeatures

clearCustomFeatures

setCustomFeatures

Custom engine specific features.

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$this

getSetValues

Specifies the list of values allowed in the column.

Only used for set data type.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSetValues

Specifies the list of values allowed in the column.

Only used for set data type.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getComment

Comment associated with the column.

Returns
TypeDescription
string

setComment

Comment associated with the column.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrdinalPosition

Column order in the table.

Returns
TypeDescription
int

setOrdinalPosition

Column order in the table.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDefaultValue

Default value of the column.

Returns
TypeDescription
string

setDefaultValue

Default value of the column.

Parameter
NameDescription
var string
Returns
TypeDescription
$this