Reference documentation and code samples for the Google Cloud Dms V1 Client class DatabaseEntity.
The base entity type for all the database related entities.
The message contains the entity name, the name of its parent, the entity type, and the specific details per entity type.
Generated from protobuf message google.cloud.clouddms.v1.DatabaseEntity
Namespace
Google \ Cloud \ CloudDms \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ short_name |
string
The short name (e.g. table name) of the entity. |
↳ parent_entity |
string
The full name of the parent entity (e.g. schema name). |
↳ tree |
int
The type of tree the entity belongs to. |
↳ entity_type |
int
The type of the database entity (table, view, index, ...). |
↳ mappings |
array<EntityMapping>
Details about entity mappings. For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details. |
↳ entity_ddl |
array<EntityDdl>
Details about the entity DDL script. Multiple DDL scripts are provided for child entities such as a table entity will have one DDL for the table with additional DDLs for each index, constraint and such. |
↳ issues |
array<EntityIssue>
Details about the various issues found for the entity. |
↳ database |
DatabaseInstanceEntity
Database. |
↳ schema |
SchemaEntity
Schema. |
↳ table |
TableEntity
Table. |
↳ view |
ViewEntity
View. |
↳ sequence |
SequenceEntity
Sequence. |
↳ stored_procedure |
StoredProcedureEntity
Stored procedure. |
↳ database_function |
FunctionEntity
Function. |
↳ synonym |
SynonymEntity
Synonym. |
↳ database_package |
PackageEntity
Package. |
↳ udt |
UDTEntity
UDT. |
↳ materialized_view |
MaterializedViewEntity
Materialized view. |
getShortName
The short name (e.g. table name) of the entity.
| Returns | |
|---|---|
| Type | Description |
string |
|
setShortName
The short name (e.g. table name) of the entity.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParentEntity
The full name of the parent entity (e.g. schema name).
| Returns | |
|---|---|
| Type | Description |
string |
|
setParentEntity
The full name of the parent entity (e.g. schema name).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTree
The type of tree the entity belongs to.
| Returns | |
|---|---|
| Type | Description |
int |
|
setTree
The type of tree the entity belongs to.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEntityType
The type of the database entity (table, view, index, ...).
| Returns | |
|---|---|
| Type | Description |
int |
|
setEntityType
The type of the database entity (table, view, index, ...).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMappings
Details about entity mappings.
For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMappings
Details about entity mappings.
For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details.
| Parameter | |
|---|---|
| Name | Description |
var |
array<EntityMapping>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEntityDdl
Details about the entity DDL script. Multiple DDL scripts are provided for child entities such as a table entity will have one DDL for the table with additional DDLs for each index, constraint and such.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEntityDdl
Details about the entity DDL script. Multiple DDL scripts are provided for child entities such as a table entity will have one DDL for the table with additional DDLs for each index, constraint and such.
| Parameter | |
|---|---|
| Name | Description |
var |
array<EntityDdl>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIssues
Details about the various issues found for the entity.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setIssues
Details about the various issues found for the entity.
| Parameter | |
|---|---|
| Name | Description |
var |
array<EntityIssue>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabase
Database.
| Returns | |
|---|---|
| Type | Description |
DatabaseInstanceEntity|null |
|
hasDatabase
setDatabase
Database.
| Parameter | |
|---|---|
| Name | Description |
var |
DatabaseInstanceEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchema
Schema.
| Returns | |
|---|---|
| Type | Description |
SchemaEntity|null |
|
hasSchema
setSchema
Schema.
| Parameter | |
|---|---|
| Name | Description |
var |
SchemaEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTable
Table.
| Returns | |
|---|---|
| Type | Description |
TableEntity|null |
|
hasTable
setTable
Table.
| Parameter | |
|---|---|
| Name | Description |
var |
TableEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getView
View.
| Returns | |
|---|---|
| Type | Description |
ViewEntity|null |
|
hasView
setView
View.
| Parameter | |
|---|---|
| Name | Description |
var |
ViewEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSequence
Sequence.
| Returns | |
|---|---|
| Type | Description |
SequenceEntity|null |
|
hasSequence
setSequence
Sequence.
| Parameter | |
|---|---|
| Name | Description |
var |
SequenceEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStoredProcedure
Stored procedure.
| Returns | |
|---|---|
| Type | Description |
StoredProcedureEntity|null |
|
hasStoredProcedure
setStoredProcedure
Stored procedure.
| Parameter | |
|---|---|
| Name | Description |
var |
StoredProcedureEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseFunction
Function.
| Returns | |
|---|---|
| Type | Description |
FunctionEntity|null |
|
hasDatabaseFunction
setDatabaseFunction
Function.
| Parameter | |
|---|---|
| Name | Description |
var |
FunctionEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSynonym
Synonym.
| Returns | |
|---|---|
| Type | Description |
SynonymEntity|null |
|
hasSynonym
setSynonym
Synonym.
| Parameter | |
|---|---|
| Name | Description |
var |
SynonymEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabasePackage
Package.
| Returns | |
|---|---|
| Type | Description |
PackageEntity|null |
|
hasDatabasePackage
setDatabasePackage
Package.
| Parameter | |
|---|---|
| Name | Description |
var |
PackageEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUdt
UDT.
| Returns | |
|---|---|
| Type | Description |
UDTEntity|null |
|
hasUdt
setUdt
UDT.
| Parameter | |
|---|---|
| Name | Description |
var |
UDTEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaterializedView
Materialized view.
| Returns | |
|---|---|
| Type | Description |
MaterializedViewEntity|null |
|
hasMaterializedView
setMaterializedView
Materialized view.
| Parameter | |
|---|---|
| Name | Description |
var |
MaterializedViewEntity
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEntityBody
| Returns | |
|---|---|
| Type | Description |
string |
|