Click or drag to resize

DBCatalog Class

Container class which contains a database catalog's meta-data.
Inheritance Hierarchy

Namespace:  SD.LLBLGen.Pro.DBDriverCore
Assembly:  SD.LLBLGen.Pro.DBDriverCore (in SD.LLBLGen.Pro.DBDriverCore.dll) Version: 5.4.0.0 (5.4.0)
Syntax
public class DBCatalog : DBElementBase, ISerializableToXml, 
	IExcludable, IDBRenameableElement, ISyncable, INotifyPropertyChanged

The DBCatalog type exposes the following members.

Constructors
  NameDescription
Public methodDBCatalog(String)
CTor
Public methodDBCatalog(String, String)
CTor
Top
Properties
  NameDescription
Public propertyAllowsNewElements
Gets a value indicating whether new elements can be created into this container. Returns true if sync source is set to Model or Mixed, false otherwise.
Public propertyCatalogName
The name of the catalog
Public propertyCreatedByDesigner
Gets or sets a value indicating whether this element is created by the designer from mappings (true) or that it was created from meta-data retrieved from the database (false, default).
(Inherited from DBElementBase.)
Public propertyCustomProperties
Gets the Custom properties (name - value pairs) read from the schema.
(Inherited from DBElementBase.)
Protected propertyDeserializing
Gets or sets a value indicating whether this instance is deserializing.
(Inherited from DBElementBase.)
Public propertyErrorLog
Gets the complete ErrorLog for this object.
(Inherited from DBElementBase.)
Public propertyFullName
Gets the full name.
(Inherited from DBElementBase.)
Public propertyFullNameForXml
Gets the full name for XML. This is a name which has the format schemaname:elementname or schemaname:elementname:fieldname. Used for references.
(Inherited from DBElementBase.)
Public propertyFullNameForXmlWithCatalog
Gets the full name for XML. This is a name which has the format catalogname:schemaname:elementname or catalogname:schemaname:elementname:fieldname. Used for references.
(Inherited from DBElementBase.)
Public propertyLastSyncWithDatabaseUTC
Gets or sets the last date/time this element was synchronized with a database. If null, it means 'never'. DateTime in UTC format.
Public propertyLastSyncWithModelUTC
Gets or sets the last date/time this element was synchronized with a model. If null, it means 'never'. DateTime in UTC format.
Public propertyMarkedForDeletion
Gets or sets a value indicating whether this element is marked for deletion.
(Inherited from DBElementBase.)
Public propertySchemas
List of schemas in this catalog
Public propertySyncSource
Gets or sets the synchronize source.
Protected propertyTypeOfDBElement
Gets the type of DB element in the form of a ContainedElementType value.
(Overrides DBElementBaseTypeOfDBElement.)
Public propertyUsedDriverID
Gets the driver ID of the driver used to fill the catalog's meta-data.
Top
Methods
  NameDescription
