Google Cloud Dms V1 Client - Class DatabaseEntity (1.4.2)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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<Google\Cloud\CloudDms\V1\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<Google\Cloud\CloudDms\V1\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<Google\Cloud\CloudDms\V1\EntityIssue>

Details about the various issues found for the entity.

↳ database Google\Cloud\CloudDms\V1\DatabaseInstanceEntity

Database.

↳ schema Google\Cloud\CloudDms\V1\SchemaEntity

Schema.

↳ table Google\Cloud\CloudDms\V1\TableEntity

Table.

↳ view Google\Cloud\CloudDms\V1\ViewEntity

View.

↳ sequence Google\Cloud\CloudDms\V1\SequenceEntity

Sequence.

↳ stored_procedure Google\Cloud\CloudDms\V1\StoredProcedureEntity

Stored procedure.

↳ database_function Google\Cloud\CloudDms\V1\FunctionEntity

Function.

↳ synonym Google\Cloud\CloudDms\V1\SynonymEntity

Synonym.

↳ database_package Google\Cloud\CloudDms\V1\PackageEntity

Package.

↳ udt Google\Cloud\CloudDms\V1\UDTEntity

UDT.

↳ materialized_view Google\Cloud\CloudDms\V1\MaterializedViewEntity

Materialized view.

getShortName

The short name (e.g. table name) of the entity.

Returns
TypeDescription
string

setShortName

The short name (e.g. table name) of the entity.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParentEntity

The full name of the parent entity (e.g. schema name).

Returns
TypeDescription
string

setParentEntity

The full name of the parent entity (e.g. schema name).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTree

The type of tree the entity belongs to.

Returns
TypeDescription
int

setTree

The type of tree the entity belongs to.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEntityType

The type of the database entity (table, view, index, ...).

Returns
TypeDescription
int

setEntityType

The type of the database entity (table, view, index, ...).

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\CloudDms\V1\EntityMapping>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\CloudDms\V1\EntityDdl>
Returns
TypeDescription
$this

getIssues

Details about the various issues found for the entity.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIssues

Details about the various issues found for the entity.

Parameter
NameDescription
var array<Google\Cloud\CloudDms\V1\EntityIssue>
Returns
TypeDescription
$this

getDatabase

Database.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\DatabaseInstanceEntity|null

hasDatabase

setDatabase

Database.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\DatabaseInstanceEntity
Returns
TypeDescription
$this

getSchema

Schema.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\SchemaEntity|null

hasSchema

setSchema

Schema.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\SchemaEntity
Returns
TypeDescription
$this

getTable

Table.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\TableEntity|null

hasTable

setTable

Table.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\TableEntity
Returns
TypeDescription
$this

getView

View.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\ViewEntity|null

hasView

setView

View.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\ViewEntity
Returns
TypeDescription
$this

getSequence

Sequence.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\SequenceEntity|null

hasSequence

setSequence

Sequence.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\SequenceEntity
Returns
TypeDescription
$this

getStoredProcedure

Stored procedure.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\StoredProcedureEntity|null

hasStoredProcedure

setStoredProcedure

Stored procedure.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\StoredProcedureEntity
Returns
TypeDescription
$this

getDatabaseFunction

Function.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\FunctionEntity|null

hasDatabaseFunction

setDatabaseFunction

Function.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\FunctionEntity
Returns
TypeDescription
$this

getSynonym

Synonym.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\SynonymEntity|null

hasSynonym

setSynonym

Synonym.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\SynonymEntity
Returns
TypeDescription
$this

getDatabasePackage

Package.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\PackageEntity|null

hasDatabasePackage

setDatabasePackage

Package.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\PackageEntity
Returns
TypeDescription
$this

getUdt

UDT.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\UDTEntity|null

hasUdt

setUdt

UDT.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\UDTEntity
Returns
TypeDescription
$this

getMaterializedView

Materialized view.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\MaterializedViewEntity|null

hasMaterializedView

setMaterializedView

Materialized view.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\MaterializedViewEntity
Returns
TypeDescription
$this

getEntityBody

Returns
TypeDescription
string