ConnectionHelper Class

Connection helper class.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.ConnectionHelper

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

Syntax

public static class ConnectionHelper

The ConnectionHelper type exposes the following members.

Fields

	Name	Description
Public field Static member	DEFAULT_CONNECTIONSTRING_NAME	Default connection string name
Public field Static member	DefaultCommandTimeout	Command timeout for the SQL commands.
Public field Static member	LongRunningCommandTimeout	Command timeout in seconds for the SQL queries which are known to possibly take more time than standard command timeout. Long running queries have to be explicitly wrapped with CMSConnectionScope with its CommandTimeout property set to this value.
Public field Static member	TransactionIsolationLevel	Isolation level for SQL operations with transactions.

Properties

	Name	Description
Public property Static member	ConnectionAvailable	Returns true if the connection is available.
Public property Static member	ConnectionString	Global connection string.
Public property Static member	ConnectionStringName	Global connection string name
Public property Static member	ConnectionStringPrefix	Global connection string prefix
Public property Static member	IsConnectionStringInitialized	Indicates whether connection string is initialized or not.

Methods

	Name	Description
Public method Static member	BuildConnectionString	Builds a connection string based on specified parameters.
Public method Static member	BulkInsert	Performs a bulk insert of the data into a target database table
Public method Static member	Clear	Clears the connection helper cache
Public method Static member	ExecuteNonQuery(String, QueryDataParameters, QueryMacros)	Executes the query and returns the number of rows affected.
Public method Static member	ExecuteNonQuery(String, QueryDataParameters, QueryTypeEnum, Boolean)	Executes the query and returns the number of rows affected.
Public method Static member	ExecuteNonQueryAsync(String, CancellationToken, QueryDataParameters, QueryMacros)	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.
Public method Static member	ExecuteNonQueryAsync(String, QueryDataParameters, QueryTypeEnum, CancellationToken, Boolean)	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.
Public method Static member	ExecuteQuery(QueryParameters)	Executes query and returns result as a dataset.
Public method Static member	ExecuteQuery(String, QueryDataParameters, QueryTypeEnum, Boolean)	Runs the query.
Public method Static member	ExecuteQuery(String, QueryDataParameters, String, String, Int32, String)	Executes query and returns result as a dataset.
Public method Static member	ExecuteQuery(String, QueryDataParameters, String, String, Int32, String, Int32, Int32, Int32)	Executes query and returns result as a dataset.
Public method Static member	ExecuteReader	Executes the query and returns result of the query as a DbDataReader.
Public method Static member	ExecuteReaderAsync	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.
Public method Static member	ExecuteScalar(String, QueryDataParameters, QueryMacros)	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.
Public method Static member	ExecuteScalar(String, QueryDataParameters, QueryTypeEnum, Boolean)	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.
Public method Static member	ExecuteScalarAsync(String, CancellationToken, QueryDataParameters, QueryMacros)	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.
Public method Static member	ExecuteScalarAsync(String, QueryDataParameters, QueryTypeEnum, CancellationToken, Boolean)	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.
Public method Static member	GetConnection	Returns the connection.
Public method Static member	GetConnectionByName	Returns the connection.
Public method Static member	GetConnectionString(String)	Gets the connection string of provided connectionStringName.
Public method Static member	GetConnectionString(String, Boolean)	Gets the connection string of provided connectionStringName.
Public method Static member	GetConnectionStringPrefix	Gets the connection string name for the given domain
Public method Static member	GetFirstFoundConnectionString	Gets the first found connection string by the prefix, if none found, returns null
Public method Static member	GetIsolationLevel	Returns the isolation level evaluated from the string representation.
Public method Static member	GetSqlConnectionString()	Returns the connection string.
Public method Static member	GetSqlConnectionString(String)	Returns the connection string.
Public method Static member	InitRequestContext	Initializes the request context to use proper database based on current domain name
Public method Static member	TestConnection(String)	Tests the given connection parameters.
Public method Static member	TestConnection(SQLServerAuthenticationModeEnum, String, String, String, String)	Tests the given connection parameters.