summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2017-08-10 22:21:11 +0200
committerGitHub <noreply@github.com>2017-08-10 22:21:11 +0200
commit660d50805b6788d592b4f1fae706b725baf0195c (patch)
tree02fa341d56dc4b89c7d16477870554bf84fe1f14 /docs
parenta146b65628e702a9a3ed5be21542ca45366fbb29 (diff)
Fixed #23766 -- Doc'd CursorWrapper.callproc().
Thanks Tim Graham for the review.
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/db/sql.txt26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/topics/db/sql.txt b/docs/topics/db/sql.txt
index b5c45844cd..94e08b8bef 100644
--- a/docs/topics/db/sql.txt
+++ b/docs/topics/db/sql.txt
@@ -346,3 +346,29 @@ is equivalent to::
c.execute(...)
finally:
c.close()
+
+Calling stored procedures
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. method:: CursorWrapper.callproc(procname, params=None)
+
+ Calls a database stored procedure with the given name and optional sequence
+ of input parameters.
+
+ For example, given this stored procedure in an Oracle database:
+
+ .. code-block:: sql
+
+ CREATE PROCEDURE "TEST_PROCEDURE"(v_i INTEGER, v_text NVARCHAR2(10)) AS
+ p_i INTEGER;
+ p_text NVARCHAR2(10);
+ BEGIN
+ p_i := v_i;
+ p_text := v_text;
+ ...
+ END;
+
+ This will call it::
+
+ with connection.cursor() as cursor:
+ cursor.callproc('test_procedure', [1, 'test'])