diff options
Diffstat (limited to 'doc/source/usage.rst')
-rw-r--r-- | doc/source/usage.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 11c8c2a..cc4f2fd 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -76,6 +76,12 @@ positional argument: results = some_reader_api_function(context) some_writer_api_function(context, 5, 10) +.. note:: The ``context.session`` and ``context.connection`` attributes + must be accessed within the scope of an appropriate writer/reader block + (either the decorator or contextmanager approach). An AttributeError is + raised otherwise. + + The scope of transaction and connectivity for both approaches is managed transparently. The configuration for the connection comes from the standard :obj:`oslo_config.cfg.CONF` collection. Additional configurations can be |