Public methodCheckIfAllMetaDataIsNew
Checks if all meta data in this catalog is new.
Public methodCheckIfDDLSQLExportActionIsRequired
Checks if a DDL SQL export action is required for the meta-data in this object
Public methodContainsAnyElementOfType
Determines whether this element directly or indirectly contains at least 1 element of the type specified.
Protected methodDeserializeAdditionalAttributes
Deserializes attributes of this element's base class from the reader.
(Inherited from DBElementBase.)
Public methodDeserializeFromReader
Deserializes from reader. Reader is positioned on the Catalog element
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from DBElementBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExclude
Excludes this instance from the project / meta-container it's in.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindSchemaByName(String)
Finds the schema with the name specified.
Public methodFindSchemaByName(String, Boolean)
Finds the schema with the name specified.
Public methodGetAllChangedElements
Gets all changed elements of type typeOfElementsToRetrieve
Public methodGetAllConstraintsToDropForUpdate
Gets all constraints of type typeOfElementsToRetrieve from this catalog which affect a changed element. Used for update DDL SQL scripts to be able to drop constraints before DDL SQL statements are executed. If typeofElementsToRetrieve isn't a constraint type, an empty set is returned.
Public methodGetAllElementNames
Gets the element names of all elements contained in this catalog in DBSchemaElementNameContainer instances
Public methodGetAllElementsMarkedForDeletion
Gets all elements of type typeOfElementsToRetrieve from this catalog which are marked for deletion
Public methodGetAllFkConstraintsReferencingTable
Gets all fk constraints which reference the specified table as the pk side.
Public methodGetAllMappableTargets
Gets all mappable targets from this catalog from all its schemas.
Public methodGetAllNewElements
Gets all new elements of type typeOfElementsToRetrieve
Public methodGetAllRenamedElements
Gets all renamed elements of type typeOfElementsToRetrieve from this catalog
Public methodGetAllSchemasFilteredBySyncSource
Gets all schemas filtered by synchronize source.
Public methodGetAllUsedConstraintNames
Gets all used constraint names in all schemas in this catalog. All names are added lowercase.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetOrCreateSchemaForNewSubElement
Finds or creates the schema with the name specified. If a schema with the name specified is found, it has to accept new elements according to its sync source, otherwise a new one is created, if this catalog accepts new elements, otherwise null is returned.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleContainedListChangedTChangeType
Handles the contained list changed.
(Inherited from DBElementBase.)
Public methodLogError
Logs an error in the ErrorLog structure of this object.
(Inherited from DBElementBase.)
Public methodLogWarning
Logs the description as a warning.
(Inherited from DBElementBase.)
Protected methodMarkElementAsChangedTChangeType
Marks the element as changed.
(Inherited from DBElementBase.)
Public methodMarkElementAsRemoved
Marks the element as removed, which raises the ElementRemoved event.
(Inherited from DBElementBase.)
Public methodMarkInvalidFkAndUniqueConstraintsForDeletion
Marks the invalid fk and unique constraints for deletion. If the containing schema has its sync source set to 'database', the elements are ignored.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodObtainAndInsertFkConstraintObjectsFromMetaData
Obtains the fk constraint objects from meta data and adds them to the tables in the schemas in this catalog.
Public methodObtainAndInsertUniqueConstraintObjectsFromMetaData
Obtains the unique constraint objects from meta data and adds them to the tables in the schemas in this catalog.
Protected methodOnContainedElementAdded
Called when this object received an event of type ContainedElementAdded
(Inherited from DBElementBase.)
Protected methodOnContainedElementChanged
Called when this object received an event of type ContainedElementChanged
(Inherited from DBElementBase.)
Protected methodOnContainedElementRemoved
Called when this object received an event of type ContainedElementRemoved
(Inherited from DBElementBase.)
Protected methodOnPropertyChanged
Raises the PropertyChanged event.
(Inherited from DBElementBase.)
Protected methodPerformAdditionalContainedElementChangedWork
Performs the additional contained element changed work.
(Overrides DBElementBasePerformAdditionalContainedElementChangedWork(ContainedElementActionEventArgs).)
Public methodPerformPostDDLSQLExportActions
Performs the post DDLSQL export actions, which means that all change trackers are reset, all elements marked for deletion are removed and all elements which are marked as created by designer have their flag reset.
Public methodResetErrorLog
Resets the Error Log for this object to an empty list.
(Inherited from DBElementBase.)
Public methodRetrieveRelationshipModel
Retrieves all the relationships between all known tables in all schemas of the catalog passed in, into a graph.
Protected methodSerializeAdditionalAttributes
Serializes the additional attributes.
(Inherited from DBElementBase.)
Public methodSerializeToWriter
Serializes the data in this class to the serializer passed in
Public methodSetDateTimeOnModelSyncedSchemas
Sets the date time of last sync on model synced schemas. This is required as the last step to avoid a lot of logic inside the schemas: we know which elements are synced, so we can set the date in one swoop
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventContainedElementAdded
Raised when an element was added to a collection (indirectly) contained in this element
(Inherited from DBElementBase.)
Public eventContainedElementChanged
Raised when an element contained in this element was changed.
(Inherited from DBElementBase.)
Public eventContainedElementRemoved
Raised when an element was removed from a collection (indirectly) contained in this element
(Inherited from DBElementBase.)
Public eventHasBeenChanged
Raised when the implementing element has been changed
(Inherited from DBElementBase.)
Public eventHasBeenRemoved
Raised when the implementing element has been removed from its container
(Inherited from DBElementBase.)
Public eventPropertyChanged
Occurs when a property value changes. (INotifyPropertyChanged)
(Inherited from DBElementBase.)
Top
Explicit Interface Implementations
See Also