Class CMSConnectionScope

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

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.

public class CMSConnectionScope : Trackable<CMSConnectionScope>, INotCopyThreadItem

Inheritance

object

DisposableObject

Trackable<CMSConnectionScope>

CMSConnectionScope

Implements

INotCopyThreadItem

Inherited Members

Trackable<CMSConnectionScope>.TypeName

Trackable<CMSConnectionScope>.Track

Trackable<CMSConnectionScope>.TrackAllOpen(string)

DisposableObject.CallOnDispose(Action)

DisposableObject.Using(IDisposable)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Remarks

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

Constructors

CMSConnectionScope(IDataConnection)

Constructor. Ensures that all database connections during the live of this object will use the given connection.

public CMSConnectionScope(IDataConnection conn)

Parameters

conn IDataConnection

Connection to use within all database operations. If null new connection is created

CMSConnectionScope(bool)

Empty constructor. Creates a new connection and ensures that all database connections during the live of this object will use that connection.

public CMSConnectionScope(bool newConnection = false)

Parameters

newConnection bool

If true, creates a new connection

CMSConnectionScope(string, bool)

Constructor. Ensures that all database connections during the live of this object will use the given connection.

public CMSConnectionScope(string connectionString, bool defaultIfNotFound = false)

Parameters

connectionString string

Connection string to use within all underlying database operations. If null new connection is created

defaultIfNotFound bool

If true, the default connection string is used if the given connection string is not found

Properties

CommandTimeout

Command timeout which will be set on the connection within the current connection scope.

public int CommandTimeout { set; }

Property Value

int

Connection

Connection of the current scope.

public IDataConnection Connection { get; }

Property Value

IDataConnection

ConnectionString

Connection string name that the thread should use to access the database

public string ConnectionString { get; protected set; }

Property Value

string

Methods

Close()

Closes the connection.

public void Close()

Dispose()

Disposes the object.

public override void Dispose()

Open()

Opens the connection.

public CMSConnectionScope Open()

Returns

CMSConnectionScope

ResetConnection()

Resets the connection to recover from error.

public void ResetConnection()