Click or drag to resize

SchemaInfoCollection Class

Contains a collection of SchemaInfo column description objects loaded from an IDataReader object. Generally you obtain a SchemaInfoCollection from GetSchemaInfo(String, SchemaInfoType).
Inheritance Hierarchy
SystemObject
  NetQuarry.DataSchemaInfoCollection

Namespace:  NetQuarry.Data
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
[SerializableAttribute]
public class SchemaInfoCollection : IEnumerable<KeyValuePair<string, SchemaInfo>>, 
	IEnumerable

The SchemaInfoCollection type exposes the following members.

Constructors
  NameDescription
Public methodSchemaInfoCollection
Default constructor. Should be used only when the corresponding object does not exist in the schema.
Public methodSchemaInfoCollection(IDataReader) Obsolete.
Initializes a new instance of the object based on the schema provided in the DataReader. This overload is intended for use with tables and views. Use SchemaInfoCollection(IDataParameterCollection, DBMSType) for stored procedures. Note that this constructor is deprecated and use of SchemaInfoCollection(IDataParameterCollection, DBMSType) is preferred because it does not assume the provider is SQLServer.
Public methodSchemaInfoCollection(IDataParameterCollection, DBMSType)
Initializes a new instance of the object based on the schema provided in the parameters collection. This overload is intended for use with stored procedures. Use SchemaInfoCollection(IDataReader, DBMSType) for tables and views.
Public methodSchemaInfoCollection(IDataReader, DBMSType)
Initializes a new instance of the object based on the schema provided in the DataReader. This overload is intended for use with tables and views. Use SchemaInfoCollection(IDataParameterCollection, DBMSType) for stored procedures.
Top
Properties
  NameDescription
Public propertyCount
Gets the number of columns in the collection. Zero columns typically indicates that the object does not exist in the schema, but it is recommended to use ObjectExists to make that determination.
Public propertyDBMSType
Gets the DBMSType (e.g. SQL-Server), or zero if not known.
Public propertyItem
Indexer for the collection returning a SchemaInfo object.
Public propertyObjectExists
Gets whether or not the object exists in the schema.
Top
Methods
  NameDescription
Public methodStatic memberClearSchemaCache(String) Obsolete.
Clears a schema cache object. This method is deprecated in favor of ClearSchemaCache(IAppContext, String) in order to prevent the possibility of cross-application clearing.
Public methodStatic memberClearSchemaCache(IAppContext, String)
Clears a schema cache object.
Public methodColumnSize
Returns the size of the specified column. If the column is unknown then -1 is returned.
Public methodStatic memberCreateInstance(IDataReader, String) Obsolete.
Creates and returns an instance of the collection from the global cache. If the object doesn't exist in the cache it is added. This method is deprecated in favor of CreateInstance(IAppContext, IDataReader, String, DBMSType) in order to prevent the possibility of cross-application caching.
Public methodStatic memberCreateInstance(IDataReader, String, DBMSType) Obsolete.
Creates and returns an instance of the collection from the global cache. If the object doesn't exist in the cache it is added. This method is deprecated in favor of CreateInstance(IAppContext, IDataReader, String, DBMSType) in order to prevent the possibility of cross-application caching.
Public methodStatic memberCreateInstance(IAppContext, IDataReader, String, DBMSType)
Creates and returns an instance of the collection from the global cache. If the object doesn't exist in the cache it is added.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsAutoIncrement
Returns true if the specified column is an AutoIncrement (Identity) column. If the column is unknown then false is returned.
Public methodIsNullable
Returns true if the specified column is nullable. If the column is unknown then false is returned.
Public methodLoadFromParameters
Load the schema information from the provided command parameters.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUpdateViewBaseTableNames
Updates the base table names when the object is a view. Works for SQL Server only.
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also