0 out of 4 rated this helpful Rate this topic

TransactionScope Class

Makes a code block transactional. This class cannot be inherited.

System.Object
  System.Transactions.TransactionScope

Namespace:  System.Transactions
Assembly:  System.Transactions (in System.Transactions.dll)
public sealed class TransactionScope : IDisposable

The TransactionScope type exposes the following members.

  Name Description
Public method TransactionScope Initializes a new instance of the TransactionScope class.
Public method TransactionScope(Transaction) Initializes a new instance of the TransactionScope class and sets the specified transaction as the ambient transaction, so that transactional work done inside the scope uses this transaction.
Public method TransactionScope(TransactionScopeOption) Initializes a new instance of the TransactionScope class with the specified requirements.
Public method TransactionScope(Transaction, TimeSpan) Initializes a new instance of the TransactionScope class with the specified timeout value, and sets the specified transaction as the ambient transaction, so that transactional work done inside the scope uses this transaction.
Public method TransactionScope(TransactionScopeOption, TimeSpan) Initializes a new instance of the TransactionScope class with the specified timeout value and requirements.
Public method TransactionScope(TransactionScopeOption, TransactionOptions) Initializes a new instance of the TransactionScope class with the specified requirements.
Public method TransactionScope(Transaction, TimeSpan, EnterpriseServicesInteropOption) Initializes a new instance of the TransactionScope class with the specified timeout value and COM+ interoperability requirements, and sets the specified transaction as the ambient transaction, so that transactional work done inside the scope uses this transaction.
Public method TransactionScope(TransactionScopeOption, TransactionOptions, EnterpriseServicesInteropOption) Initializes a new instance of the TransactionScope class with the specified scope and COM+ interoperability requirements, and transaction options.
Top
  Name Description
Public method Complete Indicates that all operations within the scope are completed successfully.
Public method Dispose Ends the transaction scope.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

The System.Transactions infrastructure provides both an explicit programming model based on the Transaction class, as well as an implicit programming model using the TransactionScope class, in which transactions are automatically managed by the infrastructure.

Important note Important

It is recommended that you create implicit transactions using the TransactionScope class, so that the ambient transaction context is automatically managed for you. You should also use the TransactionScope and DependentTransaction class for applications that require the use of the same transaction across multiple function calls or multiple thread calls. For more information on this model, see the Implementing An Implicit Transaction Using Transaction Scope topic. For more information on writing a transactional application, see Writing A Transactional Application.

Upon instantiating a TransactionScope by the new statement, the transaction manager determines which transaction to participate in. Once determined, the scope always participates in that transaction. The decision is based on two factors: whether an ambient transaction is present and the value of the TransactionScopeOption parameter in the constructor. The ambient transaction is the transaction your code executes in. You can obtain a reference to the ambient transaction by calling the static Current property of the Transaction class. For more information on how this parameter is used, please see the "Transaction Flow Management" section of the Implementing An Implicit Transaction Using Transaction Scope topic.

If no exception occurs within the transaction scope (that is, between the initialization of the TransactionScope object and the calling of its Dispose method), then the transaction in which the scope participates is allowed to proceed. If an exception does occur within the transaction scope, the transaction in which it participates will be rolled back.

When your application completes all work it wants to perform in a transaction, you should call the Complete method only once to inform that transaction manager that it is acceptable to commit the transaction. Failing to call this method aborts the transaction.

A call to the Dispose method marks the end of the transaction scope. Exceptions that occur after calling this method may not affect the transaction.

If you modify the value of Current inside a scope, an exception is thrown when Dispose is called. However, at the end of the scope, the previous value is restored. In addition, if you call Dispose on Current inside a transaction scope that created the transaction, the transaction aborts at the end of the scope.

The following example demonstrates how to use the TransactionScope class to define a block of code to participate in a transaction.


