1 out of 2 rated this helpful - Rate this topic

IDbTransaction Interface

Represents a transaction to be performed at a data source, and is implemented by .NET Framework data providers that access relational databases.

Namespace:  System.Data
Assembly:  System.Data (in System.Data.dll)
public interface IDbTransaction : IDisposable

The IDbTransaction type exposes the following members.

  Name Description
Public property Supported by the XNA Framework Connection Specifies the Connection object to associate with the transaction.
Public property Supported by the XNA Framework IsolationLevel Specifies the IsolationLevel for this transaction.
Top
  Name Description
Public method Supported by the XNA Framework Commit Commits the database transaction.
Public method Supported by the XNA Framework Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method Supported by the XNA Framework Rollback Rolls back a transaction from a pending state.
Top

The IDbTransaction interface allows an inheriting class to implement a Transaction class, which represents the transaction to be performed at a data source. For more information about Transaction classes, see Transactions and Concurrency (ADO.NET).

An application does not create an instance of the IDbTransaction interface directly, but creates an instance of a class that inherits IDbTransaction.

Classes that inherit IDbTransaction must implement the inherited members, and typically define additional members to add provider-specific functionality. For example, the IDbTransaction interface defines the Commit method. In turn, the OleDbTransaction class inherits this property, and also defines the Begin method.

Notes to Implementers

To promote consistency among .NET Framework data providers, name the inheriting class in the form Prv Transaction where Prv is the uniform prefix given to all classes in a specific .NET Framework data provider namespace. For example, Sql is the prefix of the SqlTransaction class in the System.Data.SqlClient namespace.

The following example creates instances of the derived classes, SqlConnection and SqlTransaction. It also demonstrates how to use the BeginTransaction, Commit, and Rollback methods.


private static void ExecuteSqlTransaction(string connectionString)
{
    using (SqlConnection connection = new SqlConnection(connectionString))
    {
        connection.Open();

        SqlCommand command = connection.CreateCommand();
        SqlTransaction transaction;

        // Start a local transaction.
        transaction = connection.BeginTransaction("SampleTransaction");

        // Must assign both transaction object and connection
        // to Command object for a pending local transaction
        command.Connection = connection;
        command.Transaction = transaction;

        try
        {
            command.CommandText =
                "Insert into Region (RegionID, RegionDescription) VALUES (100, 'Description')";
            command.ExecuteNonQuery();
            command.CommandText =
                "Insert into Region (RegionID, RegionDescription) VALUES (101, 'Description')";
            command.ExecuteNonQuery();

            // Attempt to commit the transaction.
            transaction.Commit();
            Console.WriteLine("Both records are written to database.");
        }
        catch (Exception ex)
        {
            Console.WriteLine("Commit Exception Type: {0}", ex.GetType());
            Console.WriteLine("  Message: {0}", ex.Message);

            // Attempt to roll back the transaction.
            try
            {
                transaction.Rollback();
            }
            catch (Exception ex2)
            {
                // This catch block will handle any errors that may have occurred
                // on the server that would cause the rollback to fail, such as
                // a closed connection.
                Console.WriteLine("Rollback Exception Type: {0}", ex2.GetType());
                Console.WriteLine("  Message: {0}", ex2.Message);
            }
        }
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
The role of IDbTransaction.Dispose
This interface derives from IDisposable, but the documentation doesn't mention what role the dispose behavior is supposed to play for transaction classes that implement this interface.  This should be specified so that both implementers and consumers are in agreement as to what the behavior is.

In particular, there are the following scenarios:
  1. IDbTransaction.Dispose is called when neither IDbTransaction.Commit nor IDbTransaction.Rollback have been called.
  2. IDbTransaction.Dispose is called after IDbTransaction.Commit has been called.
  3. IDbTransaction.Dispose is called after IDbTransaction.Rollback has been called.

For scenario #1, I believe the typical behavior is for the Dispose method to cause the transaction to roll back.  For scenarios #2 and #3, I believe the typical behavior is for the Dispose method to do nothing (or perhaps release some resources if necessary, but not to attempt to cause either a commit or a rollback, since that has already occurred).  If this behavior as described is the intended behavior of the IDbTransaction.Dispose method, then it should be specified.  Conversely, if this behavior as described is not necessarily intended by the IDbTransaction interface, then this documentation should specify that the IDbTransaction.Dispose method does not make any guarantee as to whether the transaction will be committed or rolled back, only that the resources held by the transaction will be released.