X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=psycopg2%2Fdoc%2Fapi%2Fprivate%2Fpsycopg2._psycopg.cursor-class.html;fp=psycopg2%2Fdoc%2Fapi%2Fprivate%2Fpsycopg2._psycopg.cursor-class.html;h=d3947aaf29366db4c59e563b90b2806a78b3272c;hb=e5bdc26e1423689c0ab3204931335787737946ea;hp=0000000000000000000000000000000000000000;hpb=f8dd312990da7cc744e1c148bfd395c18492f3f1;p=plcapi.git diff --git a/psycopg2/doc/api/private/psycopg2._psycopg.cursor-class.html b/psycopg2/doc/api/private/psycopg2._psycopg.cursor-class.html new file mode 100644 index 0000000..d3947aa --- /dev/null +++ b/psycopg2/doc/api/private/psycopg2._psycopg.cursor-class.html @@ -0,0 +1,599 @@ + + + + + psycopg2._psycopg.cursor + + + + + + + + + + + + + + +
   Home      Trees      Index      Help   
+ + + + +
+ + Package psycopg2 :: + Module _psycopg :: + Class cursor +
+ 		+ + +
[show private | hide private]
[frames | no frames]
+ + +

Type cursor

+ +
+object --+
+         |
+        cursor
+

+ +
Known Subclasses:
+
+ cursor, + DictCursor
+ +
+ +

A database cursor.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method Summary
 __init__(...) +
+x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 __iter__(x) +
+Return iter(x)...
 __new__(T, + S, + ...) +
+Return a new object with type S, a subtype of T...
 __repr__(x) +
+Return repr(x)...
 __str__(x) +
+Return str(x)...
 callproc(procname, + parameters, + async) +
+Execute stored procedure.
 close() +
+Close the cursor.
 copy_from(file, + table, + sep, + null) +
+Copy table from file.
 copy_to(file, + table, + sep, + null) +
+Copy table to file.
 execute(query, + vars, + async) +
+Execute query with bound vars.
 executemany(query, + vars_list, + async) +
+Execute many queries with bound vars.
list of tuplefetchall() +
+Return all the remaining rows of a query result set.
list of tuplefetchmany(size) +
+Return the next size rows of a query result set in the form of a list +of tuples (by default) or using the sequence factory previously set in +the row_factory attribute.
tuple or Nonefetchone() +
+Return the next row of a query result set in the form of a tuple (by +default) or using the sequence factory previously set in the +row_factory attribute.
intfileno() +
+Return file descriptor associated to database connection.
boolisready() +
+Return True if data is ready after an async query.
strmogrify(query, + vars) +
+Return query after vars binding.
 next(x) +
+Return the next value, or raise StopIteration...
 nextset() +
+Skip to next set of data.
 scroll(value, + mode) +
+Scroll to new position according to mode.
 setinputsizes(sizes) +
+Set memory areas before execute.
 setoutputsize(size, + column) +
+Set column buffer size.
    Inherited from object
 __delattr__(...) +
+x.__delattr__('name') <==> del x.name
 __getattribute__(...) +
+x.__getattribute__('name') <==> x.name
 __hash__(x) +
+Return hash(x)...
 __reduce__(...) +
+helper for pickle
 __reduce_ex__(...) +
+helper for pickle
 __setattr__(...) +
+x.__setattr__('name', value) <==> x.name = value

+ + + + + + + + + + + + + + + + + + + + +
Property Summary
 arraysize: Number of records fetchmany() must fetch if not explicitely specified.
 binary_types
 connection: The connection where the cursor comes from.
 description: Cursor description as defined in DBAPI-2.0.
 lastrowid: The oid of the last row inserted by the cursor.
 name
 query: The last query text sent to the backend.
 row_factory
 rowcount: Number of rows read from the backend in the last command.
 rownumber: The current row position.
 statusmessage: The return message of the last command.
 string_types
 typecaster
 tzinfo_factory

+ + + + + + +
Method Details
+ + +
+

__init__(...) +
(Constructor) +

+

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

+
+
Overrides:
+
__builtin__.object.__init__
+
+
+
+ + +
+

