Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document TTransactional for developers #8048

Merged
merged 1 commit into from
Feb 21, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions developer_manual/basics/storage/database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,47 @@ Database operations can be run in a transaction to commit or roll back a group o

.. warning:: Omitting the error handling for transactions will lead to unexpected behavior as any database operations that come after your error will still run in your transaction and due to the lack of a commit PDO will automatically roll-back all changes at the end of the script.

In the context of a class you can use the ``TTransactional`` trait and move the unit of work into a closure.

.. code-block:: php

<?php

use OCP\AppFramework\Db\TTransactional;
use OCP\IDBConnection;

class MyService() {

use TTransactional;

private IDBConnection $db;

public function __construct(IDBConnection $db) {
$this->db = $db;
}

public function doSomeWork(): void {
$this->atomic(function () {
// $this->db->...
// $this->db->...
// $this->db->...
}, $this->db);
}

/**
* It's also possible to get a result out of the closure
*/
public function doSomeWorkWithResults(): int {
return $this->atomic(function () {
// $this->db->...
// $this->db->...
// $this->db->...

return 1;
}, $this->db);
}
}

Mappers
-------

Expand Down