GeneralConnection Class

Represents a general database connection.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.GeneralConnection

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23

Syntax

[SerializableAttribute]
public class GeneralConnection : ISerializable, 
	IDataConnection, IDisposable

The GeneralConnection type exposes the following members.

Constructors

	Name	Description
Protected method	GeneralConnection(String)	Constructor.
Public method	GeneralConnection(SerializationInfo, StreamingContext)	Constructor for deserialization.

Methods

	Name	Description
Public method	BulkInsert	Performs a bulk insert of the data into a target database table
Public method	Close	Closes the connection.
Public method	Dispose	Disposes the connection
Public method	ExecuteNonQuery(QueryParameters)	Runs the query.
Public method	ExecuteNonQuery(String, QueryDataParameters, QueryMacros)	Obsolete. Executes query and returns the number of affected rows.
Public method	ExecuteNonQuery(String, QueryDataParameters, QueryTypeEnum, Boolean)	Obsolete. Runs the query.
Public method	ExecuteQuery(QueryParameters)	Executes query and returns result as a dataset.
Public method	ExecuteQuery(QueryParameters, Int32)	Executes query and returns result as a DataSet. Returns the total number of result items.
Public method	ExecuteQuery(String, QueryDataParameters, QueryMacros)	Obsolete. Executes query and returns result as a dataset.
Public method	ExecuteQuery(QueryInfo, QueryDataParameters, QueryMacros)	Obsolete. Executes query and returns result as a dataset.
Public method	ExecuteQuery(String, QueryDataParameters, QueryTypeEnum, Boolean)	Obsolete. Runs the query.
Public method	ExecuteQuery(String, QueryDataParameters, QueryMacros, Int32, Int32, Int32)	Obsolete. Executes query and returns result as a dataset.
Public method	ExecuteReader(QueryParameters, CommandBehavior)	Runs the query and returns result as Data reader. Keeps the connection open.
Public method	ExecuteReader(String, QueryDataParameters, QueryMacros, CommandBehavior)	Obsolete. Executes query and returns result as a data reader. Keeps the connection open.
Public method	ExecuteReader(String, QueryDataParameters, QueryTypeEnum, CommandBehavior)	Obsolete. Runs the query and returns result as Data reader. Keeps the connection open.
Public method	ExecuteReader(QueryInfo, QueryDataParameters, QueryMacros, CommandBehavior)	Obsolete. Executes query and returns result as a data reader. Keeps the connection open.
Public method	ExecuteScalar(QueryParameters)	Runs the query and returns result as a single value.
Public method	ExecuteScalar(String, QueryDataParameters, QueryMacros)	Obsolete. Executes query and returns result as a a single value.
Public method	ExecuteScalar(String, QueryDataParameters, QueryTypeEnum, Boolean)	Obsolete. Runs the query.
Public method	GetExecutingConnection	Gets the connection that executes the given query
Public method	GetObjectData	Gets object data.
Public method	IsOpen	Returns true if the connection is open.
Public method	LogQueryEnd	Logs the end of the query processing.
Public method	LogQueryStart	Logs query start. Logs the query to the file and to current request log for debugging.
Public method	Open	Opens the connection.
Protected method	RunQuery	Runs the query against SQL DB.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mConnectionGuid	Connection GUID to identify the connection.
Protected field	mDataConnection	Data connection for specific provider.

Properties

	Name	Description
Public property	AdvancedSettings	Advanced settings.
Public property	CacheDependency	Cache dependency for the cached items.
Public property	CacheMinutes	Cache minutes for which the selected data should be cached (only for SELECT queries).
Public property	CommandTimeout	Command timeout.
Public property	ConnectionGuid	Connection GUID to identify the connection.
Public property	ConnectionString	Connection string for specific provider.
Public property	DataConnection	Data connection for specific provider.
Public property	DisableConnectionDebug	If true, the debug is disabled on this connection
Public property	DisableQueryDebug	If true, the debug of the executed queries is disabled on this connection
Public property	FireErrorOnExecute	If true, an error if fired on execution (for debug purposes).
Public property	KeepOpen	If true, the connection stays open even if close is requested.
Public property	UserID	ID of the current user.
Public property	UseScopeConnection	If true, the connection uses the scope connection