DBTable Class

Class which contains a database table's meta data.

Inheritance Hierarchy

SystemObject
  SD.LLBLGen.Pro.DBDriverCoreDBElementBase
    SD.LLBLGen.Pro.DBDriverCoreDBSchemaElement
      SD.LLBLGen.Pro.DBDriverCoreDBTable

Namespace: SD.LLBLGen.Pro.DBDriverCore
Assembly: SD.LLBLGen.Pro.DBDriverCore (in SD.LLBLGen.Pro.DBDriverCore.dll) Version: 5.10.0.0 (5.10.0)

Syntax

Copy

public class DBTable : DBSchemaElement, ISerializableToXml, 
	IProjectElementMapTargetElement, IDBRenameableElement

Public Class DBTable
	Inherits DBSchemaElement
	Implements ISerializableToXml, IProjectElementMapTargetElement, IDBRenameableElement

The DBTable type exposes the following members.

Constructors

	Name	Description
	DBTable	Initializes a new instance of the DBTable class.
	DBTable(DBSchema)	Initializes a new instance of the DBTable class.
	DBTable(DBSchema, DBElementName)	Initializes a new instance of the DBTable class.
	DBTable(DBSchema, String)	CTor

Top

Properties

	Name	Description
	ContainingSchema	Gets or sets the parent schema. (Inherited from DBSchemaElement.)
	CreatedByDesigner	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.)
	CustomProperties	Gets the Custom properties (name - value pairs) read from the schema. (Inherited from DBElementBase.)
	Deserializing	Gets or sets a value indicating whether this instance is deserializing. (Inherited from DBElementBase.)
	ErrorLog	Gets the complete ErrorLog for this object. (Inherited from DBElementBase.)
	Fields	Gets the fields.
	ForeignKeyConstraints	Gets the foreign key constraints.
	FullName	Gets the full name. (Overrides DBElementBaseFullName.)
	FullNameForXml	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.)
	FullNameForXmlWithCatalog	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.)
	FullNameWithCatalog	Gets the full name including the catalog name (Inherited from DBSchemaElement.)
	IsTemporalTable	True if the table contains a field which has IsTemporalPeriodStart set to true and a field which has IsTemporalPeriodEnd set to true
	MarkedForDeletion	Gets or sets a value indicating whether this element is marked for deletion. (Inherited from DBElementBase.)
	Name	Gets or sets the name of the table. (Overrides DBSchemaElementName.)
	OriginalPkConstraintName	Gets the original name of the pk constraint.
	PkConstraintName	Gets the name of the pk constraint.
	PrimaryKeyFields	Gets the primary key fields.
	TypeOfDBElement	Gets the type of DB element in the form of a ContainedElementType value. (Overrides DBElementBaseTypeOfDBElement.)
	UniqueConstraints	Gets the unique constraints.
	UsedDriverID	Gets the used driver ID of the catalog this element is in. (Inherited from DBSchemaElement.)

Top

