CMSConnectionScope Class

Connection scope. Ensures that all queries within given context use the same database connection.

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: 8.2.23

Syntax

public class CMSConnectionScope : Trackable<CMSConnectionScope>, 
	INotCopyThreadItem

The CMSConnectionScope type exposes the following members.

Constructors

	Name	Description
Public method	CMSConnectionScope(Boolean, 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, Boolean)	Constructor. Ensures that all database connections during the live of this object will use the given connection.
Public method	CMSConnectionScope(String, Boolean, Boolean)	Constructor. Ensures that all database connections during the live of this object will use the given 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.)

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.)

Properties

	Name	Description
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

Remarks

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