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.
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
↳ database
↳ schema
↳ table
↳ view
↳ sequence
↳ stored_procedure
↳ database_function
↳ synonym
↳ database_package
↳ udt
↳ materialized_view
getShortName
The short name (e.g. table name) of the entity.
string
setShortName
The short name (e.g. table name) of the entity.
var
string
$this
getParentEntity
The full name of the parent entity (e.g. schema name).
string
setParentEntity
The full name of the parent entity (e.g. schema name).
var
string
$this
getTree
The type of tree the entity belongs to.
int
setTree
The type of tree the entity belongs to.
var
int
$this
getEntityType
The type of the database entity (table, view, index, ...).
int
setEntityType
The type of the database entity (table, view, index, ...).
var
int
$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.
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.
$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.
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.
$this
getIssues
Details about the various issues found for the entity.
setIssues
Details about the various issues found for the entity.
$this
getDatabase
Database.
hasDatabase
setDatabase
Database.
$this
getSchema
Schema.
hasSchema
setSchema
Schema.
$this
getTable
Table.
hasTable
setTable
Table.
$this
getView
View.
hasView
setView
View.
$this
getSequence
Sequence.
hasSequence
setSequence
Sequence.
$this
getStoredProcedure
Stored procedure.
hasStoredProcedure
setStoredProcedure
Stored procedure.
$this
getDatabaseFunction
Function.
hasDatabaseFunction
setDatabaseFunction
Function.
$this
getSynonym
Synonym.
hasSynonym
setSynonym
Synonym.
$this
getDatabasePackage
Package.
hasDatabasePackage
setDatabasePackage
Package.
$this
getUdt
UDT.
hasUdt
setUdt
UDT.
$this
getMaterializedView
Materialized view.
hasMaterializedView
setMaterializedView
Materialized view.
$this
getEntityBody
string
