Package com.ziclix.python.sql
Class PyCursor
java.lang.Object
org.python.core.PyObject
com.ziclix.python.sql.PyCursor
- All Implemented Interfaces:
WarningListener
,Serializable
,ClassDictInit
,ContextManager
,Traverseproc
- Direct Known Subclasses:
PyExtendedCursor
public class PyCursor
extends PyObject
implements ClassDictInit, WarningListener, ContextManager, Traverseproc
These objects represent a database cursor, which is used to manage the
context of a fetch operation.
- Author:
- brian zimmer
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.python.core.PyObject
PyObject.ConversionException
-
Field Summary
Fields inherited from class org.python.core.PyObject
gcMonitorGlobal, TYPE
-
Method Summary
Modifier and TypeMethodDescriptionvoid
__del__()
Delete the cursor.__enter__
(ThreadState ts) boolean
boolean
__exit__
(ThreadState ts, PyException exception) __findattr_ex__
(String name) Gets the value of the attribute name.__iter__()
Returns an iteratable object.Return the next element of the sequence that this is an iterator for.void
__setattr__
(String name, PyObject value) Sets the attribute name to value.void
This method is optional since not all databases provide stored procedures.static void
classDictInit
(PyObject dict) Initializes the object's namespace.void
close()
Close the cursor now (rather than whenever __del__ is called).void
Prepare and execute a database operation (query or command).void
executemany
(PyObject sql, PyObject params, PyObject bindings, PyObject maxRows) Prepare a database operation (query or command) and then execute it against all parameter sequences or mappings found in the sequence seq_of_parameters.fetchall()
Fetch all (remaining) rows of a query result, returning them as a sequence of sequences (e.g. a list of tuples).fetchmany
(int size) Fetch the next set of rows of a query result, returning a sequence of sequences (e.g. a list of tuples).fetchone()
Fetch the next row of a query result set, returning a single sequence, or None when no more data is available.Return the currently bound DataHandler.static boolean
Method hasParamsstatic boolean
Method isSeqstatic boolean
Method isSeqSeqnext()
Returns the next row from the currently executing SQL statement using the same semantics as .fetchone().nextset()
Move the result pointer to the next set if available.Prepare a sql statement for later execution.boolean
Optional operation.void
Scroll the cursor in the result set to a new position according to mode.toString()
String representation of the object.int
Traverses all directly containedPyObject
s.void
warning
(WarningEvent event) Adds a warning to the tuple and will follow the chain as necessary.Methods inherited from class org.python.core.PyObject
__abs__, __add__, __and__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __cmp__, __coerce__, __coerce_ex__, __complex__, __contains__, __delattr__, __delattr__, __delete__, __delitem__, __delitem__, __delslice__, __delslice__, __dir__, __div__, __divmod__, __ensure_finalizer__, __eq__, __findattr__, __findattr__, __finditem__, __finditem__, __finditem__, __float__, __floordiv__, __format__, __ge__, __get__, __getattr__, __getattr__, __getitem__, __getitem__, __getnewargs__, __getslice__, __getslice__, __gt__, __hash__, __hex__, __iadd__, __iand__, __idiv__, __idivmod__, __ifloordiv__, __ilshift__, __imod__, __imul__, __index__, __int__, __invert__, __ior__, __ipow__, __irshift__, __isub__, __itruediv__, __ixor__, __le__, __len__, __long__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __nonzero__, __not__, __oct__, __or__, __pos__, __pow__, __pow__, __radd__, __rand__, __rdiv__, __rdivmod__, __reduce__, __reduce_ex__, __reduce_ex__, __repr__, __rfloordiv__, __rlshift__, __rmod__, __rmul__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __set__, __setattr__, __setitem__, __setitem__, __setitem__, __setslice__, __setslice__, __str__, __sub__, __tojava__, __truediv__, __trunc__, __unicode__, __xor__, _add, _and, _callextra, _cmp, _div, _divmod, _doget, _doget, _doset, _eq, _floordiv, _ge, _gt, _iadd, _iand, _idiv, _idivmod, _ifloordiv, _ilshift, _imod, _imul, _in, _ior, _ipow, _irshift, _is, _isnot, _isub, _itruediv, _ixor, _jcall, _jcallexc, _jthrow, _le, _lshift, _lt, _mod, _mul, _ne, _notin, _or, _pow, _rshift, _sub, _truediv, _xor, asDouble, asIndex, asIndex, asInt, asInt, asIterable, asLong, asLong, asName, asName, asString, asString, asStringOrNull, asStringOrNull, bit_length, conjugate, delDict, delType, dispatch__init__, equals, fastGetClass, fastGetDict, getDict, getType, hashCode, implementsDescrDelete, implementsDescrGet, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isIndex, isInteger, isMappingType, isNumberType, isSequenceType, noAttributeError, object___subclasshook__, readonlyAttributeError, setDict, setType
-
Method Details
-
toString
String representation of the object. -
__setattr__
Sets the attribute name to value.- Overrides:
__setattr__
in classPyObject
- Parameters:
name
-value
-- See Also:
-
__findattr_ex__
Gets the value of the attribute name.- Overrides:
__findattr_ex__
in classPyObject
- Parameters:
name
-- Returns:
- the attribute for the given name
-
classDictInit
Initializes the object's namespace.- Parameters:
dict
-
-
__del__
public void __del__()Delete the cursor. -
close
public void close()Close the cursor now (rather than whenever __del__ is called). The cursor will be unusable from this point forward; an Error (or subclass) exception will be raised if any operation is attempted with the cursor. -
__iter__
Returns an iteratable object. -
next
Returns the next row from the currently executing SQL statement using the same semantics as .fetchone(). A StopIteration exception is raised when the result set is exhausted for Python versions 2.2 and later.- Returns:
- PyObject
- Since:
- Jython 2.2, DB API 2.0+
-
__iternext__
Return the next element of the sequence that this is an iterator for. Returns null when the end of the sequence is reached.- Overrides:
__iternext__
in classPyObject
- Returns:
- PyObject
- Since:
- Jython 2.2
-
getDataHandler
Return the currently bound DataHandler.- Returns:
- DataHandler
-
callproc
This method is optional since not all databases provide stored procedures. 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 fetchXXX() methods.- Parameters:
name
-params
-bindings
-maxRows
-
-
executemany
Prepare a database operation (query or command) and then execute it against all parameter sequences or mappings found in the sequence seq_of_parameters. Modules are free to implement this method using multiple calls to the execute() method or by using array operations to have the database process the sequence as a whole in one call. The same comments as for execute() also apply accordingly to this method. Return values are not defined.- Parameters:
sql
-params
-bindings
-maxRows
-
-
execute
Prepare and execute a database operation (query or command). Parameters may be provided as sequence or mapping and will be bound to variables in the operation. Variables are specified in a database-specific notation (see the module's paramstyle attribute for details). A reference to the operation will be retained by the cursor. If the same operation object is passed in again, then the cursor can optimize its behavior. This is most effective for algorithms where the same operation is used, but different parameters are bound to it (many times). For maximum efficiency when reusing an operation, it is best to use the setinputsizes() method to specify the parameter types and sizes ahead of time. It is legal for a parameter to not match the predefined information; the implementation should compensate, possibly with a loss of efficiency. The parameters may also be specified as list of tuples to e.g. insert multiple rows in a single operation, but this kind of usage is deprecated: executemany() should be used instead. Return values are not defined.- Parameters:
sql
- sql string or prepared statementparams
- params for a prepared statementbindings
- dictionary of (param index : SQLType binding)maxRows
- integer value of max rows
-
fetchone
Fetch the next row of a query result set, returning a single sequence, or None when no more data is available. An Error (or subclass) exception is raised if the previous call to executeXXX() did not produce any result set or no call was issued yet.- Returns:
- a single sequence from the result set, or None when no more data is available
-
fetchall
Fetch all (remaining) rows of a query result, returning them as a sequence of sequences (e.g. a list of tuples). Note that the cursor's arraysize attribute can affect the performance of this operation. An Error (or subclass) exception is raised if the previous call to executeXXX() did not produce any result set or no call was issued yet.- Returns:
- a sequence of sequences from the result set, or an empty sequence when no more data is available
-
fetchmany
Fetch the next set of rows of a query result, returning a sequence of sequences (e.g. a list of tuples). An empty sequence is returned when no more rows are available. The number of rows to fetch per call is specified by the parameter. If it is not given, the cursor's arraysize determines the number of rows to be fetched. The method should try to fetch as many rows as indicated by the size parameter. If this is not possible due to the specified number of rows not being available, fewer rows may be returned. An Error (or subclass) exception is raised if the previous call to executeXXX() did not produce any result set or no call was issued yet. Note there are performance considerations involved with the size parameter. For optimal performance, it is usually best to use the arraysize attribute. If the size parameter is used, then it is best for it to retain the same value from one fetchmany() call to the next.- Parameters:
size
-- Returns:
- a sequence of sequences from the result set, or an empty sequence when no more data is available
-
nextset
Move the result pointer to the next set if available.- Returns:
- true if more sets exist, else None
-
prepare
Prepare a sql statement for later execution.- Parameters:
sql
- The sql string to be prepared.- Returns:
- A prepared statement usable with .executeXXX()
-
scroll
Scroll the cursor in the result set to a new position according to mode. If mode is 'relative' (default), value is taken as offset to the current position in the result set, if set to 'absolute', value states an absolute target position. An IndexError should be raised in case a scroll operation would leave the result set. In this case, the cursor position is left undefined (ideal would be to not move the cursor at all). Note: This method should use native scrollable cursors, if available, or revert to an emulation for forward-only scrollable cursors. The method may raise NotSupportedErrors to signal that a specific operation is not supported by the database (e.g. backward scrolling).- Parameters:
value
-mode
-
-
warning
Adds a warning to the tuple and will follow the chain as necessary.- Specified by:
warning
in interfaceWarningListener
- Parameters:
event
-
-
isSeq
Method isSeq- Parameters:
object
-- Returns:
- true for any PyList, PyTuple or java.util.List
-
hasParams
Method hasParams- Parameters:
params
-- Returns:
- boolean
-
isSeqSeq
Method isSeqSeq- Parameters:
object
-- Returns:
- true is a sequence of sequences
-
__enter__
- Specified by:
__enter__
in interfaceContextManager
-
__enter__
-
__exit__
- Specified by:
__exit__
in interfaceContextManager
-
__exit__
-
traverse
Description copied from interface:Traverseproc
Traverses all directly containedPyObject
s. Like in CPython,arg
must be passed unmodified tovisit
as its second parameter. IfVisitproc.visit(PyObject, Object)
returns nonzero, this return value must be returned immediately by traverse.Visitproc.visit(PyObject, Object)
must not be called with anull
PyObject-argument.- Specified by:
traverse
in interfaceTraverseproc
-
refersDirectlyTo
Description copied from interface:Traverseproc
Optional operation. Should only be implemented if it is more efficient than callingTraverseproc.traverse(Visitproc, Object)
with a visitproc that just watches out forob
. Must returnfalse
ifob
isnull
.- Specified by:
refersDirectlyTo
in interfaceTraverseproc
-