Class: Google::Cloud::CloudDMS::V1::DatabaseEntity

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb

Overview

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.

Defined Under Namespace

Modules: TreeType

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity

Returns Database.

Note: The following fields are mutually exclusive: database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity) —

    Database.

    Note: The following fields are mutually exclusive: database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#database_function ⇒ ::Google::Cloud::CloudDMS::V1::FunctionEntity

Returns Function.

Note: The following fields are mutually exclusive: database_function, database, schema, table, view, sequence, stored_procedure, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::FunctionEntity) —

    Function.

    Note: The following fields are mutually exclusive: database_function, database, schema, table, view, sequence, stored_procedure, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#database_package ⇒ ::Google::Cloud::CloudDMS::V1::PackageEntity

Returns Package.

Note: The following fields are mutually exclusive: database_package, database, schema, table, view, sequence, stored_procedure, database_function, synonym, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::PackageEntity) —

    Package.

    Note: The following fields are mutually exclusive: database_package, database, schema, table, view, sequence, stored_procedure, database_function, synonym, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#entity_ddl ⇒ ::Array<::Google::Cloud::CloudDMS::V1::EntityDdl>

Returns 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:

  • (::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.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#entity_type ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseEntityType

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

Returns:



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#issues ⇒ ::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>

Returns Details about the various issues found for the entity.

Returns:



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#mappings ⇒ ::Array<::Google::Cloud::CloudDMS::V1::EntityMapping>

Returns 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:

  • (::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.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#materialized_view ⇒ ::Google::Cloud::CloudDMS::V1::MaterializedViewEntity

Returns Materialized view.

Note: The following fields are mutually exclusive: materialized_view, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::MaterializedViewEntity) —

    Materialized view.

    Note: The following fields are mutually exclusive: materialized_view, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#parent_entity ⇒ ::String

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

Returns:

  • (::String) —

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



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#schema ⇒ ::Google::Cloud::CloudDMS::V1::SchemaEntity

Returns Schema.

Note: The following fields are mutually exclusive: schema, database, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::SchemaEntity) —

    Schema.

    Note: The following fields are mutually exclusive: schema, database, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#sequence ⇒ ::Google::Cloud::CloudDMS::V1::SequenceEntity

Returns Sequence.

Note: The following fields are mutually exclusive: sequence, database, schema, table, view, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::SequenceEntity) —

    Sequence.

    Note: The following fields are mutually exclusive: sequence, database, schema, table, view, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#short_name ⇒ ::String

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

Returns:

  • (::String) —

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



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#stored_procedure ⇒ ::Google::Cloud::CloudDMS::V1::StoredProcedureEntity

Returns Stored procedure.

Note: The following fields are mutually exclusive: stored_procedure, database, schema, table, view, sequence, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::StoredProcedureEntity) —

    Stored procedure.

    Note: The following fields are mutually exclusive: stored_procedure, database, schema, table, view, sequence, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#synonym ⇒ ::Google::Cloud::CloudDMS::V1::SynonymEntity

Returns Synonym.

Note: The following fields are mutually exclusive: synonym, database, schema, table, view, sequence, stored_procedure, database_function, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::SynonymEntity) —

    Synonym.

    Note: The following fields are mutually exclusive: synonym, database, schema, table, view, sequence, stored_procedure, database_function, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#table ⇒ ::Google::Cloud::CloudDMS::V1::TableEntity

Returns Table.

Note: The following fields are mutually exclusive: table, database, schema, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::TableEntity) —

    Table.

    Note: The following fields are mutually exclusive: table, database, schema, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#tree ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType

Returns The type of tree the entity belongs to.

Returns:



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#udt ⇒ ::Google::Cloud::CloudDMS::V1::UDTEntity

Returns UDT.

Note: The following fields are mutually exclusive: udt, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::UDTEntity) —

    UDT.

    Note: The following fields are mutually exclusive: udt, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#view ⇒ ::Google::Cloud::CloudDMS::V1::ViewEntity

Returns View.

Note: The following fields are mutually exclusive: view, database, schema, table, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::ViewEntity) —

    View.

    Note: The following fields are mutually exclusive: view, database, schema, table, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 886

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end