diff options
author | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2016-12-26 04:57:07 +0100 |
---|---|---|
committer | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2016-12-26 04:57:07 +0100 |
commit | e9577e9b890fd9a27bb146e8ea1c24eb562f28b2 (patch) | |
tree | 5c5681e11b06d5cfb528219aaee05fe59b1b7ef4 /doc/src | |
parent | c46b6ea719b8a1cd97ed0161de6b6e31e0319d2b (diff) | |
parent | ffeb7001ebfaab34613ce604a509dfa1de193b80 (diff) | |
download | psycopg2-e9577e9b890fd9a27bb146e8ea1c24eb562f28b2.tar.gz |
Merge branch 'named-callproc'
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/cursor.rst | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/src/cursor.rst b/doc/src/cursor.rst index 45e6278..aee6b46 100644 --- a/doc/src/cursor.rst +++ b/doc/src/cursor.rst @@ -201,13 +201,19 @@ The ``cursor`` class Call a stored database procedure with the given name. The sequence of parameters must contain one entry for each argument that the procedure - expects. The result of the call is returned as modified copy of the - input sequence. Input parameters are left untouched, output and - input/output parameters replaced with possibly new values. - - The procedure may also provide a result set as output. This must then - be made available through the standard |fetch*|_ methods. + expects. Overloaded procedures are supported. Named parameters can be + used by supplying the parameters as a dictionary. + + This function is, at present, not DBAPI-compliant. The return value is + supposed to consist of the sequence of parameters with modified output + and input/output parameters. In future versions, the DBAPI-compliant + return value may be implemented, but for now the function returns None. + + The procedure may provide a result set as output. This is then made + available through the standard |fetch*|_ methods. + .. versionchanged:: 2.7 + added support for named arguments. .. method:: mogrify(operation [, parameters]) |