DataConnection Class

Represents SQL Server data connection.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractDataConnection
    CMS.DataProviderSQL.DataConnection

Namespace: CMS.DataProviderSQL
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131

Syntax

public class DataConnection : AbstractDataConnection

The DataConnection type exposes the following members.

Constructors

	Name	Description
Protected method	DataConnection	Constructor.

Fields

	Name	Description
Protected field	mCommandTimeout	Command timeout. (Inherited from AbstractDataConnection.)
Protected field	mConnectionString	Connection string for specific provider. (Inherited from AbstractDataConnection.)
Protected field	mConnectionStringName	Connection string name (Inherited from AbstractDataConnection.)
Protected field	mLastError	Last connection error (Inherited from AbstractDataConnection.)
Protected field	mNativeConnection	Native connection object. It depends on provider type. (Inherited from AbstractDataConnection.)
Protected field	mNestedConnections	Nested connections indexed by the connection string [connectionString -> IDbConnection] (Inherited from AbstractDataConnection.)
Protected field	mNestedConnectionsList	List of nested connections (Inherited from AbstractDataConnection.)
Protected field	mNestedOpenConnections	List of nested connections that were automatically opened (Inherited from AbstractDataConnection.)
Protected field	mNestedOpenTransactions	List of nested connections that were automatically opened with transaction (Inherited from AbstractDataConnection.)
Protected field	mUseScopeConnection	If true, the connection uses the scope connection (Inherited from AbstractDataConnection.)

Properties

	Name	Description
Public property	CommandTimeout	Command timeout. (Inherited from AbstractDataConnection.)
Public property	ConnectionString	Connection string for specific provider. (Inherited from AbstractDataConnection.)
Public property	DisableConnectionDebug	If true, the debug is disabled on this connection (Inherited from AbstractDataConnection.)
Public property	DisableQueryDebug	If true, the debug of queries is disabled on this connection (Inherited from AbstractDataConnection.)
Public property	KeepOpen	If true, the connection stays open even if close is requested. (Inherited from AbstractDataConnection.)
Protected property	LocalKeepOpen	If true, the connection stays open even if close is requested. (Inherited from AbstractDataConnection.)
Protected property	LocalTransaction	Transaction object of local instance. (Inherited from AbstractDataConnection.)
Public property	NativeConnection	Native connection object. It depends on provider type. (Inherited from AbstractDataConnection.)
Protected property	NativeDBConnection	Native connection object. It depends on provider type. (Inherited from AbstractDataConnection.)
Public property	Transaction	Transaction object. (Inherited from AbstractDataConnection.)
Public property	UseScopeConnection	If true, the connection uses the scope connection (Inherited from AbstractDataConnection.)

Methods

	Name	Description
Protected method	AddParameters	Adds the given parameters to the SQL command (Inherited from AbstractDataConnection.)
Public method	BeginTransaction()	Begins a new transaction. (Inherited from AbstractDataConnection.)
Public method	BeginTransaction(IsolationLevel)	Begins a new transaction. (Inherited from AbstractDataConnection.)
Public method	BulkInsert	Performs a bulk insert of the data into a target database table (Overrides AbstractDataConnection.BulkInsert(DataTable, String, BulkInsertSettings).)
Protected method	CheckThreadSafety	Checks the thread safety of current operation. (Inherited from AbstractDataConnection.)
Public method	Close	Closes connection to the database. (Inherited from AbstractDataConnection.)
Public method	CommitTransaction	Commits current transaction. (Inherited from AbstractDataConnection.)
Protected method	CreateCommand	Creates a new SQL command (Overrides AbstractDataConnection.CreateCommand(String).)
Protected method	CreateDataAdapter	Creates a data adapter (Overrides AbstractDataConnection.CreateDataAdapter().)
Protected method	CreateNativeConnection	Creates a new native connection (Overrides AbstractDataConnection.CreateNativeConnection().)
Protected method	CreateParameter(DataParameter)	Creates a SQL parameter from the given data parameter (Inherited from AbstractDataConnection.)
Protected method	CreateParameter(String, Object)	Creates a new command parameter (Overrides AbstractDataConnection.CreateParameter(String, Object).)
Public method	Dispose	Disposes the connection object. (Inherited from AbstractDataConnection.)
Public method	ExecuteNonQuery	Executes the query and returns the number of rows affected. (Inherited from AbstractDataConnection.)
Public method	ExecuteNonQueryAsync	An asynchronous version of ExecuteNonQuery(String, QueryDataParameters, QueryTypeEnum, Boolean) which executes the query asynchronously and returns the number of rows affected. The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object. (Inherited from AbstractDataConnection.)
Public method	ExecuteQuery	Returns result of the query. (Inherited from AbstractDataConnection.)
Public method	ExecuteReader	Executes the query and returns result of the query as a DbDataReader. (Inherited from AbstractDataConnection.)
Public method	ExecuteReaderAsync	An asynchronous version of ExecuteReader(String, QueryDataParameters, QueryTypeEnum, CommandBehavior) which executes the query asynchronously and returns result as a DbDataReader. The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object. (Inherited from AbstractDataConnection.)
Public method	ExecuteScalar	Executes the query and returns the first column of the first row in the result set returned by the query. Additional columns or rows are ignored. (Inherited from AbstractDataConnection.)
Public method	ExecuteScalarAsync	An asynchronous version of ExecuteScalar(String, QueryDataParameters, QueryTypeEnum, Boolean), which executes the query asynchronously and returns the first column of the first row in the result set returned by the query. Additional columns or rows are ignored. The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object. (Inherited from AbstractDataConnection.)
Public method	GetExecutingConnection	Gets the connection that executes the given query (Inherited from AbstractDataConnection.)
Public method	GetNestedConnection	Gets the nested connection with the given connection string (Inherited from AbstractDataConnection.)
Public method	GetXmlSchema	Returns XML schema for specified table. (Inherited from AbstractDataConnection.)
Protected method	HandleDbError	Handles the database error. Returns false, if the error was not handled (Overrides AbstractDataConnection.HandleDbError(String, DbException).)
Protected method	HandleError	Handles the error. Returns false, if the error was not handled (Inherited from AbstractDataConnection.)
Public method	IsOpen	Returns true if connection to the database is open. (Inherited from AbstractDataConnection.)
Public method	IsTransaction	Indicates if transaction is running. (Inherited from AbstractDataConnection.)
Protected method	LoadDefaultConnectionString	Loads the default connection string (Inherited from AbstractDataConnection.)
Public method	LogConnectionOperation	Logs the connection operation to the query log. (Inherited from AbstractDataConnection.)
Public method	NativeConnectionExists	Returns true if the native connection exists. (Inherited from AbstractDataConnection.)
Public method	NativeDBConnectionExists	Returns true if the native connection exists. (Inherited from AbstractDataConnection.)
Public method	Open	Opens connection to the database. (Inherited from AbstractDataConnection.)
Protected method	PrepareCommand	Prepares the SQL command for the query. (Inherited from AbstractDataConnection.)
Protected method	ProcessOutParameters	Ensures propagation of output (or input-output or stored procedure return value) parameters after the SQL command execution to the query parameters collection. (Overrides AbstractDataConnection.ProcessOutParameters(DbParameterCollection, IEnumerable<DataParameter>).)
Public method	RollbackTransaction	Rollbacks current transaction. (Inherited from AbstractDataConnection.)
Protected method	SetParameterType	Sets the parameter type to a destination type (Inherited from AbstractDataConnection.)
Protected method	ValidateTransaction	Validates the transaction (Inherited from AbstractDataConnection.)