Begins an automatic database transaction creating an instance of an IAdgTransaction object with the name and options specified.
[C#] public IAdgTransaction BeginAutoTransaction( string Name, string Options );
[Visual Basic] Public Function BeginAutoTransaction( _ ByVal Name As String _ ByVal Options As String _ ) As IAdgTransaction
[Visual RPG] BegFunc BeginAutoTransaction Access(*Public) Type(IAdgTransaction) DclSrParm Name Type(*String) DclSrParm Options Type(*String)
- Name
- An arbitrary string naming the transaction.
- Options
- A string containing database provider platform-dependent command options for initiating the transaction. Otherwise, the empty string or a null reference.
IAdgTransaction. An automatic transaction object associated with the database connection.
ASNA.DataGate.Common.dgException is thrown to signal normal procedural conditions, in addition to error conditions. The following table summarizes these conditions, and the corresponding value of the dgException.Error property.
|
Value of
dgException.Error |
Condition |
|---|---|
|
dgEsAS400ERROR |
The database server encountered a system error. Details are available via the SystemError and Text fields of dgException. For IBM i database providers, further details are available in the job log corresponding to the database connection. |
This method begins an automatic transaction for those database providers that support transaction processing. The returned IAdgTransaction object representing the transaction is associated with the database connection of AdgConnection. This version of BeginAutoTransaction produces a transaction where the TransactionLevel property of the returned IAdgTransaction object has the value TransactionLevel.Medium.
An automatic transaction (as initiated by BeginAutoTransaction) is distinguished from a manual transaction (as initiated by the BeginTransaction methods) by the behaviors of the IAdgTransaction.Commit method and IAdgTransaction.Rollback methods. Commit and Rollback result in the acceptance and cancellation, respectively, of accumulated database modifications within the current transaction's boundaries. In an automatic transaction, these methods also result in the end of the current transaction followed by the immediate creation of a new transaction under the control of IAdgTransaction. Thus, the behavior of an automatic transaction is similar to the behavior of an IBM i database transaction for all database provider platforms.
Automatic transactions can be used when an application expects the behavior of IAdgTransaction to be uniform regardless of the transaction-enabled database provider in use. However, note that at the time of this writing, only the IBM i database provider is transaction-enabled. For future multi-platform compatibility, use of automatic transactions is recommended. For the finest level of control over each transaction, use of manual transactions is recommended (see BeginTransaction).
Name may be used by the database provider to identify transaction resources. Name initializes the Name property of the IAdgTransaction object returned. Specifying the empty string or a null reference for Name results in an anonymous transaction.
Options specifies command options for initiating the new IAdgTransaction object specific to the database provider. For example, transactions on IBM i database providers are initiated via the "STRCMTCTL" CL command, with the "LCKLVL", "TEXT", and "CMTSCOPE(*JOB)" parameters. Other parameters not specified by DCS, such as "NFYOBJ" and "DFTJRN", may be specified via Options (e.g. "NFYOBJ(MYLIB/MYOBJ *MSGQ) DFTJRN(MYLIB/MYJRN)" ). If other command options are not required, specify the empty string or null reference for Options. Note that non-empty string values for Options may defeat the multi-platform compatibility provided by automatic transactions. In an automatic transaction, the value of Options is used for each new transaction created by Commit and Rollback.
Namespace: ASNA.DataGate.Client
Assembly: ASNA DataGate Client
Platforms: Windows Server 2008 R2, Windows Server 2012, Windows 7, Windows 8 Pro, Windows 8.1 Pro