HackBase/python-cx_Oracle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Correct documentation now that variables bound to DML returning statements

Browse Source 
always return an array.
This commit is contained in:
Anthony Tuininga 2018-09-10 15:27:52 -06:00
parent bc69e784f8
commit f647d738a5
1 changed files with 6 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/src/variable.rst
View File

@ -28,15 +28,9 @@ Variable Objects
Return the value at the given position in the variable. For variables Return the value at the given position in the variable. For variables
created using the method :func:`Cursor.arrayvar()` the value returned will created using the method :func:`Cursor.arrayvar()` the value returned will
be a list of each of the values in the PL/SQL index-by table. For variables be a list of each of the values in the PL/SQL index-by table. For variables
bound to DML returning statements where the attribute bound to DML returning statements, the value returned will also be a list
`cx_Oracle.__future__.dml_ret_array_val` is set to the value True, the corresponding to the returned data for the given execution of the statement
value returned will also be a list corresponding to the returned data for (as identified by the pos parameter).
the given execution of the statement (as identified by the pos parameter).
For variables bound to DML returning statements and the attribute
`cx_Oracle.__future__.dml_ret_array_val` is not set or is set to the value
False, the value returned depends on the number of rows returned by the
first execution of the statement. If pos is a valid index into that array
then the value at that index will be returned; otherwise, None is returned.
.. attribute:: Variable.inconverter .. attribute:: Variable.inconverter
@ -84,11 +78,7 @@ Variable Objects
.. attribute:: Variable.values .. attribute:: Variable.values
This read-only attribute returns a copy of the value of all actual This read-only attribute returns a copy of the value of all actual
positions in the variable as a list. For variables bound to DML returning positions in the variable as a list. This is the equivalent of calling
statements where the attribute `cx_Oracle.__future__.dml_ret_array_val` is :meth:`~Variable.getvalue()` for each valid position and the length will
not set or set to the value False, this will be the returned data for the correspond to the value of the :attr:`~Variable.actualElements` attribute.
first execution of the statement. In all other cases the elements returned
will be the equivalent of calling :meth:`~Variable.getvalue()` for each
valid position and the length will correspond to the value of the
:attr:`~Variable.actualElements` attribute.