summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Eisentraut2009-06-18 10:22:09 +0000
committerPeter Eisentraut2009-06-18 10:22:09 +0000
commit11706ed6a0b1a8e1decf246b6c23e5805be3d8cf (patch)
tree6c08dd64019fc87b7c09e7810344d94caf13432d
parent55f1ac2abb8fd4e51a81a064a629525494ba0d2c (diff)
Refine the use of terminology around bound and unbound cursors and cursor
variables. Remove the confusing term "reference cursor".
-rw-r--r--doc/src/sgml/plpgsql.sgml14
-rw-r--r--src/include/catalog/pg_type.h2
-rw-r--r--src/pl/plpgsql/src/gram.y2
3 files changed, 9 insertions, 9 deletions
diff --git a/doc/src/sgml/plpgsql.sgml b/doc/src/sgml/plpgsql.sgml
index 80dbf45327..07078e6aea 100644
--- a/doc/src/sgml/plpgsql.sgml
+++ b/doc/src/sgml/plpgsql.sgml
@@ -2450,7 +2450,7 @@ DECLARE
<note>
<para>
- Bound cursors can also be used without explicitly opening them,
+ Bound cursor variables can also be used without explicitly opening the cursor,
via the <command>FOR</> statement described in
<xref linkend="plpgsql-cursor-for-loop">.
</para>
@@ -2460,13 +2460,13 @@ DECLARE
<title><command>OPEN FOR</command> <replaceable>query</replaceable></title>
<synopsis>
-OPEN <replaceable>unbound_cursor</replaceable> <optional> <optional> NO </optional> SCROLL </optional> FOR <replaceable>query</replaceable>;
+OPEN <replaceable>unbound_cursorvar</replaceable> <optional> <optional> NO </optional> SCROLL </optional> FOR <replaceable>query</replaceable>;
</synopsis>
<para>
The cursor variable is opened and given the specified query to
execute. The cursor cannot be open already, and it must have been
- declared as an unbound cursor (that is, as a simple
+ declared as an unbound cursor variable (that is, as a simple
<type>refcursor</> variable). The query must be a
<command>SELECT</command>, or something else that returns rows
(such as <command>EXPLAIN</>). The query
@@ -2494,13 +2494,13 @@ OPEN curs1 FOR SELECT * FROM foo WHERE key = mykey;
<title><command>OPEN FOR EXECUTE</command></title>
<synopsis>
-OPEN <replaceable>unbound_cursor</replaceable> <optional> <optional> NO </optional> SCROLL </optional> FOR EXECUTE <replaceable class="command">query_string</replaceable>;
+OPEN <replaceable>unbound_cursorvar</replaceable> <optional> <optional> NO </optional> SCROLL </optional> FOR EXECUTE <replaceable class="command">query_string</replaceable>;
</synopsis>
<para>
The cursor variable is opened and given the specified query to
execute. The cursor cannot be open already, and it must have been
- declared as an unbound cursor (that is, as a simple
+ declared as an unbound cursor variable (that is, as a simple
<type>refcursor</> variable). The query is specified as a string
expression, in the same way as in the <command>EXECUTE</command>
command. As usual, this gives flexibility so the query plan can vary
@@ -2524,7 +2524,7 @@ OPEN curs1 FOR EXECUTE 'SELECT * FROM ' || quote_ident($1);
<title>Opening a Bound Cursor</title>
<synopsis>
-OPEN <replaceable>bound_cursor</replaceable> <optional> ( <replaceable>argument_values</replaceable> ) </optional>;
+OPEN <replaceable>bound_cursorvar</replaceable> <optional> ( <replaceable>argument_values</replaceable> ) </optional>;
</synopsis>
<para>
@@ -2850,7 +2850,7 @@ COMMIT;
<synopsis>
<optional> &lt;&lt;<replaceable>label</replaceable>&gt;&gt; </optional>
-FOR <replaceable>recordvar</replaceable> IN <replaceable>bound_cursor</replaceable> <optional> ( <replaceable>argument_values</replaceable> ) </optional> LOOP
+FOR <replaceable>recordvar</replaceable> IN <replaceable>bound_cursorvar</replaceable> <optional> ( <replaceable>argument_values</replaceable> ) </optional> LOOP
<replaceable>statements</replaceable>
END LOOP <optional> <replaceable>label</replaceable> </optional>;
</synopsis>
diff --git a/src/include/catalog/pg_type.h b/src/include/catalog/pg_type.h
index 6128097a3a..1b8c34a3d2 100644
--- a/src/include/catalog/pg_type.h
+++ b/src/include/catalog/pg_type.h
@@ -520,7 +520,7 @@ DESCR("numeric(precision, decimal), arbitrary precision number");
#define NUMERICOID 1700
DATA(insert OID = 1790 ( refcursor PGNSP PGUID -1 f b U f t \054 0 0 2201 textin textout textrecv textsend - - - i x f 0 -1 0 _null_ _null_ ));
-DESCR("reference cursor (portal name)");
+DESCR("reference to cursor (portal name)");
#define REFCURSOROID 1790
/* OIDS 2200 - 2299 */
diff --git a/src/pl/plpgsql/src/gram.y b/src/pl/plpgsql/src/gram.y
index 06704cf593..c271bcedb5 100644
--- a/src/pl/plpgsql/src/gram.y
+++ b/src/pl/plpgsql/src/gram.y
@@ -1585,7 +1585,7 @@ stmt_open : K_OPEN lno cursor_variable
(errcode(ERRCODE_SYNTAX_ERROR),
errmsg("syntax error at \"%s\"",
yytext),
- errdetail("Expected \"FOR\", to open a reference cursor.")));
+ errdetail("Expected \"FOR\", to open a cursor for an unbound cursor variable.")));
}
tok = yylex();