DatabaseEntity

import type { DatabaseEntity } from "https://googleapis.deno.dev/v1/datamigration:v1.ts";

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.

interface DatabaseEntity {

database?: DatabaseInstanceEntity;

databaseFunction?: FunctionEntity;

databasePackage?: PackageEntity;

entityDdl?: EntityDdl[];

entityType?:

| "DATABASE_ENTITY_TYPE_UNSPECIFIED"

| "DATABASE_ENTITY_TYPE_SCHEMA"

| "DATABASE_ENTITY_TYPE_TABLE"

| "DATABASE_ENTITY_TYPE_COLUMN"

| "DATABASE_ENTITY_TYPE_CONSTRAINT"

| "DATABASE_ENTITY_TYPE_INDEX"

| "DATABASE_ENTITY_TYPE_TRIGGER"

| "DATABASE_ENTITY_TYPE_VIEW"

| "DATABASE_ENTITY_TYPE_SEQUENCE"

| "DATABASE_ENTITY_TYPE_STORED_PROCEDURE"

| "DATABASE_ENTITY_TYPE_FUNCTION"

| "DATABASE_ENTITY_TYPE_SYNONYM"

| "DATABASE_ENTITY_TYPE_DATABASE_PACKAGE"

| "DATABASE_ENTITY_TYPE_UDT"

| "DATABASE_ENTITY_TYPE_MATERIALIZED_VIEW"

| "DATABASE_ENTITY_TYPE_DATABASE";

issues?: EntityIssue[];

mappings?: EntityMapping[];

materializedView?: MaterializedViewEntity;

parentEntity?: string;

schema?: SchemaEntity;

sequence?: SequenceEntity;

shortName?: string;

storedProcedure?: StoredProcedureEntity;

synonym?: SynonymEntity;

table?: TableEntity;

tree?:

| "TREE_TYPE_UNSPECIFIED"

| "SOURCE"

| "DRAFT"

| "DESTINATION";

udt?: UDTEntity;

view?: ViewEntity;

}

§Properties

database?: DatabaseInstanceEntity

[src]

Database.

databaseFunction?: FunctionEntity

[src]

Function.

databasePackage?: PackageEntity

[src]

Package.

entityDdl?: EntityDdl[]

[src]

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.

[src]

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

issues?: EntityIssue[]

[src]

Details about the various issues found for the entity.

mappings?: EntityMapping[]

[src]

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.

materializedView?: MaterializedViewEntity

[src]

Materialized view.

parentEntity?: string

[src]

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

schema?: SchemaEntity

[src]

Schema.

sequence?: SequenceEntity

[src]

Sequence.