Click or drag to resize

DBTable Class

Class which contains a database table's meta data.
Inheritance Hierarchy

Namespace:  SD.LLBLGen.Pro.DBDriverCore
Assembly:  SD.LLBLGen.Pro.DBDriverCore (in SD.LLBLGen.Pro.DBDriverCore.dll) Version: 5.6.0.0 (5.6.19.0117)
Syntax
public class DBTable : DBSchemaElement, ISerializableToXml, 
	IProjectElementMapTargetElement, IDBRenameableElement

The DBTable type exposes the following members.

Constructors
  NameDescription
Public methodDBTable
Initializes a new instance of the DBTable class.
Public methodDBTable(DBSchema)
Initializes a new instance of the DBTable class.
Public methodDBTable(DBSchema, DBElementName)
Initializes a new instance of the DBTable class.
Public methodDBTable(DBSchema, String)
CTor
Top
Properties
  NameDescription
Public propertyContainingSchema
Gets or sets the parent schema.
(Inherited from DBSchemaElement.)
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 propertyFields
Gets the fields.
Public propertyForeignKeyConstraints
Gets the foreign key constraints.
Public propertyFullName
Gets the full name.
(Overrides DBElementBaseFullName.)
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 DBSchemaElement.)
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 DBSchemaElement.)
Public propertyFullNameWithCatalog
Gets the full name including the catalog name
(Inherited from DBSchemaElement.)
Public propertyMarkedForDeletion
Gets or sets a value indicating whether this element is marked for deletion.
(Inherited from DBElementBase.)
Public propertyName
Gets or sets the name of the table.
(Overrides DBSchemaElementName.)
Public propertyOriginalPkConstraintName
Gets the original name of the pk constraint.
Public propertyPkConstraintName
Gets the name of the pk constraint.
Public propertyPrimaryKeyFields
Gets the primary key fields.
Protected propertyTypeOfDBElement
Gets the type of DB element in the form of a ContainedElementType value.
(Overrides DBElementBaseTypeOfDBElement.)
Public propertyUniqueConstraints
Gets the unique constraints.
Public propertyUsedDriverID
Gets the used driver ID of the catalog this element is in.
(Inherited from DBSchemaElement.)
Top
Methods
  NameDescription
Public methodContainsAnyElementOfType
Determines whether this element directly or indirectly contains at least 1 element of the type specified.
Public methodCreateNewField(DBDriverBase, Int32, String, Int32, Int32, Int32, Boolean)
Creates a new field based on the elements specified. It assumes there are no fields with the name specified already in this target. The field is added at the end of the fields list.
Public methodCreateNewField(DBDriverBase, String, Type, Int32, Int32, Int32, Boolean, Boolean, Int32, LogNode)
Creates a new field based on the elements specified. It assumes there are no fields with the name specified already in this target. The field is added at the end of the fields list.
Public methodCreateNewFkConstraintIfNecessary
Creates a new fk constraint if necessary. Flags all fk constraints which are already formed by the Fk fields as deleted first.
Public methodCreateNewUcConstraintIfNecessary
Creates a new uc constraint if necessary on the fields specified. If there's already an existing UC however it's marked as deleted, it's unmarked as deleted.
Protected methodDeserializeAdditionalAttributes
Deserializes attributes of this element's base class from the reader.
(Inherited from DBElementBase.)
Public methodDeserializeFromReader
Deserializes from reader. Reader is positioned at the Table 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.
(Inherited from DBSchemaElement.)
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 methodFindFieldByName(String)
Finds the field with the name specified.
Public methodFindFieldByName(String, Boolean)
Finds the field with the name specified.
Public methodFindFKConstraintByName
Finds the fk constraint with the name specified.
Public methodFindFKConstraintsByFieldSets
Gets the foreign key constraints between the field sets given, or if pkFields isn't specified, defined on the fkFields specified
Public methodFindFKConstraintsByFkFields
Finds the FK constraints defined on the fk fields specified.
Public methodFindUCConstraintByName
Finds the uc constraint with the name specified.
Public methodFindUCConstraintsByFieldSet
Finds the UC constraints defined by the fields specified.
Public methodGetAllFkConstraintsReferencingThisTable
Gets all fk constraints referencing this table.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
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. Override if additional work has to be done after the OnContainedElementChanged method has run.
(Inherited from DBElementBase.)
Public methodRemoveDuplicateUniqueConstraints
Removes all the unique constraints which are duplicates of other unique constraints in the list.
Public methodResetErrorLog
Resets the Error Log for this object to an empty list.
(Inherited from DBElementBase.)
Protected methodSerializeAdditionalAttributes
Serializes the additional attributes.
(Inherited from DBElementBase.)
Public methodSerializeToWriter
Serializes the data in this class to the serializer passed in
Public methodSetDefaultValuesOnFields
Sets the default values on fields.
Public methodSetPkConstraintNameIfNecessary
Sets the pk constraint name if necessary to the name specified, after it's been made unique
Public methodSetPkFields
Sets the pk fields.
Public methodToString
Returns a String that represents the current Object.
(Inherited from DBSchemaElement.)
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
  NameDescription
Explicit interface implementationPrivate propertyIDBRenameableElementIsRenamed
Gets a value indicating whether this instance is renamed to a new value.
Explicit interface implementationPrivate propertyIDBRenameableElementNewName
Gets the new name, if the element was renamed, otherwise the original name
Explicit interface implementationPrivate propertyIDBRenameableElementOriginalName
Gets the original name of the element.
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementContainingSchema
Gets or sets the parent schema.
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementCustomProperties
Gets the Custom properties (name - value pairs) read from the schema.
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementDriverID
Gets the driver ID of the database the target is associated with.
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementElementType
Type of the element.
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementFields
IList with all the fields of this target. The list contains elements sorted on ordinal position. Ordinal positions should start at 1.
Explicit interface implementationPrivate methodIProjectElementMapTargetElementFindFieldByName(String)
Helper method which will return a reference to a IProjectElementFieldMapTargetElement instance with the given FieldName
Explicit interface implementationPrivate methodIProjectElementMapTargetElementFindFieldByName(String, Boolean)
Finds the field with the name specified.
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementForeignKeyConstraints
Enumerable with all foreign key constraints of this target, empty otherwise
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementFullName
Gets the full name.
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementFullNameForXml
Gets the full name for XML. This is a name which has the format schemaname:elementname or schemaname:elementname:fieldname. Used for references.
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementFullNameWithCatalog
Gets the full name including the catalog name
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementName
Literal name of the object
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementPrimaryKeyFields
Enumerable with all primary key fields
Explicit interface implementationPrivate propertyIProjectElementMapTargetElementUniqueConstraints
Enumerable with all the unique constraints of this target, empty otherwise
Top
See Also