Actions

Difference between revisions of "Using transactions in Joomla"

From Joomla! Documentation

(Start page)
 
(Add version)
Line 1: Line 1:
==Transactions==
+
{{version|3.x}}
 
{{dablink|'''IMPORTANT NOTE:''' Transactions can only be used against transaction-aware storage engine such as InnoDB. All core Joomla tables use InnoDB however 3rd party extensions may not. Check this before using transactions}}
 
{{dablink|'''IMPORTANT NOTE:''' Transactions can only be used against transaction-aware storage engine such as InnoDB. All core Joomla tables use InnoDB however 3rd party extensions may not. Check this before using transactions}}
  

Revision as of 11:30, 5 September 2013

Joomla Joomla 3.x introduced SQL transactions (where supported) via the JDatabaseDriver's transactionStart, transactionCommit and transactionRollback. This supersedes the queryBatch method which was introduced in Joomla Joomla 2.5.

$db = JFactory::getDbo();
 
try
{
    $db->transactionStart();
 
    $query = $db->getQuery(true);
 
    $values = array($db->quote('TEST_CONSTANT'), $db->quote('Custom'), $db->quote('/path/to/translation.ini'));
 
    $query->insert($db->quoteName('#__overrider'));
    $query->columns($db->quoteName(array('constant', 'string', 'file')));
    $query->values(implode(',',$values));
 
    $db->setQuery($query);
    $result = $db->execute();
 
    $db->transactionCommit();
}
catch (Exception $e)
{
    // catch any database errors.
    $db->transactionRollback();
    JErrorPage::render($e);
}

Anything between the transactionStart and transactionCommit methods are not executed until transactionCommit is called. If an exception occurs, we can roll back the changes using the transactionRollback method. This allows us to return the database to the original state if a problem occurs even though we may execute a number of changes to the database's tables.