Methods

	Name	Description
	ContainsAnyElementOfType	Determines whether this element directly or indirectly contains at least 1 element of the type specified.
	CreateNewField(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.
	CreateNewField(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.
	CreateNewFkConstraintIfNecessary	Creates a new fk constraint if necessary. Flags all fk constraints which are already formed by the Fk fields as deleted first.
	CreateNewUcConstraintIfNecessary	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.
	DeserializeAdditionalAttributes	Deserializes attributes of this element's base class from the reader. (Inherited from DBElementBase.)
	DeserializeFromReader	Deserializes from reader. Reader is positioned at the Table element
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DBElementBase.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Exclude	Excludes this instance from the project / meta-container it's in. (Inherited from DBSchemaElement.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindFieldByName(String)	Finds the field with the name specified.
	FindFieldByName(String, Boolean)	Finds the field with the name specified.
	FindFKConstraintByName	Finds the fk constraint with the name specified.
	FindFKConstraintsByFieldSets	Gets the foreign key constraints between the field sets given, or if pkFields isn't specified, defined on the fkFields specified
	FindFKConstraintsByFkFields	Finds the FK constraints defined on the fk fields specified.
	FindUCConstraintByName	Finds the uc constraint with the name specified.
	FindUCConstraintsByFieldSet	Finds the UC constraints defined by the fields specified.
	GetAllFkConstraintsReferencingThisTable	Gets all fk constraints referencing this table.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HandleContainedListChangedTChangeType	Handles the contained list changed. (Inherited from DBElementBase.)
	LogError	Logs an error in the ErrorLog structure of this object. (Inherited from DBElementBase.)
	LogWarning	Logs the description as a warning. (Inherited from DBElementBase.)
	MarkElementAsChangedTChangeType	Marks the element as changed. (Inherited from DBElementBase.)
	MarkElementAsRemoved	Marks the element as removed, which raises the ElementRemoved event. (Inherited from DBElementBase.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnContainedElementAdded	Called when this object received an event of type ContainedElementAdded (Inherited from DBElementBase.)
	OnContainedElementChanged	Called when this object received an event of type ContainedElementChanged (Inherited from DBElementBase.)
	OnContainedElementRemoved	Called when this object received an event of type ContainedElementRemoved (Inherited from DBElementBase.)
	OnPropertyChanged	Raises the PropertyChanged event. (Inherited from DBElementBase.)
	PerformAdditionalContainedElementChangedWork	Performs the additional contained element changed work. Override if additional work has to be done after the OnContainedElementChanged method has run. (Inherited from DBElementBase.)
	RemoveDuplicateUniqueConstraints	Removes all the unique constraints which are duplicates of other unique constraints in the list.
	ResetErrorLog	Resets the Error Log for this object to an empty list. (Inherited from DBElementBase.)
	SerializeAdditionalAttributes	Serializes the additional attributes. (Inherited from DBElementBase.)
	SerializeToWriter	Serializes the data in this class to the serializer passed in
	SetDefaultValuesOnFields	Sets the default values on fields.
	SetPkConstraintNameIfNecessary	Sets the pk constraint name if necessary to the name specified, after it's been made unique
	SetPkFields	Sets the pk fields.
	ToString	Returns a String that represents the current Object. (Inherited from DBSchemaElement.)

Top

Events

	Name	Description
	ContainedElementAdded	Raised when an element was added to a collection (indirectly) contained in this element (Inherited from DBElementBase.)
	ContainedElementChanged	Raised when an element contained in this element was changed. (Inherited from DBElementBase.)
	ContainedElementRemoved	Raised when an element was removed from a collection (indirectly) contained in this element (Inherited from DBElementBase.)
	HasBeenChanged	Raised when the implementing element has been changed (Inherited from DBElementBase.)
	HasBeenRemoved	Raised when the implementing element has been removed from its container (Inherited from DBElementBase.)
	PropertyChanged	Occurs when a property value changes. (INotifyPropertyChanged) (Inherited from DBElementBase.)

Top

Explicit Interface Implementations

	Name	Description
	IDBRenameableElementIsRenamed	Gets a value indicating whether this instance is renamed to a new value.
	IDBRenameableElementNewName	Gets the new name, if the element was renamed, otherwise the original name
	IDBRenameableElementOriginalName	Gets the original name of the element.
	IProjectElementMapTargetElementContainingSchema	Gets or sets the parent schema.
	IProjectElementMapTargetElementCustomProperties	Gets the Custom properties (name - value pairs) read from the schema.
	IProjectElementMapTargetElementDriverID	Gets the driver ID of the database the target is associated with.
	IProjectElementMapTargetElementElementType	Type of the element.
	IProjectElementMapTargetElementFields	IList with all the fields of this target. The list contains elements sorted on ordinal position. Ordinal positions should start at 1.
	IProjectElementMapTargetElementFindFieldByName(String)	Helper method which will return a reference to a IProjectElementFieldMapTargetElement instance with the given FieldName
	IProjectElementMapTargetElementFindFieldByName(String, Boolean)	Finds the field with the name specified.
	IProjectElementMapTargetElementForeignKeyConstraints	Enumerable with all foreign key constraints of this target, empty otherwise
	IProjectElementMapTargetElementFullName	Gets the full name.
	IProjectElementMapTargetElementFullNameForXml	Gets the full name for XML. This is a name which has the format schemaname:elementname or schemaname:elementname:fieldname. Used for references.
	IProjectElementMapTargetElementFullNameWithCatalog	Gets the full name including the catalog name
	IProjectElementMapTargetElementName	Literal name of the object
	IProjectElementMapTargetElementPrimaryKeyFields	Enumerable with all primary key fields
	IProjectElementMapTargetElementUniqueConstraints	Enumerable with all the unique constraints of this target, empty otherwise

Top

Reference

SD.LLBLGen.Pro.DBDriverCore Namespace