// This function takes arguments for 2 connection strings and commands to create a transaction 
// involving two SQL Servers. It returns a value > 0 if the transaction is committed, 0 if the 
// transaction is rolled back. To test this code, you can connect to two different databases 
// on the same server by altering the connection string, or to another 3rd party RDBMS by 
// altering the code in the connection2 code block.
static public int CreateTransactionScope(
    string connectString1, string connectString2,
    string commandText1, string commandText2)
{
    // Initialize the return value to zero and create a StringWriter to display results.
    int returnValue = 0;
    System.IO.StringWriter writer = new System.IO.StringWriter();

    try
    {
        // Create the TransactionScope to execute the commands, guaranteeing
        // that both commands can commit or roll back as a single unit of work.
        using (TransactionScope scope = new TransactionScope())
        {
            using (SqlConnection connection1 = new SqlConnection(connectString1))
            {
                // Opening the connection automatically enlists it in the 
                // TransactionScope as a lightweight transaction.
                connection1.Open();

                // Create the SqlCommand object and execute the first command.
                SqlCommand command1 = new SqlCommand(commandText1, connection1);
                returnValue = command1.ExecuteNonQuery();
                writer.WriteLine("Rows to be affected by command1: {0}", returnValue);

                // If you get here, this means that command1 succeeded. By nesting
                // the using block for connection2 inside that of connection1, you
                // conserve server and network resources as connection2 is opened
                // only when there is a chance that the transaction can commit.   
                using (SqlConnection connection2 = new SqlConnection(connectString2))
                {
                    // The transaction is escalated to a full distributed
                    // transaction when connection2 is opened.
                    connection2.Open();

                    // Execute the second command in the second database.
                    returnValue = 0;
                    SqlCommand command2 = new SqlCommand(commandText2, connection2);
                    returnValue = command2.ExecuteNonQuery();
                    writer.WriteLine("Rows to be affected by command2: {0}", returnValue);
                }
            }

            // The Complete method commits the transaction. If an exception has been thrown,
            // Complete is not  called and the transaction is rolled back.
            scope.Complete();

        }

    }
    catch (TransactionAbortedException ex)
    {
        writer.WriteLine("TransactionAbortedException Message: {0}", ex.Message);
    }
    catch (ApplicationException ex)
    {
        writer.WriteLine("ApplicationException Message: {0}", ex.Message);
    }

    // Display messages.
    Console.WriteLine(writer.ToString());

    return returnValue;
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

This type is thread safe.

Did you find this helpful?
(2000 characters remaining)
Community Content Add
Annotations FAQ
TransactionScope Default Isolation Level
@Michael Teper - the default IsolationLevel for the TransactionScope is Serializeable and the documentation link is : http://msdn.microsoft.com/en-us/library/ms172152(v=vs.90).aspx please find it under "Setting the TransactionScope isolation level"
Enter title here.Incomplete Article
Please read Triynko article on stackoverflow before using TransactionScope.
Good stuff at StackOverflow
http://stackoverflow.com/questions/2884863/under-what-circumstances-is-an-sqlconnection-automatically-enlisted-in-an-ambient/2886326

...about TransactionScope and what is not said on this page.
Unmentioned Rules and Behaviors of TransactionScope
There are rules and interactions that occur with using this class that are not explained AT ALL here.

There is no mention of how using this class interacts with the existing SqlTransaction class or how it behaves when a transaction was started on the server side, or how nested transaction scopes interact with existing scopes (for example... enlisting the connection in a nested scope with the RequiresNew option will throw an error, while enlisting in one with the Required option will not throw an error, but will also not increase the @@trancount as might be expected.  Meanwhile, starting a new transaction scope first, then calling BeginTransaction on the connection will not throw an error and will increase @@trancount, but if you hadn't started a transaction scope, and then called BeginTransaction, and then attempted to enlist in a new transaction scope, you will get a similar, but slightly different error about a local transaction being present (whereas when trying to start a new transaction scope transaction where there already will say there was an active transaction already, but will not use the word "local").  So basically, there are two different, but similar, error message thrown depending on whether a transaction scope transaction is already active on the connection or a SqlTransaction was started on the connection by calling BeginTransaction when you attempt to activate a new transaction scope.

There is little talk about the automatic enlistment process that occurs when a connection is opened inside a connection scope, and no talk about the need to call EnlistTransaction on an existing connection opened outside the transaction scope.

There is no mention of the escalation to a distributed transaction that occurs when more than one connection is opened, nor is there talk about the hacked out DbConnectionScope that someone on MSDN created to work around that issue, nor is there talk about this may have been fixed (transparently) in SQL Server 2008, so that two connections with the same connection string are not escalated to a distributed transaction, despite that the local Transaction object still initializes a GUID for its TransactionInformation.DistributedIdentifier property.33

For a comprehensive post on all of this stuff, see my post at StackOverflow:  http://stackoverflow.com/questions/2884863/under-what-circumstances-is-an-sqlconnection-automatically-enlisted-in-an-ambient
What is the default isolation level?
I believe the default isolation level used by the TransactionScope is Serializeable, but I can't find this documented. Please clarify.
"scope.complete" out of scope (C#)
For the C# example, the "scope.complete();" statement seemed to be out of scope (no pun intended).  When I copied the example into a C# project it gave me a scope error.  I resolved by looking at the VB example and then moving the curley bracket for the "using (TransactionScope scope = new TransactionScope())" statement after the "scope.complete" statement.