Cédric Krier
c4ddbb064a
Once the cache has been cleared, we must ensure that transaction started before the clearing cannot fill the global cache. issue8019 review56541002
124 lines
4.1 KiB
ReStructuredText
124 lines
4.1 KiB
ReStructuredText
.. _ref-transaction:
|
|
.. module:: trytond.transaction
|
|
|
|
===========
|
|
Transaction
|
|
===========
|
|
|
|
.. class:: Transaction
|
|
|
|
This class represents a Tryton transaction that contains thread-local
|
|
parameters of a database connection. The Transaction instances are
|
|
`context manager`_ that will commit or rollback the database transaction. In
|
|
the event of an exception the transaction is rolled back, otherwise it is
|
|
commited.
|
|
|
|
.. attribute:: Transaction.database
|
|
|
|
The database.
|
|
|
|
.. attribute:: Transaction.readonly
|
|
|
|
.. attribute:: Transaction.connection
|
|
|
|
The database connection as defined by the `PEP-0249`_.
|
|
|
|
.. attribute:: Transaction.user
|
|
|
|
The id of the user.
|
|
|
|
.. attribute:: Transaction.context
|
|
|
|
.. attribute:: Transaction.create_records
|
|
|
|
.. attribute:: Transaction.delete_records
|
|
|
|
.. attribute:: Transaction.delete
|
|
|
|
.. attribute:: Transaction.timestamp
|
|
|
|
.. attribute:: Transaction.started_at
|
|
|
|
The monotonic timestamp when the transaction started.
|
|
|
|
.. attribute:: Transaction.language
|
|
|
|
The language code defines in the context.
|
|
|
|
.. attribute:: Transaction.counter
|
|
|
|
Count the number of modification made in this transaction.
|
|
|
|
.. staticmethod:: Transaction.monotonic_time
|
|
|
|
Return a monotonic time used to populate :attr:~Transaction.started_at.
|
|
|
|
.. method:: Transaction.start(database_name, user[, readonly[, context[, close[, autocommit]]]])
|
|
|
|
Start a new transaction and return a `context manager`_. The non-readonly
|
|
transaction will be committed when exiting the `with` statement without
|
|
exception. The other cases will be rollbacked.
|
|
|
|
.. method:: Transaction.stop([commit])
|
|
|
|
Stop the transaction. If commit is True, the transaction will be committed
|
|
otherwise it will be rollbacked.
|
|
The `context manager`_ returned by :meth:`Transaction.start` should be used
|
|
instead of calling this method.
|
|
|
|
.. method:: Transaction.set_context(context, \**kwargs)
|
|
|
|
Update the transaction context and return a `context manager`_. The context
|
|
will be restored when exiting the `with` statement.
|
|
|
|
.. method:: Transaction.reset_context()
|
|
|
|
Clear the transaction context and return a `context manager`_. The context
|
|
will be restored when exiting the `with` statement.
|
|
|
|
.. method:: Transaction.set_user(user[, set_context])
|
|
|
|
Modify the user of the transaction and return a `context manager`_.
|
|
`set_context` will put the previous user id in the context to simulate the
|
|
record rules. The user will be restored when exiting the `with` statement.
|
|
|
|
.. method:: Transaction.set_current_transaction(transaction)
|
|
|
|
Add a specific ``transaction`` on the top of the transaction stack. A
|
|
transaction is commited or rollbacked only when its last reference is
|
|
popped from the stack.
|
|
|
|
.. method:: Transaction.new_transaction([autocommit[, readonly]])
|
|
|
|
Create a new transaction with the same database, user and context as the
|
|
original transaction and adds it to the stack of transactions.
|
|
|
|
.. method:: Transaction.commit()
|
|
|
|
Commit the transaction and all data managers associated.
|
|
|
|
.. method:: Transaction.rollback()
|
|
|
|
Rollback the transaction and all data managers associated.
|
|
|
|
.. method:: Transaction.join(datamanager)
|
|
|
|
Register in the transaction a data manager conforming to the `Two-Phase
|
|
Commit protocol`_. More information on how to implement such data manager
|
|
is available at the `Zope documentation`_.
|
|
|
|
This method returns the registered datamanager. It could be a different yet
|
|
equivalent (in term of python equality) datamanager than the one passed to the
|
|
method.
|
|
|
|
.. method:: Transaction.atexit(func, \*args, \*\*kwargs)
|
|
|
|
Register a function to be executed upon normal transaction termination.
|
|
The function can not use the current transaction because it will be already
|
|
committed or rollbacked.
|
|
|
|
.. _`context manager`: http://docs.python.org/reference/datamodel.html#context-managers
|
|
.. _`PEP-0249`: https://www.python.org/dev/peps/pep-0249/
|
|
.. _`Two-Phase Commit protocol`: https://en.wikipedia.org/wiki/Two-phase_commit_protocol
|
|
.. _`Zope documentation`: http://zodb.readthedocs.org/en/latest/transactions.html#the-two-phase-commit-protocol-in-practice
|