Struct DatabaseEntity 

#[non_exhaustive]
pub struct DatabaseEntity {
    pub short_name: String,
    pub parent_entity: String,
    pub tree: TreeType,
    pub entity_type: DatabaseEntityType,
    pub mappings: Vec<EntityMapping>,
    pub entity_ddl: Vec<EntityDdl>,
    pub issues: Vec<EntityIssue>,
    pub entity_body: Option<EntityBody>,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

The type of tree the entity belongs to.

entity_type: DatabaseEntityType

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

mappings: Vec<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: Vec<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: Vec<EntityIssue>

Details about the various issues found for the entity.

entity_body: Option<EntityBody>

The specific body for each entity type.

Implementations

impl DatabaseEntity

pub fn new() -> Self

pub fn set_short_name<T: Into<String>>(self, v: T) -> Self

Sets the value of short_name.

pub fn set_parent_entity<T: Into<String>>(self, v: T) -> Self

Sets the value of parent_entity.

pub fn set_tree<T: Into<TreeType>>(self, v: T) -> Self

Sets the value of tree.

pub fn set_entity_type<T: Into<DatabaseEntityType>>(self, v: T) -> Self

Sets the value of entity_type.

pub fn set_mappings<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<EntityMapping>,

Sets the value of mappings.

pub fn set_entity_ddl<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<EntityDdl>,

Sets the value of entity_ddl.

pub fn set_issues<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<EntityIssue>,

Sets the value of issues.

pub fn set_entity_body<T: Into<Option<EntityBody>>>(self, v: T) -> Self

Sets the value of entity_body.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn database(&self) -> Option<&Box<DatabaseInstanceEntity>>

The value of entity_body if it holds a Database, None if the field is not set or holds a different branch.

pub fn set_database<T: Into<Box<DatabaseInstanceEntity>>>(self, v: T) -> Self

Sets the value of entity_body to hold a Database.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn schema(&self) -> Option<&Box<SchemaEntity>>

The value of entity_body if it holds a Schema, None if the field is not set or holds a different branch.

pub fn set_schema<T: Into<Box<SchemaEntity>>>(self, v: T) -> Self

Sets the value of entity_body to hold a Schema.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn table(&self) -> Option<&Box<TableEntity>>

The value of entity_body if it holds a Table, None if the field is not set or holds a different branch.

pub fn set_table<T: Into<Box<TableEntity>>>(self, v: T) -> Self

Sets the value of entity_body to hold a Table.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn view(&self) -> Option<&Box<ViewEntity>>

The value of entity_body if it holds a View, None if the field is not set or holds a different branch.

pub fn set_view<T: Into<Box<ViewEntity>>>(self, v: T) -> Self

Sets the value of entity_body to hold a View.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn sequence(&self) -> Option<&Box<SequenceEntity>>

The value of entity_body if it holds a Sequence, None if the field is not set or holds a different branch.

pub fn set_sequence<T: Into<Box<SequenceEntity>>>(self, v: T) -> Self

Sets the value of entity_body to hold a Sequence.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn stored_procedure(&self) -> Option<&Box<StoredProcedureEntity>>

The value of entity_body if it holds a StoredProcedure, None if the field is not set or holds a different branch.

pub fn set_stored_procedure<T: Into<Box<StoredProcedureEntity>>>( self, v: T, ) -> Self

Sets the value of entity_body to hold a StoredProcedure.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn database_function(&self) -> Option<&Box<FunctionEntity>>

The value of entity_body if it holds a DatabaseFunction, None if the field is not set or holds a different branch.

pub fn set_database_function<T: Into<Box<FunctionEntity>>>(self, v: T) -> Self

Sets the value of entity_body to hold a DatabaseFunction.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn synonym(&self) -> Option<&Box<SynonymEntity>>

The value of entity_body if it holds a Synonym, None if the field is not set or holds a different branch.

pub fn set_synonym<T: Into<Box<SynonymEntity>>>(self, v: T) -> Self

Sets the value of entity_body to hold a Synonym.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn database_package(&self) -> Option<&Box<PackageEntity>>

The value of entity_body if it holds a DatabasePackage, None if the field is not set or holds a different branch.

pub fn set_database_package<T: Into<Box<PackageEntity>>>(self, v: T) -> Self

Sets the value of entity_body to hold a DatabasePackage.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn udt(&self) -> Option<&Box<UDTEntity>>

The value of entity_body if it holds a Udt, None if the field is not set or holds a different branch.

pub fn set_udt<T: Into<Box<UDTEntity>>>(self, v: T) -> Self

Sets the value of entity_body to hold a Udt.

Note that all the setters affecting entity_body are mutually exclusive.

pub fn materialized_view(&self) -> Option<&Box<MaterializedViewEntity>>

The value of entity_body if it holds a MaterializedView, None if the field is not set or holds a different branch.

pub fn set_materialized_view<T: Into<Box<MaterializedViewEntity>>>( self, v: T, ) -> Self

Sets the value of entity_body to hold a MaterializedView.

Note that all the setters affecting entity_body are mutually exclusive.

Trait Implementations

impl Clone for DatabaseEntity

fn clone(&self) -> DatabaseEntity

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatabaseEntity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DatabaseEntity

fn default() -> DatabaseEntity

Returns the “default value” for a type.

impl Message for DatabaseEntity

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DatabaseEntity

fn eq(&self, other: &DatabaseEntity) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DatabaseEntity