diff options
| author | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2010-04-23 11:41:31 +0100 |
|---|---|---|
| committer | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2010-04-23 13:28:49 +0100 |
| commit | dab098c1cb7c2d84292b51ed3aa8d9737596bd44 (patch) | |
| tree | 8e49fa8f9df6d9610c2db8c404aa3d931593977b | |
| parent | cb40342afa383176684c805789782403ee49a0a7 (diff) | |
| download | psycopg2-dab098c1cb7c2d84292b51ed3aa8d9737596bd44.tar.gz | |
Cleaned up documentation for connection status constants.
Dropped reference to unused/internal states.
| -rw-r--r-- | doc/src/extensions.rst | 19 |
1 files changed, 6 insertions, 13 deletions
diff --git a/doc/src/extensions.rst b/doc/src/extensions.rst index 552dfdc..839ed67 100644 --- a/doc/src/extensions.rst +++ b/doc/src/extensions.rst @@ -427,30 +427,23 @@ Connection status constants These values represent the possible status of a connection: the current value can be read from the `~connection.status` attribute. -.. data:: STATUS_SETUP - - Used internally. +It is possible to find the connection in other status than the one shown below. +Those are the only states in which a working connection is expected to be found +during the execution of regular Python client code: other states are for +internal usage and Python code should not rely on them. .. data:: STATUS_READY - Connection established. + Connection established. No transaction in progress. .. data:: STATUS_BEGIN - Connection established. A transaction is in progress. + Connection established. A transaction is currently in progress. .. data:: STATUS_IN_TRANSACTION An alias for `STATUS_BEGIN` -.. data:: STATUS_SYNC - - Used internally. - -.. data:: STATUS_ASYNC - - Used internally. - .. index:: |