Skip to content

Commit 6797034

Browse files
author
James William Pye
committed
Use the full name, Cursor, and remove the "metadata" section.
1 parent e7a1da5 commit 6797034

1 file changed

Lines changed: 12 additions & 16 deletions

File tree

postgresql/documentation/driver.txt

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -867,7 +867,7 @@ Cursor Interface Points
867867
For cursors that return row data, these interfaces are provided for accessing
868868
those results:
869869

870-
``c.read(quantity = None, direction = None)``
870+
``Cursor.read(quantity = None, direction = None)``
871871
This method name is borrowed from `file` objects, and are semantically
872872
similar. However, this being a cursor, rows are returned instead of bytes or
873873
characters. When the number of rows returned is less then the quantity
@@ -878,26 +878,26 @@ those results:
878878
Like, ``seek()``, the ``direction`` *property* on the cursor object effects
879879
this method.
880880

881-
``c.seek(position[, whence = 0])``
881+
``Cursor.seek(position[, whence = 0])``
882882
When the cursor is scrollable, this seek interface can be used to move the
883883
position of the cursor. See `Scrollable Cursors`_ for more information.
884884

885-
``next(c)``
885+
``next(Cursor)``
886886
This fetches the next row in the cursor object. Cursors support the iterator
887887
protocol. While equivalent to ``cursor.read(1)[0]``, `StopIteration` is raised
888888
if the returned sequence is empty. (``__next__()``)
889889

890-
``c.close()``
890+
``Cursor.close()``
891891
For cursors opened using ``cursor_from_id()``, this method must be called in
892892
order to ``CLOSE`` the cursor. For cursors created by invoking a prepared
893893
statement, this is not necessary as the garbage collection interface will take
894894
the appropriate steps.
895895

896-
``c.clone()``
896+
``Cursor.clone()``
897897
Create a new cursor object based on the same factors that were used to
898898
create ``c``.
899899

900-
``c.msghook(msg)``
900+
``Cursor.msghook(msg)``
901901
By default, the `msghook` attribute does not exist. If set to a callable, any
902902
message that occurs during an operation of the cursor will be given to the
903903
callable. See the `Database Messages`_ section for more information.
@@ -906,37 +906,33 @@ those results:
906906
Cursors have some additional configuration properties that may be modified
907907
during the use of the cursor:
908908

909-
``c.direction``
909+
``Cursor.direction``
910910
A value of `True`, the default, will cause read to fetch forwards, whereas a
911911
value of `False` will cause it to fetch backwards. ``'BACKWARD'`` and
912912
``'FORWARD'`` can be used instead of `False` and `True`.
913913

914-
915-
Cursor Metadata
916-
---------------
917-
918914
Cursors normally share metadata with the statements that create them, so it is
919915
usually unnecessary for referencing the cursor's column descriptions directly.
920916
However, when a cursor is opened from an identifier, the cursor interface must
921917
collect the metadata itself. These attributes provide the metadata in absence of
922918
a statement object:
923919

924-
``sql_column_types``
920+
``Cursor.sql_column_types``
925921
A sequence of SQL type names specifying the types of the columns produced by
926922
the cursor. `None` if the cursor does not return row-data.
927923

928-
``pg_column_types``
924+
``Cursor.pg_column_types``
929925
A sequence of PostgreSQL type Oid's specifying the types of the columns produced by
930926
the cursor. `None` if the cursor does not return row-data.
931927

932-
``column_types``
928+
``Cursor.column_types``
933929
A sequence of Python types that the cursor will produce.
934930

935-
``column_names``
931+
``Cursor.column_names``
936932
A sequence of `str` objects specifying the names of the columns produced by
937933
the cursor. `None` if the cursor does not return row-data.
938934

939-
``statement``
935+
``Cursor.statement``
940936
The statement that was executed that created the cursor. `None` if
941937
unknown--``db.cursor_from_id()``.
942938

0 commit comments

Comments
 (0)