Session.RollbackTransaction() Method

Rolls back a transaction to its starting point, and completes it.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public virtual void RollbackTransaction()

VB.NET

Public Overridable Sub RollbackTransaction

Remarks

To start a transaction, use the Session.BeginTransaction method. To discard all data modifications made since the start of the transaction and complete the transaction (set Session.InTransaction to false), call the RollbackTransaction method. To commit these modifications, call the Session.CommitTransaction or Session.CommitTransactionAsync method.

To determine if a transaction is in progress, use the Session.InTransaction property.

After the RollbackTransaction method is called, the Session.BeforeRollbackTransaction event is raised.

Important

An object’s state, modified within a transaction, is not automatically returned to its former state by the RollbackTransaction method call. In order to refresh the object’s state, use the XPBaseObject.Reload method.

Example

The following example demonstrates how to work with transactions.

In this example, the transaction begins when a persistent object is saved. The Session.BeginTransaction method marks the starting point of the transaction. If the value of the persistent object’s Amount property is negative, the Session.RollbackTransaction method is called which completes the transaction discarding all the changes made since the transaction was started.

Otherwise, if the Amount property’s value isn’t negative, the Session.CommitTransaction method is called to complete the transaction and save all the data modifications made.

C#

using System;
using DevExpress.Xpo;
using DevExpress.Xpo.DB;

namespace ConsoleApplication1 {
    class Account : XPObject {
        public const double DefaultAmount = 100;
        private double amount = DefaultAmount;
        public Account(Session session) : base(session) { }
        public double Amount {
            get { return amount; }
            set { SetPropertyValue<double>(nameof(Amount), ref amount, value); }
        }
        protected override void OnSaving() {
            base.OnSaving();
            if (!IsDeleted) {
                if (Amount < 0) {
                    throw new Exception("Negative amount!");
                }
            }
        }
    }

    class Program {
        static void Main(string[] args) {
            string connectionString = MSSqlConnectionProvider.GetConnectionString("(local)", "ConsoleApplication1");
            XpoDefault.DataLayer = XpoDefault.GetDataLayer(connectionString, AutoCreateOption.DatabaseAndSchema);
            TransferAmount(100);
            TransferAmount(200);
            Console.WriteLine("Press <Enter> to exit");
            Console.ReadLine();
        }

        static void TransferAmount(double amount) {
            using (Session session = new Session()) {
                Console.WriteLine("Creating Account1 with amount = " + Account.DefaultAmount);
                Account account1 = new Account(session);
                account1.Save();
                Console.WriteLine("Creating Account2 with amount = " + Account.DefaultAmount);
                Account account2 = new Account(session);
                account2.Save();
                Console.WriteLine("");
                Console.WriteLine("Beginning the transaction...");
                session.BeginTransaction();
                try {
                    Console.WriteLine(String.Format(" Withdrawing {0} from Account1", amount));
                    account1.Amount -= amount;
                    account1.Save();
                    Console.WriteLine(String.Format(" Transferring {0} to Account2", amount));
                    account2.Amount += amount;
                    account2.Save();
                    Console.WriteLine("Committing the transaction...");
                    session.CommitTransaction();
                }
                catch (Exception e) {
                    Console.WriteLine("Exception message: " + e.Message);
                    Console.WriteLine("Rolling back the transaction");
                    session.RollbackTransaction();
                    Console.WriteLine("Reloading the accounts from database...");
                    account1.Reload();
                    account2.Reload();
                }
                Console.WriteLine("Account1 amount: " + account1.Amount);
                Console.WriteLine("Account2 amount: " + account2.Amount);
                Console.WriteLine();
            }
        }
    }
}

VB.NET

Imports System
Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB

Namespace ConsoleApplication1
    Friend Class Account
        Inherits XPObject

        Public Const DefaultAmount As Double = 100
        Private _amount As Double = DefaultAmount
        Public Sub New(ByVal session As Session)
            MyBase.New(session)
        End Sub
        Public Property Amount() As Double
            Get
                Return _amount
            End Get
            Set(ByVal value As Double)
                SetPropertyValue(Of Double)(NameOf(Amount), _amount, value)
            End Set
        End Property
        Protected Overrides Sub OnSaving()
            MyBase.OnSaving()
            If Not IsDeleted Then
                If Amount < 0 Then
                    Throw New Exception("Negative amount!")
                End If
            End If
        End Sub
    End Class

    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            Dim connectionString As String = MSSqlConnectionProvider.GetConnectionString("(local)", "ConsoleApplication1")
            XpoDefault.DataLayer = XpoDefault.GetDataLayer(connectionString, AutoCreateOption.DatabaseAndSchema)
            TransferAmount(100)
            TransferAmount(200)
            Console.WriteLine("Press <Enter> to exit")
            Console.ReadLine()
        End Sub

        Private Shared Sub TransferAmount(ByVal amount As Double)
            Using session As New Session()
                Console.WriteLine("Creating Account1 with amount = " & Account.DefaultAmount)
                Dim account1 As New Account(session)
                account1.Save()
                Console.WriteLine("Creating Account2 with amount = " & Account.DefaultAmount)
                Dim account2 As New Account(session)
                account2.Save()
                Console.WriteLine("")
                Console.WriteLine("Beginning the transaction...")
                session.BeginTransaction()
                Try
                    Console.WriteLine(String.Format(" Withdrawing {0} from Account1", amount))
                    account1.Amount -= amount
                    account1.Save()
                    Console.WriteLine(String.Format(" Transferring {0} to Account2", amount))
                    account2.Amount += amount
                    account2.Save()
                    Console.WriteLine("Committing the transaction...")
                    session.CommitTransaction()
                Catch e As Exception
                    Console.WriteLine("Exception message: " & e.Message)
                    Console.WriteLine("Rolling back the transaction")
                    session.RollbackTransaction()
                    Console.WriteLine("Reloading the accounts from database...")
                    account1.Reload()
                    account2.Reload()
                End Try
                Console.WriteLine("Account1 amount: " & account1.Amount)
                Console.WriteLine("Account2 amount: " & account2.Amount)
                Console.WriteLine()
            End Using
        End Sub
    End Class
End Namespace