Laravel DB::transaction() return value

Question

It's my first time to use DB::transaction() but how exactly does it work if a transaction fails or is successful? In the example below, do I have to manually assign a value to return true, or if it fails will the method either return false or totally exit the transaction (therefore skipping the rest of the code)? The docs aren't so helpful on this.

use Exception;
use DB;

try {
    $success = DB::transaction(function() {
        // Run some queries
    });

    print_r($success);

} catch(Exception $e) {
    echo 'Uh oh.';
}

ilpaijin · Accepted Answer · 2013-11-24 15:22:51Z

15

By giving a look at function transaction it does its process inside a try/catch block

public function transaction(Closure $callback)
{
    $this->beginTransaction();

    // We'll simply execute the given callback within a try / catch block
    // and if we catch any exception we can rollback the transaction
    // so that none of the changes are persisted to the database.
    try
    {
        $result = $callback($this);

        $this->commit();
    }

    // If we catch an exception, we will roll back so nothing gets messed
    // up in the database. Then we'll re-throw the exception so it can
    // be handled how the developer sees fit for their applications.
    catch (\Exception $e)
    {
        $this->rollBack();

        throw $e;
    }

So throws an Exception (after the rollback) if fails or returns $result, which is the result of your callback

answered Nov 24, 2013 at 15:22

ilpaijin

3,7152 gold badges25 silver badges26 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

enchance Over a year ago

Is there a way to simulate a failed transaction?

ilpaijin Over a year ago

meaning u want to catch catch(Exception $e) { echo 'Uh oh.'; } ?

enchance Over a year ago

Sorry, no need. I momentarily forgot about throw.

Mehedi Hassan · Accepted Answer · 2021-10-10 15:59:13Z

5

There is a short version if you want to use the default transaction method that ships with Laravel without handling it manually.

$result = DB::transaction(function () { 
    // logic here
    return $somethingYouWantToCheckLater;
});

answered Oct 10, 2021 at 15:59

Mehedi Hassan

3964 silver badges10 bronze badges

Comments

LeRoy · Accepted Answer · 2016-05-24 21:27:37Z

0

You can also use the following

DB::rollback();

answered May 24, 2016 at 21:27

LeRoy

4,5562 gold badges40 silver badges48 bronze badges

Comments

halfer · Accepted Answer · 2023-09-16 10:29:00Z

0

(Posted on behalf of the question author, to move the solution to the answer space).

Since I was more concerned about returning a boolean value depending on the success of my query, with a few modifications it now returns true/false depending on its success:

use Exception;
use DB;

try {
  $exception = DB::transaction(function() {
    // Run queries here
  });

  return is_null($exception) ? true : $exception;

} catch(Exception $e) {
    return false;
}

Take note that the variable $exception is never returned since if something goes wrong with your query, the catch is immediately triggered returning false. Thanks to @ilaijin for showing that an Exception object is thrown if something goes wrong.

answered Sep 16, 2023 at 10:29

community wiki

halfer

Collectives™ on Stack Overflow

Laravel DB::transaction() return value

4 Answers 4

3 Comments

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

3 Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related