__iter__(x) +

+
+
Returns:
+
+
+iter(x)
+
+
+
+
+
+ + +
+

__new__(T, + S, + ...) +

+
+
Returns:
+
+
+a new object with type S, a subtype of T
+
+
+
+
Overrides:
+
__builtin__.object.__new__
+
+
+
+ + +
+

__repr__(x) +
(Representation operator) +

+
+
Returns:
+
+
+repr(x)
+
+
+
+
Overrides:
+
__builtin__.object.__repr__
+
+
+
+ + +
+

__str__(x) +
(Informal representation operator) +

+
+
Returns:
+
+
+str(x)
+
+
+
+
Overrides:
+
__builtin__.object.__str__
+
+
+
+ + +
+

callproc(procname, + parameters=None, + async=0) +

+

Execute stored procedure.

+
+
+
+ + +
+

close() +

+

Close the cursor.

+
+
+
+ + +
+

copy_from(file, + table, + sep='\t', + null='\N') +

+

Copy table from file.

+
+
+
+ + +
+

copy_to(file, + table, + sep='\t', + null='\N') +

+

Copy table to file.

+
+
+
+ + +
+

execute(query, + vars=None, + async=0) +

+

Execute query with bound vars.

+
+
+
+ + +
+

executemany(query, + vars_list=(), + async=0) +

+

Execute many queries with bound vars.

+
+
+
+ + +
+

fetchall() +

+

Return all the remaining rows of a query result set.

+

Rows are returned in the form of a list of tuples (by default) or using +the sequence factory previously set in the row_factory attribute. +Return None when no more data is available.

+
+
Returns:
+
+list of tuple
+
+
+
+ + +
+

fetchmany(size=self.arraysize) +

+

Return the next size rows of a query result set in the form of a list +of tuples (by default) or using the sequence factory previously set in +the row_factory attribute. Return None when no more data is available.

+
+
Returns:
+
+list of tuple
+
+
+
+ + +
+

fetchone() +

+

Return the next row of a query result set in the form of a tuple (by +default) or using the sequence factory previously set in the +row_factory attribute. Return None when no more data is available.

+
+
Returns:
+
+tuple or None
+
+
+
+ + +
+

fileno() +

+

Return file descriptor associated to database connection.

+
+
Returns:
+
+int
+
+
+
+ + +
+

isready() +

+

Return True if data is ready after an async query.

+
+
Returns:
+
+bool
+
+
+
+ + +
+

mogrify(query, + vars=None) +

+

Return query after vars binding.

+
+
Returns:
+
+str
+
+
+
+ + +
+

next(x) +

+
+
Returns:
+
+
+the next value, or raise StopIteration
+
+
+
+
+
+ + +
+

nextset() +

+

Skip to next set of data.

+

This method is not supported (PostgreSQL does not have multiple data +sets) and will raise a NotSupportedError exception.

+
+
+
+ + +
+

scroll(value, + mode='relative') +

+

Scroll to new position according to mode.

+
+
+
+ + +
+

setinputsizes(sizes) +

+

Set memory areas before execute.

+

This method currently does nothing but it is safe to call it.

+
+
+
+ + +
+

setoutputsize(size, + column=None) +

+

Set column buffer size.

+

This method currently does nothing but it is safe to call it.

+
+
+
+
+ + + + + + +
Property Details
+
+ + +

arraysize

+

Number of records fetchmany() must fetch if not explicitely specified.

+
+ + +

connection

+

The connection where the cursor comes from.

+
+ + +

description

+

Cursor description as defined in DBAPI-2.0.

+
+ + +

lastrowid

+

The oid of the last row inserted by the cursor.

+
+ + +

query

+

The last query text sent to the backend.

+
+ + +

rowcount

+

Number of rows read from the backend in the last command.

+
+ + +

rownumber

+

The current row position.

+
+ + +

statusmessage

+

The return message of the last command.

+

+ + + + + + + + + + + +
   Home      Trees      Index      Help   
+ + + + + + +
Generated by Epydoc 2.1 on Sat Jan 14 01:42:34 2006 + http://epydoc.sf.net +
+ +