Database Migration v1 API - Class DatabaseEntity (2.3.0)

public sealed class DatabaseEntity : IMessage<DatabaseEntity>, IEquatable<DatabaseEntity>, IDeepCloneable<DatabaseEntity>, IBufferMessage, IMessage

Reference documentation and code samples for the Database Migration v1 API 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.

Inheritance

object > DatabaseEntity

Implements

IMessage DatabaseEntity, IEquatable DatabaseEntity, IDeepCloneable DatabaseEntity, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.CloudDms.V1

Assembly

Google.Cloud.CloudDms.V1.dll

Constructors

DatabaseEntity()

public DatabaseEntity()

DatabaseEntity(DatabaseEntity)

public DatabaseEntity(DatabaseEntity other)

Parameter
Name	Description
`other`	`DatabaseEntity`

Properties

Database

public DatabaseInstanceEntity Database { get; set; }

Database.

Property Value
Type	Description
`DatabaseInstanceEntity`

DatabaseFunction

public FunctionEntity DatabaseFunction { get; set; }

Function.

Property Value
Type	Description
`FunctionEntity`

DatabasePackage

public PackageEntity DatabasePackage { get; set; }

Package.

Property Value
Type	Description
`PackageEntity`

EntityBodyCase

public DatabaseEntity.EntityBodyOneofCase EntityBodyCase { get; }

Property Value
Type	Description
`DatabaseEntityEntityBodyOneofCase`

EntityDdl

public RepeatedField<EntityDdl> EntityDdl { get; }

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.

Property Value
Type	Description
`RepeatedFieldEntityDdl`

EntityType

public DatabaseEntityType EntityType { get; set; }

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

Property Value
Type	Description
`DatabaseEntityType`

Issues

public RepeatedField<EntityIssue> Issues { get; }

Details about the various issues found for the entity.

Property Value
Type	Description
`RepeatedFieldEntityIssue`

Mappings

public RepeatedField<EntityMapping> Mappings { get; }

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.

Property Value
Type	Description
`RepeatedFieldEntityMapping`

MaterializedView

public MaterializedViewEntity MaterializedView { get; set; }

Materialized view.

Property Value
Type	Description
`MaterializedViewEntity`

ParentEntity

public string ParentEntity { get; set; }

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

Property Value
Type	Description
`string`

Schema

public SchemaEntity Schema { get; set; }

Schema.

Property Value
Type	Description
`SchemaEntity`

Sequence

public SequenceEntity Sequence { get; set; }

Sequence.

Property Value
Type	Description
`SequenceEntity`

ShortName

public string ShortName { get; set; }

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

Property Value
Type	Description
`string`

StoredProcedure

public StoredProcedureEntity StoredProcedure { get; set; }

Stored procedure.

Property Value
Type	Description
`StoredProcedureEntity`

Synonym

public SynonymEntity Synonym { get; set; }

Synonym.

Property Value
Type	Description
`SynonymEntity`

Table

public TableEntity Table { get; set; }

Table.

Property Value
Type	Description
`TableEntity`

Tree

public DatabaseEntity.Types.TreeType Tree { get; set; }

The type of tree the entity belongs to.

Property Value
Type	Description
`DatabaseEntityTypesTreeType`

Udt

public UDTEntity Udt { get; set; }

UDT.

Property Value
Type	Description
`UDTEntity`

View

public ViewEntity View { get; set; }

View.

Property Value
Type	Description
`ViewEntity`