typo, parameter and type fixes
[mdref/mdref-pq] / pq / Cursor.md
1 # class pq\Cursor
2
3 Declare a cursor.
4
5 ## Constants:
6
7 * BINARY
8 Causes the cursor to return data in binary rather than in text format. You probably do not want to use that.
9 * INSENSITIVE
10 The data returned by the cursor should be unaffected by updates to the tables underlying the cursor that take place after the cursor was opened.
11 * WITH_HOLD
12 The cursor should stay usable after the transaction that created it was successfully committed.
13 * SCROLL
14 Force that rows can be retrieved in any order from the cursor.
15 * NO_SCROLL
16 Force that rows are only retrievable in sequiential order.
17
18 > ***NOTE:***
19 See the [notes in the official PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-declare.html#SQL-DECLARE-NOTES) for more information.
20
21 ## Properties:
22
23 * public (readonly) pq\Connection $connection
24 The connection the cursor was declared on.
25 * public (readonly) string $name
26 The identifying name of the cursor.