Add transaction logging option to python api documentation.

This commit is contained in:
Balachandar Namasivayam 2019-12-09 18:36:29 -08:00
parent d94a1dfef2
commit 416c5578b7
2 changed files with 16 additions and 0 deletions

View File

@ -441,6 +441,14 @@
Sets the maximum escaped length of key and value fields to be logged to the trace file via the LOG_TRANSACTION option, after which the field will be truncated. A negative value disables truncation. One can set the default max field length for all transactions by calling |transaction-logging-max-field-length-database-option|.
.. |option-set--debug-transaction-identifier| replace::
Sets a client provided identifier for the transaction that will be used in scenarios like tracing or profiling. Client trace logging or transaction profiling must be separately enabled.
.. |option-set-log-transaction| replace::
Enables tracing for this transaction and logs results to the client trace logs. The DEBUG_TRANSACTION_IDENTIFIER option must be set before using this option, and client trace logging must be enabled and to get log output.
.. |future-blurb1| replace::
Many FoundationDB API functions return "future" objects. A brief overview of futures is included in the :doc:`class scheduling tutorial <class-scheduling>`. Most future objects behave just like a normal object, but block when you use them for the first time if the asynchronous function which returned the future has not yet completed its action. A future object is considered ready when either a value is available, or when an error has occurred.

View File

@ -881,6 +881,14 @@ Transaction options
|option-set-transaction-logging-max-field-length-blurb|
.. method:: Transaction.options.set_debug_transaction_identifier(identifier)
|option-set--debug-transaction-identifier|
.. method:: Transaction.options.set_log_transaction()
|option-set-log-transaction|
.. _api-python-future:
Future objects