Google Cloud Dms V1 Client - Class DatabaseEntity (1.3.0)

Version 1.3.0

• 2.0.2 (latest)
• 2.0.1
• 1.5.5
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.5

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
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<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.
↳ 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.

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<Google\Cloud\CloudDms\V1\EntityMapping>

Returns
Type	Description
$this

getSchema

Schema.

Returns
Type	Description
Google\Cloud\CloudDms\V1\SchemaEntity|null

hasSchema

setSchema

Schema.

Parameter
Name	Description
var	Google\Cloud\CloudDms\V1\SchemaEntity

Returns
Type	Description
$this

getTable

Table.

Returns
Type	Description
Google\Cloud\CloudDms\V1\TableEntity|null

hasTable

setTable

Table.

Parameter
Name	Description
var	Google\Cloud\CloudDms\V1\TableEntity

Returns
Type	Description
$this

getView

View.

Returns
Type	Description
Google\Cloud\CloudDms\V1\ViewEntity|null

hasView

setView

View.

Parameter
Name	Description
var	Google\Cloud\CloudDms\V1\ViewEntity

Returns
Type	Description
$this

getSequence

Sequence.

Returns
Type	Description
Google\Cloud\CloudDms\V1\SequenceEntity|null

hasSequence

setSequence

Sequence.

Parameter
Name	Description
var	Google\Cloud\CloudDms\V1\SequenceEntity

Returns
Type	Description
$this

getStoredProcedure

Stored procedure.

Returns
Type	Description
Google\Cloud\CloudDms\V1\StoredProcedureEntity|null

hasStoredProcedure

setStoredProcedure

Stored procedure.

Parameter
Name	Description
var	Google\Cloud\CloudDms\V1\StoredProcedureEntity

Returns
Type	Description
$this

getDatabaseFunction

Function.

Returns
Type	Description
Google\Cloud\CloudDms\V1\FunctionEntity|null

hasDatabaseFunction

setDatabaseFunction

Function.

Parameter
Name	Description
var	Google\Cloud\CloudDms\V1\FunctionEntity

Returns
Type	Description
$this

getSynonym

Synonym.

Returns
Type	Description
Google\Cloud\CloudDms\V1\SynonymEntity|null

hasSynonym

setSynonym

Synonym.

Parameter
Name	Description
var	Google\Cloud\CloudDms\V1\SynonymEntity

Returns
Type	Description
$this

getDatabasePackage

Package.

Returns
Type	Description
Google\Cloud\CloudDms\V1\PackageEntity|null

hasDatabasePackage

setDatabasePackage

Package.

Parameter
Name	Description
var	Google\Cloud\CloudDms\V1\PackageEntity

Returns
Type	Description
$this

getEntityBody

Returns
Type	Description
string