Click or drag to resize

DBSchemaRetriever Class

Base class for Schema related meta data retrieval.
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 abstract class DBSchemaRetriever : DBElementBase

The DBSchemaRetriever type exposes the following members.

Constructors
  NameDescription
Protected methodDBSchemaRetriever
CTor
Top
Properties
  NameDescription
Public propertyBatchSize
Gets the size of the batch into which the work is divided. This number should be lower than the maximum number of parameters a driver could take. The default implementation returns 100
Protected propertyCatalogRetriever
Gets the catalog retriever to use.
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 propertyDefaultSequence
Gets or sets the default sequence.
Protected propertyDeserializing
Gets or sets a value indicating whether this instance is deserializing.
(Inherited from DBElementBase.)
Protected propertyDriverToUse
Gets the driver to use.
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 propertyMarkedForDeletion
Gets or sets a value indicating whether this element is marked for deletion.
(Inherited from DBElementBase.)
Public propertySubTaskProgressInitHandler
The handler of the SubTaskProgressInitCallBack to initialize the subtask progress cycle. Parameter is the number of subtasks
Public propertySubTaskProgressTaskCompletedHandler
The handler of the SubTaskProgressTaskCompletedCallBack to log the completion of a subtask.
Public propertySubTaskProgressTaskStartHandler
The handler of the SubTaskProgressTaskStartCallBack to log the start of a subtask. Parameter is the description to show.
Protected propertyTypeOfDBElement
Gets the type of DB element in the form of a ContainedElementType value.
(Overrides DBElementBaseTypeOfDBElement.)
Top
Methods
  NameDescription
Protected methodDeserializeAdditionalAttributes
Deserializes attributes of this element's base class from the reader.
(Inherited from DBElementBase.)
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.)
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetTableValuedFunctionCallPattern
Gets the table valued function call pattern. This pattern is used for creating the call to the Table valued function. The pattern has to have two placeholders, {0} for the function name and {1} for the parameters location.
Protected methodGetTvfResultsetSchemaDbTypeColumnName
Gets the name of the TVF resultset schema db type column.
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 methodResetErrorLog
Resets the Error Log for this object to an empty list.
(Inherited from DBElementBase.)
Public methodRetrieveSchema
Retrieves the schema meta data and the element meta-data of the elements which names are specified in the nameContainer specified, from the catalog which is specified.
Protected methodRetrieveSequences
Retrieves the sequences for the schema specified.
Protected methodRetrieveStoredProcedureAndParameterMetaData
Retrieves the stored procedure- and parameter meta data for the stored procedures which names are in the passed in elementNames and which are in the schema specified.
Protected methodRetrieveStoredProcedureResultsetMetaData
Retrieves the stored procedure resultset meta data for all stored procedures in schemaToFill which names are present in elementNames.
Protected methodRetrieveSynonymAndFieldMetaData
Retrieves the synonym- and field meta data for the synonyms (tables/views) which names are in the passed in elementNames and which are in the schema specified.
Protected methodRetrieveTableAndFieldMetaData
Retrieves the table- and field meta data for the tables which names are in the passed in elementNames and which are in the schema specified.
Protected methodRetrieveTableValuedFunctionAndParameterMetaData
Retrieves the table valued function- and parameter meta data for the table valued functions which names are in the passed in elementNames and which are in the schema specified.
Protected methodRetrieveTableValuedFunctionsResultsetMetaData
Retrieves the stored procedure resultset meta data for all stored procedures in schemaToFill which names are present in elementNames.
Protected methodRetrieveViewAndFieldMetaData
Retrieves the view- and field meta data for the views which names are in the passed in elementNames and which are in the schema specified.
Protected methodSerializeAdditionalAttributes
Serializes the additional attributes.
(Inherited from DBElementBase.)
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
See Also