diff options
author | Bruce Momjian <bruce@momjian.us> | 2007-01-30 02:32:05 +0000 |
---|---|---|
committer | Bruce Momjian <bruce@momjian.us> | 2007-01-30 02:32:05 +0000 |
commit | c22f642f2f697d040d6f738a1d4bd280ccc4fc20 (patch) | |
tree | ea8fa3941a6b9e6f4b80a9fac5602c220823ab42 /doc/src | |
parent | 01d9754bd9c535fd0a6b859acda01359db0eb6a2 (diff) | |
download | postgresql-c22f642f2f697d040d6f738a1d4bd280ccc4fc20.tar.gz postgresql-c22f642f2f697d040d6f738a1d4bd280ccc4fc20.zip |
Clarify paramater handling for pg_get_serial_sequence().
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/func.sgml | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 5f7a8322f76..8c3ca324a4c 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.347.2.1 2007/01/12 23:35:03 tgl Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.347.2.2 2007/01/30 02:32:04 momjian Exp $ --> <chapter id="functions"> <title>Functions and Operators</title> @@ -9882,12 +9882,18 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); </para> <para> - <function>pg_get_serial_sequence</function> fetches the name of the - sequence associated with a column, or NULL if there is no sequence - associated with the column. The result is suitably formatted for passing - to the sequence functions (see <xref linkend="functions-sequence">). - This association can be modified or removed with <command>ALTER SEQUENCE - OWNED BY</>. (The function probably should have been called + <function>pg_get_serial_sequence</function> returns the name of the + sequence associated with a column, or NULL if no sequence is associated + with the column. The first input parameter is a table name with + optional schema, and the second parameter is a column name. Because + the first parameter is potentially a schema and table, it is not treated + as a double-quoted identifier, meaning it is lowercased by default, + while the second parameter, being just a column name, is treated as + double-quoted and has its case preserved. The function returns a value + suitably formatted for passing to the sequence functions (see <xref + linkend="functions-sequence">). This association can be modified or + removed with <command>ALTER SEQUENCE OWNED BY</>. (The function + probably should have been called <function>pg_get_owned_sequence</function>; its name reflects the fact that it's typically used with <type>serial</> or <type>bigserial</> columns.) |