CMSConnectionScope Class

Allows changing command timeout for a code block. Also allows specifying a connection that is used for executing all ConnectionHelper calls that are passed the query text directly within a code block.

Inheritance Hierarchy

System.Object
  CMS.Base.DisposableObject
    CMS.Helpers.Trackable<CMSConnectionScope>
      CMS.DataEngine.CMSConnectionScope

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

Syntax

public class CMSConnectionScope : Trackable<CMSConnectionScope>, 
	INotCopyThreadItem

The CMSConnectionScope type exposes the following members.

Constructors

	Name	Description
Public method	CMSConnectionScope(Boolean)	Empty constructor. Creates a new connection and ensures that all database connections during the live of this object will use that connection.
Public method	CMSConnectionScope(IDataConnection)	Constructor. Ensures that all database connections during the live of this object will use the given connection.
Public method	CMSConnectionScope(Boolean, Boolean)	Obsolete. Empty constructor. Creates a new connection and ensures that all database connections during the live of this object will use that connection.
Public method	CMSConnectionScope(String, Boolean)	Constructor. Ensures that all database connections during the live of this object will use the given connection.
Public method	CMSConnectionScope(IDataConnection, Boolean)	Obsolete. Constructor. Ensures that all database connections during the live of this object will use the given connection.
Public method	CMSConnectionScope(String, Boolean, Boolean)	Obsolete. Constructor. Ensures that all database connections during the live of this object will use the given connection.

Properties

	Name	Description
Public property	CommandTimeout	Command timeout which will be set on the connection within the current connection scope.
Public property	Connection	Connection of the current scope.
Public property	ConnectionString	Connection string name that the thread should use to access the database
Public property	DisableConnectionDebug	If true, the debug is disabled on this connection
Public property	DisableDebug	If true, the debug of queries is disabled on this connection
Public property	DisableQueryDebug	If true, the debug of queries is disabled on this connection

Methods

	Name	Description
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from DisposableObject.)
Public method	Close	Closes the connection.
Public method	Dispose	Disposes the object. (Overrides DisposableObject.Dispose().)
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from DisposableObject.)
Public method	Open	Opens the connection.
Public method	ResetConnection	Resets the connection to recover from error.
Public method	Using	Adds the given object to the list of the allocated objects to dispose (Inherited from DisposableObject.)

Remarks

To set the connection scope for the whole API (e.g. DataQuery), use the CMSConnectionContext class.