diff options
| author | Bruce Momjian <bruce@momjian.us> | 2003-09-07 04:37:13 +0000 |
|---|---|---|
| committer | Bruce Momjian <bruce@momjian.us> | 2003-09-07 04:37:13 +0000 |
| commit | c40ed5131948495a30caac2efff7927b673cd2d0 (patch) | |
| tree | 4ee7a43fa571f53a370e60d0be421f4c6927c97f /doc/src | |
| parent | 432ca9116bc51f6cfe6e88be33dbe6cb078cda9d (diff) | |
Update this branch to match CVS head, includes WIN32 improvements.
Diffstat (limited to 'doc/src')
169 files changed, 5753 insertions, 5243 deletions
diff --git a/doc/src/FAQ/FAQ.html b/doc/src/FAQ/FAQ.html index 641a3de6ea2..2983f0519d3 100644 --- a/doc/src/FAQ/FAQ.html +++ b/doc/src/FAQ/FAQ.html @@ -10,7 +10,7 @@ alink="#0000ff"> <H1>Frequently Asked Questions (FAQ) for PostgreSQL</H1> - <P>Last updated: Fri Jul 25 18:07:30 EDT 2003</P> + <P>Last updated: Fri Sep 5 12:42:57 EDT 2003</P> <P>Current maintainer: Bruce Momjian (<A href= "mailto:pgman@candle.pha.pa.us">pgman@candle.pha.pa.us</A>)<BR> @@ -251,7 +251,9 @@ <p>A native port to MS Win NT/2000/XP is currently being worked on. For more details on the current status of PostgreSQL on Windows see <a href="http://techdocs.postgresql.org/guides/Windows"> - http://techdocs.postgresql.org/guides/Windows</a>.</p> + http://techdocs.postgresql.org/guides/Windows</a> and + <a href="http://candle.pha.pa.us/main/writings/pgsql/win32.html"> + http://candle.pha.pa.us/main/writings/pgsql/win32.html</a>.</p> <p>There is also a Novell Netware 6 port at <a href="http://forge.novell.com">http://forge.novell.com</a>.</p> @@ -1152,7 +1154,8 @@ BYTEA bytea variable-length byte array (null-byte safe) Finally, you could use the <A href="#4.16"><SMALL>OID</SMALL></A> returned from the <SMALL>INSERT</SMALL> statement to look up the - default value, though this is probably the least portable approach. + default value, though this is probably the least portable approach, + and the oid value will wrap around when it reaches 4 billion. In Perl, using DBI with Edmund Mergl's DBD::Pg module, the oid value is made available via <I>$sth->{pg_oid_status}</I> after <I>$sth->execute()</I>. diff --git a/doc/src/FAQ/FAQ_german.html b/doc/src/FAQ/FAQ_german.html index 60752bcb5b2..5042cdfdca9 100644 --- a/doc/src/FAQ/FAQ_german.html +++ b/doc/src/FAQ/FAQ_german.html @@ -14,7 +14,7 @@ href="mailto:pgman@candle.pha.pa.us">pgman@candle.pha.pa.us</a>).</p> <p>Deutsche Übersetzung von Ian Barwick (<a href="mailto:barwick@gmx.net">barwick@gmx.net</a>).</p> - <p>Letzte Aktualisierung der deutschen Übersetzung: Di., den 22.07.2003, 16:20 CET</p> + <p>Letzte Aktualisierung der deutschen Übersetzung: Di., den 02.09.2003, 10:00 CET</p> <p>Die aktuellste Version dieses Dokuments liegt auf der PostgreSQL Website:</p> <ul> @@ -1060,8 +1060,12 @@ BYTEA bytea Bytearray mit variabler Länge new_id = output of execute("SELECT currval('person_id_seq')"); </pre> <p>Schließlich besteht noch die Möglichkeit, den von einer <small>INSERT</small>-Anweisung - zurückgelieferten <small>OID</small>-Wert als einmaligen Wert zu verwenden. - In Perl mit dem <em>DBD::Pg</em>-Modul von Edmund Mergl wird der OID-Wert nach einem + zurückgelieferten <a href="#4.16"><small>OID</small></a>-Wert als einmaligen Wert zu verwenden. + Dieser Ansatz ist allerdings PostgreSQL-spezifisch; außerdem wird nach + ca. 4 Milliarden Einträgen der <small>OID</small>-Wert wieder auf eine kleine Zahl + gesetzt, ist also nicht garantiert einmalig.</p> + + <p>In Perl mit dem <em>DBD::Pg</em>-Modul wird der OID-Wert nach einem <em>$sth->excute()</em> über <em>$sth->{pg_oid_status}</em> zurückgeliefert.</p> <h4><a name="4.15.3">4.15.3</a>) Führen <em>currval()</em> und <em>nextval()</em> zu einer Race-Condition mit anderen @@ -1285,13 +1289,21 @@ BYTEA bytea Bytearray mit variabler Länge <ul> <li><em>contrib/pgcrypto</em> enthält diverse Funktionen für die Benützung mit - SQL-Abfragen;</li> - <li>die einzige Möglichkeit, Kommunikationen zwischen Client und Server - zu verschlüsseln, ist durch die Anwendung von <em>hostssl</em> in <em>pg_hba.conf</em>;</li> + SQL-Abfragen.</li> + + <li>Um Verbindungen zwischen dem Server und Client-Anwendungen zu + verschlüsseln, muss in der Server-Konfigurationsdatei <em>postgresql.conf</em> + die <em>ssl</em>-Option auf <em>true</em> (Voreinstellung: <em>false</em>) gesetzt werden + und ein passender <em>host</em>- bzw. <em>hostssl</em>-Eintrag muss in + <em>pg_hba.conf</em> vorhanden sein. Zudem muss die <em>sslmode</em>-Einstellung + beim Client nicht auf <em>disable</em> gesetzt werden. (Bitte beachten Sie auch, + daß neben der eingebauten SSL-Unterstützung verschlüsselte Verbindungen + auch über externe Anwendungen wie <em>stunnel</em> oder <em>ssh</em> aufgebaut werden können).</li> + <li>Die Passwörter der Datenbanknutzer werden ab Version 7.3 automatisch verschlüsselt (in früheren Versionen muß der Parameter <em>PASSWORD_ENCRYPTION</em> - in <em>postgresql.conf</em> explizit eingeschaltet werden);</li> - <li>der Server läuft auf einem verschlüsselten Dateisystem.</li> + in <em>postgresql.conf</em> explizit eingeschaltet werden).</li> + <li>Betrieb des Servers auf einem verschlüsselten Dateisystem.</li> </ul> <hr /> @@ -1333,9 +1345,15 @@ BYTEA bytea Bytearray mit variabler Länge <p>Die englische Vorlage dieser FAQ wird ständig überarbeitet. Daher liegt die Übersetzung nicht immer auf dem aktuellsten Stand.</p> + <p>Die aktuellste Version der deutschen Übersetzung befindet sich immer unter + <a href="http://sql-info.de/postgresql/FAQ_german.html">http://sql-info.de/postgresql/FAQ_german.html</a>. + Diese "Arbeitsversion" enthält eventuell Änderungen, die noch nicht auf der + PostgreSQL-Website eingebunden worden sind.</p> + <p>Über Verbesserungshinweise und Korrekturvorschläge sowie Verständnisfragen zum Inhalt der FAQ freue ich mich. Ich nehme auch allgemeine Fragen zu PostgreSQL gerne - entgegen, kann aber leider keine zeitige Antwort garantieren.</p> + entgegen, verweise jedoch auf die Mailing-Listen als schnelle und zuverlässige + Anlaufstellen.</p> <p>Diese Übersetzung basiert teilweise auf einer früheren Übersetzung von Karsten Schulz (<a href="mailto:schulz@linux-systemhaus.de">schulz@linux-systemhaus.de</a>).</p> diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile index 42551d24074..22f8e427df2 100644 --- a/doc/src/sgml/Makefile +++ b/doc/src/sgml/Makefile @@ -2,7 +2,7 @@ # # PostgreSQL documentation makefile # -# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.57 2003/04/10 01:22:44 petere Exp $ +# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.57.2.1 2003/09/07 04:36:40 momjian Exp $ # #---------------------------------------------------------------------------- @@ -48,7 +48,7 @@ endif # Enable draft mode during development ifneq (,$(findstring devel, $(VERSION))) -JADEFLAGS += -V draft-mode +override JADEFLAGS += -V draft-mode endif @@ -82,7 +82,7 @@ html: postgres.sgml $(ALLSGML) stylesheet.dsl $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -i output-html -t sgml $< -COLLATEINDEX := $(PERL) $(COLLATEINDEX) -f -g +COLLATEINDEX := LC_ALL=C $(PERL) $(COLLATEINDEX) -f -g ifeq (,$(wildcard HTML.index)) bookindex.sgml: diff --git a/doc/src/sgml/advanced.sgml b/doc/src/sgml/advanced.sgml index d6d7881ef38..a0b4726a919 100644 --- a/doc/src/sgml/advanced.sgml +++ b/doc/src/sgml/advanced.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/advanced.sgml,v 1.34 2003/03/25 16:15:35 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/advanced.sgml,v 1.34.2.1 2003/09/07 04:36:40 momjian Exp $ --> <chapter id="tutorial-advanced"> @@ -142,7 +142,7 @@ ERROR: <unnamed> referential integrity violation - key referenced from we <title>Transactions</title> <indexterm zone="tutorial-transactions"> - <primary>transactions</primary> + <primary>transaction</primary> </indexterm> <para> diff --git a/doc/src/sgml/array.sgml b/doc/src/sgml/array.sgml index fabf2e732cd..a06c00cd348 100644 --- a/doc/src/sgml/array.sgml +++ b/doc/src/sgml/array.sgml @@ -1,10 +1,10 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/array.sgml,v 1.29 2003/08/09 22:50:21 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/array.sgml,v 1.29.2.1 2003/09/07 04:36:40 momjian Exp $ --> <sect1 id="arrays"> <title>Arrays</title> <indexterm> - <primary>arrays</primary> + <primary>array</primary> </indexterm> <para> @@ -162,7 +162,6 @@ ERROR: multidimensional arrays must have array expressions with matching dimens expression syntax is discussed in more detail in <xref linkend="sql-syntax-array-constructors">. </para> - </sect2> <sect2> @@ -326,9 +325,9 @@ UPDATE sal_emp SET pay_by_quarter[1:2] = '{27000,27000}' <literal>||</literal>. <programlisting> SELECT ARRAY[1,2] || ARRAY[3,4]; - ?column? ---------------- - {{1,2},{3,4}} + ?column? +----------- + {1,2,3,4} (1 row) SELECT ARRAY[5,6] || ARRAY[[1,2],[3,4]]; @@ -337,27 +336,68 @@ SELECT ARRAY[5,6] || ARRAY[[1,2],[3,4]]; {{5,6},{1,2},{3,4}} (1 row) </programlisting> + </para> + <para> The concatenation operator allows a single element to be pushed on to the beginning or end of a one-dimensional array. It also accepts two <replaceable>N</>-dimensional arrays, or an <replaceable>N</>-dimensional - and an <replaceable>N+1</>-dimensional array. In the former case, the two - <replaceable>N</>-dimension arrays become outer elements of an - <replaceable>N+1</>-dimensional array. In the latter, the - <replaceable>N</>-dimensional array is added as either the first or last - outer element of the <replaceable>N+1</>-dimensional array. - - When extending an array by concatenation, the subscripts of its existing - elements are preserved. For example, when pushing - onto the beginning of an array with one-based subscripts, the resulting - array has zero-based subscripts: + and an <replaceable>N+1</>-dimensional array. + </para> + <para> + When a single element is pushed on to the beginning of a one-dimensional + array, the result is an array with a lower bound subscript equal to + the righthand operand's lower bound subscript, minus one. When a single + element is pushed on to the end of a one-dimensional array, the result is + an array retaining the lower bound of the lefthand operand. For example: <programlisting> SELECT array_dims(1 || ARRAY[2,3]); array_dims ------------ [0:2] (1 row) + +SELECT array_dims(ARRAY[1,2] || 3); + array_dims +------------ + [1:3] +(1 row) +</programlisting> + </para> + + <para> + When two arrays with an equal number of dimensions are concatenated, the + result retains the lower bound subscript of the lefthand operand's outer + dimension. The result is an array comprising every element of the lefthand + operand followed by every element of the righthand operand. For example: +<programlisting> +SELECT array_dims(ARRAY[1,2] || ARRAY[3,4,5]); + array_dims +------------ + [1:5] +(1 row) + +SELECT array_dims(ARRAY[[1,2],[3,4]] || ARRAY[[5,6],[7,8],[9,0]]); + array_dims +------------ + [1:5][1:2] +(1 row) +</programlisting> + </para> + + <para> + When an <replaceable>N</>-dimensional array is pushed on to the beginning + or end of an <replaceable>N+1</>-dimensional array, the result is + analogous to the element-array case above. Each <replaceable>N</>-dimensional + sub-array is essentially an element of the <replaceable>N+1</>-dimensional + array's outer dimension. For example: +<programlisting> +SELECT array_dims(ARRAY[1,2] || ARRAY[[3,4],[5,6]]); + array_dims +------------ + [0:2][1:2] +(1 row) </programlisting> </para> @@ -386,9 +426,9 @@ SELECT array_append(ARRAY[1,2], 3); (1 row) SELECT array_cat(ARRAY[1,2], ARRAY[3,4]); - array_cat ---------------- - {{1,2},{3,4}} + array_cat +----------- + {1,2,3,4} (1 row) SELECT array_cat(ARRAY[[1,2],[3,4]], ARRAY[5,6]); diff --git a/doc/src/sgml/backup.sgml b/doc/src/sgml/backup.sgml index 6e7e9cbf0be..204ffa5b838 100644 --- a/doc/src/sgml/backup.sgml +++ b/doc/src/sgml/backup.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/backup.sgml,v 2.27 2003/08/01 01:01:52 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/backup.sgml,v 2.27.2.1 2003/09/07 04:36:40 momjian Exp $ --> <chapter id="backup"> <title>Backup and Restore</title> @@ -153,6 +153,12 @@ pg_dump -h <replaceable>host1</> <replaceable>dbname</> | psql -h <replaceable>h </para> </important> + <tip> + <para> + Restore performance can be improved by increasing <literal>SORT_MEM</> + (see <xref linkend="runtime-config-resource-memory">). + </para> + </tip> </sect2> <sect2 id="backup-dump-all"> @@ -279,13 +285,15 @@ pg_dump -Fc <replaceable class="parameter">dbname</replaceable> > <replaceable c </para> <para> - For reasons of backward compatibility, <application>pg_dump</> does - not dump large objects by default. To dump large objects you must use - either the custom or the TAR output format, and use the <option>-b</> option in - <application>pg_dump</>. See the reference pages for details. - The directory <filename>contrib/pg_dumplo</> of the - <productname>PostgreSQL</> source tree also contains a program that can - dump large objects. + For reasons of backward compatibility, <application>pg_dump</> + does not dump large objects by default.<indexterm><primary>large + object</primary><secondary>backup</secondary></indexterm> To dump + large objects you must use either the custom or the TAR output + format, and use the <option>-b</> option in + <application>pg_dump</>. See the reference pages for details. The + directory <filename>contrib/pg_dumplo</> of the + <productname>PostgreSQL</> source tree also contains a program + that can dump large objects. </para> <para> @@ -365,7 +373,15 @@ tar -cf backup.tar /usr/local/pgsql/data <sect1 id="migration"> <title>Migration between releases</title> - <indexterm zone="migration"><primary>upgrading</></> + + <indexterm zone="migration"> + <primary>upgrading</primary> + </indexterm> + + <indexterm zone="migration"> + <primary>version</primary> + <secondary>compatibility</secondary> + </indexterm> <para> As a general rule, the internal data storage format is subject to diff --git a/doc/src/sgml/charset.sgml b/doc/src/sgml/charset.sgml index fb9db34019c..ec2ada9b488 100644 --- a/doc/src/sgml/charset.sgml +++ b/doc/src/sgml/charset.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/charset.sgml,v 2.37 2003/08/04 04:03:03 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/charset.sgml,v 2.37.2.1 2003/09/07 04:36:40 momjian Exp $ --> <chapter id="charset"> <title>Localization</> @@ -197,7 +197,7 @@ initdb --locale=sv_SE <listitem> <para> Sort order in queries using <command>ORDER BY</> - <indexterm><primary>ORDER BY</></> + <indexterm><primary>ORDER BY</><secondary>and locales</></indexterm> </para> </listitem> diff --git a/doc/src/sgml/client-auth.sgml b/doc/src/sgml/client-auth.sgml index e6180c762ee..0564779552a 100644 --- a/doc/src/sgml/client-auth.sgml +++ b/doc/src/sgml/client-auth.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/client-auth.sgml,v 1.53 2003/07/26 13:50:01 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/client-auth.sgml,v 1.53.2.1 2003/09/07 04:36:40 momjian Exp $ --> <chapter id="client-authentication"> @@ -199,13 +199,17 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable> <programlisting> (<replaceable>actual-IP-address</replaceable> xor <replaceable>IP-address-field</replaceable>) and <replaceable>IP-mask-field</replaceable> </programlisting> - must be zero for the record to match. (Of course IP addresses - can be spoofed but this consideration is beyond the scope of - <productname>PostgreSQL</productname>.) If you machine supports - IPv6, the default <filename>pg_hba.conf</> file will have an - IPv6 entry for <literal>localhost</>. You can add your own IPv6 - entries to the file. IPv6 entries are used only for IPv6 - connections. + must be zero for the record to match. + </para> + + <para> + An IP address given in IPv4 format will match IPv6 connections that + have the corresponding address, for example <literal>127.0.0.1</> + will match the IPv6 address <literal>::ffff:127.0.0.1</>. An entry + given in IPv6 format will match only IPv6 connections, even if the + represented address is in the IPv4-in-IPv6 range. Note that entries + in IPv6 format will be rejected if the system's C library does not have + support for IPv6 addresses. </para> <para> @@ -219,9 +223,10 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable> <term><replaceable>CIDR-mask</replaceable></term> <listitem> <para> - This is an integer specifying the number of significant bits - to set in the mask, and is an alternative to using the - <replaceable>IP-mask</replaceable> notation. The number must + This field may be used as an alternative to the + <replaceable>IP-mask</replaceable> notation. It is an + integer specifying the number of high-order bits + to set in the mask. The number must be between 0 and 32 (in the case of an IPv4 address) or 128 (in the case of an IPv6 address) inclusive. 0 will match any address, while 32/128 will match only the exact host specified. @@ -451,6 +456,11 @@ local all all trust # TYPE DATABASE USER IP-ADDRESS IP-MASK METHOD host all all 127.0.0.1 255.255.255.255 trust +# The same as the last line but using a CIDR mask +# +# TYPE DATABASE USER IP-ADDRESS/CIDR-mask METHOD +host all all 127.0.0.1/32 trust + # Allow any user from any host with IP address 192.168.93.x to connect # to database "template1" as the same user name that ident reports for # the connection (typically the Unix user name). @@ -458,6 +468,11 @@ host all all 127.0.0.1 255.255.255.255 trust # TYPE DATABASE USER IP-ADDRESS IP-MASK METHOD host template1 all 192.168.93.0 255.255.255.0 ident sameuser +# The same as the last line but using a CIDR mask +# +# TYPE DATABASE USER IP-ADDRESS/CIDR-mask METHOD +host template1 all 192.168.93.0/24 ident sameuser + # Allow a user from host 192.168.12.10 to connect to database # "template1" if the user's password is correctly supplied. # @@ -566,6 +581,7 @@ local db1,db2,@demodbs all md5 </indexterm> <indexterm> <primary>password</primary> + <secondary>authentication</secondary> </indexterm> <para> @@ -610,16 +626,21 @@ local db1,db2,@demodbs all md5 <para> <productname>Kerberos</productname> is an industry-standard secure - authentication system suitable for distributed computing over a - public network. A description of the - <productname>Kerberos</productname> system is far beyond the scope - of this document; in all generality it can be quite complex (yet - powerful). The <ulink + authentication system suitable for distributed computing over a public + network. A description of the <productname>Kerberos</productname> system + is far beyond the scope of this document; in all generality it can be + quite complex (yet powerful). The <ulink url="http://www.nrl.navy.mil/CCS/people/kenh/kerberos-faq.html">Kerberos - <acronym>FAQ</></ulink> or <ulink - url="ftp://athena-dist.mit.edu">MIT Project Athena</ulink> can be - a good starting point for exploration. Several sources for - <productname>Kerberos</> distributions exist. + <acronym>FAQ</></ulink> or <ulink url="ftp://athena-dist.mit.edu">MIT + Project Athena</ulink> can be a good starting point for exploration. + Several sources for <productname>Kerberos</> distributions exist. + </para> + + <para> + While <productname>PostgreSQL</> supports both Kerberos 4 and + Kerberos 5, only Kerberos 5 is recommended. Kerberos 4 is + considered insecure and no longer recommended for general + use. </para> <para> @@ -850,6 +871,10 @@ omicron bryanh guest1 <sect2 id="auth-pam"> <title>PAM Authentication</title> + <indexterm zone="auth-pam"> + <primary>PAM</primary> + </indexterm> + <para> This authentication method operates similarly to <literal>password</literal> except that it uses PAM (Pluggable diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml index b8053f94e55..295cbd779a0 100644 --- a/doc/src/sgml/datatype.sgml +++ b/doc/src/sgml/datatype.sgml @@ -1,17 +1,17 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.122 2003/08/09 22:50:21 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.122.2.1 2003/09/07 04:36:40 momjian Exp $ --> <chapter id="datatype"> <title id="datatype-title">Data Types</title> <indexterm zone="datatype"> - <primary>data types</primary> + <primary>data type</primary> </indexterm> <indexterm> - <primary>types</primary> - <see>data types</see> + <primary>type</primary> + <see>data type</see> </indexterm> <para> @@ -279,68 +279,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.122 2003/08/09 22:50:21 t <title>Numeric Types</title> <indexterm zone="datatype-numeric"> - <primary>data types</primary> + <primary>data type</primary> <secondary>numeric</secondary> </indexterm> - <indexterm zone="datatype-numeric"> - <primary>integer</primary> - </indexterm> - - <indexterm zone="datatype-numeric"> - <primary>smallint</primary> - </indexterm> - - <indexterm zone="datatype-numeric"> - <primary>bigint</primary> - </indexterm> - - <indexterm> - <primary>int4</primary> - <see>integer</see> - </indexterm> - - <indexterm> - <primary>int2</primary> - <see>smallint</see> - </indexterm> - - <indexterm> - <primary>int8</primary> - <see>bigint</see> - </indexterm> - - <indexterm zone="datatype-numeric"> - <primary>numeric (data type)</primary> - </indexterm> - - <indexterm> - <primary>decimal</primary> - <see>numeric</see> - </indexterm> - - <indexterm zone="datatype-numeric"> - <primary>real</primary> - </indexterm> - - <indexterm zone="datatype-numeric"> - <primary>double precision</primary> - </indexterm> - - <indexterm> - <primary>float4</primary> - <see>real</see> - </indexterm> - - <indexterm> - <primary>float8</primary> - <see>double precision</see> - </indexterm> - - <indexterm zone="datatype-numeric"> - <primary>floating point</primary> - </indexterm> - <para> Numeric types consist of two-, four-, and eight-byte integers, four- and eight-byte floating-point numbers, and fixed-precision @@ -434,6 +376,33 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.122 2003/08/09 22:50:21 t <sect2 id="datatype-int"> <title>Integer Types</title> + <indexterm zone="datatype-int"> + <primary>integer</primary> + </indexterm> + + <indexterm zone="datatype-int"> + <primary>smallint</primary> + </indexterm> + + <indexterm zone="datatype-int"> + <primary>bigint</primary> + </indexterm> + + <indexterm> + <primary>int4</primary> + <see>integer</see> + </indexterm> + + <indexterm> + <primary>int2</primary> + <see>smallint</see> + </indexterm> + + <indexterm> + <primary>int8</primary> + <see>bigint</see> + </indexterm> + <para> The types <type>smallint</type>, <type>integer</type>, and <type>bigint</type> store whole numbers, that is, numbers without @@ -495,6 +464,15 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datatype.sgml,v 1.122 2003/08/09 22:50:21 t <sect2 id="datatype-numeric-decimal"> <title>Arbitrary Precision Numbers</title> + <indexterm zone="datatype-numeric-decimal"> + <primary>numeric (data type)</primary> + </indexterm> + + <indexterm> + <primary>decimal</primary> + <see>numeric</see> + </indexterm> + <para> The type <type>numeric</type> can store numbers with up to 1000 digits of precision and perform calculations exactly. It is @@ -562,6 +540,28 @@ NUMERIC <sect2 id="datatype-float"> <title>Floating-Point Types</title> + <indexterm zone="datatype-float"> + <primary>real</primary> + </indexterm> + + <indexterm zone="datatype-float"> + <primary>double precision</primary> + </indexterm> + + <indexterm> + <primary>float4</primary> + <see>real</see> + </indexterm> + + <indexterm> + <primary>float8</primary> + <see>double precision</see> + </indexterm> + + <indexterm zone="datatype-float"> + <primary>floating point</primary> + </indexterm> + <para> The data types <type>real</type> and <type>double precision</type> are inexact, variable-precision numeric types. @@ -675,7 +675,7 @@ NUMERIC </indexterm> <indexterm> - <primary>sequences</primary> + <primary>sequence</primary> <secondary>and serial type</secondary> </indexterm> @@ -807,18 +807,33 @@ CREATE TABLE <replaceable class="parameter">tablename</replaceable> ( <title>Character Types</title> <indexterm zone="datatype-character"> - <primary>character strings</primary> + <primary>character string</primary> <secondary>data types</secondary> </indexterm> <indexterm> - <primary>strings</primary> - <see>character strings</see> + <primary>string</primary> + <see>character string</see> </indexterm> - <indexterm> + <indexterm zone="datatype-character"> + <primary>character</primary> + </indexterm> + + <indexterm zone="datatype-character"> + <primary>character varying</primary> + </indexterm> + + <indexterm zone="datatype-character"> <primary>text</primary> - <see>character strings</see> + </indexterm> + + <indexterm zone="datatype-character"> + <primary>char</primary> + </indexterm> + + <indexterm zone="datatype-character"> + <primary>varchar</primary> </indexterm> <table id="datatype-character-table"> @@ -1020,6 +1035,15 @@ SELECT b, char_length(b) FROM test2; <sect1 id="datatype-binary"> <title>Binary Data Types</title> + + <indexterm zone="datatype-binary"> + <primary>binary data</primary> + </indexterm> + + <indexterm zone="datatype-binary"> + <primary>bytea</primary> + </indexterm> + <para> The <type>bytea</type> data type allows storage of binary strings; see <xref linkend="datatype-binary-table">. @@ -1210,6 +1234,34 @@ SELECT b, char_length(b) FROM test2; <sect1 id="datatype-datetime"> <title>Date/Time Types</title> + <indexterm zone="datatype-datetime"> + <primary>date</primary> + </indexterm> + <indexterm zone="datatype-datetime"> + <primary>time</primary> + </indexterm> + <indexterm zone="datatype-datetime"> + <primary>time without time zone</primary> + </indexterm> + <indexterm zone="datatype-datetime"> + <primary>time with time zone</primary> + </indexterm> + <indexterm zone="datatype-datetime"> + <primary>timestamp</primary> + </indexterm> + <indexterm zone="datatype-datetime"> + <primary>timestamp with time zone</primary> + </indexterm> + <indexterm zone="datatype-datetime"> + <primary>timestamp without time zone</primary> + </indexterm> + <indexterm zone="datatype-datetime"> + <primary>interval</primary> + </indexterm> + <indexterm zone="datatype-datetime"> + <primary>time span</primary> + </indexterm> + <para> <productname>PostgreSQL</productname> supports the full set of <acronym>SQL</acronym> date and time types, shown in <xref @@ -1387,7 +1439,6 @@ SELECT b, char_length(b) FROM test2; <indexterm> <primary>date</primary> - <secondary>data type</secondary> </indexterm> <para> @@ -1461,15 +1512,12 @@ SELECT b, char_length(b) FROM test2; <indexterm> <primary>time</primary> - <secondary>data type</secondary> </indexterm> <indexterm> <primary>time without time zone</primary> - <secondary>time</secondary> </indexterm> <indexterm> <primary>time with time zone</primary> - <secondary>data type</secondary> </indexterm> <para> @@ -1587,17 +1635,14 @@ SELECT b, char_length(b) FROM test2; <indexterm> <primary>timestamp</primary> - <secondary>data type</secondary> </indexterm> <indexterm> <primary>timestamp with time zone</primary> - <secondary>data type</secondary> </indexterm> <indexterm> <primary>timestamp without time zone</primary> - <secondary>data type</secondary> </indexterm> <para> @@ -1797,13 +1842,13 @@ January 8 04:05:06 1999 PST <indexterm> <primary>date</primary> <secondary>output format</secondary> - <seealso>Formatting</seealso> + <seealso>formatting</seealso> </indexterm> <indexterm> <primary>time</primary> <secondary>output format</secondary> - <seealso>Formatting</seealso> + <seealso>formatting</seealso> </indexterm> <para> @@ -1924,7 +1969,7 @@ January 8 04:05:06 1999 PST <title>Time Zones</title> <indexterm zone="datatype-timezones"> - <primary>time zones</primary> + <primary>time zone</primary> </indexterm> <para> @@ -2265,7 +2310,11 @@ SELECT * FROM test1 WHERE a; <title>Line Segments</title> <indexterm> - <primary>line</primary> + <primary>lseg</primary> + </indexterm> + + <indexterm> + <primary>line segment</primary> </indexterm> <para> @@ -2293,6 +2342,10 @@ SELECT * FROM test1 WHERE a; <primary>box (data type)</primary> </indexterm> + <indexterm> + <primary>rectangle</primary> + </indexterm> + <para> Boxes are represented by pairs of points that are opposite corners of the box. @@ -2431,7 +2484,7 @@ SELECT * FROM test1 WHERE a; <indexterm zone="datatype-net-types"> <primary>network</primary> - <secondary>addresses</secondary> + <secondary>data types</secondary> </indexterm> <para> @@ -2708,7 +2761,7 @@ SELECT * FROM test1 WHERE a; <title>Bit String Types</title> <indexterm zone="datatype-bit"> - <primary>bit strings</primary> + <primary>bit string</primary> <secondary>data type</secondary> </indexterm> @@ -3046,11 +3099,6 @@ SELECT * FROM test; <tbody> <row> - <entry><type>record</></entry> - <entry>Identifies a function returning an unspecified row type.</entry> - </row> - - <row> <entry><type>any</></entry> <entry>Indicates that a function accepts any input data type whatever.</entry> </row> @@ -3058,23 +3106,24 @@ SELECT * FROM test; <row> <entry><type>anyarray</></entry> <entry>Indicates that a function accepts any array data type - (see <xref linkend="types-polymorphic">).</entry> + (see <xref linkend="extend-types-polymorphic">).</entry> </row> <row> <entry><type>anyelement</></entry> <entry>Indicates that a function accepts any data type - (see <xref linkend="types-polymorphic">).</entry> + (see <xref linkend="extend-types-polymorphic">).</entry> </row> <row> - <entry><type>void</></entry> - <entry>Indicates that a function returns no value.</entry> + <entry><type>cstring</></entry> + <entry>Indicates that a function accepts or returns a null-terminated C string.</entry> </row> <row> - <entry><type>trigger</></entry> - <entry>A trigger function is declared to return <type>trigger.</></entry> + <entry><type>internal</></entry> + <entry>Indicates that a function accepts or returns a server-internal + data type.</entry> </row> <row> @@ -3083,14 +3132,18 @@ SELECT * FROM test; </row> <row> - <entry><type>cstring</></entry> - <entry>Indicates that a function accepts or returns a null-terminated C string.</entry> + <entry><type>record</></entry> + <entry>Identifies a function returning an unspecified row type.</entry> </row> <row> - <entry><type>internal</></entry> - <entry>Indicates that a function accepts or returns a server-internal - data type.</entry> + <entry><type>trigger</></entry> + <entry>A trigger function is declared to return <type>trigger.</></entry> + </row> + + <row> + <entry><type>void</></entry> + <entry>Indicates that a function returns no value.</entry> </row> <row> diff --git a/doc/src/sgml/datetime.sgml b/doc/src/sgml/datetime.sgml index c205ee9c314..9c97f633898 100644 --- a/doc/src/sgml/datetime.sgml +++ b/doc/src/sgml/datetime.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.32 2003/07/29 00:03:17 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.32.2.1 2003/09/07 04:36:41 momjian Exp $ --> <appendix id="datetime-appendix"> @@ -364,7 +364,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.32 2003/07/29 00:03:17 tg </para> <indexterm> - <primary>time zones</primary> + <primary>time zone</primary> + <secondary>abbreviations</secondary> </indexterm> <para> @@ -536,18 +537,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.32 2003/07/29 00:03:17 tg <entry>+07:00</entry> <entry>Christmas (Island) Time</entry> </row> -<!-- - Conflicts with China Coastal Time - <row> - <entry>CCT</entry> - <entry>+06:30</entry> - <entry>Cocos Island Time</entry> - </row> ---> <row> <entry>MMT</entry> <entry>+06:30</entry> - <entry>Myannar Time</entry> + <entry>Myanmar Time</entry> </row> <row> <entry>ALMT</entry> @@ -760,6 +753,21 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.32 2003/07/29 00:03:17 tg <entry>West Africa Time</entry> </row> <row> + <entry>FNST</entry> + <entry>-01:00</entry> + <entry>Fernando de Noronha Summer Time</entry> + </row> + <row> + <entry>FNT</entry> + <entry>-02:00</entry> + <entry>Fernando de Noronha Time</entry> + </row> + <row> + <entry>BRST</entry> + <entry>-02:00</entry> + <entry>Brasilia Summer Time</entry> + </row> + <row> <entry>NDT</entry> <entry>-02:30</entry> <entry>Newfoundland Daylight-Saving Time</entry> @@ -775,6 +783,11 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.32 2003/07/29 00:03:17 tg <entry>(unknown)</entry> </row> <row> + <entry>BRT</entry> + <entry>-03:00</entry> + <entry>Brasilia Time</entry> + </row> + <row> <entry>NFT</entry> <entry>-03:30</entry> <entry>Newfoundland Standard Time</entry> @@ -795,11 +808,6 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.32 2003/07/29 00:03:17 tg <entry>Atlantic/Porto Acre Summer Time</entry> </row> <row> - <entry>ACT</entry> - <entry>-05:00</entry> - <entry>Atlantic/Porto Acre Standard Time</entry> - </row> - <row> <entry>EDT</entry> <entry>-04:00</entry> <entry>Eastern Daylight-Saving Time</entry> @@ -812,6 +820,11 @@ $Header: /cvsroot/pgsql/doc/src/sgml/datetime.sgml,v 2.32 2003/07/29 00:03:17 tg </row> --> <row> + <entry>ACT</entry> + <entry>-05:00</entry> + <entry>Atlantic/Porto Acre Standard Time</entry> + </row> + <row> <entry>CDT</entry> <entry>-05:00</entry> <entry>Central Daylight-Saving Time</entry> diff --git a/doc/src/sgml/ddl.sgml b/doc/src/sgml/ddl.sgml index fc6cdc331c2..183a8f790d3 100644 --- a/doc/src/sgml/ddl.sgml +++ b/doc/src/sgml/ddl.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.17 2003/08/14 23:13:27 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.17.2.1 2003/09/07 04:36:41 momjian Exp $ --> <chapter id="ddl"> <title>Data Definition</title> @@ -19,6 +19,18 @@ <sect1 id="ddl-basics"> <title>Table Basics</title> + <indexterm zone="ddl-basics"> + <primary>table</primary> + </indexterm> + + <indexterm> + <primary>row</primary> + </indexterm> + + <indexterm> + <primary>column</primary> + </indexterm> + <para> A table in a relational database is much like a table on paper: It consists of rows and columns. The number and order of the columns @@ -60,6 +72,11 @@ containing both date and time. </para> + <indexterm> + <primary>table</primary> + <secondary>creating</secondary> + </indexterm> + <para> To create a table, you use the aptly named <literal>CREATE TABLE</literal> command. In this command you specify at least a @@ -114,6 +131,11 @@ CREATE TABLE products ( highly unusual and often a questionable design. </para> + <indexterm> + <primary>table</primary> + <secondary>removing</secondary> + </indexterm> + <para> If you no longer need a table, you can remove it using the <command>DROP TABLE</command> command. For example: @@ -156,8 +178,8 @@ DROP TABLE products; </para> <indexterm> - <primary>columns</primary> - <secondary>system columns</secondary> + <primary>column</primary> + <secondary>system column</secondary> </indexterm> <variablelist> @@ -167,6 +189,7 @@ DROP TABLE products; <para> <indexterm> <primary>OID</primary> + <secondary>column</secondary> </indexterm> The object identifier (object ID) of a row. This is a serial number that is automatically added by @@ -182,6 +205,10 @@ DROP TABLE products; <varlistentry> <term><structfield>tableoid</></term> <listitem> + <indexterm> + <primary>tableoid</primary> + </indexterm> + <para> The OID of the table containing this row. This column is particularly handy for queries that select from inheritance @@ -197,6 +224,10 @@ DROP TABLE products; <varlistentry> <term><structfield>xmin</></term> <listitem> + <indexterm> + <primary>xmin</primary> + </indexterm> + <para> The identity (transaction ID) of the inserting transaction for this tuple. (Note: In this context, a tuple is an individual @@ -209,6 +240,10 @@ DROP TABLE products; <varlistentry> <term><structfield>cmin</></term> <listitem> + <indexterm> + <primary>cmin</primary> + </indexterm> + <para> The command identifier (starting at zero) within the inserting transaction. @@ -219,6 +254,10 @@ DROP TABLE products; <varlistentry> <term><structfield>xmax</></term> <listitem> + <indexterm> + <primary>xmax</primary> + </indexterm> + <para> The identity (transaction ID) of the deleting transaction, or zero for an undeleted tuple. It is possible for this column to @@ -232,6 +271,10 @@ DROP TABLE products; <varlistentry> <term><structfield>cmax</></term> <listitem> + <indexterm> + <primary>cmax</primary> + </indexterm> + <para> The command identifier within the deleting transaction, or zero. </para> @@ -241,6 +284,10 @@ DROP TABLE products; <varlistentry> <term><structfield>ctid</></term> <listitem> + <indexterm> + <primary>ctid</primary> + </indexterm> + <para> The physical location of the tuple within its table. Note that although the <structfield>ctid</structfield> can be used to @@ -292,6 +339,10 @@ DROP TABLE products; <sect1 id="ddl-default"> <title>Default Values</title> + <indexterm zone="ddl-default"> + <primary>default value</primary> + </indexterm> + <para> A column can be assigned a default value. When a new row is created and no values are specified for some of the columns, the @@ -302,6 +353,7 @@ DROP TABLE products; </para> <para> + <indexterm><primary>null value</primary><secondary>default value</secondary></indexterm> If no default value is declared explicitly, the null value is the default value. This usually makes sense because a null value can be thought to represent unknown data. @@ -329,6 +381,10 @@ CREATE TABLE products ( <sect1 id="ddl-constraints"> <title>Constraints</title> + <indexterm zone="ddl-constraints"> + <primary>constraint</primary> + </indexterm> + <para> Data types are a way to limit the kind of data that can be stored in a table. For many applications, however, the constraint they @@ -351,6 +407,15 @@ CREATE TABLE products ( <sect2> <title>Check Constraints</title> + <indexterm> + <primary>check constraint</primary> + </indexterm> + + <indexterm> + <primary>constraint</primary> + <secondary>check</secondary> + </indexterm> + <para> A check constraint is the most generic constraint type. It allows you to specify that the value in a certain column must satisfy an @@ -375,6 +440,11 @@ CREATE TABLE products ( would not make too much sense. </para> + <indexterm> + <primary>constraint</primary> + <secondary>name</secondary> + </indexterm> + <para> You can also give the constraint a separate name. This clarifies error messages and allows you to refer to the constraint when you @@ -444,6 +514,11 @@ CREATE TABLE products ( It's a matter of taste. </para> + <indexterm> + <primary>null value</primary> + <secondary sortas="check constraints">with check constraints</secondary> + </indexterm> + <para> It should be noted that a check constraint is satisfied if the check expression evaluates to true or the null value. Since most @@ -457,6 +532,15 @@ CREATE TABLE products ( <sect2> <title>Not-Null Constraints</title> + <indexterm> + <primary>not-null constraint</primary> + </indexterm> + + <indexterm> + <primary>constraint</primary> + <secondary>NOT NULL</secondary> + </indexterm> + <para> A not-null constraint simply specifies that a column must not assume the null value. A syntax example: @@ -526,6 +610,15 @@ CREATE TABLE products ( <sect2> <title>Unique Constraints</title> + <indexterm> + <primary>unique constraint</primary> + </indexterm> + + <indexterm> + <primary>constraint</primary> + <secondary>unique</secondary> + </indexterm> + <para> Unique constraints ensure that the data contained in a column or a group of columns is unique with respect to all the rows in the @@ -573,6 +666,11 @@ CREATE TABLE products ( </programlisting> </para> + <indexterm> + <primary>null value</primary> + <secondary sortas="unique constraints">with unique constraints</secondary> + </indexterm> + <para> In general, a unique constraint is violated when there are (at least) two rows in the table where the values of each of the @@ -591,6 +689,15 @@ CREATE TABLE products ( <sect2> <title>Primary Keys</title> + <indexterm> + <primary>primary key</primary> + </indexterm> + + <indexterm> + <primary>constraint</primary> + <secondary>primary key</secondary> + </indexterm> + <para> Technically, a primary key constraint is simply a combination of a unique constraint and a not-null constraint. So, the following @@ -649,6 +756,19 @@ CREATE TABLE example ( <sect2 id="ddl-constraints-fk"> <title>Foreign Keys</title> + <indexterm> + <primary>foreign key</primary> + </indexterm> + + <indexterm> + <primary>constraint</primary> + <secondary>foreign key</secondary> + </indexterm> + + <indexterm> + <primary>referential integrity</primary> + </indexterm> + <para> A foreign key constraint specifies that the values in a column (or a group of columns) must match the values appearing in some row @@ -749,6 +869,16 @@ CREATE TABLE order_items ( the last table. </para> + <indexterm> + <primary>CASCADE</primary> + <secondary>foreign key action</secondary> + </indexterm> + + <indexterm> + <primary>RESTRICT</primary> + <secondary>foreign key action</secondary> + </indexterm> + <para> We know that the foreign keys disallow creation of orders that do not relate to any products. But what if a product is removed @@ -998,6 +1128,11 @@ SET SQL_Inheritance TO OFF; <sect1 id="ddl-alter"> <title>Modifying Tables</title> + <indexterm zone="ddl-alter"> + <primary>table</primary> + <secondary>modifying</secondary> + </indexterm> + <para> When you create a table and you realize that you made a mistake, or the requirements of the application changed, then you can drop the @@ -1042,6 +1177,11 @@ SET SQL_Inheritance TO OFF; <sect2> <title>Adding a Column</title> + <indexterm> + <primary>column</primary> + <secondary>adding</secondary> + </indexterm> + <para> To add a column, use this command: <programlisting> @@ -1070,6 +1210,11 @@ ALTER TABLE products ADD COLUMN description text CHECK (description <> '') <sect2> <title>Removing a Column</title> + <indexterm> + <primary>column</primary> + <secondary>removing</secondary> + </indexterm> + <para> To remove a column, use this command: <programlisting> @@ -1081,6 +1226,11 @@ ALTER TABLE products DROP COLUMN description; <sect2> <title>Adding a Constraint</title> + <indexterm> + <primary>constraint</primary> + <secondary>adding</secondary> + </indexterm> + <para> To add a constraint, the table constraint syntax is used. For example: <programlisting> @@ -1104,6 +1254,11 @@ ALTER TABLE products ALTER COLUMN product_no SET NOT NULL; <sect2> <title>Removing a Constraint</title> + <indexterm> + <primary>constraint</primary> + <secondary>removing</secondary> + </indexterm> + <para> To remove a constraint you need to know its name. If you gave it a name then that's easy. Otherwise the system assigned a @@ -1127,6 +1282,11 @@ ALTER TABLE products ALTER COLUMN product_no DROP NOT NULL; <sect2> <title>Changing the Default</title> + <indexterm> + <primary>default value</primary> + <secondary>changing</secondary> + </indexterm> + <para> To set a new default for a column, use a command like this: <programlisting> @@ -1146,6 +1306,11 @@ ALTER TABLE products ALTER COLUMN price DROP DEFAULT; <sect2> <title>Renaming a Column</title> + <indexterm> + <primary>column</primary> + <secondary>renaming</secondary> + </indexterm> + <para> To rename a column: <programlisting> @@ -1157,6 +1322,11 @@ ALTER TABLE products RENAME COLUMN product_no TO product_number; <sect2> <title>Renaming a Table</title> + <indexterm> + <primary>table</primary> + <secondary>renaming</secondary> + </indexterm> + <para> To rename a table: <programlisting> @@ -1169,6 +1339,15 @@ ALTER TABLE products RENAME TO items; <sect1 id="ddl-priv"> <title>Privileges</title> + <indexterm zone="ddl-priv"> + <primary>privilege</primary> + </indexterm> + + <indexterm> + <primary>permission</primary> + <see>privilege</see> + </indexterm> + <para> When you create a database object, you become its owner. By default, only the owner of an object can do anything with the @@ -1241,12 +1420,8 @@ REVOKE ALL ON accounts FROM PUBLIC; <sect1 id="ddl-schemas"> <title>Schemas</title> - <indexterm> - <primary>schemas</primary> - </indexterm> - - <indexterm> - <primary>namespaces</primary> + <indexterm zone="ddl-schemas"> + <primary>schema</primary> </indexterm> <para> @@ -1313,6 +1488,11 @@ REVOKE ALL ON accounts FROM PUBLIC; <sect2 id="ddl-schemas-create"> <title>Creating a Schema</title> + <indexterm zone="ddl-schemas-create"> + <primary>schema</primary> + <secondary>creating</secondary> + </indexterm> + <para> To create a separate schema, use the command <literal>CREATE SCHEMA</literal>. Give the schema a name of your choice. For @@ -1323,11 +1503,11 @@ CREATE SCHEMA myschema; </para> <indexterm> - <primary>qualified names</primary> + <primary>qualified name</primary> </indexterm> <indexterm> - <primary>names</primary> + <primary>name</primary> <secondary>qualified</secondary> </indexterm> @@ -1359,6 +1539,11 @@ CREATE TABLE myschema.mytable ( the following chapters. </para> + <indexterm> + <primary>schema</primary> + <secondary>removing</secondary> + </indexterm> + <para> To drop a schema if it's empty (all objects in it have been dropped), use @@ -1394,6 +1579,11 @@ CREATE SCHEMA <replaceable>schemaname</replaceable> AUTHORIZATION <replaceable>u <sect2 id="ddl-schemas-public"> <title>The Public Schema</title> + <indexterm zone="ddl-schemas-public"> + <primary>schema</primary> + <secondary>public</secondary> + </indexterm> + <para> In the previous sections we created tables without specifying any schema names. By default, such tables (and other objects) are @@ -1417,11 +1607,11 @@ CREATE TABLE public.products ( ... ); </indexterm> <indexterm> - <primary>unqualified names</primary> + <primary>unqualified name</primary> </indexterm> <indexterm> - <primary>names</primary> + <primary>name</primary> <secondary>unqualified</secondary> </indexterm> @@ -1437,6 +1627,11 @@ CREATE TABLE public.products ( ... ); in other schemas in the database. </para> + <indexterm> + <primary>schema</primary> + <secondary>current</secondary> + </indexterm> + <para> The first schema named in the search path is called the current schema. Aside from being the first schema searched, it is also the schema in @@ -1444,6 +1639,10 @@ CREATE TABLE public.products ( ... ); command does not specify a schema name. </para> + <indexterm> + <primary>search_path</primary> + </indexterm> + <para> To show the current search path, use the following command: <programlisting> @@ -1523,6 +1722,11 @@ SELECT 3 OPERATOR(pg_catalog.+) 4; <sect2 id="ddl-schemas-priv"> <title>Schemas and Privileges</title> + <indexterm zone="ddl-schemas-priv"> + <primary>privilege</primary> + <secondary sortas="schemas">for schemas</secondary> + </indexterm> + <para> By default, users cannot see the objects in schemas they do not own. To allow that, the owner of the schema needs to grant the @@ -1550,9 +1754,14 @@ REVOKE CREATE ON SCHEMA public FROM PUBLIC; </para> </sect2> - <sect2> + <sect2 id="ddl-schemas-catalog"> <title>The System Catalog Schema</title> + <indexterm zone="ddl-schemas-catalog"> + <primary>system catalog</primary> + <secondary>schema</secondary> + </indexterm> + <para> In addition to <literal>public</> and user-created schemas, each database contains a <literal>pg_catalog</> schema, which contains @@ -1701,6 +1910,16 @@ REVOKE CREATE ON SCHEMA public FROM PUBLIC; <sect1 id="ddl-depend"> <title>Dependency Tracking</title> + <indexterm zone="ddl-depend"> + <primary>CASCADE</primary> + <secondary sortas="DROP">with DROP</secondary> + </indexterm> + + <indexterm zone="ddl-depend"> + <primary>RESTRICT</primary> + <secondary sortas="DROP">with DROP</secondary> + </indexterm> + <para> When you create complex database structures involving many tables with foreign key constraints, views, triggers, functions, etc. you diff --git a/doc/src/sgml/dfunc.sgml b/doc/src/sgml/dfunc.sgml index 3898a2bc176..57fb6f208f3 100644 --- a/doc/src/sgml/dfunc.sgml +++ b/doc/src/sgml/dfunc.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.25 2003/04/10 01:22:44 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.25.2.1 2003/09/07 04:36:41 momjian Exp $ --> <sect2 id="dfunc"> @@ -8,9 +8,11 @@ $Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.25 2003/04/10 01:22:44 peter <para> Before you are able to use your <productname>PostgreSQL</productname> extension functions written in - C, they must be compiled and linked in a special way to produce a file - that can be dynamically loaded by the server. To be - precise, a <firstterm>shared library</firstterm> needs to be created. + C, they must be compiled and linked in a special way to produce a + file that can be dynamically loaded by the server. To be precise, a + <firstterm>shared library</firstterm> needs to be + created.<indexterm><primary>shared library</></indexterm> + </para> <para> @@ -26,17 +28,18 @@ $Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.25 2003/04/10 01:22:44 peter </para> <para> - <indexterm><primary>PIC</></> - Creating shared libraries is generally analogous to linking - executables: first the source files are compiled into object files, - then the object files are linked together. The object files need to - be created as <firstterm>position-independent code</firstterm> - (<acronym>PIC</acronym>), which conceptually means that they can be - placed at an arbitrary location in memory when they are loaded by the - executable. (Object files intended for executables are usually not compiled - that way.) The command to link a shared library contains special - flags to distinguish it from linking an executable. --- At least - this is the theory. On some systems the practice is much uglier. + <indexterm><primary>PIC</></> Creating shared libraries is generally + analogous to linking executables: first the source files are + compiled into object files, then the object files are linked + together. The object files need to be created as + <firstterm>position-independent code</firstterm> + (<acronym>PIC</acronym>),<indexterm><primary>PIC</></> which + conceptually means that they can be placed at an arbitrary location + in memory when they are loaded by the executable. (Object files + intended for executables are usually not compiled that way.) The + command to link a shared library contains special flags to + distinguish it from linking an executable. --- At least this is the + theory. On some systems the practice is much uglier. </para> <para> @@ -57,7 +60,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.25 2003/04/10 01:22:44 peter <variablelist> <varlistentry> <term><systemitem class="osname">BSD/OS</></term> - <indexterm><primary>BSD/OS</></> + <indexterm><primary>BSD/OS</><secondary>shared library</></> <listitem> <para> The compiler flag to create <acronym>PIC</acronym> is @@ -75,7 +78,7 @@ ld -shared -o foo.so foo.o <varlistentry> <term><systemitem class="osname">FreeBSD</></term> - <indexterm><primary>FreeBSD</></> + <indexterm><primary>FreeBSD</><secondary>shared library</></> <listitem> <para> The compiler flag to create <acronym>PIC</acronym> is @@ -93,7 +96,7 @@ gcc -shared -o foo.so foo.o <varlistentry> <term><systemitem class="osname">HP-UX</></term> - <indexterm><primary>HP-UX</></> + <indexterm><primary>HP-UX</><secondary>shared library</></> <listitem> <para> The compiler flag of the system compiler to create @@ -120,7 +123,7 @@ ld -b -o foo.sl foo.o <varlistentry> <term><systemitem class="osname">IRIX</></term> - <indexterm><primary>IRIX</></> + <indexterm><primary>IRIX</><secondary>shared library</></> <listitem> <para> <acronym>PIC</acronym> is the default, no special compiler @@ -136,7 +139,7 @@ ld -shared -o foo.so foo.o <varlistentry> <term><systemitem class="osname">Linux</></term> - <indexterm><primary>Linux</></> + <indexterm><primary>Linux</><secondary>shared library</></> <listitem> <para> The compiler flag to create <acronym>PIC</acronym> is @@ -155,7 +158,7 @@ cc -shared -o foo.so foo.o <varlistentry> <term><systemitem class="osname">MacOS X</></term> - <indexterm><primary>MacOS X</></> + <indexterm><primary>MacOS X</><secondary>shared library</></> <listitem> <para> Here is an example. It assumes the developer tools are installed. @@ -169,7 +172,7 @@ cc -bundle -flat_namespace -undefined suppress -o foo.so foo.o <varlistentry> <term><systemitem class="osname">NetBSD</></term> - <indexterm><primary>NetBSD</></> + <indexterm><primary>NetBSD</><secondary>shared library</></> <listitem> <para> The compiler flag to create <acronym>PIC</acronym> is @@ -187,7 +190,7 @@ gcc -shared -o foo.so foo.o <varlistentry> <term><systemitem class="osname">OpenBSD</></term> - <indexterm><primary>OpenBSD</></> + <indexterm><primary>OpenBSD</><secondary>shared library</></> <listitem> <para> The compiler flag to create <acronym>PIC</acronym> is @@ -203,7 +206,7 @@ ld -Bshareable -o foo.so foo.o <varlistentry> <term><systemitem class="osname">Solaris</></term> - <indexterm><primary>Solaris</></> + <indexterm><primary>Solaris</><secondary>shared library</></> <listitem> <para> The compiler flag to create <acronym>PIC</acronym> is @@ -227,7 +230,7 @@ gcc -G -o foo.so foo.o <varlistentry> <term><systemitem class="osname">Tru64 UNIX</></term> - <indexterm><primary>Tru64 UNIX</></> + <indexterm><primary>Tru64 UNIX</><secondary>shared library</></> <indexterm><primary>Digital UNIX</><see>Tru64 UNIX</></> <listitem> <para> @@ -246,7 +249,7 @@ ld -shared -expect_unresolved '*' -o foo.so foo.o <varlistentry> <term><systemitem class="osname">UnixWare</></term> - <indexterm><primary>UnixWare</></> + <indexterm><primary>UnixWare</><secondary>shared library</></> <listitem> <para> The compiler flag to create <acronym>PIC</acronym> is <option>-K diff --git a/doc/src/sgml/dml.sgml b/doc/src/sgml/dml.sgml index 6476fcf14ab..4f9343cce98 100644 --- a/doc/src/sgml/dml.sgml +++ b/doc/src/sgml/dml.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/dml.sgml,v 1.5 2003/08/10 01:20:34 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/dml.sgml,v 1.5.2.1 2003/09/07 04:36:41 momjian Exp $ --> <chapter id="dml"> <title>Data Manipulation</title> @@ -20,6 +20,14 @@ <sect1 id="dml-insert"> <title>Inserting Data</title> + <indexterm zone="dml-insert"> + <primary>inserting</primary> + </indexterm> + + <indexterm zone="dml-insert"> + <primary>INSERT</primary> + </indexterm> + <para> When a table is created, it contains no data. The first thing to do before a database can be of much use is to insert data. Data is @@ -98,6 +106,14 @@ INSERT INTO products DEFAULT VALUES; <sect1 id="dml-update"> <title>Updating Data</title> + <indexterm zone="dml-update"> + <primary>updating</primary> + </indexterm> + + <indexterm zone="dml-update"> + <primary>UPDATE</primary> + </indexterm> + <para> The modification of data that is already in the database is referred to as updating. You can update individual rows, all the @@ -182,6 +198,14 @@ UPDATE mytable SET a = 5, b = 3, c = 1 WHERE a > 0; <sect1 id="dml-delete"> <title>Deleting Data</title> + <indexterm zone="dml-delete"> + <primary>deleting</primary> + </indexterm> + + <indexterm zone="dml-delete"> + <primary>DELETE</primary> + </indexterm> + <para> So far we have explained how to add data to tables and how to change data. What remains is to discuss how to remove data that is diff --git a/doc/src/sgml/ecpg.sgml b/doc/src/sgml/ecpg.sgml index c26b10ab0e3..4c9fb206290 100644 --- a/doc/src/sgml/ecpg.sgml +++ b/doc/src/sgml/ecpg.sgml @@ -1,11 +1,13 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.48 2003/08/07 04:17:21 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.48.2.1 2003/09/07 04:36:41 momjian Exp $ --> <chapter id="ecpg"> <title><application>ECPG</application> - Embedded <acronym>SQL</acronym> in C</title> <indexterm zone="ecpg"><primary>embedded SQL</primary><secondary>in C</secondary></indexterm> + <indexterm zone="ecpg"><primary>C</primary></indexterm> + <indexterm zone="ecpg"><primary>ECPG</primary></indexterm> <para> This chapter describes the embedded <acronym>SQL</acronym> package diff --git a/doc/src/sgml/extend.sgml b/doc/src/sgml/extend.sgml index 7d0f65f0679..f8e0ec08ac3 100644 --- a/doc/src/sgml/extend.sgml +++ b/doc/src/sgml/extend.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.23 2003/08/09 22:50:21 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.23.2.1 2003/09/07 04:36:41 momjian Exp $ --> <chapter id="extend"> @@ -80,16 +80,25 @@ $Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.23 2003/08/09 22:50:21 tgl </para> </sect1> - <sect1 id="type-system"> + <sect1 id="extend-type-system"> <title>The <productname>PostgreSQL</productname> Type System</title> - <indexterm zone="type-system"> - <primary>extending SQL</primary> - <secondary>types</secondary> + <indexterm zone="extend-type-system"> + <primary>base type</primary> + </indexterm> + + <indexterm zone="extend-type-system"> + <primary>data type</primary> + <secondary>base</secondary> + </indexterm> + + <indexterm zone="extend-type-system"> + <primary>composite type</primary> </indexterm> - <indexterm zone="type-system"> - <primary>data types</primary> + <indexterm zone="extend-type-system"> + <primary>data type</primary> + <secondary>composite</secondary> </indexterm> <para> @@ -138,15 +147,25 @@ $Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.23 2003/08/09 22:50:21 tgl pseudo-types. </para> - <sect2 id="types-polymorphic"> + <sect2 id="extend-types-polymorphic"> <title>Polymorphic Types and Functions</title> - <indexterm> - <primary>polymorphic types</primary> + <indexterm zone="extend-types-polymorphic"> + <primary>polymorphic type</primary> + </indexterm> + + <indexterm zone="extend-types-polymorphic"> + <primary>polymorphic function</primary> + </indexterm> + + <indexterm zone="extend-types-polymorphic"> + <primary>type</primary> + <secondary>polymorphic</secondary> </indexterm> - <indexterm> - <primary>polymorphic functions</primary> + <indexterm zone="extend-types-polymorphic"> + <primary>function</primary> + <secondary>polymorphic</secondary> </indexterm> <para> diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml index 4ba2bd9e51a..888220d8df1 100644 --- a/doc/src/sgml/filelist.sgml +++ b/doc/src/sgml/filelist.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/filelist.sgml,v 1.29 2003/05/18 20:55:56 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/filelist.sgml,v 1.29.2.1 2003/09/07 04:36:41 momjian Exp $ --> <!entity history SYSTEM "history.sgml"> <!entity info SYSTEM "info.sgml"> @@ -68,7 +68,6 @@ <!entity libpgeasy SYSTEM "libpgeasy.sgml"> <!entity libpq SYSTEM "libpq.sgml"> <!entity libpgtcl SYSTEM "libpgtcl.sgml"> -<!entity pygresql SYSTEM "pygresql.sgml"> <!entity lobj SYSTEM "lobj.sgml"> <!entity odbc SYSTEM "odbc.sgml"> <!entity rules SYSTEM "rules.sgml"> diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 6729dc677e8..59dd23c2efa 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/func.sgml,v 1.166 2003/08/10 01:20:34 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/func.sgml,v 1.166.2.1 2003/09/07 04:36:41 momjian Exp $ PostgreSQL documentation --> @@ -7,11 +7,11 @@ PostgreSQL documentation <title>Functions and Operators</title> <indexterm zone="functions"> - <primary>functions</primary> + <primary>function</primary> </indexterm> <indexterm zone="functions"> - <primary>operators</primary> + <primary>operator</primary> </indexterm> <para> @@ -40,7 +40,7 @@ PostgreSQL documentation <title>Logical Operators</title> <indexterm zone="functions-logical"> - <primary>operators</primary> + <primary>operator</primary> <secondary>logical</secondary> </indexterm> @@ -54,18 +54,27 @@ PostgreSQL documentation The usual logical operators are available: <indexterm> - <primary>and</primary> - <secondary>operator</secondary> + <primary>AND (operator)</primary> </indexterm> <indexterm> - <primary>or</primary> - <secondary>operator</secondary> + <primary>OR (operator)</primary> </indexterm> <indexterm> - <primary>not</primary> - <secondary>operator</secondary> + <primary>NOT (operator)</primary> + </indexterm> + + <indexterm> + <primary>conjunction</primary> + </indexterm> + + <indexterm> + <primary>disjunction</primary> + </indexterm> + + <indexterm> + <primary>negation</primary> </indexterm> <simplelist> @@ -252,7 +261,7 @@ PostgreSQL documentation <primary>between</primary> </indexterm> In addition to the comparison operators, the special - <token>BETWEEN</token> construct is available. + <token>BETWEEN</token> construct is available.<indexterm><primary>BETWEEN</primary></indexterm> <synopsis> <replaceable>a</replaceable> BETWEEN <replaceable>x</replaceable> AND <replaceable>y</replaceable> </synopsis> @@ -284,6 +293,7 @@ PostgreSQL documentation <replaceable>expression</replaceable> ISNULL <replaceable>expression</replaceable> NOTNULL </synopsis> + <indexterm><primary>null value</primary><secondary>comparing</secondary></indexterm> </para> <para> @@ -847,7 +857,7 @@ PostgreSQL documentation <entry> String concatenation <indexterm> - <primary>character strings</primary> + <primary>character string</primary> <secondary>concatenation</secondary> </indexterm> </entry> @@ -869,12 +879,12 @@ PostgreSQL documentation <entry> Number of characters in string <indexterm> - <primary>character strings</primary> + <primary>character string</primary> <secondary>length</secondary> </indexterm> <indexterm> <primary>length</primary> - <secondary>character strings</secondary> + <secondary sortas="character string">of a character string</secondary> <see>character strings, length</see> </indexterm> </entry> @@ -1110,12 +1120,12 @@ PostgreSQL documentation <entry> Number of characters in string <indexterm> - <primary>character strings</primary> + <primary>character string</primary> <secondary>length</secondary> </indexterm> <indexterm> <primary>length</primary> - <secondary>character strings</secondary> + <secondary sortas="character string">of a character string</secondary> <see>character strings, length</see> </indexterm> </entry> @@ -1174,7 +1184,7 @@ PostgreSQL documentation </row> <row> - <entry><literal><function>quote_ident</function>(<parameter>string</parameter> text)</literal></entry> + <entry><literal><function>quote_ident</function>(<parameter>string</parameter> text)</literal><indexterm><primary>quote_ident</></></entry> <entry><type>text</type></entry> <entry> Return the given string suitably quoted to be used as an identifier @@ -1188,7 +1198,7 @@ PostgreSQL documentation </row> <row> - <entry><literal><function>quote_literal</function>(<parameter>string</parameter> text)</literal></entry> + <entry><literal><function>quote_literal</function>(<parameter>string</parameter> text)</literal><indexterm><primary>quote_literal</></></entry> <entry><type>text</type></entry> <entry> Return the given string suitably quoted to be used as a string literal @@ -2055,6 +2065,11 @@ PostgreSQL documentation <sect1 id="functions-binarystring"> <title>Binary String Functions and Operators</title> + <indexterm zone="functions-binarystring"> + <primary>binary data</primary> + <secondary>functions</secondary> + </indexterm> + <para> This section describes functions and operators for examining and manipulating values of type <type>bytea</type>. @@ -2092,7 +2107,7 @@ PostgreSQL documentation <entry> String concatenation <indexterm> - <primary>binary strings</primary> + <primary>binary string</primary> <secondary>concatenation</secondary> </indexterm> </entry> @@ -2243,12 +2258,12 @@ PostgreSQL documentation <entry> Length of binary string <indexterm> - <primary>binary strings</primary> + <primary>binary string</primary> <secondary>length</secondary> </indexterm> <indexterm> <primary>length</primary> - <secondary>binary strings</secondary> + <secondary sortas="binary string">of a binary string</secondary> <see>binary strings, length</see> </indexterm> </entry> @@ -2321,8 +2336,8 @@ PostgreSQL documentation <sect2 id="functions-like"> <title><function>LIKE</function></title> - <indexterm> - <primary>like</primary> + <indexterm zone="functions-like"> + <primary>LIKE</primary> </indexterm> <synopsis> @@ -2420,12 +2435,12 @@ PostgreSQL documentation Regular Expressions</title> <indexterm zone="functions-sql99-regexp"> - <primary>regular expressions</primary> + <primary>regular expression</primary> <!-- <seealso>pattern matching</seealso> breaks index build --> </indexterm> <indexterm> - <primary>similar to</primary> + <primary>SIMILAR TO</primary> </indexterm> <indexterm> @@ -2547,7 +2562,7 @@ substring('foobar' from '#"o_b#"%' for '#') <lineannotation>NULL</lineannotat <title><acronym>POSIX</acronym> Regular Expressions</title> <indexterm zone="functions-posix-regexp"> - <primary>regular expressions</primary> + <primary>regular expression</primary> <seealso>pattern matching</seealso> </indexterm> @@ -3794,6 +3809,10 @@ substring('foobar' from 'o(.)b') <lineannotation>o</lineannotation> <primary>formatting</primary> </indexterm> + <indexterm zone="functions-formatting"> + <primary>to_char</primary> + </indexterm> + <para> The <productname>PostgreSQL</productname> formatting functions provide a powerful set of tools for converting various data types @@ -3871,6 +3890,11 @@ substring('foobar' from 'o(.)b') <lineannotation>o</lineannotation> </table> <para> + Warning. <literal><function>to_char</function>(<type>interval</type>, <type>text</type>)</literal> + is deprecated and should not be used in newly-written code. Will be removed in the next version. + </para> + + <para> In an output template string (for <function>to_char</>), there are certain patterns that are recognized and replaced with appropriately-formatted data from the value to be formatted. Any text that is not a template pattern is simply @@ -5999,7 +6023,7 @@ SELECT TIMESTAMP 'now'; <title>Sequence-Manipulation Functions</title> <indexterm> - <primary>sequences</primary> + <primary>sequence</primary> </indexterm> <indexterm> <primary>nextval</primary> @@ -6162,11 +6186,11 @@ SELECT setval('foo', 42, false); <lineannotation>Next <function>nextval</> wi <title>Conditional Expressions</title> <indexterm> - <primary>case</primary> + <primary>CASE</primary> </indexterm> <indexterm> - <primary>conditionals</primary> + <primary>conditional expression</primary> </indexterm> <para> @@ -6287,8 +6311,12 @@ SELECT a, <sect2> <title><literal>COALESCE</></title> + <indexterm> + <primary>COALESCE</primary> + </indexterm> + <synopsis> -<function>COALESCE</function>(<replaceable>value</replaceable> <optional>, ...</optional>) +<function>coalesce</function>(<replaceable>value</replaceable> <optional>, ...</optional>) </synopsis> <para> @@ -6497,7 +6525,8 @@ SET search_path TO <replaceable>schema</> <optional>, <replaceable>schema</>, .. <indexterm zone="functions-misc"> <primary>configuration</primary> - <secondary>server</secondary> + <secondary sortas="server">of the server</secondary> + <tertiary>functions</tertiary> </indexterm> <para> @@ -6534,6 +6563,11 @@ SELECT set_config('show_statement_stats', 'off', false); </programlisting> </para> + <indexterm> + <primary>privilege</primary> + <secondary>querying</secondary> + </indexterm> + <para> <xref linkend="functions-misc-access-table"> lists functions that allow the user to query object access privileges programmatically. @@ -6966,6 +7000,11 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); <primary>col_description</primary> </indexterm> + <indexterm zone="functions-misc"> + <primary>comment</primary> + <secondary sortas="database objects">about database objects</secondary> + </indexterm> + <para> The function shown in <xref linkend="functions-misc-comment-table"> extract comments @@ -7027,7 +7066,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); <para> <xref linkend="array-operators-table"> shows the operators - available for the <type>array</type> types. + available for <type>array</type> types. </para> <table id="array-operators-table"> @@ -7088,7 +7127,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); <entry> <literal>||</literal> </entry> <entry>array-to-array concatenation</entry> <entry><literal>ARRAY[1,2,3] || ARRAY[4,5,6]</literal></entry> - <entry><literal>{{1,2,3},{4,5,6}}</literal></entry> + <entry><literal>{1,2,3,4,5,6}</literal></entry> </row> <row> @@ -7116,6 +7155,11 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); </table> <para> + See <xref linkend="arrays"> for more details about array operator + behavior. + </para> + + <para> <xref linkend="array-functions-table"> shows the functions available for use with array types. See <xref linkend="arrays"> for more discussion and examples for the use of these functions. @@ -7162,7 +7206,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); for <literal>NULL</literal> inputs </entry> <entry><literal>array_cat(ARRAY[1,2,3], ARRAY[4,5,6])</literal></entry> - <entry><literal>{{1,2,3},{4,5,6}}</literal></entry> + <entry><literal>{1,2,3,4,5,6}</literal></entry> </row> <row> <entry> @@ -7262,6 +7306,11 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); <sect1 id="functions-aggregate"> <title>Aggregate Functions</title> + <indexterm zone="functions-aggregate"> + <primary>aggregate function</primary> + <secondary>built-in</secondary> + </indexterm> + <para> <firstterm>Aggregate functions</firstterm> compute a single result value from a set of input values. <xref @@ -7290,7 +7339,6 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); <entry> <indexterm> <primary>average</primary> - <secondary>function</secondary> </indexterm> <function>avg(<replaceable class="parameter">expression</replaceable>)</function> </entry> @@ -7472,31 +7520,31 @@ SELECT col FROM sometable ORDER BY col ASC LIMIT 1; <title>Subquery Expressions</title> <indexterm> - <primary>exists</primary> + <primary>EXISTS</primary> </indexterm> <indexterm> - <primary>in</primary> + <primary>IN</primary> </indexterm> <indexterm> - <primary>not in</primary> + <primary>NOT IN</primary> </indexterm> <indexterm> - <primary>any</primary> + <primary>ANY</primary> </indexterm> <indexterm> - <primary>all</primary> + <primary>ALL</primary> </indexterm> <indexterm> - <primary>some</primary> + <primary>SOME</primary> </indexterm> <indexterm> - <primary>subqueries</primary> + <primary>subquery</primary> </indexterm> <para> @@ -7798,6 +7846,11 @@ SELECT col1 FROM tab1 <sect2> <title>Row-wise Comparison</title> + <indexterm> + <primary>comparison</primary> + <secondary>of rows</secondary> + </indexterm> + <synopsis> (<replaceable>expression</replaceable> <optional>, <replaceable>expression</replaceable> ...</optional>) <replaceable>operator</replaceable> (<replaceable>subquery</replaceable>) </synopsis> diff --git a/doc/src/sgml/indices.sgml b/doc/src/sgml/indices.sgml index 4e79084e7ec..45166fcdea0 100644 --- a/doc/src/sgml/indices.sgml +++ b/doc/src/sgml/indices.sgml @@ -1,10 +1,10 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/indices.sgml,v 1.42 2003/05/28 16:03:55 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/indices.sgml,v 1.42.2.1 2003/09/07 04:36:41 momjian Exp $ --> <chapter id="indexes"> <title id="indexes-title">Indexes</title> <indexterm zone="indexes"> - <primary>indexes</primary> + <primary>index</primary> </indexterm> <para> @@ -109,12 +109,12 @@ CREATE INDEX test1_id_index ON test1 (id); B-tree, R-tree, GiST, and Hash. Each index type is more appropriate for a particular query type because of the algorithm it uses. <indexterm> - <primary>indexes</primary> + <primary>index</primary> <secondary>B-tree</secondary> </indexterm> <indexterm> <primary>B-tree</primary> - <see>indexes</see> + <see>index</see> </indexterm> By default, the <command>CREATE INDEX</command> command will create a @@ -147,12 +147,12 @@ CREATE INDEX test1_id_index ON test1 (id); <para> <indexterm> - <primary>indexes</primary> + <primary>index</primary> <secondary>R-tree</secondary> </indexterm> <indexterm> <primary>R-tree</primary> - <see>indexes</see> + <see>index</see> </indexterm> R-tree indexes are especially suited for spatial data. To create an R-tree index, use a command of the form @@ -178,12 +178,12 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable> <para> <indexterm> - <primary>indexes</primary> + <primary>index</primary> <secondary>hash</secondary> </indexterm> <indexterm> <primary>hash</primary> - <see>indexes</see> + <see>index</see> </indexterm> The query planner will consider using a hash index whenever an indexed column is involved in a comparison using the @@ -219,7 +219,7 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable> <title>Multicolumn Indexes</title> <indexterm zone="indexes-multicolumn"> - <primary>indexes</primary> + <primary>index</primary> <secondary>multicolumn</secondary> </indexterm> @@ -294,7 +294,7 @@ SELECT name FROM test2 WHERE major = <replaceable>constant</replaceable> OR mino <title>Unique Indexes</title> <indexterm zone="indexes-unique"> - <primary>indexes</primary> + <primary>index</primary> <secondary>unique</secondary> </indexterm> @@ -337,8 +337,8 @@ CREATE UNIQUE INDEX <replaceable>name</replaceable> ON <replaceable>table</repla <title>Indexes on Expressions</title> <indexterm zone="indexes-expressional"> - <primary>indexes</primary> - <secondary>on expressions</secondary> + <primary>index</primary> + <secondary sortas="expressions">on expressions</secondary> </indexterm> <para> @@ -392,6 +392,10 @@ CREATE INDEX people_names ON people ((first_name || ' ' || last_name)); <sect1 id="indexes-opclass"> <title>Operator Classes</title> + <indexterm zone="indexes-opclass"> + <primary>operator class</primary> + </indexterm> + <para> An index definition may specify an <firstterm>operator class</firstterm> for each column of an index. @@ -492,7 +496,7 @@ SELECT am.amname AS index_method, <title>Partial Indexes</title> <indexterm zone="indexes-partial"> - <primary>indexes</primary> + <primary>index</primary> <secondary>partial</secondary> </indexterm> @@ -709,6 +713,11 @@ CREATE UNIQUE INDEX tests_success_constraint ON tests (subject, target) <sect1 id="indexes-examine"> <title>Examining Index Usage</title> + <indexterm zone="indexes-examine"> + <primary>index</primary> + <secondary>examining usage</secondary> + </indexterm> + <para> Although indexes in <productname>PostgreSQL</> do not need maintenance and tuning, it is still important to check diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index 6f4f8486023..ac24dc76720 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.138 2003/08/04 04:03:03 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.138.2.1 2003/09/07 04:36:41 momjian Exp $ --> <chapter id="installation"> <title><![%standalone-include[<productname>PostgreSQL</>]]> @@ -169,10 +169,9 @@ su - postgres <listitem> <para> - To build the Python interface module or the PL/Python server - programming language, you need a Python installation, including - the header files. - Since PL/Python will be a shared library, the + To build the PL/Python server programming language, you need a + Python installation, including the header files. Since + PL/Python will be a shared library, the <indexterm><primary>libpython</primary></indexterm> <filename>libpython</filename> library must be a shared library also on most platforms. This is not the case in a default @@ -383,6 +382,7 @@ JAVACMD=$JAVA_HOME/bin/java <para> <indexterm> <primary>pg_dumpall</primary> + <secondary>use during upgrade</secondary> </indexterm> To back up your database installation, type: @@ -750,10 +750,7 @@ JAVACMD=$JAVA_HOME/bin/java <term><option>--with-python</option></term> <listitem> <para> - Build the Python interface module and the PL/Python - server-side language. You need to have root access to be able - to install the Python module at its default place - (<filename>/usr/lib/python<replaceable>x</>.<replaceable>y</></>). + Build the PL/Python server-side language. </para> </listitem> </varlistentry> @@ -875,8 +872,8 @@ JAVACMD=$JAVA_HOME/bin/java <term><option>--with-pam</option></term> <listitem> <para> - Build with <acronym>PAM</> (Pluggable Authentication Modules) - support. + Build with <acronym>PAM</><indexterm><primary>PAM</></> + (Pluggable Authentication Modules) support. </para> </listitem> </varlistentry> @@ -1079,20 +1076,6 @@ All of PostgreSQL is successfully made. Ready to install. </para> <para> - If you built the Python interfaces and you were not the - root user when you executed the above command then that part of - the installation probably failed. In that case you should become - the root user and then do -<screen> -<userinput>gmake -C src/interfaces/python install</userinput> -</screen> - If you do not have root access you are on your own: - you can still take the required files and place them in - other directories where Python can find them, but how to - do that is left as an exercise. - </para> - - <para> The standard installation provides only the header files needed for client application development. If you plan to do any server-side program development (such as custom functions or data types written in C), @@ -1163,7 +1146,7 @@ All of PostgreSQL is successfully made. Ready to install. <title>Shared Libraries</title> <indexterm> - <primary>shared libraries</primary> + <primary>shared library</primary> </indexterm> <para> @@ -1284,7 +1267,6 @@ set path = ( /usr/local/pgsql/bin $path ) <para> <indexterm> <primary><envar>MANPATH</envar></primary> - <seealso>man pages</seealso> </indexterm> To enable your system to find the <application>man</> documentation, you need to add lines like the following to a diff --git a/doc/src/sgml/jdbc.sgml b/doc/src/sgml/jdbc.sgml index a577398bbb4..b524f9dec8c 100644 --- a/doc/src/sgml/jdbc.sgml +++ b/doc/src/sgml/jdbc.sgml @@ -1,10 +1,18 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.47 2003/08/07 05:06:40 barry Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.47.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="jdbc"> <title><acronym>JDBC</acronym> Interface</title> + <indexterm zone="jdbc"> + <primary>JDBC</primary> + </indexterm> + + <indexterm zone="jdbc"> + <primary>Java</primary> + </indexterm> + <para> <acronym>JDBC</acronym> is a core <acronym>API</acronym> of Java 1.1 and later. It provides a standard set of @@ -66,6 +74,14 @@ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.47 2003/08/07 05:06:40 <sect2 id="jdbc-classpath"> <title>Setting up the Class Path</title> + <indexterm zone="jdbc-classpath"> + <primary>class path</primary> + </indexterm> + + <indexterm zone="jdbc-classpath"> + <primary>CLASSPATH</primary> + </indexterm> + <para> To use the driver, the JAR archive (named <filename>postgresql.jar</filename> if you built from source, otherwise @@ -316,6 +332,18 @@ db.close(); <sect1 id="jdbc-query"> <title>Issuing a Query and Processing the Result</title> + <indexterm zone="jdbc-query"> + <primary>Statement</primary> + </indexterm> + + <indexterm zone="jdbc-query"> + <primary>PreparedStatement</primary> + </indexterm> + + <indexterm zone="jdbc-query"> + <primary>ResultSet</primary> + </indexterm> + <para> Any time you want to issue <acronym>SQL</acronym> statements to the database, you require a <classname>Statement</classname> or @@ -681,6 +709,16 @@ st.close(); <sect1 id="jdbc-binary-data"> <title>Storing Binary Data</title> + <indexterm zone="jdbc-binary-data"> + <primary>bytea</primary> + <secondary sortas="JDBC">in JDBC</secondary> + </indexterm> + + <indexterm zone="jdbc-binary-data"> + <primary>large object</primary> + <secondary sortas="JDBC">in JDBC</secondary> + </indexterm> + <para> <application>PostgreSQL</application> provides two distinct ways to store binary data. Binary data can be stored in a table using @@ -2597,6 +2635,11 @@ public void unlink(int oid) throws SQLException <sect1 id="jdbc-thread"> <title>Using the Driver in a Multithreaded or a Servlet Environment</title> + <indexterm zone="jdbc-thread"> + <primary>threads</primary> + <secondary sortas="JDBC">with JDBC</secondary> + </indexterm> + <para> A problem with many <acronym>JDBC</acronym> drivers is that only one thread can use a <classname>Connection</classname> at any one @@ -2645,6 +2688,15 @@ public void unlink(int oid) throws SQLException <sect1 id="jdbc-datasource"> <title>Connection Pools and Data Sources</title> + <indexterm zone="jdbc-datasource"> + <primary>connection pool</primary> + <secondary sortas="JDBC">in JDBC</secondary> + </indexterm> + + <indexterm zone="jdbc-datasource"> + <primary>DataSource</primary> + </indexterm> + <para> <acronym>JDBC</> 2 introduced standard connection pooling features in an add-on <acronym>API</> known as the <acronym>JDBC</acronym> 2.0 Optional @@ -3029,7 +3081,11 @@ try { </sect2> <sect2 id="jdbc-jndi"> - <title>Data Sources and <acronym>JNDI</acronym></title> + <title>Data Sources and <acronym>JNDI</acronym></title> + + <indexterm zone="jdbc-jndi"> + <primary>JNDI</primary> + </indexterm> <para> All the <literal>ConnectionPoolDataSource</literal> and diff --git a/doc/src/sgml/keywords.sgml b/doc/src/sgml/keywords.sgml index 26764553f87..b6d129354a2 100644 --- a/doc/src/sgml/keywords.sgml +++ b/doc/src/sgml/keywords.sgml @@ -1,10 +1,10 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/keywords.sgml,v 2.9 2003/06/12 07:49:43 momjian Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/keywords.sgml,v 2.9.2.1 2003/09/07 04:36:42 momjian Exp $ --> <appendix id="sql-keywords-appendix"> <title><acronym>SQL</acronym> Key Words</title> <indexterm zone="sql-keywords-appendix"> - <primary>key words</primary> + <primary>key word</primary> <secondary>list of</secondary> </indexterm> diff --git a/doc/src/sgml/libpgtcl.sgml b/doc/src/sgml/libpgtcl.sgml index 220a7d42be2..afcc7061ede 100644 --- a/doc/src/sgml/libpgtcl.sgml +++ b/doc/src/sgml/libpgtcl.sgml @@ -125,8 +125,8 @@ <para> The <function>pg_lo_*</function> commands are interfaces to the large object features of - <ProductName>PostgreSQL</ProductName>.<indexterm><primary>Large - Object</></> The functions are designed to mimic the analogous file + <ProductName>PostgreSQL</ProductName>.<indexterm><primary>large + object</><secondary>in pgctl</></> The functions are designed to mimic the analogous file system functions in the standard Unix file system interface. The <function>pg_lo_*</function> commands should be used within a <command>BEGIN</command>/<command>COMMIT</command> transaction @@ -1043,12 +1043,12 @@ pg_listen <parameter>conn</parameter> <parameter>notifyName</parameter> <optiona message bearing the given name arrives from the server. This occurs when any <productname>PostgreSQL</productname> client application issues a - <command>NOTIFY</command><indexterm><primary>NOTIFY</><secondary>in - pgtcl</></> command referencing that name. The command string is - executed from the Tcl idle loop. That is the normal idle state of - an application written with Tk. In non-Tk Tcl shells, you can - execute <function>update</function> or <function>vwait</function> - to cause the idle loop to be entered. + <command>NOTIFY</command><indexterm><primary>NOTIFY</><secondary + sortas="pgtcl">in pgtcl</></> command referencing that name. The + command string is executed from the Tcl idle loop. That is the + normal idle state of an application written with Tk. In non-Tk Tcl + shells, you can execute <function>update</function> or + <function>vwait</function> to cause the idle loop to be entered. </para> <para> diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 8284d4b5f8d..935b1c1186d 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/libpq.sgml,v 1.131 2003/08/13 16:29:03 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/libpq.sgml,v 1.131.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="libpq"> @@ -9,6 +9,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/libpq.sgml,v 1.131 2003/08/13 16:29:03 tgl <primary>libpq</primary> </indexterm> + <indexterm zone="libpq"> + <primary>C</primary> + </indexterm> + <para> <application>libpq</application> is the <acronym>C</acronym> application programmer's interface to @@ -31,9 +35,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/libpq.sgml,v 1.131 2003/08/13 16:29:03 tgl </para> <para> - Client programs that use <application>libpq</application> must include the - header file <filename>libpq-fe.h</filename> and must link with the - <application>libpq</application> library. + Client programs that use <application>libpq</application> must + include the header file + <filename>libpq-fe.h</filename><indexterm><primary>libpq-fe.h</></> + and must link with the <application>libpq</application> library. </para> <sect1 id="libpq-connect"> @@ -45,17 +50,18 @@ $Header: /cvsroot/pgsql/doc/src/sgml/libpq.sgml,v 1.131 2003/08/13 16:29:03 tgl application program can have several backend connections open at one time. (One reason to do that is to access more than one database.) Each connection is represented by a - <structname>PGconn</> object which is obtained from the function - <function>PQconnectdb</> or <function>PQsetdbLogin</>. Note that - these functions will always return a non-null object pointer, - unless perhaps there is too little memory even to allocate the - <structname>PGconn</> object. The <function>PQstatus</> function - should be called to check whether a connection was successfully - made before queries are sent via the connection object. + <structname>PGconn</><indexterm><primary>PGconn</></> object which + is obtained from the function <function>PQconnectdb</> or + <function>PQsetdbLogin</>. Note that these functions will always + return a non-null object pointer, unless perhaps there is too + little memory even to allocate the <structname>PGconn</> object. + The <function>PQstatus</> function should be called to check + whether a connection was successfully made before queries are sent + via the connection object. <variablelist> <varlistentry> - <term><function>PQconnectdb</function></term> + <term><function>PQconnectdb</function><indexterm><primary>PQconnectdb</></></term> <listitem> <para> Makes a new connection to the database server. @@ -93,12 +99,13 @@ PGconn *PQconnectdb(const char *conninfo); <term><literal>host</literal></term> <listitem> <para> - Name of host to connect to. - If this begins with a slash, it specifies Unix-domain communication - rather than TCP/IP communication; the value is the name of the - directory in which the socket file is stored. - The default is to connect to a Unix-domain socket in - <filename>/tmp</filename>. + Name of host to connect to.<indexterm><primary>host name</></> + If this begins with a slash, it specifies Unix-domain + communication rather than TCP/IP communication; the value is the + name of the directory in which the socket file is stored. The + default is to connect to a Unix-domain socket in + <filename>/tmp</filename>.<indexterm><primary>Unix domain + socket</></> </para> </listitem> </varlistentry> @@ -144,8 +151,9 @@ PGconn *PQconnectdb(const char *conninfo); <term><literal>port</literal></term> <listitem> <para> - Port number to connect to at the server host, - or socket file name extension for Unix-domain connections. + Port number to connect to at the server host, or socket file + name extension for Unix-domain + connections.<indexterm><primary>port</></> </para> </listitem> </varlistentry> @@ -209,44 +217,51 @@ PGconn *PQconnectdb(const char *conninfo); <varlistentry> <term><literal>sslmode</literal></term> <listitem> - <para> - This option determines whether or with what priority an <acronym>SSL</> - connection will be negotiated with the server. There are four - modes: <literal>disable</> will attempt only an unencrypted - <acronym>SSL</> connection; <literal>allow</> will negotiate, - trying first a non-<acronym>SSL</> connection, then if that fails, - trying an <acronym>SSL</> connection; <literal>prefer</> - (the default) will negotiate, trying first an <acronym>SSL</> connection, - then if that fails, trying a regular non-<acronym>SSL</> connection; - <literal>require</> will try only an <acronym>SSL</> connection. - </para> - <para> - If <productname>PostgreSQL</> is compiled without SSL support, - using option <literal>require</> will cause an error, and options - <literal>allow</> and <literal>prefer</> will be tolerated but - <application>libpq</> will be unable to negotiate an <acronym>SSL</> - connection. - </para> + <para> + This option determines whether or with what priority an + <acronym>SSL</> connection will be negotiated with the + server. There are four modes: <literal>disable</> will attempt + only an unencrypted <acronym>SSL</> connection; + <literal>allow</> will negotiate, trying first a + non-<acronym>SSL</> connection, then if that fails, trying an + <acronym>SSL</> connection; <literal>prefer</> (the default) + will negotiate, trying first an <acronym>SSL</> connection, + then if that fails, trying a regular non-<acronym>SSL</> + connection; <literal>require</> will try only an + <acronym>SSL</> connection. + </para> + + <para> + If <productname>PostgreSQL</> is compiled without SSL support, + using option <literal>require</> will cause an error, and + options <literal>allow</> and <literal>prefer</> will be + tolerated but <application>libpq</> will be unable to negotiate + an <acronym>SSL</> + connection.<indexterm><primary>SSL</><secondary + sortas="libpq">with libpq</></indexterm> + </para> </listitem> </varlistentry> <varlistentry> <term><literal>requiressl</literal></term> <listitem> - <para> - This option is deprecated in favor of the <literal>sslmode</> - setting. - </para> - <para> - If set to 1, an <acronym>SSL</acronym> connection to the server is required - (this is equivalent to <literal>sslmode</> <literal>require</>). - <application>libpq</> will then refuse to connect if the server does not - accept an <acronym>SSL</acronym> connection. - If set to 0 (default), <application>libpq</> will negotiate the connection - type with the server (equivalent to <literal>sslmode</> <literal>prefer</>). - This option is only available if - <productname>PostgreSQL</> is compiled with SSL support. - </para> + <para> + This option is deprecated in favor of the <literal>sslmode</> + setting. + </para> + + <para> + If set to 1, an <acronym>SSL</acronym> connection to the server + is required (this is equivalent to <literal>sslmode</> + <literal>require</>). <application>libpq</> will then refuse + to connect if the server does not accept an + <acronym>SSL</acronym> connection. If set to 0 (default), + <application>libpq</> will negotiate the connection type with + the server (equivalent to <literal>sslmode</> + <literal>prefer</>). This option is only available if + <productname>PostgreSQL</> is compiled with SSL support. + </para> </listitem> </varlistentry> @@ -274,7 +289,7 @@ PGconn *PQconnectdb(const char *conninfo); </varlistentry> <varlistentry> - <term><function>PQsetdbLogin</function></term> + <term><function>PQsetdbLogin</function><indexterm><primary>PQsetdbLogin</></></term> <listitem> <para> Makes a new connection to the database server. @@ -299,7 +314,7 @@ PGconn *PQsetdbLogin(const char *pghost, </varlistentry> <varlistentry> - <term><function>PQsetdb</function></term> + <term><function>PQsetdb</function><indexterm><primary>PQsetdb</></></term> <listitem> <para> Makes a new connection to the database server. @@ -321,8 +336,8 @@ PGconn *PQsetdb(char *pghost, </varlistentry> <varlistentry> - <term><function>PQconnectStart</function></term> - <term><function>PQconnectPoll</function></term> + <term><function>PQconnectStart</function><indexterm><primary>PQconnectStart</></></term> + <term><function>PQconnectPoll</function><indexterm><primary>PQconnectPoll</></></term> <listitem> <para> <indexterm><primary>nonblocking connection</primary></indexterm> @@ -515,7 +530,7 @@ switch(PQstatus(conn)) </varlistentry> <varlistentry> - <term><function>PQconndefaults</function></term> + <term><function>PQconndefaults</function><indexterm><primary>PQconndefaults</></></term> <listitem> <para> Returns the default connection options. @@ -560,7 +575,7 @@ typedef struct </varlistentry> <varlistentry> - <term><function>PQfinish</function></term> + <term><function>PQfinish</function><indexterm><primary>PQfinish</></></term> <listitem> <para> Closes the connection to the server. Also frees @@ -581,7 +596,7 @@ void PQfinish(PGconn *conn); </varlistentry> <varlistentry> - <term><function>PQreset</function></term> + <term><function>PQreset</function><indexterm><primary>PQreset</></></term> <listitem> <para> Resets the communication channel to the server. @@ -601,8 +616,8 @@ void PQreset(PGconn *conn); </varlistentry> <varlistentry> - <term><function>PQresetStart</function></term> - <term><function>PQresetPoll</function></term> + <term><function>PQresetStart</function><indexterm><primary>PQresetStart</></></term> + <term><function>PQresetPoll</function><indexterm><primary>PQresetPoll</></></term> <listitem> <para> Reset the communication channel to the server, in a nonblocking manner. @@ -665,7 +680,7 @@ These values are fixed for the life of the <structname>PGconn</> object. <variablelist> <varlistentry> -<term><function>PQdb</function></term> +<term><function>PQdb</function><indexterm><primary>PQdb</></></term> <listitem> <para> Returns the database name of the connection. @@ -677,7 +692,7 @@ char *PQdb(const PGconn *conn); </varlistentry> <varlistentry> -<term><function>PQuser</function></term> +<term><function>PQuser</function><indexterm><primary>PQuser</></></term> <listitem> <para> Returns the user name of the connection. @@ -689,7 +704,7 @@ char *PQuser(const PGconn *conn); </varlistentry> <varlistentry> -<term><function>PQpass</function></term> +<term><function>PQpass</function><indexterm><primary>PQpass</></></term> <listitem> <para> Returns the password of the connection. @@ -701,7 +716,7 @@ char *PQpass(const PGconn *conn); </varlistentry> <varlistentry> -<term><function>PQhost</function></term> +<term><function>PQhost</function><indexterm><primary>PQhost</></></term> <listitem> <para> Returns the server host name of the connection. @@ -713,7 +728,7 @@ char *PQhost(const PGconn *conn); </varlistentry> <varlistentry> -<term><function>PQport</function></term> +<term><function>PQport</function><indexterm><primary>PQport</></></term> <listitem> <para> Returns the port of the connection. @@ -725,13 +740,13 @@ char *PQport(const PGconn *conn); </varlistentry> <varlistentry> -<term><function>PQtty</function></term> +<term><function>PQtty</function><indexterm><primary>PQtty</></></term> <listitem> <para> Returns the debug <acronym>TTY</acronym> of the connection. - (This is obsolete, since the server no longer pays attention - to the <acronym>TTY</acronym> setting, but the function remains - for backwards compatibility.) + (This is obsolete, since the server no longer pays attention + to the <acronym>TTY</acronym> setting, but the function remains + for backwards compatibility.) <synopsis> char *PQtty(const PGconn *conn); </synopsis> @@ -740,7 +755,7 @@ char *PQtty(const PGconn *conn); </varlistentry> <varlistentry> -<term><function>PQoptions</function></term> +<term><function>PQoptions</function><indexterm><primary>PQoptions</></></term> <listitem> <para> Returns the command-line options passed in the connection request. @@ -759,7 +774,7 @@ are executed on the <structname>PGconn</> object. <variablelist> <varlistentry> -<term><function>PQstatus</function></term> +<term><function>PQstatus</function><indexterm><primary>PQstatus</></></term> <listitem> <para> Returns the status of the connection. @@ -795,7 +810,7 @@ ConnStatusType PQstatus(const PGconn *conn); </varlistentry> <varlistentry> -<term><function>PQtransactionStatus</function></term> +<term><function>PQtransactionStatus</function><indexterm><primary>PQtransactionStatus</></></term> <listitem> <para> Returns the current in-transaction status of the server. @@ -823,7 +838,7 @@ deprecated and does not exist in later server versions. </varlistentry> <varlistentry> -<term><function>PQparameterStatus</function></term> +<term><function>PQparameterStatus</function><indexterm><primary>PQparameterStatus</></></term> <listitem> <para> Looks up a current parameter setting of the server. @@ -841,27 +856,27 @@ is not known. <para> Parameters reported as of the current release include <literal>server_version</> (cannot change after startup); -<literal>server_encoding</> (also not presently changeable after start); <literal>client_encoding</>, -<literal>is_superuser</>, and +<literal>is_superuser</>, +<literal>session_authorization</literal>, and <literal>DateStyle</>. </para> <para> -Pre-3.0-protocol servers do not report parameter settings, -but <application>libpq</> includes logic to obtain values for -<literal>server_version</>, <literal>server_encoding</>, and -<literal>client_encoding</>. Applications are encouraged to use -<function>PQparameterStatus</> rather than ad-hoc code to determine these -values. (Beware however that on a pre-3.0 connection, changing -<literal>client_encoding</> via <command>SET</> after connection startup -will not be reflected by <function>PQparameterStatus</>.) +Pre-3.0-protocol servers do not report parameter settings, but +<application>libpq</> includes logic to obtain values for +<literal>server_version</>, and <literal>client_encoding</>. +Applications are encouraged to use <function>PQparameterStatus</> +rather than ad-hoc code to determine these values. (Beware however +that on a pre-3.0 connection, changing <literal>client_encoding</> via +<command>SET</> after connection startup will not be reflected by +<function>PQparameterStatus</>.) </para> </listitem> </varlistentry> <varlistentry> -<term><function>PQprotocolVersion</function></term> +<term><function>PQprotocolVersion</function><indexterm><primary>PQprotocolVersion</></></term> <listitem> <para> Interrogates the frontend/backend protocol being used. @@ -881,7 +896,7 @@ only protocol 2.0. (Protocol 1.0 is obsolete and not supported by libpq.) </varlistentry> <varlistentry> - <term><function>PQerrorMessage</function></term> + <term><function>PQerrorMessage</function><indexterm><primary>PQerrorMessage</></></term> <listitem> <para> <indexterm><primary>error message</></> @@ -903,7 +918,7 @@ char *PQerrorMessage(const PGconn* conn); </varlistentry> <varlistentry> - <term><function>PQsocket</function></term> + <term><function>PQsocket</function><indexterm><primary>PQsocket</></></term> <listitem> <para> Obtains the file descriptor number of the connection socket to @@ -919,11 +934,13 @@ int PQsocket(const PGconn *conn); </varlistentry> <varlistentry> - <term><function>PQbackendPID</function></term> + <term><function>PQbackendPID</function><indexterm><primary>PQbackendPID</></></term> <listitem> <para> - Returns the process <acronym>ID</acronym> of the backend server process - handling this connection. + Returns the process <acronym>ID</acronym> + (PID)<indexterm><primary>PID</><secondary>determining PID of + server process</><tertiary>in libpq</></> of the backend server + process handling this connection. <synopsis> int PQbackendPID(const PGconn *conn); </synopsis> @@ -941,10 +958,10 @@ int PQbackendPID(const PGconn *conn); </varlistentry> <varlistentry> - <term><function>PQgetssl</function></term> + <term><function>PQgetssl</function><indexterm><primary>PQgetssl</></></term> <listitem> <para> - <indexterm><primary>SSL</></> + <indexterm><primary>SSL</><secondary sortas="libpq">in libpq</secondary></indexterm> Returns the SSL structure used in the connection, or null if SSL is not in use. <synopsis> @@ -985,7 +1002,7 @@ SQL queries and commands. <para> <variablelist> <varlistentry> -<term><function>PQexec</function></term> +<term><function>PQexec</function><indexterm><primary>PQexec</></></term> <listitem> <para> Submits a command to the server @@ -1001,8 +1018,8 @@ PGresult *PQexec(PGconn *conn, const char *command); out-of-memory conditions or serious errors such as inability to send the command to the server. If a null pointer is returned, it - should be treated like a <symbol>PGRES_FATAL_ERROR</symbol> result. Use - <function>PQerrorMessage</function> to get more information about the error. + should be treated like a <symbol>PGRES_FATAL_ERROR</symbol> result. Use + <function>PQerrorMessage</function> to get more information about the error. </para> </listitem> </varlistentry> @@ -1022,12 +1039,12 @@ condition. <para> <variablelist> <varlistentry> -<term><function>PQexecParams</function></term> +<term><function>PQexecParams</function><indexterm><primary>PQexecParams</></></term> <listitem> <para> Submits a command to the server and waits for the result, - with the ability to pass parameters separately from the SQL - command text. + with the ability to pass parameters separately from the SQL + command text. <synopsis> PGresult *PQexecParams(PGconn *conn, const char *command, @@ -1093,11 +1110,11 @@ but has some usefulness as an extra defense against SQL-injection attacks. <para> <variablelist> <varlistentry> -<term><function>PQexecPrepared</function></term> +<term><function>PQexecPrepared</function><indexterm><primary>PQexecPrepared</></></term> <listitem> <para> Sends a request to execute a prepared statement with given - parameters, and waits for the result. + parameters, and waits for the result. <synopsis> PGresult *PQexecPrepared(PGconn *conn, const char *stmtName, @@ -1138,16 +1155,19 @@ future release. </para> <para> -The <structname>PGresult</structname> structure encapsulates the result -returned by the server. -<application>libpq</application> application programmers should be careful to -maintain the <structname>PGresult</structname> abstraction. Use the accessor functions below to get -at the contents of <structname>PGresult</structname>. Avoid directly referencing the fields of the -<structname>PGresult</structname> structure because they are subject to change in the future. +The +<structname>PGresult</structname><indexterm><primary>PGresult</></> +structure encapsulates the result returned by the server. +<application>libpq</application> application programmers should be +careful to maintain the <structname>PGresult</structname> abstraction. +Use the accessor functions below to get at the contents of +<structname>PGresult</structname>. Avoid directly referencing the +fields of the <structname>PGresult</structname> structure because they +are subject to change in the future. <variablelist> <varlistentry> -<term><function>PQresultStatus</function></term> +<term><function>PQresultStatus</function><indexterm><primary>PQresultStatus</></></term> <listitem> <para> Returns the result status of the command. @@ -1238,11 +1258,11 @@ processor (see <xref linkend="libpq-notice-processing">). </varlistentry> <varlistentry> -<term><function>PQresStatus</function></term> +<term><function>PQresStatus</function><indexterm><primary>PQresStatus</></></term> <listitem> <para> - Converts the enumerated type returned by <function>PQresultStatus</> into - a string constant describing the status code. + Converts the enumerated type returned by <function>PQresultStatus</> into + a string constant describing the status code. <synopsis> char *PQresStatus(ExecStatusType status); </synopsis> @@ -1251,7 +1271,7 @@ char *PQresStatus(ExecStatusType status); </varlistentry> <varlistentry> -<term><function>PQresultErrorMessage</function></term> +<term><function>PQresultErrorMessage</function><indexterm><primary>PQresultErrorMessage</></></term> <listitem> <para> Returns the error message associated with the command, or an empty string @@ -1276,27 +1296,145 @@ when you want to know the status from the latest operation on the connection. </varlistentry> <varlistentry> -<term><function>PQresultErrorField</function></term> +<term><function>PQresultErrorField</function><indexterm><primary>PQresultErrorField</></></term> <listitem> <para> Returns an individual field of an error report. <synopsis> char *PQresultErrorField(const PGresult *res, int fieldcode); </synopsis> -<parameter>fieldcode</> is an error field identifier defined by the -<productname>PostgreSQL</> protocol (see <xref -linkend="protocol-error-fields">), for example <literal>'C'</> for -the SQLSTATE error code. NULL is returned if the +<parameter>fieldcode</> is an error field identifier; see the symbols +listed below. <symbol>NULL</symbol> is returned if the <structname>PGresult</structname> is not an error or warning result, or does not include the specified field. Field values will normally not include a trailing newline. </para> <para> -Errors generated internally by libpq will have severity and primary message, -but typically no other fields. Errors returned by a pre-3.0-protocol server -will include severity and primary message, and sometimes a detail message, -but no other fields. +The following field codes are available: +<variablelist> + +<varlistentry> +<term><symbol>PG_DIAG_SEVERITY</></term> +<listitem> +<para> +The severity; the field contents are <literal>ERROR</>, +<literal>FATAL</>, or <literal>PANIC</> (in an error message), or +<literal>WARNING</>, <literal>NOTICE</>, <literal>DEBUG</>, +<literal>INFO</>, or <literal>LOG</> (in a notice message), or a +localized translation of one of these. Always present. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><symbol>PG_DIAG_SQLSTATE</> +</term> +<listitem> +<para> +The SQLSTATE code for the error (a 5-character string following SQL +spec conventions). Not localizable. Always present. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><symbol>PG_DIAG_MESSAGE_PRIMARY</></term> +<listitem> +<para> +The primary human-readable error message (typically one line). Always +present. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><symbol>PG_DIAG_MESSAGE_DETAIL</></term> +<listitem> +<para> +Detail: an optional secondary error message carrying more detail about +the problem. May run to multiple lines. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><symbol>PG_DIAG_MESSAGE_HINT</></term> +<listitem> +<para> +Hint: an optional suggestion what to do about the problem. This is +intended to differ from detail in that it offers advice (potentially +inappropriate) rather than hard facts. May run to multiple lines. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><symbol>PG_DIAG_STATEMENT_POSITION</></term> +<listitem> +<para> +A string containing a decimal integer indicating an error cursor +position as an index into the original statement string. The first +character has index 1, and positions are measured in characters not +bytes. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><symbol>PG_DIAG_CONTEXT</></term> +<listitem> +<para> +An indication of the context in which the error occurred. Presently +this includes a call stack traceback of active PL functions. The +trace is one entry per line, most recent first. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><symbol>PG_DIAG_SOURCE_FILE</></term> +<listitem> +<para> +The file name of the source-code location where the error was +reported. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><symbol>PG_DIAG_SOURCE_LINE</></term> +<listitem> +<para> +The line number of the source-code location where the error was +reported. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><symbol>PG_DIAG_SOURCE_FUNCTION</></term> +<listitem> +<para> +The name of the source-code function reporting the error. +</para> +</listitem> +</varlistentry> +</variablelist> +</para> + +<para> +The client is responsible for formatting displayed information to meet +its needs; in particular it should break long lines as needed. +Newline characters appearing in the error message fields should be +treated as paragraph breaks, not line breaks. +</para> + +<para> +Errors generated internally by <application>libpq</application> will +have severity and primary message, but typically no other fields. +Errors returned by a pre-3.0-protocol server will include severity and +primary message, and sometimes a detail message, but no other fields. </para> <para> @@ -1309,7 +1447,7 @@ Note that error fields are only available from </varlistentry> <varlistentry> -<term><function>PQclear</function></term> +<term><function>PQclear</function><indexterm><primary>PQclear</></></term> <listitem> <para> Frees the storage associated with a <structname>PGresult</structname>. @@ -1331,7 +1469,7 @@ void PQclear(PQresult *res); </varlistentry> <varlistentry> -<term><function>PQmakeEmptyPGresult</function></term> +<term><function>PQmakeEmptyPGresult</function><indexterm><primary>PQmakeEmptyPGresult</></></term> <listitem> <para> Constructs an empty <structname>PGresult</structname> object with the given status. @@ -1368,7 +1506,7 @@ values they will act as though the result has zero rows and zero columns. <variablelist> <varlistentry> -<term><function>PQntuples</function></term> +<term><function>PQntuples</function><indexterm><primary>PQntuples</></></term> <listitem> <para> Returns the number of rows (tuples) @@ -1381,7 +1519,7 @@ int PQntuples(const PGresult *res); </varlistentry> <varlistentry> -<term><function>PQnfields</function></term> +<term><function>PQnfields</function><indexterm><primary>PQnfields</></></term> <listitem> <para> Returns the number of columns (fields) @@ -1394,7 +1532,7 @@ int PQnfields(const PGresult *res); </varlistentry> <varlistentry> -<term><function>PQfname</function></term> +<term><function>PQfname</function><indexterm><primary>PQfname</></></term> <listitem> <para> Returns the column name associated with the given column number. @@ -1412,7 +1550,7 @@ NULL is returned if the column number is out of range. </varlistentry> <varlistentry> -<term><function>PQfnumber</function></term> +<term><function>PQfnumber</function><indexterm><primary>PQfnumber</></></term> <listitem> <para> Returns the column number @@ -1430,7 +1568,7 @@ int PQfnumber(const PGresult *res, </varlistentry> <varlistentry> -<term><function>PQftable</function></term> +<term><function>PQftable</function><indexterm><primary>PQftable</></></term> <listitem> <para> Returns the OID of the table from which the given column was fetched. @@ -1459,7 +1597,7 @@ exactly which table is referenced. </varlistentry> <varlistentry> -<term><function>PQftablecol</function></term> +<term><function>PQftablecol</function><indexterm><primary>PQftablecol</></></term> <listitem> <para> Returns the column number (within its table) of the column making up @@ -1480,7 +1618,7 @@ or when using pre-3.0 protocol. </varlistentry> <varlistentry> -<term><function>PQfformat</function></term> +<term><function>PQfformat</function><indexterm><primary>PQfformat</></></term> <listitem> <para> Returns the format code indicating the format of the given column. @@ -1500,7 +1638,7 @@ for future definition.) </varlistentry> <varlistentry> -<term><function>PQftype</function></term> +<term><function>PQftype</function><indexterm><primary>PQftype</></></term> <listitem> <para> Returns the data type associated with the @@ -1523,7 +1661,7 @@ in the source tree. </varlistentry> <varlistentry> -<term><function>PQfmod</function></term> +<term><function>PQfmod</function><indexterm><primary>PQfmod</></></term> <listitem> <para> Returns the type modifier of the column @@ -1545,7 +1683,7 @@ in which case the value is always -1. </varlistentry> <varlistentry> -<term><function>PQfsize</function></term> +<term><function>PQfsize</function><indexterm><primary>PQfsize</></></term> <listitem> <para> Returns the size in bytes of the column @@ -1567,7 +1705,7 @@ A negative value indicates the data type is variable-length. </varlistentry> <varlistentry> -<term><function>PQbinaryTuples</function></term> +<term><function>PQbinaryTuples</function><indexterm><primary>PQbinaryTuples</></></term> <listitem> <para> Returns 1 if the <structname>PGresult</> contains binary data @@ -1589,11 +1727,11 @@ returns 1 only if all columns of the result are binary (format 1). </varlistentry> <varlistentry> -<term><function>PQgetvalue</function></term> +<term><function>PQgetvalue</function><indexterm><primary>PQgetvalue</></></term> <listitem> <para> Returns a single field value of one row - of a <structname>PGresult</structname>. + of a <structname>PGresult</structname>. Row and column numbers start at 0. <synopsis> char* PQgetvalue(const PGresult *res, @@ -1629,8 +1767,8 @@ be used past the lifetime of the <structname>PGresult</structname> structure i </varlistentry> <varlistentry> -<term><function>PQgetisnull</function></term> -<listitem> +<term><function>PQgetisnull</function><indexterm><primary>PQgetisnull</></></term> +<indexterm><primary>null value</><secondary sortas="libpq">in libpq</></indexterm><listitem> <para> Tests a field for a null value. Row and column numbers start at 0. @@ -1650,7 +1788,7 @@ will return an empty string, not a null pointer, for a null field.) </varlistentry> <varlistentry> -<term><function>PQgetlength</function></term> +<term><function>PQgetlength</function><indexterm><primary>PQgetlength</></></term> <listitem> <para> Returns the actual length of a field value in bytes. @@ -1673,7 +1811,7 @@ on <function>PQfsize</function> to obtain the actual data length. </varlistentry> <varlistentry> -<term><function>PQprint</function></term> +<term><function>PQprint</function><indexterm><primary>PQprint</></></term> <listitem> <para> Prints out all the rows and, optionally, the @@ -1719,11 +1857,11 @@ results. <variablelist> <varlistentry> -<term><function>PQcmdStatus</function></term> +<term><function>PQcmdStatus</function><indexterm><primary>PQcmdStatus</></></term> <listitem> <para> Returns the command status tag from the SQL command that - generated the <structname>PGresult</structname>. + generated the <structname>PGresult</structname>. <synopsis> char * PQcmdStatus(PGresult *res); </synopsis> @@ -1736,10 +1874,10 @@ data such as the number of rows processed. </varlistentry> <varlistentry> -<term><function>PQcmdTuples</function></term> +<term><function>PQcmdTuples</function><indexterm><primary>PQcmdTuples</></></term> <listitem> <para> - Returns the number of rows affected by the SQL command. + Returns the number of rows affected by the SQL command. <synopsis> char * PQcmdTuples(PGresult *res); </synopsis> @@ -1747,23 +1885,25 @@ char * PQcmdTuples(PGresult *res); <para> If the <acronym>SQL</acronym> command that generated the - <structname>PGresult</structname> was <command>INSERT</>, - <command>UPDATE</>, <command>DELETE</command>, <command>MOVE</>, - or <command>FETCH</>, this returns a - string containing the number of rows affected. If the + <structname>PGresult</structname> was <command>INSERT</>, + <command>UPDATE</>, <command>DELETE</command>, <command>MOVE</>, + or <command>FETCH</>, this returns a + string containing the number of rows affected. If the command was anything else, it returns the empty string. </para> </listitem> </varlistentry> <varlistentry> -<term><function>PQoidValue</function></term> +<term><function>PQoidValue</function><indexterm><primary>PQoidValue</></></term> <listitem> <para> - Returns the OID of the inserted row, if the - <acronym>SQL</acronym> command was an <command>INSERT</command> - that inserted exactly one row into a table that has OIDs. - Otherwise, returns <literal>InvalidOid</literal>. + Returns the OID<indexterm><primary>OID</><secondary>in + libpq</></> of the inserted row, if the + <acronym>SQL</acronym> command was an + <command>INSERT</command> that inserted exactly one row into + a table that has OIDs. Otherwise, returns + <literal>InvalidOid</literal>. <synopsis> Oid PQoidValue(const PGresult *res); </synopsis> @@ -1772,7 +1912,7 @@ Oid PQoidValue(const PGresult *res); </varlistentry> <varlistentry> -<term><function>PQoidStatus</function></term> +<term><function>PQoidStatus</function><indexterm><primary>PQoidStatus</></></term> <listitem> <para> Returns a string with the OID of the inserted row, if the @@ -1800,6 +1940,7 @@ It is not thread-safe. <sect2 id="libpq-exec-escape-string"> <title>Escaping Strings for Inclusion in SQL Commands</title> + <indexterm zone="libpq-exec-escape-string"><primary>PQescapeString</></> <indexterm zone="libpq-exec-escape-string"><primary>escaping strings</></> <para> @@ -1858,13 +1999,15 @@ strings overlap. <sect2 id="libpq-exec-escape-bytea"> <title>Escaping Binary Strings for Inclusion in SQL Commands</title> + <indexterm zone="libpq-exec-escape-bytea"> - <primary>escaping binary strings</primary> + <primary>bytea</> + <secondary sortas="libpq">in libpq</> </indexterm> <variablelist> <varlistentry> - <term><function>PQescapeBytea</function></term> + <term><function>PQescapeBytea</function><indexterm><primary>PQescapeBytea</></></term> <listitem> <para> Escapes binary data for use within an SQL command with the type @@ -1916,7 +2059,7 @@ unsigned char *PQescapeBytea(const unsigned char *from, </varlistentry> <varlistentry> - <term><function>PQunescapeBytea</function></term> + <term><function>PQunescapeBytea</function><indexterm><primary>PQunescapeBytea</></></term> <listitem> <para> Converts an escaped string representation of binary data into binary @@ -1943,7 +2086,7 @@ unsigned char *PQunescapeBytea(const unsigned char *from, size_t *to_length); </varlistentry> <varlistentry> - <term><function>PQfreemem</function></term> + <term><function>PQfreemem</function><indexterm><primary>PQfreemem</></></term> <listitem> <para> Frees memory allocated by <application>libpq</>. @@ -2016,32 +2159,32 @@ respectively. <variablelist> <varlistentry> -<term><function>PQsendQuery</function></term> +<term><function>PQsendQuery</function><indexterm><primary>PQsendQuery</></></term> <listitem> <para> Submits a command to the server without - waiting for the result(s). 1 is returned if the command was - successfully dispatched and 0 if not (in which case, use - <function>PQerrorMessage</> to get more information about the failure). + waiting for the result(s). 1 is returned if the command was + successfully dispatched and 0 if not (in which case, use + <function>PQerrorMessage</> to get more information about the failure). <synopsis> int PQsendQuery(PGconn *conn, const char *command); </synopsis> - After successfully calling <function>PQsendQuery</function>, call + After successfully calling <function>PQsendQuery</function>, call <function>PQgetResult</function> one or more - times to obtain the results. <function>PQsendQuery</function> may not be called - again (on the same connection) until <function>PQgetResult</function> has returned a null pointer, - indicating that the command is done. + times to obtain the results. <function>PQsendQuery</function> may not be called + again (on the same connection) until <function>PQgetResult</function> has returned a null pointer, + indicating that the command is done. </para> </listitem> </varlistentry> <varlistentry> -<term><function>PQsendQueryParams</function></term> +<term><function>PQsendQueryParams</function><indexterm><primary>PQsendQueryParams</></></term> <listitem> <para> Submits a command and separate parameters to the server without - waiting for the result(s). + waiting for the result(s). <synopsis> int PQsendQueryParams(PGconn *conn, const char *command, @@ -2053,22 +2196,22 @@ int PQsendQueryParams(PGconn *conn, int resultFormat); </synopsis> - This is equivalent to <function>PQsendQuery</function> except that - query parameters can be specified separately from the query string. - The function's parameters are handled identically to - <function>PQexecParams</function>. Like - <function>PQexecParams</function>, it will not work on 2.0-protocol - connections, and it allows only one command in the query string. + This is equivalent to <function>PQsendQuery</function> except that + query parameters can be specified separately from the query string. + The function's parameters are handled identically to + <function>PQexecParams</function>. Like + <function>PQexecParams</function>, it will not work on 2.0-protocol + connections, and it allows only one command in the query string. </para> </listitem> </varlistentry> <varlistentry> -<term><function>PQsendQueryPrepared</function></term> +<term><function>PQsendQueryPrepared</function><indexterm><primary>PQsendQueryPrepared</></></term> <listitem> <para> Sends a request to execute a prepared statement with given - parameters, without waiting for the result(s). + parameters, without waiting for the result(s). <synopsis> int PQsendQueryPrepared(PGconn *conn, const char *stmtName, @@ -2079,41 +2222,41 @@ int PQsendQueryPrepared(PGconn *conn, int resultFormat); </synopsis> - This is similar to <function>PQsendQueryParams</function>, but the - command to be executed is specified by naming a previously-prepared - statement, instead of giving a query string. - The function's parameters are handled identically to - <function>PQexecPrepared</function>. Like - <function>PQexecPrepared</function>, it will not work on 2.0-protocol - connections. + This is similar to <function>PQsendQueryParams</function>, but the + command to be executed is specified by naming a previously-prepared + statement, instead of giving a query string. + The function's parameters are handled identically to + <function>PQexecPrepared</function>. Like + <function>PQexecPrepared</function>, it will not work on 2.0-protocol + connections. </para> </listitem> </varlistentry> <varlistentry> -<term><function>PQgetResult</function></term> +<term><function>PQgetResult</function><indexterm><primary>PQgetResult</></></term> <listitem> <para> Waits for the next result from a prior - <function>PQsendQuery</function>, - <function>PQsendQueryParams</function>, or - <function>PQsendQueryPrepared</function> call, - and returns it. A null pointer is returned when the command is complete - and there will be no more results. + <function>PQsendQuery</function>, + <function>PQsendQueryParams</function>, or + <function>PQsendQueryPrepared</function> call, + and returns it. A null pointer is returned when the command is complete + and there will be no more results. <synopsis> PGresult *PQgetResult(PGconn *conn); </synopsis> </para> <para> - <function>PQgetResult</function> must be called repeatedly until it returns a null pointer, - indicating that the command is done. (If called when no command is - active, <function>PQgetResult</function> will just return a null pointer at once.) - Each non-null result from <function>PQgetResult</function> should be processed using - the same <structname>PGresult</> accessor functions previously described. - Don't forget to free each result object with <function>PQclear</function> when done with it. - Note that <function>PQgetResult</function> will block only if a command is active and the - necessary response data has not yet been read by <function>PQconsumeInput</function>. + <function>PQgetResult</function> must be called repeatedly until it returns a null pointer, + indicating that the command is done. (If called when no command is + active, <function>PQgetResult</function> will just return a null pointer at once.) + Each non-null result from <function>PQgetResult</function> should be processed using + the same <structname>PGresult</> accessor functions previously described. + Don't forget to free each result object with <function>PQclear</function> when done with it. + Note that <function>PQgetResult</function> will block only if a command is active and the + necessary response data has not yet been read by <function>PQconsumeInput</function>. </para> </listitem> </varlistentry> @@ -2134,10 +2277,10 @@ more functions: <variablelist> <varlistentry> -<term><function>PQconsumeInput</function></term> +<term><function>PQconsumeInput</function><indexterm><primary>PQconsumeInput</></></term> <listitem> <para> - If input is available from the server, consume it. + If input is available from the server, consume it. <synopsis> int PQconsumeInput(PGconn *conn); </synopsis> @@ -2165,7 +2308,7 @@ application can thus use <function>PQconsumeInput</function> to clear the </varlistentry> <varlistentry> -<term><function>PQisBusy</function></term> +<term><function>PQisBusy</function><indexterm><primary>PQisBusy</></></term> <listitem> <para> Returns 1 if a command is busy, that is, <function>PQgetResult</function> would block @@ -2201,16 +2344,18 @@ if <function>PQisBusy</function> returns false (0). It can also call </para> <para> -A client that uses <function>PQsendQuery</function>/<function>PQgetResult</function> -can also attempt to cancel a command that is still being processed by the server. +A client that uses +<function>PQsendQuery</function>/<function>PQgetResult</function> can +also attempt to cancel a command that is still being processed by the +server.<indexterm><primary>canceling</><secondary>SQL command</></> <variablelist> <varlistentry> -<term><function>PQrequestCancel</function></term> +<term><function>PQrequestCancel</function><indexterm><primary>PQrequestCancel</></></term> <listitem> <para> - Requests that the server abandon - processing of the current command. + Requests that the server abandon + processing of the current command. <synopsis> int PQrequestCancel(PGconn *conn); </synopsis> @@ -2259,7 +2404,7 @@ functions may be used. <variablelist> <varlistentry> - <term><function>PQsetnonblocking</function></term> + <term><function>PQsetnonblocking</function><indexterm><primary>PQsetnonblocking</></></term> <listitem> <para> Sets the nonblocking status of the connection. @@ -2289,7 +2434,7 @@ int PQsetnonblocking(PGconn *conn, int arg); </varlistentry> <varlistentry> -<term><function>PQisnonblocking</function></term> +<term><function>PQisnonblocking</function><indexterm><primary>PQisnonblocking</></></term> <listitem> <para> Returns the blocking status of the database connection. @@ -2306,7 +2451,7 @@ int PQisnonblocking(const PGconn *conn); </varlistentry> <varlistentry> -<term><function>PQflush</function></term> +<term><function>PQflush</function><indexterm><primary>PQflush</></></term> <listitem> <para> Attempts to flush any queued output data to the server. @@ -2335,6 +2480,8 @@ and then read the response as described above. <sect1 id="libpq-fastpath"> <title>The Fast-Path Interface</title> +<indexterm zone="libpq-fastpath"><primary>fast path</></> + <para> <productname>PostgreSQL</productname> provides a fast-path interface to send simple function calls to the server. @@ -2350,8 +2497,8 @@ parameters and results substitutes for a fast-path function call. </tip> <para> -The function <function>PQfn</function> requests execution of a server -function via the fast-path interface: +The function <function>PQfn</function><indexterm><primary>PQfn</></> +requests execution of a server function via the fast-path interface: <synopsis> PGresult* PQfn(PGconn* conn, int fnid, @@ -2417,7 +2564,10 @@ set-valued results when using this interface. <sect1 id="libpq-notify"> <title>Asynchronous Notification</title> - <indexterm zone="libpq-notify"><primary>NOTIFY</primary></indexterm> + <indexterm zone="libpq-notify"> + <primary>NOTIFY</primary> + <secondary>in libpq</secondary> + </indexterm> <para> <productname>PostgreSQL</productname> offers asynchronous notification via the @@ -2433,9 +2583,11 @@ not necessary for there to be any associated table. </para> <para> -<application>libpq</application> applications submit <command>LISTEN</command> and <command>UNLISTEN</command> -commands as ordinary SQL commands. The arrival of <command>NOTIFY</command> -messages can subsequently be detected by calling <function>PQnotifies</function>. +<application>libpq</application> applications submit +<command>LISTEN</command> and <command>UNLISTEN</command> commands as +ordinary SQL commands. The arrival of <command>NOTIFY</command> +messages can subsequently be detected by calling +<function>PQnotifies</function>.<indexterm><primary>PQnotifies</></> </para> <para> @@ -2443,8 +2595,8 @@ The function <function>PQnotifies</function> returns the next notification from a list of unhandled notification messages received from the server. It returns a null pointer if there are no pending notifications. Once a notification is - returned from <function>PQnotifies</>, it is considered handled and will be - removed from the list of notifications. + returned from <function>PQnotifies</>, it is considered handled and will be + removed from the list of notifications. <synopsis> PGnotify* PQnotifies(PGconn *conn); @@ -2570,7 +2722,7 @@ if any notifications came in during the processing of the command. <variablelist> <varlistentry> -<term><function>PQnfields</function></term> +<term><function>PQnfields</function><indexterm><primary>PQnfields</><secondary>with COPY</></></term> <listitem> <para> Returns the number of columns (fields) to be copied. @@ -2579,30 +2731,30 @@ if any notifications came in during the processing of the command. </varlistentry> <varlistentry> -<term><function>PQbinaryTuples</function></term> +<term><function>PQbinaryTuples</function><indexterm><primary>PQbinaryTuples</><secondary>with COPY</></></term> <listitem> <para> 0 indicates the overall copy format is textual (rows - separated by newlines, columns separated by separator - characters, etc). - 1 indicates the overall copy format is binary. - See <xref linkend="sql-copy" endterm="sql-copy-title"> - for more information. + separated by newlines, columns separated by separator + characters, etc). + 1 indicates the overall copy format is binary. + See <xref linkend="sql-copy" endterm="sql-copy-title"> + for more information. </para> </listitem> </varlistentry> <varlistentry> -<term><function>PQfformat</function></term> +<term><function>PQfformat</function><indexterm><primary>PQfformat</><secondary>with COPY</></></term> <listitem> <para> Returns the format code (0 for text, 1 for binary) associated - with each column of the copy operation. The per-column format - codes will always be zero when the overall copy format is textual, - but the binary format can support both text and binary columns. - (However, as of the current implementation of <command>COPY</>, - only binary columns appear in a binary copy; so the per-column - formats always match the overall format at present.) + with each column of the copy operation. The per-column format + codes will always be zero when the overall copy format is textual, + but the binary format can support both text and binary columns. + (However, as of the current implementation of <command>COPY</>, + only binary columns appear in a binary copy; so the per-column + formats always match the overall format at present.) </para> </listitem> </varlistentry> @@ -2627,7 +2779,7 @@ When using protocol 2.0, all these functions will return 0. <variablelist> <varlistentry> -<term><function>PQputCopyData</function></term> +<term><function>PQputCopyData</function><indexterm><primary>PQputCopyData</></></term> <listitem> <para> Sends data to the server during <literal>COPY_IN</> state. @@ -2658,7 +2810,7 @@ by the <command>COPY</> command; see </varlistentry> <varlistentry> -<term><function>PQputCopyEnd</function></term> +<term><function>PQputCopyEnd</function><indexterm><primary>PQputCopyEnd</></></term> <listitem> <para> Sends end-of-data indication to the server during <literal>COPY_IN</> state. @@ -2710,7 +2862,7 @@ operation. <variablelist> <varlistentry> -<term><function>PQgetCopyData</function></term> +<term><function>PQgetCopyData</function><indexterm><primary>PQgetCopyData</></></term> <listitem> <para> Receives data from the server during <literal>COPY_OUT</> state. @@ -2779,7 +2931,7 @@ operation. <variablelist> <varlistentry> -<term><function>PQgetline</function></term> +<term><function>PQgetline</function><indexterm><primary>PQgetline</></></term> <listitem> <para> Reads a newline-terminated line of characters @@ -2815,7 +2967,7 @@ for a terminator line). </varlistentry> <varlistentry> -<term><function>PQgetlineAsync</function></term> +<term><function>PQgetlineAsync</function><indexterm><primary>PQgetlineAsync</></></term> <listitem> <para> Reads a row of COPY data @@ -2867,7 +3019,7 @@ than the room actually available.) </varlistentry> <varlistentry> -<term><function>PQputline</function></term> +<term><function>PQputline</function><indexterm><primary>PQputline</></></term> <listitem> <para> Sends a null-terminated string to the server. @@ -2901,7 +3053,7 @@ having sent the actual data. </varlistentry> <varlistentry> -<term><function>PQputnbytes</function></term> +<term><function>PQputnbytes</function><indexterm><primary>PQputnbytes</></></term> <listitem> <para> Sends a non-null-terminated string to the server. @@ -2922,7 +3074,7 @@ specified directly. Use this procedure when sending binary data. </varlistentry> <varlistentry> -<term><function>PQendcopy</function></term> +<term><function>PQendcopy</function><indexterm><primary>PQendcopy</></></term> <listitem> <para> Synchronizes with the server. @@ -2981,7 +3133,7 @@ These functions control miscellaneous details of <variablelist> <varlistentry> -<term><function>PQsetErrorVerbosity</function></term> +<term><function>PQsetErrorVerbosity</function><indexterm><primary>PQsetErrorVerbosity</></></term> <listitem> <para> Determines the verbosity of messages returned by @@ -3007,7 +3159,7 @@ ones. </varlistentry> <varlistentry> -<term><function>PQtrace</function></term> +<term><function>PQtrace</function><indexterm><primary>PQtrace</></></term> <listitem> <para> Enables tracing of the client/server communication to a debugging file stream. @@ -3019,7 +3171,7 @@ void PQtrace(PGconn *conn, FILE *stream); </varlistentry> <varlistentry> -<term><function>PQuntrace</function></term> +<term><function>PQuntrace</function><indexterm><primary>PQuntrace</></></term> <listitem> <para> Disables tracing started by <function>PQtrace</function>. @@ -3036,6 +3188,11 @@ void PQuntrace(PGconn *conn); <sect1 id="libpq-notice-processing"> <title>Notice Processing</title> +<indexterm zone="libpq-notice-processing"> + <primary>notice processing</primary> + <secondary>in libpq</secondary> +</indexterm> + <para> Notice and warning messages generated by the server are not returned by the query execution functions, since they do not imply failure of the query. @@ -3056,10 +3213,10 @@ work in the notice receiver. <para> The function <function>PQsetNoticeReceiver</function> -<indexterm><primary>notice receiver</></> +<indexterm><primary>notice receiver</></><indexterm><primary>PQsetNoticeReceiver</></> sets or examines the current notice receiver for a connection object. Similarly, <function>PQsetNoticeProcessor</function> -<indexterm><primary>notice processor</></> +<indexterm><primary>notice processor</></><indexterm><primary>PQsetNoticeProcessor</></> sets or examines the current notice processor. <synopsis> @@ -3137,7 +3294,7 @@ functions like <function>PQgetvalue</function>. <title>Environment Variables</title> <indexterm zone="libpq-envars"> - <primary>environment variables</primary> + <primary>environment variable</primary> </indexterm> <para> @@ -3426,11 +3583,12 @@ call <function>fe_setauthsvc</function> at all. </para> <para> -<application>libpq</application> applications that use the <literal>crypt</literal> -authentication method rely on the <literal>crypt()</literal> operating -system function, which is often not thread-safe. It is better to use the -<literal>md5</literal> method, which is thread-safe on all -platforms. +<application>libpq</application> applications that use the +<literal>crypt</literal> authentication method rely on the +<literal>crypt()</literal> operating system function, which is often +not thread-safe.<indexterm><primary>crypt</><secondary>thread +safety</></> It is better to use the <literal>md5</literal> method, +which is thread-safe on all platforms. </para> </sect1> @@ -3438,6 +3596,11 @@ platforms. <sect1 id="libpq-build"> <title>Building <application>libpq</application> Programs</title> + <indexterm zone="libpq-build"> + <primary>compiling</primary> + <secondary>libpq applications</secondary> + </indexterm> + <para> To build (i.e., compile and link) your <application>libpq</application> programs you need to do all of the following things: @@ -3482,12 +3645,12 @@ CPPFLAGS += -I/usr/local/pgsql/include </para> <para> - <indexterm><primary>pg_config</></> If there is any chance that your program might be compiled by other users then you should not hardcode the directory location like that. Instead, you can run the utility - <command>pg_config</command> to find out where the header files - are on the local system: + <command>pg_config</command><indexterm><primary>pg_config</><secondary + sortas="libpq">with libpq</></> to find out where the header + files are on the local system: <screen> <prompt>$</prompt> pg_config --includedir <computeroutput>/usr/local/include</computeroutput> @@ -3576,7 +3739,7 @@ testlibpq.o(.text+0xa4): undefined reference to `PQerrorMessage' /* * testlibpq.c * - * Test the C version of LIBPQ, the POSTGRES frontend library. + * Test the C version of LIBPQ, the POSTGRES frontend library. */ #include <stdio.h> #include <stdlib.h> @@ -3585,112 +3748,112 @@ testlibpq.o(.text+0xa4): undefined reference to `PQerrorMessage' static void exit_nicely(PGconn *conn) { - PQfinish(conn); - exit(1); + PQfinish(conn); + exit(1); } int main(int argc, char **argv) { - const char *conninfo; - PGconn *conn; - PGresult *res; - int nFields; - int i, - j; - - /* - * If the user supplies a parameter on the command line, use it as - * the conninfo string; otherwise default to setting dbname=template1 - * and using environment variables or defaults for all other connection - * parameters. - */ - if (argc > 1) - conninfo = argv[1]; - else - conninfo = "dbname = template1"; - - /* Make a connection to the database */ - conn = PQconnectdb(conninfo); - - /* Check to see that the backend connection was successfully made */ - if (PQstatus(conn) != CONNECTION_OK) - { - fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn)); - fprintf(stderr, "%s", PQerrorMessage(conn)); - exit_nicely(conn); - } - - /* - * Our test case here involves using a cursor, for which we must be - * inside a transaction block. We could do the whole thing with a - * single PQexec() of "select * from pg_database", but that's too - * trivial to make a good example. - */ - - /* Start a transaction block */ - res = PQexec(conn, "BEGIN"); - if (PQresultStatus(res) != PGRES_COMMAND_OK) - { - fprintf(stderr, "BEGIN command failed: %s", PQerrorMessage(conn)); - PQclear(res); - exit_nicely(conn); - } - - /* - * Should PQclear PGresult whenever it is no longer needed to avoid - * memory leaks - */ - PQclear(res); - - /* - * Fetch rows from pg_database, the system catalog of databases - */ - res = PQexec(conn, "DECLARE myportal CURSOR FOR select * from pg_database"); - if (PQresultStatus(res) != PGRES_COMMAND_OK) - { - fprintf(stderr, "DECLARE CURSOR failed: %s", PQerrorMessage(conn)); - PQclear(res); - exit_nicely(conn); - } - PQclear(res); - - res = PQexec(conn, "FETCH ALL in myportal"); - if (PQresultStatus(res) != PGRES_TUPLES_OK) - { - fprintf(stderr, "FETCH ALL failed: %s", PQerrorMessage(conn)); - PQclear(res); - exit_nicely(conn); - } - - /* first, print out the attribute names */ - nFields = PQnfields(res); - for (i = 0; i < nFields; i++) - printf("%-15s", PQfname(res, i)); - printf("\n\n"); - - /* next, print out the rows */ - for (i = 0; i < PQntuples(res); i++) - { - for (j = 0; j < nFields; j++) - printf("%-15s", PQgetvalue(res, i, j)); - printf("\n"); - } - - PQclear(res); - - /* close the portal ... we don't bother to check for errors ... */ - res = PQexec(conn, "CLOSE myportal"); - PQclear(res); - - /* end the transaction */ - res = PQexec(conn, "END"); - PQclear(res); - - /* close the connection to the database and cleanup */ - PQfinish(conn); - - return 0; + const char *conninfo; + PGconn *conn; + PGresult *res; + int nFields; + int i, + j; + + /* + * If the user supplies a parameter on the command line, use it as + * the conninfo string; otherwise default to setting dbname=template1 + * and using environment variables or defaults for all other connection + * parameters. + */ + if (argc > 1) + conninfo = argv[1]; + else + conninfo = "dbname = template1"; + + /* Make a connection to the database */ + conn = PQconnectdb(conninfo); + + /* Check to see that the backend connection was successfully made */ + if (PQstatus(conn) != CONNECTION_OK) + { + fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn)); + fprintf(stderr, "%s", PQerrorMessage(conn)); + exit_nicely(conn); + } + + /* + * Our test case here involves using a cursor, for which we must be + * inside a transaction block. We could do the whole thing with a + * single PQexec() of "select * from pg_database", but that's too + * trivial to make a good example. + */ + + /* Start a transaction block */ + res = PQexec(conn, "BEGIN"); + if (PQresultStatus(res) != PGRES_COMMAND_OK) + { + fprintf(stderr, "BEGIN command failed: %s", PQerrorMessage(conn)); + PQclear(res); + exit_nicely(conn); + } + + /* + * Should PQclear PGresult whenever it is no longer needed to avoid + * memory leaks + */ + PQclear(res); + + /* + * Fetch rows from pg_database, the system catalog of databases + */ + res = PQexec(conn, "DECLARE myportal CURSOR FOR select * from pg_database"); + if (PQresultStatus(res) != PGRES_COMMAND_OK) + { + fprintf(stderr, "DECLARE CURSOR failed: %s", PQerrorMessage(conn)); + PQclear(res); + exit_nicely(conn); + } + PQclear(res); + + res = PQexec(conn, "FETCH ALL in myportal"); + if (PQresultStatus(res) != PGRES_TUPLES_OK) + { + fprintf(stderr, "FETCH ALL failed: %s", PQerrorMessage(conn)); + PQclear(res); + exit_nicely(conn); + } + + /* first, print out the attribute names */ + nFields = PQnfields(res); + for (i = 0; i < nFields; i++) + printf("%-15s", PQfname(res, i)); + printf("\n\n"); + + /* next, print out the rows */ + for (i = 0; i < PQntuples(res); i++) + { + for (j = 0; j < nFields; j++) + printf("%-15s", PQgetvalue(res, i, j)); + printf("\n"); + } + + PQclear(res); + + /* close the portal ... we don't bother to check for errors ... */ + res = PQexec(conn, "CLOSE myportal"); + PQclear(res); + + /* end the transaction */ + res = PQexec(conn, "END"); + PQclear(res); + + /* close the connection to the database and cleanup */ + PQfinish(conn); + + return 0; } </programlisting> </example> @@ -3701,7 +3864,7 @@ main(int argc, char **argv) <programlisting> /* * testlibpq2.c - * Test of the asynchronous notification interface + * Test of the asynchronous notification interface * * Start this program, then from psql in another window do * NOTIFY TBL2; @@ -3732,102 +3895,102 @@ main(int argc, char **argv) static void exit_nicely(PGconn *conn) { - PQfinish(conn); - exit(1); + PQfinish(conn); + exit(1); } int main(int argc, char **argv) { - const char *conninfo; - PGconn *conn; - PGresult *res; - PGnotify *notify; - int nnotifies; - - /* - * If the user supplies a parameter on the command line, use it as - * the conninfo string; otherwise default to setting dbname=template1 - * and using environment variables or defaults for all other connection - * parameters. - */ - if (argc > 1) - conninfo = argv[1]; - else - conninfo = "dbname = template1"; - - /* Make a connection to the database */ - conn = PQconnectdb(conninfo); - - /* Check to see that the backend connection was successfully made */ - if (PQstatus(conn) != CONNECTION_OK) - { - fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn)); - fprintf(stderr, "%s", PQerrorMessage(conn)); - exit_nicely(conn); - } - - /* - * Issue LISTEN command to enable notifications from the rule's NOTIFY. - */ - res = PQexec(conn, "LISTEN TBL2"); - if (PQresultStatus(res) != PGRES_COMMAND_OK) - { - fprintf(stderr, "LISTEN command failed: %s", PQerrorMessage(conn)); - PQclear(res); - exit_nicely(conn); - } - - /* - * should PQclear PGresult whenever it is no longer needed to avoid - * memory leaks - */ - PQclear(res); - - /* Quit after four notifies are received. */ - nnotifies = 0; - while (nnotifies < 4) - { - /* - * Sleep until something happens on the connection. We use select(2) - * to wait for input, but you could also use poll() or similar - * facilities. - */ - int sock; - fd_set input_mask; - - sock = PQsocket(conn); - - if (sock < 0) - break; /* shouldn't happen */ - - FD_ZERO(&input_mask); - FD_SET(sock, &input_mask); - - if (select(sock + 1, &input_mask, NULL, NULL, NULL) < 0) - { - fprintf(stderr, "select() failed: %s\n", strerror(errno)); - exit_nicely(conn); - } - - /* Now check for input */ - PQconsumeInput(conn); - while ((notify = PQnotifies(conn)) != NULL) - { - fprintf(stderr, - "ASYNC NOTIFY of '%s' received from backend pid %d\n", - notify->relname, notify->be_pid); - PQfreemem(notify); - nnotifies++; - } - } - - fprintf(stderr, "Done.\n"); - - /* close the connection to the database and cleanup */ - PQfinish(conn); - - return 0; + const char *conninfo; + PGconn *conn; + PGresult *res; + PGnotify *notify; + int nnotifies; + + /* + * If the user supplies a parameter on the command line, use it as + * the conninfo string; otherwise default to setting dbname=template1 + * and using environment variables or defaults for all other connection + * parameters. + */ + if (argc > 1) + conninfo = argv[1]; + else + conninfo = "dbname = template1"; + + /* Make a connection to the database */ + conn = PQconnectdb(conninfo); + + /* Check to see that the backend connection was successfully made */ + if (PQstatus(conn) != CONNECTION_OK) + { + fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn)); + fprintf(stderr, "%s", PQerrorMessage(conn)); + exit_nicely(conn); + } + + /* + * Issue LISTEN command to enable notifications from the rule's NOTIFY. + */ + res = PQexec(conn, "LISTEN TBL2"); + if (PQresultStatus(res) != PGRES_COMMAND_OK) + { + fprintf(stderr, "LISTEN command failed: %s", PQerrorMessage(conn)); + PQclear(res); + exit_nicely(conn); + } + + /* + * should PQclear PGresult whenever it is no longer needed to avoid + * memory leaks + */ + PQclear(res); + + /* Quit after four notifies are received. */ + nnotifies = 0; + while (nnotifies < 4) + { + /* + * Sleep until something happens on the connection. We use select(2) + * to wait for input, but you could also use poll() or similar + * facilities. + */ + int sock; + fd_set input_mask; + + sock = PQsocket(conn); + + if (sock < 0) + break; /* shouldn't happen */ + + FD_ZERO(&input_mask); + FD_SET(sock, &input_mask); + + if (select(sock + 1, &input_mask, NULL, NULL, NULL) < 0) + { + fprintf(stderr, "select() failed: %s\n", strerror(errno)); + exit_nicely(conn); + } + + /* Now check for input */ + PQconsumeInput(conn); + while ((notify = PQnotifies(conn)) != NULL) + { + fprintf(stderr, + "ASYNC NOTIFY of '%s' received from backend pid %d\n", + notify->relname, notify->be_pid); + PQfreemem(notify); + nnotifies++; + } + } + + fprintf(stderr, "Done.\n"); + + /* close the connection to the database and cleanup */ + PQfinish(conn); + + return 0; } </programlisting> </example> @@ -3838,7 +4001,7 @@ main(int argc, char **argv) <programlisting> /* * testlibpq3.c - * Test out-of-line parameters and binary I/O. + * Test out-of-line parameters and binary I/O. * * Before running this, populate a database with the following commands * (provided in src/test/examples/testlibpq3.sql): @@ -3870,125 +4033,125 @@ main(int argc, char **argv) static void exit_nicely(PGconn *conn) { - PQfinish(conn); - exit(1); + PQfinish(conn); + exit(1); } int main(int argc, char **argv) { - const char *conninfo; - PGconn *conn; - PGresult *res; - const char *paramValues[1]; - int i, - j; - int i_fnum, - t_fnum, - b_fnum; - - /* - * If the user supplies a parameter on the command line, use it as - * the conninfo string; otherwise default to setting dbname=template1 - * and using environment variables or defaults for all other connection - * parameters. - */ - if (argc > 1) - conninfo = argv[1]; - else - conninfo = "dbname = template1"; - - /* Make a connection to the database */ - conn = PQconnectdb(conninfo); - - /* Check to see that the backend connection was successfully made */ - if (PQstatus(conn) != CONNECTION_OK) - { - fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn)); - fprintf(stderr, "%s", PQerrorMessage(conn)); - exit_nicely(conn); - } - - /* - * The point of this program is to illustrate use of PQexecParams() - * with out-of-line parameters, as well as binary transmission of - * results. By using out-of-line parameters we can avoid a lot of - * tedious mucking about with quoting and escaping. Notice how we - * don't have to do anything special with the quote mark in the - * parameter value. - */ - - /* Here is our out-of-line parameter value */ - paramValues[0] = "joe's place"; - - res = PQexecParams(conn, - "SELECT * FROM test1 WHERE t = $1", - 1, /* one param */ - NULL, /* let the backend deduce param type */ - paramValues, - NULL, /* don't need param lengths since text */ - NULL, /* default to all text params */ - 1); /* ask for binary results */ - - if (PQresultStatus(res) != PGRES_TUPLES_OK) - { - fprintf(stderr, "SELECT failed: %s", PQerrorMessage(conn)); - PQclear(res); - exit_nicely(conn); - } - - /* Use PQfnumber to avoid assumptions about field order in result */ - i_fnum = PQfnumber(res, "i"); - t_fnum = PQfnumber(res, "t"); - b_fnum = PQfnumber(res, "b"); - - for (i = 0; i < PQntuples(res); i++) - { - char *iptr; - char *tptr; - char *bptr; - int blen; - int ival; - - /* Get the field values (we ignore possibility they are null!) */ - iptr = PQgetvalue(res, i, i_fnum); - tptr = PQgetvalue(res, i, t_fnum); - bptr = PQgetvalue(res, i, b_fnum); - - /* - * The binary representation of INT4 is in network byte order, - * which we'd better coerce to the local byte order. - */ - ival = ntohl(*((uint32_t *) iptr)); - - /* - * The binary representation of TEXT is, well, text, and since - * libpq was nice enough to append a zero byte to it, it'll work - * just fine as a C string. - * - * The binary representation of BYTEA is a bunch of bytes, which - * could include embedded nulls so we have to pay attention to - * field length. - */ - blen = PQgetlength(res, i, b_fnum); - - printf("tuple %d: got\n", i); - printf(" i = (%d bytes) %d\n", - PQgetlength(res, i, i_fnum), ival); - printf(" t = (%d bytes) '%s'\n", - PQgetlength(res, i, t_fnum), tptr); - printf(" b = (%d bytes) ", blen); - for (j = 0; j < blen; j++) - printf("\\%03o", bptr[j]); - printf("\n\n"); - } - - PQclear(res); - - /* close the connection to the database and cleanup */ - PQfinish(conn); - - return 0; + const char *conninfo; + PGconn *conn; + PGresult *res; + const char *paramValues[1]; + int i, + j; + int i_fnum, + t_fnum, + b_fnum; + + /* + * If the user supplies a parameter on the command line, use it as + * the conninfo string; otherwise default to setting dbname=template1 + * and using environment variables or defaults for all other connection + * parameters. + */ + if (argc > 1) + conninfo = argv[1]; + else + conninfo = "dbname = template1"; + + /* Make a connection to the database */ + conn = PQconnectdb(conninfo); + + /* Check to see that the backend connection was successfully made */ + if (PQstatus(conn) != CONNECTION_OK) + { + fprintf(stderr, "Connection to database '%s' failed.\n", PQdb(conn)); + fprintf(stderr, "%s", PQerrorMessage(conn)); + exit_nicely(conn); + } + + /* + * The point of this program is to illustrate use of PQexecParams() + * with out-of-line parameters, as well as binary transmission of + * results. By using out-of-line parameters we can avoid a lot of + * tedious mucking about with quoting and escaping. Notice how we + * don't have to do anything special with the quote mark in the + * parameter value. + */ + + /* Here is our out-of-line parameter value */ + paramValues[0] = "joe's place"; + + res = PQexecParams(conn, + "SELECT * FROM test1 WHERE t = $1", + 1, /* one param */ + NULL, /* let the backend deduce param type */ + paramValues, + NULL, /* don't need param lengths since text */ + NULL, /* default to all text params */ + 1); /* ask for binary results */ + + if (PQresultStatus(res) != PGRES_TUPLES_OK) + { + fprintf(stderr, "SELECT failed: %s", PQerrorMessage(conn)); + PQclear(res); + exit_nicely(conn); + } + + /* Use PQfnumber to avoid assumptions about field order in result */ + i_fnum = PQfnumber(res, "i"); + t_fnum = PQfnumber(res, "t"); + b_fnum = PQfnumber(res, "b"); + + for (i = 0; i < PQntuples(res); i++) + { + char *iptr; + char *tptr; + char *bptr; + int blen; + int ival; + + /* Get the field values (we ignore possibility they are null!) */ + iptr = PQgetvalue(res, i, i_fnum); + tptr = PQgetvalue(res, i, t_fnum); + bptr = PQgetvalue(res, i, b_fnum); + + /* + * The binary representation of INT4 is in network byte order, + * which we'd better coerce to the local byte order. + */ + ival = ntohl(*((uint32_t *) iptr)); + + /* + * The binary representation of TEXT is, well, text, and since + * libpq was nice enough to append a zero byte to it, it'll work + * just fine as a C string. + * + * The binary representation of BYTEA is a bunch of bytes, which + * could include embedded nulls so we have to pay attention to + * field length. + */ + blen = PQgetlength(res, i, b_fnum); + + printf("tuple %d: got\n", i); + printf(" i = (%d bytes) %d\n", + PQgetlength(res, i, i_fnum), ival); + printf(" t = (%d bytes) '%s'\n", + PQgetlength(res, i, t_fnum), tptr); + printf(" b = (%d bytes) ", blen); + for (j = 0; j < blen; j++) + printf("\\%03o", bptr[j]); + printf("\n\n"); + } + + PQclear(res); + + /* close the connection to the database and cleanup */ + PQfinish(conn); + + return 0; } </programlisting> </example> diff --git a/doc/src/sgml/lobj.sgml b/doc/src/sgml/lobj.sgml index 019c715c25f..c41c7571a61 100644 --- a/doc/src/sgml/lobj.sgml +++ b/doc/src/sgml/lobj.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/lobj.sgml,v 1.29 2003/06/21 21:51:33 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/lobj.sgml,v 1.29.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="largeObjects"> @@ -113,6 +113,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/lobj.sgml,v 1.29 2003/06/21 21:51:33 tgl Ex <synopsis> Oid lo_creat(PGconn *conn, int mode); </synopsis> + <indexterm><primary>lo_creat</></> creates a new large object. <replaceable class="parameter">mode</replaceable> is a bit mask describing several different attributes of the new @@ -143,7 +144,8 @@ inv_oid = lo_creat(INV_READ|INV_WRITE); <synopsis> Oid lo_import(PGconn *conn, const char *filename); </synopsis> - <replaceable class="parameter">filename</replaceable> + <indexterm><primary>lo_import</></> + <replaceable class="parameter">filename</replaceable> specifies the operating system name of the file to be imported as a large object. The return value is the OID that was assigned to the new large object. @@ -159,6 +161,7 @@ Oid lo_import(PGconn *conn, const char *filename); <synopsis> int lo_export(PGconn *conn, Oid lobjId, const char *filename); </synopsis> + <indexterm><primary>lo_export</></> The <parameter>lobjId</parameter> argument specifies the OID of the large object to export and the <parameter>filename</parameter> argument specifies the operating system name name of the file. @@ -173,6 +176,7 @@ int lo_export(PGconn *conn, Oid lobjId, const char *filename); <synopsis> int lo_open(PGconn *conn, Oid lobjId, int mode); </synopsis> + <indexterm><primary>lo_open</></> The <parameter>lobjId</parameter> argument specifies the OID of the large object to open. The <parameter>mode</parameter> bits control whether the object is opened for reading (<symbol>INV_READ</>), writing (<symbol>INV_WRITE</symbol>), or @@ -194,10 +198,13 @@ int lo_open(PGconn *conn, Oid lobjId, int mode); <synopsis> int lo_write(PGconn *conn, int fd, const char *buf, size_t len); </synopsis> - writes <parameter>len</parameter> bytes from <parameter>buf</parameter> to large object <parameter>fd</>. The <parameter>fd</parameter> - argument must have been returned by a previous <function>lo_open</function>. - The number of bytes actually written is returned. In - the event of an error, the return value is negative. + <indexterm><primary>lo_write</></> writes + <parameter>len</parameter> bytes from <parameter>buf</parameter> + to large object <parameter>fd</>. The <parameter>fd</parameter> + argument must have been returned by a previous + <function>lo_open</function>. The number of bytes actually + written is returned. In the event of an error, the return value + is negative. </para> </sect2> @@ -209,10 +216,13 @@ int lo_write(PGconn *conn, int fd, const char *buf, size_t len); <synopsis> int lo_read(PGconn *conn, int fd, char *buf, size_t len); </synopsis> - reads <parameter>len</parameter> bytes from large object <parameter>fd</parameter> into <parameter>buf</parameter>. The <parameter>fd</parameter> - argument must have been returned by a previous <function>lo_open</function>. - The number of bytes actually read is returned. In - the event of an error, the return value is negative. + <indexterm><primary>lo_read</></> reads + <parameter>len</parameter> bytes from large object + <parameter>fd</parameter> into <parameter>buf</parameter>. The + <parameter>fd</parameter> argument must have been returned by a + previous <function>lo_open</function>. The number of bytes + actually read is returned. In the event of an error, the return + value is negative. </para> </sect2> @@ -225,10 +235,14 @@ int lo_read(PGconn *conn, int fd, char *buf, size_t len); <synopsis> int lo_lseek(PGconn *conn, int fd, int offset, int whence); </synopsis> - This function moves the current location pointer for the - large object described by <parameter>fd</> to the new location specified - by <parameter>offset</>. The valid values for <parameter>whence</> are - <symbol>SEEK_SET</> (seek from object start), <symbol>SEEK_CUR</> (seek from current position), and <symbol>SEEK_END</> (seek from object end). The return value is the new location pointer. + <indexterm><primary>lo_lseek</></> This function moves the + current location pointer for the large object described by + <parameter>fd</> to the new location specified by + <parameter>offset</>. The valid values for <parameter>whence</> + are <symbol>SEEK_SET</> (seek from object start), + <symbol>SEEK_CUR</> (seek from current position), and + <symbol>SEEK_END</> (seek from object end). The return value is + the new location pointer. </para> </sect2> @@ -241,7 +255,8 @@ int lo_lseek(PGconn *conn, int fd, int offset, int whence); <synopsis> int lo_tell(PGconn *conn, int fd); </synopsis> - If there is an error, the return value is negative. + <indexterm><primary>lo_tell</></> If there is an error, the + return value is negative. </para> </sect2> @@ -253,9 +268,10 @@ int lo_tell(PGconn *conn, int fd); <synopsis> int lo_close(PGconn *conn, int fd); </synopsis> - where <parameter>fd</> is a large object descriptor returned by - <function>lo_open</function>. On success, <function>lo_close</function> - returns zero. On error, the return value is negative. + <indexterm><primary>lo_close</></> where <parameter>fd</> is a + large object descriptor returned by <function>lo_open</function>. + On success, <function>lo_close</function> returns zero. On + error, the return value is negative. </para> <para> @@ -272,8 +288,10 @@ int lo_close(PGconn *conn, int fd); <synopsis> int lo_unlink(PGconn *conn, Oid lobjId); </synopsis> - The <parameter>lobjId</parameter> argument specifies the OID of the large - object to remove. In the event of an error, the return value is negative. + <indexterm><primary>lo_unlink</></> The + <parameter>lobjId</parameter> argument specifies the OID of the + large object to remove. In the event of an error, the return + value is negative. </para> </sect2> @@ -284,11 +302,13 @@ int lo_unlink(PGconn *conn, Oid lobjId); <title>Server-side Functions</title> <para> - There are two built-in server-side functions, <function>lo_import</function> - and <function>lo_export</function>, for large object access, which are available for use - in <acronym>SQL</acronym> - commands. - Here is an example of their use: + There are two built-in server-side functions, + <function>lo_import</function><indexterm><primary>lo_import</></> + and + <function>lo_export</function>,<indexterm><primary>lo_export</></> + for large object access, which are available for use in + <acronym>SQL</acronym> commands. Here is an example of their + use: <programlisting> CREATE TABLE image ( name text, diff --git a/doc/src/sgml/maintenance.sgml b/doc/src/sgml/maintenance.sgml index 122137ad2b9..4404c5e929e 100644 --- a/doc/src/sgml/maintenance.sgml +++ b/doc/src/sgml/maintenance.sgml @@ -1,10 +1,14 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/maintenance.sgml,v 1.23 2003/06/18 12:19:11 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/maintenance.sgml,v 1.23.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="maintenance"> <title>Routine Database Maintenance Tasks</title> + <indexterm zone="maintenance"> + <primary>maintenance</primary> + </indexterm> + <para> There are a few routine maintenance chores that must be performed on a regular basis to keep a <productname>PostgreSQL</productname> @@ -158,6 +162,15 @@ $Header: /cvsroot/pgsql/doc/src/sgml/maintenance.sgml,v 1.23 2003/06/18 12:19:11 <sect2 id="vacuum-for-statistics"> <title>Updating planner statistics</title> + <indexterm zone="vacuum-for-statistics"> + <primary>statistics</primary> + <secondary>of the planner</secondary> + </indexterm> + + <indexterm zone="vacuum-for-statistics"> + <primary>ANALYZE</primary> + </indexterm> + <para> The <productname>PostgreSQL</productname> query planner relies on statistical information about the contents of tables in order to @@ -396,7 +409,8 @@ VACUUM <title>Log File Maintenance</title> <indexterm zone="logfile-maintenance"> - <primary>log files</primary> + <primary>server log</primary> + <secondary>log file maintenance</secondary> </indexterm> <para> diff --git a/doc/src/sgml/manage-ag.sgml b/doc/src/sgml/manage-ag.sgml index dd0b390230c..c55f78f5cb7 100644 --- a/doc/src/sgml/manage-ag.sgml +++ b/doc/src/sgml/manage-ag.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.27 2003/03/25 16:15:37 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.27.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="managing-databases"> @@ -19,6 +19,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.27 2003/03/25 16:15:37 p <sect1 id="manage-ag-overview"> <title>Overview</title> + <indexterm zone="manage-ag-overview"> + <primary>schema</primary> + </indexterm> + <para> A database is a named collection of <acronym>SQL</acronym> objects (<quote>database objects</quote>). Generally, every database @@ -70,8 +74,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.27 2003/03/25 16:15:37 p </para> <para> - Databases are created with the SQL command - <command>CREATE DATABASE</command>: + Databases are created with the SQL command <command>CREATE + DATABASE</command>:<indexterm><primary>CREATE DATABASE</></> <synopsis> CREATE DATABASE <replaceable>name</>; </synopsis> @@ -93,9 +97,10 @@ CREATE DATABASE <replaceable>name</>; question remains how the <emphasis>first</> database at any given site can be created. The first database is always created by the <command>initdb</> command when the data storage area is - initialized. (See <xref linkend="creating-cluster">.) - This database is called <literal>template1</>. So to create the - first <quote>real</> database you can connect to + initialized. (See <xref linkend="creating-cluster">.) This + database is called + <literal>template1</>.<indexterm><primary>template1</></> So to + create the first <quote>real</> database you can connect to <literal>template1</>. </para> @@ -112,7 +117,7 @@ CREATE DATABASE <replaceable>name</>; <para> As an extra convenience, there is also a program that you can execute from the shell to create new databases, - <command>createdb</>. + <command>createdb</>.<indexterm><primary>createdb</></> <synopsis> createdb <replaceable class="parameter">dbname</replaceable> @@ -157,31 +162,33 @@ createdb -O <replaceable>username</> <replaceable>dbname</> <para> <command>CREATE DATABASE</> actually works by copying an existing database. By default, it copies the standard system database named - <literal>template1</>. Thus that database is the <quote>template</> - from which new databases are made. If you add objects to - <literal>template1</>, these objects + <literal>template1</>.<indexterm><primary>template1</></> Thus that + database is the <quote>template</> from which new databases are + made. If you add objects to <literal>template1</>, these objects will be copied into subsequently created user databases. This behavior allows site-local modifications to the standard set of objects in databases. For example, if you install the procedural language <application>PL/pgSQL</> in <literal>template1</>, it will - automatically be available in user databases without any extra action - being taken when those databases are made. + automatically be available in user databases without any extra + action being taken when those databases are made. </para> <para> - There is a second standard system database named <literal>template0</>. - This database contains the same data as the initial contents of - <literal>template1</>, that is, only the standard objects predefined by - your version of <productname>PostgreSQL</productname>. - <literal>template0</> should never be changed - after <command>initdb</>. By instructing <command>CREATE DATABASE</> to - copy <literal>template0</> instead of <literal>template1</>, you can - create a <quote>virgin</> user database that contains none of the - site-local additions in <literal>template1</>. This is particularly - handy when restoring a <literal>pg_dump</> dump: the dump script should - be restored in a virgin database to ensure that one recreates the - correct contents of the dumped database, without any conflicts with - additions that may now be present in <literal>template1</>. + There is a second standard system database named + <literal>template0</>.<indexterm><primary>template0</></> This + database contains the same data as the initial contents of + <literal>template1</>, that is, only the standard objects + predefined by your version of + <productname>PostgreSQL</productname>. <literal>template0</> + should never be changed after <command>initdb</>. By instructing + <command>CREATE DATABASE</> to copy <literal>template0</> instead + of <literal>template1</>, you can create a <quote>virgin</> user + database that contains none of the site-local additions in + <literal>template1</>. This is particularly handy when restoring a + <literal>pg_dump</> dump: the dump script should be restored in a + virgin database to ensure that one recreates the correct contents + of the dumped database, without any conflicts with additions that + may now be present in <literal>template1</>. </para> <para> @@ -214,7 +221,7 @@ createdb -T template0 <replaceable>dbname</> </para> <para> - Two useful flags exist in <literal>pg_database</literal> for each + Two useful flags exist in <literal>pg_database</literal><indexterm><primary>pg_database</></> for each database: the columns <literal>datistemplate</literal> and <literal>datallowconn</literal>. <literal>datistemplate</literal> may be set to indicate that a database is intended as a template for @@ -382,7 +389,8 @@ gmake CPPFLAGS=-DALLOW_ABSOLUTE_DBPATHS all <title>Destroying a Database</title> <para> - Databases are destroyed with the command <command>DROP DATABASE</command>: + Databases are destroyed with the command <command>DROP + DATABASE</command>:<indexterm><primary>DROP DATABASE</></> <synopsis> DROP DATABASE <replaceable>name</>; </synopsis> @@ -403,7 +411,8 @@ DROP DATABASE <replaceable>name</>; </para> <para> - For convenience, there is also a shell program to drop databases: + For convenience, there is also a shell program to drop + databases:<indexterm><primary>dropdb</></> <synopsis> dropdb <replaceable class="parameter">dbname</replaceable> </synopsis> diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 90a77d0a2c8..03ca970c768 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -1,10 +1,20 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/monitoring.sgml,v 1.20 2003/04/04 03:03:53 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/monitoring.sgml,v 1.20.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="monitoring"> <title>Monitoring Database Activity</title> + <indexterm zone="monitoring"> + <primary>monitoring</primary> + <secondary>database activity</secondary> + </indexterm> + + <indexterm zone="monitoring"> + <primary>database activity</primary> + <secondary>monitoring</secondary> + </indexterm> + <para> A database administrator frequently wonders, <quote>What is the system doing right now?</quote> @@ -589,6 +599,11 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS procpid, <sect1 id="monitoring-locks"> <title>Viewing Locks</title> + <indexterm zone="monitoring-locks"> + <primary>lock</primary> + <secondary>monitoring</secondary> + </indexterm> + <para> Another useful tool for monitoring database activity is the <literal>pg_locks</literal> system table. It allows the diff --git a/doc/src/sgml/mvcc.sgml b/doc/src/sgml/mvcc.sgml index b5cda133ef2..077b0c3219c 100644 --- a/doc/src/sgml/mvcc.sgml +++ b/doc/src/sgml/mvcc.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.35 2003/03/25 16:15:37 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.35.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="mvcc"> @@ -22,6 +22,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.35 2003/03/25 16:15:37 petere <sect1 id="mvcc-intro"> <title>Introduction</title> + <indexterm> + <primary>MVCC</primary> + </indexterm> + <para> Unlike traditional database systems which use locks for concurrency control, <productname>PostgreSQL</productname> @@ -57,6 +61,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.35 2003/03/25 16:15:37 petere <sect1 id="transaction-iso"> <title>Transaction Isolation</title> + <indexterm> + <primary>transaction isolation</primary> + </indexterm> + <para> The <acronym>SQL</acronym> standard defines four levels of transaction isolation in terms of three phenomena that must be @@ -108,7 +116,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.35 2003/03/25 16:15:37 petere <para> <indexterm> - <primary>isolation levels</primary> + <primary>transaction isolation level</primary> </indexterm> The four transaction isolation levels and the corresponding behaviors are described in <xref linkend="mvcc-isolevel-table">. @@ -206,7 +214,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.35 2003/03/25 16:15:37 petere <title>Read Committed Isolation Level</title> <indexterm> - <primary>isolation levels</primary> + <primary>transaction isolation level</primary> <secondary>read committed</secondary> </indexterm> @@ -292,7 +300,7 @@ COMMIT; <title>Serializable Isolation Level</title> <indexterm> - <primary>isolation levels</primary> + <primary>transaction isolation level</primary> <secondary>serializable</secondary> </indexterm> @@ -376,7 +384,7 @@ ERROR: Can't serialize access due to concurrent update <title>Explicit Locking</title> <indexterm> - <primary>locking</primary> + <primary>lock</primary> </indexterm> <para> @@ -394,6 +402,10 @@ ERROR: Can't serialize access due to concurrent update <sect2 id="locking-tables"> <title>Table-Level Locks</title> + <indexterm zone="locking-tables"> + <primary>LOCK</primary> + </indexterm> + <para> The list below shows the available lock modes and the contexts in which they are used automatically by @@ -644,6 +656,10 @@ ERROR: Can't serialize access due to concurrent update <sect2 id="locking-deadlocks"> <title>Deadlocks</title> + <indexterm zone="locking-deadlocks"> + <primary>deadlock</primary> + </indexterm> + <para> The use of explicit locking can increase the likelyhood of <firstterm>deadlocks</>, wherein two (or more) transactions each @@ -813,6 +829,11 @@ UPDATE accounts SET balance = balance - 100.00 WHERE acctnum = 22222; <sect1 id="locking-indexes"> <title>Locking and Indexes</title> + <indexterm zone="locking-indexes"> + <primary>index</primary> + <secondary>locks</secondary> + </indexterm> + <para> Though <productname>PostgreSQL</productname> provides nonblocking read/write access to table diff --git a/doc/src/sgml/perform.sgml b/doc/src/sgml/perform.sgml index 0de183a01e0..fa887a406e4 100644 --- a/doc/src/sgml/perform.sgml +++ b/doc/src/sgml/perform.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.30 2003/06/25 02:07:33 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.30.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="performance-tips"> @@ -15,6 +15,14 @@ $Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.30 2003/06/25 02:07:33 mom <sect1 id="using-explain"> <title>Using <command>EXPLAIN</command></title> + <indexterm zone="using-explain"> + <primary>EXPLAIN</primary> + </indexterm> + + <indexterm zone="using-explain"> + <primary>query plan</primary> + </indexterm> + <para> <productname>PostgreSQL</productname> devises a <firstterm>query plan</firstterm> for each query it is given. Choosing the right @@ -336,6 +344,11 @@ EXPLAIN ANALYZE SELECT * FROM tenk1 t1, tenk2 t2 WHERE t1.unique1 < 50 AND t1 <sect1 id="planner-stats"> <title>Statistics Used by the Planner</title> + <indexterm zone="planner-stats"> + <primary>statistics</primary> + <secondary>of the planner</secondary> + </indexterm> + <para> As we saw in the previous section, the query planner needs to estimate the number of rows retrieved by a query in order to make good choices @@ -381,6 +394,10 @@ SELECT relname, relkind, reltuples, relpages FROM pg_class WHERE relname LIKE 't since it does not read every row of the table. </para> + <indexterm> + <primary>pg_statistic</primary> + </indexterm> + <para> Most queries retrieve only a fraction of the rows in a table, due to having <literal>WHERE</> clauses that restrict the rows to be examined. @@ -393,6 +410,10 @@ SELECT relname, relkind, reltuples, relpages FROM pg_class WHERE relname LIKE 't and are always approximate even when freshly updated. </para> + <indexterm> + <primary>pg_stats</primary> + </indexterm> + <para> Rather than look at <structname>pg_statistic</structname> directly, it's better to look at its view <structname>pg_stats</structname> @@ -538,6 +559,11 @@ SELECT attname, n_distinct, most_common_vals FROM pg_stats WHERE tablename = 'ro <sect1 id="explicit-joins"> <title>Controlling the Planner with Explicit <literal>JOIN</> Clauses</title> + <indexterm zone="explicit-joins"> + <primary>join</primary> + <secondary>controlling the order</secondary> + </indexterm> + <para> It is possible to control the query planner to some extent by using the explicit <literal>JOIN</> @@ -700,6 +726,10 @@ SELECT * FROM x, y, a, b, c WHERE something AND somethingelse; <sect2 id="disable-autocommit"> <title>Disable Autocommit</title> + <indexterm zone="disable-autocommit"> + <primary>autocommit</primary> + </indexterm> + <para> Turn off autocommit and just do one commit at the end. (In plain SQL, this means issuing <command>BEGIN</command> diff --git a/doc/src/sgml/plperl.sgml b/doc/src/sgml/plperl.sgml index 02d38bc5340..55eb99a439a 100644 --- a/doc/src/sgml/plperl.sgml +++ b/doc/src/sgml/plperl.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/plperl.sgml,v 2.19 2003/04/07 01:29:25 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/plperl.sgml,v 2.19.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="plperl"> @@ -73,11 +73,12 @@ CREATE FUNCTION perl_max (integer, integer) RETURNS integer AS ' </para> <para> - If an SQL null value is passed to a function, the argument value - will appear as <quote>undefined</> in Perl. The above function - definition will not behave very nicely with null inputs (in fact, - it will act as though they are zeroes). We could add - <literal>STRICT</> to the function definition to make + If an SQL null value<indexterm><primary>null value</><secondary + sortas="PL/Perl">in PL/Perl</></indexterm> is passed to a function, + the argument value will appear as <quote>undefined</> in Perl. The + above function definition will not behave very nicely with null + inputs (in fact, it will act as though they are zeroes). We could + add <literal>STRICT</> to the function definition to make <productname>PostgreSQL</productname> do something more reasonable: if a null value is passed, the function will not be called at all, but will just return a null result automatically. Alternatively, @@ -170,7 +171,7 @@ SELECT name, empcomp(employee) FROM employee; mirror sites</ulink>). This module makes available a <acronym>DBI</>-compliant database-handle named <varname>$pg_dbh</varname> that can be used to perform queries - with normal <acronym>DBI</> syntax. + with normal <acronym>DBI</> syntax.<indexterm><primary>DBI</></indexterm> </para> <para> @@ -180,7 +181,7 @@ SELECT name, empcomp(employee) FROM employee; <varlistentry> <indexterm> <primary>elog</primary> - <secondary>PL/Perl</secondary> + <secondary>in PL/Perl</secondary> </indexterm> <term><function>elog</> <replaceable>level</replaceable>, <replaceable>msg</replaceable></term> @@ -202,6 +203,11 @@ SELECT name, empcomp(employee) FROM employee; <sect1 id="plperl-trusted"> <title>Trusted and Untrusted PL/Perl</title> + <indexterm zone="plperl-trusted"> + <primary>trusted</primary> + <secondary>PL/Perl</secondary> + </indexterm> + <para> Normally, PL/Perl is installed as a <quote>trusted</> programming language named <literal>plperl</>. In this setup, certain Perl @@ -231,13 +237,14 @@ CREATE FUNCTION badfunc() RETURNS integer AS ' <para> Sometimes it is desirable to write Perl functions that are not - restricted. For example, one might want a Perl function that - sends mail. To handle these cases, PL/Perl can also be installed - as an <quote>untrusted</> language (usually called - <application>PL/PerlU</application>). In this case the full Perl language is - available. If the <command>createlang</command> program is used to - install the language, the language name <literal>plperlu</literal> - will select the untrusted PL/Perl variant. + restricted. For example, one might want a Perl function that sends + mail. To handle these cases, PL/Perl can also be installed as an + <quote>untrusted</> language (usually called + <application>PL/PerlU</application><indexterm><primary>PL/PerlU</></indexterm>). + In this case the full Perl language is available. If the + <command>createlang</command> program is used to install the + language, the language name <literal>plperlu</literal> will select + the untrusted PL/Perl variant. </para> <para> @@ -272,7 +279,9 @@ CREATE FUNCTION badfunc() RETURNS integer AS ' <listitem> <para> - PL/Perl cannot be used to write trigger functions. + PL/Perl cannot be used to write trigger + functions.<indexterm><primary>trigger</><secondary>in + PL/Perl</></indexterm> </para> </listitem> diff --git a/doc/src/sgml/plpgsql.sgml b/doc/src/sgml/plpgsql.sgml index b313860ea0c..c616cec5cdc 100644 --- a/doc/src/sgml/plpgsql.sgml +++ b/doc/src/sgml/plpgsql.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/plpgsql.sgml,v 1.20 2003/08/09 22:50:22 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/plpgsql.sgml,v 1.20.2.1 2003/09/07 04:36:42 momjian Exp $ --> <chapter id="plpgsql"> @@ -63,20 +63,22 @@ $Header: /cvsroot/pgsql/doc/src/sgml/plpgsql.sgml,v 1.20 2003/08/09 22:50:22 tgl </para> <para> - As each expression and <acronym>SQL</acronym> command is first used - in the function, the <application>PL/pgSQL</> interpreter creates - a prepared execution plan (using the <acronym>SPI</acronym> - manager's <function>SPI_prepare</function> and - <function>SPI_saveplan</function> functions). Subsequent visits - to that expression or command reuse the prepared plan. Thus, a - function with conditional code that contains many statements for - which execution plans might be required will only prepare and save - those plans that are really used during the lifetime of the - database connection. This can substantially reduce the total - amount of time required to parse, and generate execution plans for the - statements in a <application>PL/pgSQL</> function. A disadvantage is - that errors in a specific expression or command may not be detected - until that part of the function is reached in execution. + As each expression and <acronym>SQL</acronym> command is first + used in the function, the <application>PL/pgSQL</> interpreter + creates a prepared execution plan (using the + <acronym>SPI</acronym> manager's <function>SPI_prepare</function> + and <function>SPI_saveplan</function> + functions).<indexterm><primary>preparing a query</><secondary>in + PL/pgSQL</></> Subsequent visits to that expression or command + reuse the prepared plan. Thus, a function with conditional code + that contains many statements for which execution plans might be + required will only prepare and save those plans that are really + used during the lifetime of the database connection. This can + substantially reduce the total amount of time required to parse, + and generate execution plans for the statements in a + <application>PL/pgSQL</> function. A disadvantage is that errors + in a specific expression or command may not be detected until that + part of the function is reached in execution. </para> <para> @@ -196,7 +198,7 @@ END; and return the <quote>polymorphic</> types <type>anyelement</type> and <type>anyarray</type>. The actual datatypes handled by a polymorphic function can vary from call to - call, as discussed in <xref linkend="types-polymorphic">. + call, as discussed in <xref linkend="extend-types-polymorphic">. An example is shown in <xref linkend="plpgsql-declaration-aliases">. </para> @@ -563,7 +565,7 @@ END; or <type>anyarray</type>), a special parameter <literal>$0</literal> is created. Its datatype is the actual return type of the function, as deduced from the actual input types (see <xref - linkend="types-polymorphic">). + linkend="extend-types-polymorphic">). This allows the function to access its actual return type as shown in <xref linkend="plpgsql-declaration-type">. <literal>$0</literal> is initialized to NULL and can be modified by @@ -903,6 +905,11 @@ tax := subtotal * 0.06; <sect2 id="plpgsql-select-into"> <title><command>SELECT INTO</command></title> + <indexterm zone="plpgsql-select-into"> + <primary>SELECT INTO</primary> + <secondary>in PL/pgSQL</secondary> + </indexterm> + <para> The result of a <command>SELECT</command> command yielding multiple columns (but only one row) can be assigned to a record variable, row-type @@ -1097,14 +1104,16 @@ EXECUTE ''UPDATE tbl SET '' <para> This example shows use of the functions <function>quote_ident(<type>text</type>)</function> and - <function>quote_literal(<type>text</type>)</function>. - Variables containing column and table identifiers should be - passed to function <function>quote_ident</function>. - Variables containing values that should be literal strings in the - constructed command should be passed to - <function>quote_literal</function>. Both take the - appropriate steps to return the input text enclosed in double - or single quotes respectively, with any embedded special characters + <function>quote_literal(<type>text</type>)</function>.<indexterm><primary>quote_ident</><secondary>use + in + PL/pgSQL</></indexterm><indexterm><primary>quote_literal</><secondary>use + in PL/pgSQL</></indexterm> Variables containing column and table + identifiers should be passed to function + <function>quote_ident</function>. Variables containing values + that should be literal strings in the constructed command should + be passed to <function>quote_literal</function>. Both take the + appropriate steps to return the input text enclosed in double or + single quotes respectively, with any embedded special characters properly escaped. </para> @@ -1517,6 +1526,11 @@ END IF; <sect2 id="plpgsql-control-structures-loops"> <title>Simple Loops</title> + <indexterm zone="plpgsql-control-structures-loops"> + <primary>loop</primary> + <secondary>in PL/pgSQL</secondary> + </indexterm> + <para> With the <literal>LOOP</>, <literal>EXIT</>, <literal>WHILE</>, and <literal>FOR</> statements, you can arrange for your @@ -1655,6 +1669,11 @@ FOR i IN REVERSE 10..1 LOOP END LOOP; </programlisting> </para> + + <para> + If the lower bound is greater than the upper bound, the loop body is not + executed at all, but no error is raised. + </para> </sect3> </sect2> @@ -1734,6 +1753,11 @@ END LOOP; <sect1 id="plpgsql-cursors"> <title>Cursors</title> + <indexterm zone="plpgsql-cursors"> + <primary>cursor</primary> + <secondary>in PL/pgSQL</secondary> + </indexterm> + <para> Rather than executing a whole query at once, it is possible to set up a <firstterm>cursor</> that encapsulates the query, and then read @@ -2096,6 +2120,11 @@ RAISE EXCEPTION ''Inexistent ID --> %'', user_id; <sect1 id="plpgsql-trigger"> <title>Trigger Procedures</title> + <indexterm zone="plpgsql-trigger"> + <primary>trigger</primary> + <secondary>in PL/pgSQL</secondary> + </indexterm> + <para> <application>PL/pgSQL</application> can be used to define trigger procedures. A trigger procedure is created with the @@ -2302,10 +2331,12 @@ CREATE TRIGGER emp_stamp BEFORE INSERT OR UPDATE ON emp <indexterm zone="plpgsql-porting"> <primary>Oracle</primary> + <secondary>porting from PL/SQL to PL/pgSQL</secondary> </indexterm> <indexterm zone="plpgsql-porting"> - <primary>PL/SQL</primary> + <primary>PL/SQL (Oracle)</primary> + <secondary>porting to PL/pgSQL</secondary> </indexterm> <para> @@ -2546,7 +2577,8 @@ END; with <literal>OUT</> parameters and string manipulation. <productname>PostgreSQL</> does not have an <function>instr</function> function, but you can work around it - using a combination of other functions. In <xref + using a combination of other + functions.<indexterm><primary>instr</></indexterm> In <xref linkend="plpgsql-porting-appendix"> there is a <application>PL/pgSQL</application> implementation of <function>instr</function> that you can use to make your porting diff --git a/doc/src/sgml/plpython.sgml b/doc/src/sgml/plpython.sgml index 0a101384ee7..8d476a7a43a 100644 --- a/doc/src/sgml/plpython.sgml +++ b/doc/src/sgml/plpython.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/plpython.sgml,v 1.18 2003/07/01 13:52:29 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/plpython.sgml,v 1.18.2.1 2003/09/07 04:36:43 momjian Exp $ --> <chapter id="plpython"> <title>PL/Python - Python Procedural Language</title> @@ -68,9 +68,10 @@ def __plpython_procedure_myfunc_23456(): <para> If you do not provide a return value, Python returns the default - <symbol>None</symbol>. The - language module translates Python's <symbol>None</symbol> into the - SQL null value. + <symbol>None</symbol>. The language module translates Python's + <symbol>None</symbol> into the SQL null + value.<indexterm><primary>null value</><secondary + sortas="PL/Python">in PL/Python</></indexterm> </para> <para> @@ -87,7 +88,9 @@ def __plpython_procedure_myfunc_23456(): The global dictionary <varname>SD</varname> is available to store data between function calls. This variable is private static data. The global dictionary <varname>GD</varname> is public data, - available to all Python functions within a session. Use with care. + available to all Python functions within a session. Use with + care.<indexterm><primary>global data</><secondary>in + PL/Python</></indexterm> </para> <para> @@ -102,6 +105,11 @@ def __plpython_procedure_myfunc_23456(): <sect1 id="plpython-trigger"> <title>Trigger Functions</title> + <indexterm zone="plpython-trigger"> + <primary>trigger</primary> + <secondary>in PL/Python</secondary> + </indexterm> + <para> When a function is used in a trigger, the dictionary <literal>TD</literal> contains trigger-related values. The trigger @@ -146,7 +154,8 @@ def __plpython_procedure_myfunc_23456(): <literal>plpy.error("msg")</literal>, and <literal>plpy.fatal("msg")</literal>. They are mostly equivalent to calling <literal>elog(<replaceable>LEVEL</>, "msg")</literal> - from C code. <function>plpy.error</function> and + from C code.<indexterm><primary>elog</><secondary>in + PL/Python</></indexterm> <function>plpy.error</function> and <function>plpy.fatal</function> actually raise a Python exception which, if uncaught, causes the PL/Python module to call <literal>elog(ERROR, msg)</literal> when the function handler @@ -187,10 +196,11 @@ foo = rv[i]["my_column"] </para> <para> - The second function, <function>plpy.prepare</function>, prepares the - execution plan for a query. It is called with a query string and a - list of parameter types, if you have parameter references in the - query. For example: + <indexterm><primary>preparing a query</><secondary>in PL/Python</></indexterm> + The second function, <function>plpy.prepare</function>, prepares + the execution plan for a query. It is called with a query string + and a list of parameter types, if you have parameter references in + the query. For example: <programlisting> plan = plpy.prepare("SELECT last_name FROM my_users WHERE first_name = $1", [ "text" ]) </programlisting> @@ -235,7 +245,8 @@ CREATE FUNCTION usesavedplan() RETURNS trigger AS ' </para> </sect1> -<!-- NOT CURRENTLY SUPPORTED +<![IGNORE[ + <!-- NOT CURRENTLY SUPPORTED --> <sect1 id="plpython-trusted"> <title>Restricted Environment</title> @@ -259,6 +270,6 @@ CREATE FUNCTION usesavedplan() RETURNS trigger AS ' </para> </sect1> ---> +]]> </chapter> diff --git a/doc/src/sgml/pltcl.sgml b/doc/src/sgml/pltcl.sgml index d93f7f6517f..ebcf8bdfb8f 100644 --- a/doc/src/sgml/pltcl.sgml +++ b/doc/src/sgml/pltcl.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/pltcl.sgml,v 2.24 2003/06/22 16:17:00 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/pltcl.sgml,v 2.24.2.1 2003/09/07 04:36:43 momjian Exp $ --> <chapter id="pltcl"> @@ -190,6 +190,11 @@ CREATE FUNCTION overpaid(employee) RETURNS boolean AS ' <sect1 id="pltcl-global"> <title>Global Data in PL/Tcl</title> + <indexterm zone="pltcl-global"> + <primary>global data</primary> + <secondary>in PL/Tcl</secondary> + </indexterm> + <para> Sometimes it is useful to have some global data that is held between two @@ -298,8 +303,10 @@ spi_exec -array C "SELECT * FROM pg_class" { <term><function>spi_prepare</function> <replaceable>query</replaceable> <replaceable>typelist</replaceable></term> <listitem> <para> - Prepares and saves a query plan for later execution. The saved plan - will be retained for the life of the current session. + Prepares and saves a query plan for later execution. The + saved plan will be retained for the life of the current + session.<indexterm><primary>preparing a query</><secondary>in + PL/Tcl</></> </para> <para> The query may use parameters, that is, placeholders for @@ -437,7 +444,7 @@ SELECT 'doesn''t' AS ret <varlistentry> <indexterm> <primary>elog</primary> - <secondary>PL/Tcl</secondary> + <secondary>in PL/Tcl</secondary> </indexterm> <term><function>elog</> <replaceable>level</replaceable> <replaceable>msg</replaceable></term> <listitem> @@ -466,7 +473,7 @@ SELECT 'doesn''t' AS ret <title>Trigger Procedures in PL/Tcl</title> <indexterm> - <primary>triggers</primary> + <primary>trigger</primary> <secondary>in PL/Tcl</secondary> </indexterm> diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml index cca78b63977..2642b356214 100644 --- a/doc/src/sgml/postgres.sgml +++ b/doc/src/sgml/postgres.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.53 2003/06/22 16:16:44 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.53.2.1 2003/09/07 04:36:43 momjian Exp $ --> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ @@ -188,7 +188,6 @@ $Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.53 2003/06/22 16:16:44 tg &libpgtcl; &ecpg; &jdbc; - &pygresql; &infoschema; </part> diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index 1de14ddeb61..d949a57df56 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/protocol.sgml,v 1.41 2003/08/14 20:09:31 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/protocol.sgml,v 1.41.2.1 2003/09/07 04:36:43 momjian Exp $ --> <chapter id="protocol"> <title>Frontend/Backend Protocol</title> @@ -1005,9 +1005,9 @@ ParameterStatus will be generated: they are <literal>server_version</> (a pseudo-parameter that cannot change after startup); - <literal>server_encoding</> (also not presently changeable after start); <literal>client_encoding</>, - <literal>is_superuser</>, and + <literal>is_superuser</>, + <literal>session_authorization</literal>, and <literal>DateStyle</>. This set might change in the future, or even become configurable. Accordingly, a frontend should simply ignore ParameterStatus for diff --git a/doc/src/sgml/queries.sgml b/doc/src/sgml/queries.sgml index d3ec786ac27..6ca1e023081 100644 --- a/doc/src/sgml/queries.sgml +++ b/doc/src/sgml/queries.sgml @@ -1,8 +1,16 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/queries.sgml,v 1.22 2003/08/14 23:13:27 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/queries.sgml,v 1.22.2.1 2003/09/07 04:36:43 momjian Exp $ --> <chapter id="queries"> <title>Queries</title> + <indexterm zone="queries"> + <primary>query</primary> + </indexterm> + + <indexterm zone="queries"> + <primary>SELECT</primary> + </indexterm> + <para> The previous chapters explained how to create tables, how to fill them with data, and how to manipulate that data. Now we finally @@ -73,6 +81,10 @@ SELECT random(); <sect1 id="queries-table-expressions"> <title>Table Expressions</title> + <indexterm zone="queries-table-expressions"> + <primary>table expression</primary> + </indexterm> + <para> A <firstterm>table expression</firstterm> computes a table. The table expression contains a <literal>FROM</> clause that is @@ -112,6 +124,10 @@ FROM <replaceable>table_reference</replaceable> <optional>, <replaceable>table_r overall table expression. </para> + <indexterm> + <primary>ONLY</primary> + </indexterm> + <para> When a table reference names a table that is the supertable of a table inheritance hierarchy, the table reference produces rows of @@ -125,7 +141,7 @@ FROM <replaceable>table_reference</replaceable> <optional>, <replaceable>table_r <title>Joined Tables</title> <indexterm zone="queries-join"> - <primary>joins</primary> + <primary>join</primary> </indexterm> <para> @@ -141,10 +157,14 @@ FROM <replaceable>table_reference</replaceable> <optional>, <replaceable>table_r <term>Cross join</term> <indexterm> - <primary>joins</primary> + <primary>join</primary> <secondary>cross</secondary> </indexterm> + <indexterm> + <primary>cross join</primary> + </indexterm> + <listitem> <synopsis> <replaceable>T1</replaceable> CROSS JOIN <replaceable>T2</replaceable> @@ -175,10 +195,14 @@ FROM <replaceable>table_reference</replaceable> <optional>, <replaceable>table_r <term>Qualified joins</term> <indexterm> - <primary>joins</primary> + <primary>join</primary> <secondary>outer</secondary> </indexterm> + <indexterm> + <primary>outer join</primary> + </indexterm> + <listitem> <synopsis> <replaceable>T1</replaceable> { <optional>INNER</optional> | { LEFT | RIGHT | FULL } <optional>OUTER</optional> } JOIN <replaceable>T2</replaceable> ON <replaceable>boolean_expression</replaceable> @@ -227,9 +251,12 @@ FROM <replaceable>table_reference</replaceable> <optional>, <replaceable>table_r <para> <indexterm> - <primary>joins</primary> + <primary>join</primary> <secondary>natural</secondary> </indexterm> + <indexterm> + <primary>natural join</primary> + </indexterm> Finally, <literal>NATURAL</> is a shorthand form of <literal>USING</>: it forms a <literal>USING</> list consisting of exactly those column names that appear in both @@ -256,10 +283,14 @@ FROM <replaceable>table_reference</replaceable> <optional>, <replaceable>table_r <term><literal>LEFT OUTER JOIN</></term> <indexterm> - <primary>joins</primary> + <primary>join</primary> <secondary>left</secondary> </indexterm> + <indexterm> + <primary>left join</primary> + </indexterm> + <listitem> <para> First, an inner join is performed. Then, for each row in @@ -274,6 +305,15 @@ FROM <replaceable>table_reference</replaceable> <optional>, <replaceable>table_r <varlistentry> <term><literal>RIGHT OUTER JOIN</></term> + <indexterm> + <primary>join</primary> + <secondary>right</secondary> + </indexterm> + + <indexterm> + <primary>right join</primary> + </indexterm> + <listitem> <para> First, an inner join is performed. Then, for each row in @@ -424,13 +464,13 @@ FROM <replaceable>table_reference</replaceable> <optional>, <replaceable>table_r <title>Table and Column Aliases</title> <indexterm zone="queries-table-aliases"> - <primary>label</primary> - <secondary>table</secondary> + <primary>alias</primary> + <secondary>in the FROM clause</secondary> </indexterm> <indexterm> - <primary>alias</primary> - <see>label</see> + <primary>label</primary> + <see>alias</see> </indexterm> <para> @@ -530,7 +570,7 @@ SELECT a.* FROM (my_table AS a JOIN your_table AS b ON ...) AS c <title>Subqueries</title> <indexterm zone="queries-subqueries"> - <primary>subqueries</primary> + <primary>subquery</primary> </indexterm> <para> @@ -556,6 +596,11 @@ FROM (SELECT * FROM table1) AS alias_name <indexterm zone="queries-tablefunctions"><primary>table function</></> + <indexterm zone="queries-tablefunctions"> + <primary>function</> + <secondary>in the FROM clause</> + </indexterm> + <para> Table functions are functions that produce a set of rows, made up of either base data types (scalar types) or composite data types @@ -628,7 +673,7 @@ SELECT * <title>The WHERE Clause</title> <indexterm zone="queries-where"> - <primary>where</primary> + <primary>WHERE</primary> </indexterm> <para> @@ -716,7 +761,11 @@ SELECT ... FROM fdt WHERE EXISTS (SELECT c1 FROM t2 WHERE c2 > fdt.c1) <title>The GROUP BY and HAVING Clauses</title> <indexterm zone="queries-group"> - <primary>group</primary> + <primary>GROUP BY</primary> + </indexterm> + + <indexterm zone="queries-group"> + <primary>grouping</primary> </indexterm> <para> @@ -827,6 +876,10 @@ SELECT product_id, p.name, (sum(s.units) * p.price) AS sales column names is also allowed. </para> + <indexterm> + <primary>HAVING</primary> + </indexterm> + <para> If a table has been grouped using a <literal>GROUP BY</literal> clause, but then only certain groups are of interest, the @@ -884,7 +937,7 @@ SELECT product_id, p.name, (sum(s.units) * (p.price - p.cost)) AS profit <title>Select Lists</title> <indexterm> - <primary>select</primary> + <primary>SELECT</primary> <secondary>select list</secondary> </indexterm> @@ -901,6 +954,10 @@ SELECT product_id, p.name, (sum(s.units) * (p.price - p.cost)) AS profit <sect2 id="queries-select-list-items"> <title>Select-List Items</title> + <indexterm> + <primary>*</primary> + </indexterm> + <para> The simplest kind of select list is <literal>*</literal> which emits all columns that the table expression produces. Otherwise, @@ -944,8 +1001,8 @@ SELECT tbl1.a, tbl2.a, tbl1.b FROM ... <title>Column Labels</title> <indexterm zone="queries-column-labels"> - <primary>label</primary> - <secondary>column</secondary> + <primary>alias</primary> + <secondary>in the select list</secondary> </indexterm> <para> @@ -981,7 +1038,11 @@ SELECT a AS value, b + c AS sum FROM ... <title>DISTINCT</title> <indexterm zone="queries-distinct"> - <primary>distinct</primary> + <primary>DISTINCT</primary> + </indexterm> + + <indexterm zone="queries-distinct"> + <primary>duplicates</primary> </indexterm> <para> @@ -997,6 +1058,8 @@ SELECT DISTINCT <replaceable>select_list</replaceable> ... </para> <para> + <indexterm><primary>null value</><secondary sortas="DISTINCT">in + DISTINCT</></indexterm> Obviously, two rows are considered distinct if they differ in at least one column value. Null values are considered equal in this comparison. @@ -1035,13 +1098,25 @@ SELECT DISTINCT ON (<replaceable>expression</replaceable> <optional>, <replaceab <title>Combining Queries</title> <indexterm zone="queries-union"> - <primary>union</primary> + <primary>UNION</primary> + </indexterm> + <indexterm zone="queries-union"> + <primary>INTERSECT</primary> + </indexterm> + <indexterm zone="queries-union"> + <primary>EXCEPT</primary> + </indexterm> + <indexterm zone="queries-union"> + <primary>set union</primary> + </indexterm> + <indexterm zone="queries-union"> + <primary>set intersection</primary> </indexterm> <indexterm zone="queries-union"> - <primary>intersection</primary> + <primary>set difference</primary> </indexterm> <indexterm zone="queries-union"> - <primary>except</primary> + <primary>set operation</primary> </indexterm> <para> @@ -1104,7 +1179,10 @@ SELECT DISTINCT ON (<replaceable>expression</replaceable> <optional>, <replaceab <indexterm zone="queries-order"> <primary>sorting</primary> - <secondary>query results</secondary> + </indexterm> + + <indexterm zone="queries-order"> + <primary>ORDER BY</primary> </indexterm> <para> @@ -1173,12 +1251,11 @@ SELECT a AS b FROM table1 ORDER BY a; <title>LIMIT and OFFSET</title> <indexterm zone="queries-limit"> - <primary>limit</primary> + <primary>LIMIT</primary> </indexterm> <indexterm zone="queries-limit"> - <primary>offset</primary> - <secondary>with query results</secondary> + <primary>OFFSET</primary> </indexterm> <para> diff --git a/doc/src/sgml/query.sgml b/doc/src/sgml/query.sgml index 5a7a7f4e62e..de464785a4f 100644 --- a/doc/src/sgml/query.sgml +++ b/doc/src/sgml/query.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/query.sgml,v 1.32 2003/06/24 23:27:24 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/query.sgml,v 1.32.2.1 2003/09/07 04:36:43 momjian Exp $ --> <chapter id="tutorial-sql"> @@ -87,7 +87,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/query.sgml,v 1.32 2003/06/24 23:27:24 momji </para> <para> - <indexterm><primary>cluster</primary></indexterm> + <indexterm><primary>database cluster</primary></indexterm> + <indexterm><primary>cluster</primary><secondary>of databases</secondary><see>database cluster</see></indexterm> Tables are grouped into databases, and a collection of databases managed by a single <productname>PostgreSQL</productname> server @@ -562,7 +563,7 @@ SELECT * <title>Aggregate Functions</title> <indexterm zone="tutorial-agg"> - <primary>aggregate</primary> + <primary>aggregate function</primary> </indexterm> <para> diff --git a/doc/src/sgml/ref/abort.sgml b/doc/src/sgml/ref/abort.sgml index 5d1d4472d01..87b27265f16 100644 --- a/doc/src/sgml/ref/abort.sgml +++ b/doc/src/sgml/ref/abort.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/abort.sgml,v 1.13 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/abort.sgml,v 1.13.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>abort the current transaction</refpurpose> </refnamediv> + <indexterm zone="sql-abort"> + <primary>ABORT</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ABORT [ WORK | TRANSACTION ] diff --git a/doc/src/sgml/ref/alter_aggregate.sgml b/doc/src/sgml/ref/alter_aggregate.sgml index 972accd7565..f1c85849b3f 100644 --- a/doc/src/sgml/ref/alter_aggregate.sgml +++ b/doc/src/sgml/ref/alter_aggregate.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_aggregate.sgml,v 1.1 2003/06/27 14:45:25 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_aggregate.sgml,v 1.1.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change the definition of an aggregate function</refpurpose> </refnamediv> + <indexterm zone="sql-alteraggregate"> + <primary>ALTER AGGREGATE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER AGGREGATE <replaceable>name</replaceable> ( <replaceable>type</replaceable> ) RENAME TO <replaceable>newname</replaceable> diff --git a/doc/src/sgml/ref/alter_conversion.sgml b/doc/src/sgml/ref/alter_conversion.sgml index b2767405ca8..469b7e5ec5f 100644 --- a/doc/src/sgml/ref/alter_conversion.sgml +++ b/doc/src/sgml/ref/alter_conversion.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_conversion.sgml,v 1.1 2003/06/27 14:45:25 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_conversion.sgml,v 1.1.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change the definition of a conversion</refpurpose> </refnamediv> + <indexterm zone="sql-alterconversion"> + <primary>ALTER CONVERSION</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER CONVERSION <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable> diff --git a/doc/src/sgml/ref/alter_database.sgml b/doc/src/sgml/ref/alter_database.sgml index 12447d6b0a7..bb895328c93 100644 --- a/doc/src/sgml/ref/alter_database.sgml +++ b/doc/src/sgml/ref/alter_database.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.7 2003/06/27 14:45:25 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.7.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change a database</refpurpose> </refnamediv> + <indexterm zone="sql-alterdatabase"> + <primary>ALTER DATABASE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> SET <replaceable>variable</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT } diff --git a/doc/src/sgml/ref/alter_domain.sgml b/doc/src/sgml/ref/alter_domain.sgml index fdbf08e6d48..3980a6f4298 100644 --- a/doc/src/sgml/ref/alter_domain.sgml +++ b/doc/src/sgml/ref/alter_domain.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_domain.sgml,v 1.7 2003/01/06 00:31:44 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_domain.sgml,v 1.7.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -8,6 +8,7 @@ PostgreSQL documentation <refentrytitle id="sql-alterdomain-title">ALTER DOMAIN</refentrytitle> <refmiscinfo>SQL - Language Statements</refmiscinfo> </refmeta> + <refnamediv> <refname> ALTER DOMAIN @@ -16,6 +17,11 @@ PostgreSQL documentation change the definition of a domain </refpurpose> </refnamediv> + + <indexterm zone="sql-alterdomain"> + <primary>ALTER DOMAIN</primary> + </indexterm> + <refsynopsisdiv> <refsynopsisdivinfo> <date>2002-11-27</date> diff --git a/doc/src/sgml/ref/alter_function.sgml b/doc/src/sgml/ref/alter_function.sgml index 621350980b8..c54974788d8 100644 --- a/doc/src/sgml/ref/alter_function.sgml +++ b/doc/src/sgml/ref/alter_function.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_function.sgml,v 1.1 2003/06/27 14:45:25 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_function.sgml,v 1.1.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change the definition of a function</refpurpose> </refnamediv> + <indexterm zone="sql-alterfunction"> + <primary>ALTER FUNCTION</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER FUNCTION <replaceable>name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) RENAME TO <replaceable>newname</replaceable> diff --git a/doc/src/sgml/ref/alter_group.sgml b/doc/src/sgml/ref/alter_group.sgml index 6d0695b9384..588eeec2232 100644 --- a/doc/src/sgml/ref/alter_group.sgml +++ b/doc/src/sgml/ref/alter_group.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_group.sgml,v 1.10 2003/06/27 14:45:25 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_group.sgml,v 1.10.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change a user group</refpurpose> </refnamediv> + <indexterm zone="sql-altergroup"> + <primary>ALTER GROUP</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER GROUP <replaceable class="PARAMETER">groupname</replaceable> ADD USER <replaceable class="PARAMETER">username</replaceable> [, ... ] diff --git a/doc/src/sgml/ref/alter_language.sgml b/doc/src/sgml/ref/alter_language.sgml index 2c922d58830..51545e308f4 100644 --- a/doc/src/sgml/ref/alter_language.sgml +++ b/doc/src/sgml/ref/alter_language.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_language.sgml,v 1.1 2003/06/27 14:45:25 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_language.sgml,v 1.1.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change the definition of a procedural language</refpurpose> </refnamediv> + <indexterm zone="sql-alterlanguage"> + <primary>ALTER LANGUAGE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER LANGUAGE <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable> diff --git a/doc/src/sgml/ref/alter_opclass.sgml b/doc/src/sgml/ref/alter_opclass.sgml index 5a9694c73a8..186b42bcc93 100644 --- a/doc/src/sgml/ref/alter_opclass.sgml +++ b/doc/src/sgml/ref/alter_opclass.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_opclass.sgml,v 1.1 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_opclass.sgml,v 1.1.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change the definition of an operator class</refpurpose> </refnamediv> + <indexterm zone="sql-alteropclass"> + <primary>ALTER OPERATOR CLASS</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER OPERATOR CLASS <replaceable>name</replaceable> USING <replaceable class="parameter">index_method</replaceable> RENAME TO <replaceable>newname</replaceable> diff --git a/doc/src/sgml/ref/alter_schema.sgml b/doc/src/sgml/ref/alter_schema.sgml index 6e3c78c9c7c..6247993e13c 100644 --- a/doc/src/sgml/ref/alter_schema.sgml +++ b/doc/src/sgml/ref/alter_schema.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_schema.sgml,v 1.1 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_schema.sgml,v 1.1.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change the definition of a schema</refpurpose> </refnamediv> + <indexterm zone="sql-alterschema"> + <primary>ALTER SCHEMA</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER SCHEMA <replaceable>name</replaceable> RENAME TO <replaceable>newname</replaceable> diff --git a/doc/src/sgml/ref/alter_sequence.sgml b/doc/src/sgml/ref/alter_sequence.sgml index 28a81022aab..b7ad7ea245a 100644 --- a/doc/src/sgml/ref/alter_sequence.sgml +++ b/doc/src/sgml/ref/alter_sequence.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_sequence.sgml,v 1.2 2003/06/12 07:49:43 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_sequence.sgml,v 1.2.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -8,6 +8,7 @@ PostgreSQL documentation <refentrytitle id="SQL-ALTERSEQUENCE-TITLE">ALTER SEQUENCE</refentrytitle> <refmiscinfo>SQL - Language Statements</refmiscinfo> </refmeta> + <refnamediv> <refname> ALTER SEQUENCE @@ -16,6 +17,11 @@ PostgreSQL documentation alter the definition of a sequence generator </refpurpose> </refnamediv> + + <indexterm zone="sql-altersequence"> + <primary>ALTER SEQUENCE</primary> + </indexterm> + <refsynopsisdiv> <refsynopsisdivinfo> <date>1999-07-20</date> diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml index 7f5456c2772..7a208787734 100644 --- a/doc/src/sgml/ref/alter_table.sgml +++ b/doc/src/sgml/ref/alter_table.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.59 2003/04/15 13:25:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.59.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change the definition of a table</refpurpose> </refnamediv> + <indexterm zone="sql-altertable"> + <primary>ALTER TABLE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER TABLE [ ONLY ] <replaceable class="PARAMETER">table</replaceable> [ * ] diff --git a/doc/src/sgml/ref/alter_trigger.sgml b/doc/src/sgml/ref/alter_trigger.sgml index b335434eaf8..90ebe0ce063 100644 --- a/doc/src/sgml/ref/alter_trigger.sgml +++ b/doc/src/sgml/ref/alter_trigger.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_trigger.sgml,v 1.4 2003/04/15 13:25:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_trigger.sgml,v 1.4.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change the definition of a trigger</refpurpose> </refnamediv> + <indexterm zone="sql-altertrigger"> + <primary>ALTER TRIGGER</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER TRIGGER <replaceable class="PARAMETER">trigger</replaceable> ON <replaceable class="PARAMETER">table</replaceable> diff --git a/doc/src/sgml/ref/alter_user.sgml b/doc/src/sgml/ref/alter_user.sgml index 95de7a592d5..a46a6aa029e 100644 --- a/doc/src/sgml/ref/alter_user.sgml +++ b/doc/src/sgml/ref/alter_user.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.28 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.28.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change a database user account</refpurpose> </refnamediv> + <indexterm zone="sql-alteruser"> + <primary>ALTER USER</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ALTER USER <replaceable class="PARAMETER">username</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ] diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml index 4977964f4e7..12fd1e63be2 100644 --- a/doc/src/sgml/ref/analyze.sgml +++ b/doc/src/sgml/ref/analyze.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.12 2003/04/15 13:25:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.12.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>collect statistics about a database</refpurpose> </refnamediv> + <indexterm zone="sql-analyze"> + <primary>ANALYZE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ANALYZE [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> [ (<replaceable class="PARAMETER">column</replaceable> [, ...] ) ] ] diff --git a/doc/src/sgml/ref/begin.sgml b/doc/src/sgml/ref/begin.sgml index 7bd1309d289..30c78be8bcd 100644 --- a/doc/src/sgml/ref/begin.sgml +++ b/doc/src/sgml/ref/begin.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.24 2003/05/14 03:26:00 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.24.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>start a transaction block</refpurpose> </refnamediv> + <indexterm zone="sql-begin"> + <primary>BEGIN</primary> + </indexterm> + <refsynopsisdiv> <synopsis> BEGIN [ WORK | TRANSACTION ] diff --git a/doc/src/sgml/ref/checkpoint.sgml b/doc/src/sgml/ref/checkpoint.sgml index 71d075d542e..2ceacfad1a0 100644 --- a/doc/src/sgml/ref/checkpoint.sgml +++ b/doc/src/sgml/ref/checkpoint.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.9 2003/04/15 13:25:08 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.9.2.1 2003/09/07 04:36:44 momjian Exp $ --> <refentry id="sql-checkpoint"> <refmeta> @@ -11,6 +11,10 @@ <refpurpose>force a transaction log checkpoint</refpurpose> </refnamediv> + <indexterm zone="sql-checkpoint"> + <primary>CHECKPOINT</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CHECKPOINT diff --git a/doc/src/sgml/ref/close.sgml b/doc/src/sgml/ref/close.sgml index 9ae487c3f78..5b8df9cfe07 100644 --- a/doc/src/sgml/ref/close.sgml +++ b/doc/src/sgml/ref/close.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/close.sgml,v 1.14 2003/04/15 13:25:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/close.sgml,v 1.14.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>close a cursor</refpurpose> </refnamediv> + <indexterm zone="sql-close"> + <primary>CLOSE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CLOSE <replaceable class="PARAMETER">cursor</replaceable> @@ -31,9 +35,13 @@ CLOSE <replaceable class="PARAMETER">cursor</replaceable> </para> <para> - Every open cursor is implicitly closed when a transaction is - terminated by <command>COMMIT</command> or - <command>ROLLBACK</command>. + Every non-holdable open cursor is implicitly closed when a + transaction is terminated by <command>COMMIT</command> or + <command>ROLLBACK</command>. Holdable cursors are implicitely + closed if the transaction that created them aborts via + <command>ROLLBACK</command>; if this does not happen, the holdable + cursor remains open until an explicit <command>CLOSE</command> is + executed, or the client disconnects. </para> </refsect1> @@ -66,10 +74,10 @@ CLOSE <replaceable class="PARAMETER">cursor</replaceable> </varlistentry> <varlistentry> - <term><computeroutput>WARNING: PerformPortalClose: portal "<replaceable class="PARAMETER">cursor</replaceable>" not found</computeroutput></term> + <term><computeroutput>ERROR: cursor "<replaceable class="PARAMETER">cursor</replaceable>" does not exist</computeroutput></term> <listitem> <para> - This warning is given if <replaceable + Message returned if <replaceable class="PARAMETER">cursor</replaceable> is not declared or has already been closed. </para> diff --git a/doc/src/sgml/ref/cluster.sgml b/doc/src/sgml/ref/cluster.sgml index 90c56551a33..c57f361cfdb 100644 --- a/doc/src/sgml/ref/cluster.sgml +++ b/doc/src/sgml/ref/cluster.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/cluster.sgml,v 1.26 2003/04/15 13:25:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/cluster.sgml,v 1.26.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>cluster a table according to an index</refpurpose> </refnamediv> + <indexterm zone="sql-cluster"> + <primary>CLUSTER</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CLUSTER <replaceable class="PARAMETER">indexname</replaceable> ON <replaceable class="PARAMETER">tablename</replaceable> diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml index eb814261876..69aed65428c 100644 --- a/doc/src/sgml/ref/clusterdb.sgml +++ b/doc/src/sgml/ref/clusterdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.10 2003/06/18 12:19:11 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.10.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>cluster a <productname>PostgreSQL</productname> database</refpurpose> </refnamediv> + <indexterm zone="app-clusterdb"> + <primary>clusterdb</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>clusterdb</command> @@ -129,10 +133,9 @@ PostgreSQL documentation <term><option>--host <replaceable class="parameter">host</replaceable></></term> <listitem> <para> - Specifies the host name of the machine on which the - server - is running. If the value begins with a slash, it is used - as the directory for the Unix domain socket. + Specifies the host name of the machine on which the server is + running. If the value begins with a slash, it is used as the + directory for the Unix domain socket. </para> </listitem> </varlistentry> @@ -182,7 +185,7 @@ PostgreSQL documentation <term><computeroutput>CLUSTER</computeroutput></term> <listitem> <para> - Everything went well. + The database was successfully clustered. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/comment.sgml b/doc/src/sgml/ref/comment.sgml index 2eaf4ada45d..7e37ed29957 100644 --- a/doc/src/sgml/ref/comment.sgml +++ b/doc/src/sgml/ref/comment.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/comment.sgml,v 1.21 2003/04/15 13:25:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/comment.sgml,v 1.21.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define or change the comment of an object</refpurpose> </refnamediv> + <indexterm zone="sql-comment"> + <primary>COMMENT</primary> + </indexterm> + <refsynopsisdiv> <synopsis> COMMENT ON diff --git a/doc/src/sgml/ref/commit.sgml b/doc/src/sgml/ref/commit.sgml index a84c61a9011..724f6102e0e 100644 --- a/doc/src/sgml/ref/commit.sgml +++ b/doc/src/sgml/ref/commit.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/commit.sgml,v 1.15 2003/04/15 13:25:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/commit.sgml,v 1.15.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>commit the current transaction</refpurpose> </refnamediv> + <indexterm zone="sql-commit"> + <primary>COMMIT</primary> + </indexterm> + <refsynopsisdiv> <synopsis> COMMIT [ WORK | TRANSACTION ] diff --git a/doc/src/sgml/ref/copy.sgml b/doc/src/sgml/ref/copy.sgml index 0e24f8b3eec..ddd819eecb5 100644 --- a/doc/src/sgml/ref/copy.sgml +++ b/doc/src/sgml/ref/copy.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/copy.sgml,v 1.46 2003/05/09 21:19:48 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/copy.sgml,v 1.46.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>copy data between files and tables</refpurpose> </refnamediv> + <indexterm zone="sql-copy"> + <primary>COPY</primary> + </indexterm> + <refsynopsisdiv> <synopsis> COPY <replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column</replaceable> [, ...] ) ] @@ -380,7 +384,7 @@ COPY <replaceable class="parameter">table</replaceable> [ ( <replaceable class=" The file format used for <command>COPY BINARY</command> changed in <application>PostgreSQL</application> 7.4. The new format consists of a file header, zero or more tuples containing the row data, and - a file trailer. + a file trailer. Headers and data are now in network byte order. </para> <refsect3> @@ -484,6 +488,15 @@ to be specified. </para> <para> +To determine the appropriate binary format for the actual tuple data you +should consult the <application>PostgreSQL</application> source, in +particular the <function>*send</> and <function>*recv</> functions for +the data type (typically found in the <filename>src/backend/utils/adt</filename> +directory). The <application>contrib/binarycopy</application> module +can also be used to create an appropriate format file. + </para> + + <para> If OIDs are included in the file, the OID field immediately follows the field-count word. It is a normal field except that it's not included in the field-count. In particular it has a length word --- this will allow diff --git a/doc/src/sgml/ref/create_aggregate.sgml b/doc/src/sgml/ref/create_aggregate.sgml index 2aff0636713..81578b30b97 100644 --- a/doc/src/sgml/ref/create_aggregate.sgml +++ b/doc/src/sgml/ref/create_aggregate.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_aggregate.sgml,v 1.26 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_aggregate.sgml,v 1.26.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new aggregate function</refpurpose> </refnamediv> + <indexterm zone="sql-createaggregate"> + <primary>CREATE AGGREGATE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE AGGREGATE <replaceable class="PARAMETER">name</replaceable> ( diff --git a/doc/src/sgml/ref/create_cast.sgml b/doc/src/sgml/ref/create_cast.sgml index b97135c9538..02002e3bdde 100644 --- a/doc/src/sgml/ref/create_cast.sgml +++ b/doc/src/sgml/ref/create_cast.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.11 2003/04/22 10:08:08 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.11.2.1 2003/09/07 04:36:44 momjian Exp $ --> <refentry id="SQL-CREATECAST"> <refmeta> @@ -11,6 +11,10 @@ <refpurpose>define a user-defined cast</refpurpose> </refnamediv> + <indexterm zone="sql-createcast"> + <primary>CREATE CAST</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE CAST (<replaceable>sourcetype</replaceable> AS <replaceable>targettype</replaceable>) diff --git a/doc/src/sgml/ref/create_constraint.sgml b/doc/src/sgml/ref/create_constraint.sgml index b61cd5d911f..eaa93ba78ee 100644 --- a/doc/src/sgml/ref/create_constraint.sgml +++ b/doc/src/sgml/ref/create_constraint.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_constraint.sgml,v 1.9 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_constraint.sgml,v 1.9.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new constraint trigger</refpurpose> </refnamediv> + <indexterm zone="sql-createconstraint"> + <primary>CREATE CONSTRAINT</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE CONSTRAINT TRIGGER <replaceable class="parameter">name</replaceable> diff --git a/doc/src/sgml/ref/create_conversion.sgml b/doc/src/sgml/ref/create_conversion.sgml index 382c5089832..1ced8820b87 100644 --- a/doc/src/sgml/ref/create_conversion.sgml +++ b/doc/src/sgml/ref/create_conversion.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.10 2003/06/27 14:45:26 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.10.2.1 2003/09/07 04:36:44 momjian Exp $ --> <refentry id="SQL-CREATECONVERSION"> <refmeta> @@ -11,6 +11,10 @@ <refpurpose>define a user-defined conversion</refpurpose> </refnamediv> + <indexterm zone="sql-createconversion"> + <primary>CREATE CONVERSION</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE [DEFAULT] CONVERSION <replaceable>name</replaceable> diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index ad0008de403..398b70386ee 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.34 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.34.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>create a new database</refpurpose> </refnamediv> + <indexterm zone="sql-createdatabase"> + <primary>CREATE DATABASE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE DATABASE <replaceable class="PARAMETER">name</replaceable> diff --git a/doc/src/sgml/ref/create_domain.sgml b/doc/src/sgml/ref/create_domain.sgml index 0d6fe6ef50a..3ff05d603a5 100644 --- a/doc/src/sgml/ref/create_domain.sgml +++ b/doc/src/sgml/ref/create_domain.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_domain.sgml,v 1.13 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_domain.sgml,v 1.13.2.1 2003/09/07 04:36:44 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new domain</refpurpose> </refnamediv> + <indexterm zone="sql-createdomain"> + <primary>CREATE DOMAIN</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE DOMAIN <replaceable class="parameter">domainname</replaceable> [AS] <replaceable class="parameter">data_type</replaceable> diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index 4e1978c6eec..a6467d774d6 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.48 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.48.2.1 2003/09/07 04:36:45 momjian Exp $ --> <refentry id="SQL-CREATEFUNCTION"> @@ -13,6 +13,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.48 2003/06/27 <refpurpose>define a new function</refpurpose> </refnamediv> + <indexterm zone="sql-createfunction"> + <primary>CREATE FUNCTION</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE [ OR REPLACE ] FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable class="parameter">argtype</replaceable> [, ...] ] ) diff --git a/doc/src/sgml/ref/create_group.sgml b/doc/src/sgml/ref/create_group.sgml index d90dd31086a..7758de6d47e 100644 --- a/doc/src/sgml/ref/create_group.sgml +++ b/doc/src/sgml/ref/create_group.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_group.sgml,v 1.11 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_group.sgml,v 1.11.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new user group</refpurpose> </refnamediv> + <indexterm zone="sql-creategroup"> + <primary>CREATE GROUP</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE GROUP <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ] diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml index ff60aaa3b01..05293b25d5f 100644 --- a/doc/src/sgml/ref/create_index.sgml +++ b/doc/src/sgml/ref/create_index.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.39 2003/05/28 16:03:55 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.39.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new index</refpurpose> </refnamediv> + <indexterm zone="sql-createindex"> + <primary>CREATE INDEX</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE [ UNIQUE ] INDEX <replaceable class="parameter">index_name</replaceable> ON <replaceable class="parameter">table</replaceable> [ USING <replaceable class="parameter">method</replaceable> ] diff --git a/doc/src/sgml/ref/create_language.sgml b/doc/src/sgml/ref/create_language.sgml index d26eb48911d..a6884abee1d 100644 --- a/doc/src/sgml/ref/create_language.sgml +++ b/doc/src/sgml/ref/create_language.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.33 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.33.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new procedural language</refpurpose> </refnamediv> + <indexterm zone="sql-createlanguage"> + <primary>CREATE LANGUAGE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE [ TRUSTED ] [ PROCEDURAL ] LANGUAGE <replaceable class="parameter">langname</replaceable> diff --git a/doc/src/sgml/ref/create_opclass.sgml b/doc/src/sgml/ref/create_opclass.sgml index eddb8e71287..6696a9eb343 100644 --- a/doc/src/sgml/ref/create_opclass.sgml +++ b/doc/src/sgml/ref/create_opclass.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_opclass.sgml,v 1.8 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_opclass.sgml,v 1.8.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new operator class for indexes</refpurpose> </refnamediv> + <indexterm zone="sql-createopclass"> + <primary>CREATE OPERATOR CLASS</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE OPERATOR CLASS <replaceable class="parameter">name</replaceable> [ DEFAULT ] FOR TYPE <replaceable class="parameter">data_type</replaceable> USING <replaceable class="parameter">index_method</replaceable> AS diff --git a/doc/src/sgml/ref/create_operator.sgml b/doc/src/sgml/ref/create_operator.sgml index 2ac9d3f2edd..d64bc28f2d9 100644 --- a/doc/src/sgml/ref/create_operator.sgml +++ b/doc/src/sgml/ref/create_operator.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.35 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.35.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new operator</refpurpose> </refnamediv> + <indexterm zone="sql-createoperator"> + <primary>CREATE OPERATOR</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE OPERATOR <replaceable>name</replaceable> ( @@ -43,19 +47,13 @@ CREATE OPERATOR <replaceable>name</replaceable> ( The operator name is a sequence of up to <symbol>NAMEDATALEN</>-1 (63 by default) characters from the following list: <literallayout> -+ - * / < > = ~ ! @ # % ^ & | ` ? $ ++ - * / < > = ~ ! @ # % ^ & | ` ? </literallayout> There are a few restrictions on your choice of name: <itemizedlist> <listitem> <para> - <literal>$</literal> cannot be defined as a single-character operator, - although it can be part of a multicharacter operator name. - </para> - </listitem> - <listitem> - <para> <literal>--</literal> and <literal>/*</literal> cannot appear anywhere in an operator name, since they will be taken as the start of a comment. </para> @@ -66,7 +64,7 @@ CREATE OPERATOR <replaceable>name</replaceable> ( <literal>-</literal>, unless the name also contains at least one of these characters: <literallayout> -~ ! @ # % ^ & | ` ? $ +~ ! @ # % ^ & | ` ? </literallayout> For example, <literal>@-</literal> is an allowed operator name, but <literal>*-</literal> is not. diff --git a/doc/src/sgml/ref/create_rule.sgml b/doc/src/sgml/ref/create_rule.sgml index ff7f2bfb134..566f8bddfb8 100644 --- a/doc/src/sgml/ref/create_rule.sgml +++ b/doc/src/sgml/ref/create_rule.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_rule.sgml,v 1.39 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_rule.sgml,v 1.39.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new rewrite rule</refpurpose> </refnamediv> + <indexterm zone="sql-createrule"> + <primary>CREATE RULE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE [ OR REPLACE ] RULE <replaceable class="parameter">name</replaceable> AS ON <replaceable class="parameter">event</replaceable> diff --git a/doc/src/sgml/ref/create_schema.sgml b/doc/src/sgml/ref/create_schema.sgml index e70d29a37b8..4a40160caf3 100644 --- a/doc/src/sgml/ref/create_schema.sgml +++ b/doc/src/sgml/ref/create_schema.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_schema.sgml,v 1.6 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_schema.sgml,v 1.6.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new schema</refpurpose> </refnamediv> + <indexterm zone="sql-createschema"> + <primary>CREATE SCHEMA</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE SCHEMA <replaceable class="parameter">schemaname</replaceable> [ AUTHORIZATION <replaceable class="parameter">username</replaceable> ] [ <replaceable class="parameter">schema_element</replaceable> [ ... ] ] diff --git a/doc/src/sgml/ref/create_sequence.sgml b/doc/src/sgml/ref/create_sequence.sgml index 374f34cb0a8..93b6fc7d50c 100644 --- a/doc/src/sgml/ref/create_sequence.sgml +++ b/doc/src/sgml/ref/create_sequence.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.33 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.33.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new sequence generator</refpurpose> </refnamediv> + <indexterm zone="sql-createsequence"> + <primary>CREATE SEQUENCE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE [ TEMPORARY | TEMP ] SEQUENCE <replaceable class="parameter">seqname</replaceable> [ INCREMENT [ BY ] <replaceable class="parameter">increment</replaceable> ] diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index 2d55997e708..ea35353d314 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.70 2003/06/12 18:34:06 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.70.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new table</refpurpose> </refnamediv> + <indexterm zone="sql-createtable"> + <primary>CREATE TABLE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE <replaceable class="PARAMETER">table_name</replaceable> ( diff --git a/doc/src/sgml/ref/create_table_as.sgml b/doc/src/sgml/ref/create_table_as.sgml index 0f648d56b3a..4e9a54a9e42 100644 --- a/doc/src/sgml/ref/create_table_as.sgml +++ b/doc/src/sgml/ref/create_table_as.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.14 2003/07/01 00:04:31 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.14.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>create a new table from the results of a query</refpurpose> </refnamediv> + <indexterm zone="sql-createtableas"> + <primary>CREATE TABLE AS</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE <replaceable>table_name</replaceable> [ (<replaceable>column_name</replaceable> [, ...] ) ] diff --git a/doc/src/sgml/ref/create_trigger.sgml b/doc/src/sgml/ref/create_trigger.sgml index 1856264954c..9ceea50c503 100644 --- a/doc/src/sgml/ref/create_trigger.sgml +++ b/doc/src/sgml/ref/create_trigger.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.34 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.34.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new trigger</refpurpose> </refnamediv> + <indexterm zone="sql-createtrigger"> + <primary>CREATE TRIGGER</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE TRIGGER <replaceable class="PARAMETER">name</replaceable> { BEFORE | AFTER } { <replaceable class="PARAMETER">event</replaceable> [ OR ... ] } diff --git a/doc/src/sgml/ref/create_type.sgml b/doc/src/sgml/ref/create_type.sgml index 2d2b92a85aa..f72d5344ccf 100644 --- a/doc/src/sgml/ref/create_type.sgml +++ b/doc/src/sgml/ref/create_type.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.43 2003/05/09 23:01:44 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.43.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new data type</refpurpose> </refnamediv> + <indexterm zone="sql-createtype"> + <primary>CREATE TYPE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE TYPE <replaceable class="parameter">typename</replaceable> AS diff --git a/doc/src/sgml/ref/create_user.sgml b/doc/src/sgml/ref/create_user.sgml index 23d64bd2c54..382f1a246ce 100644 --- a/doc/src/sgml/ref/create_user.sgml +++ b/doc/src/sgml/ref/create_user.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.26 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.26.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new database user account</refpurpose> </refnamediv> + <indexterm zone="sql-createuser"> + <primary>CREATE USER</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE USER <replaceable class="PARAMETER">username</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ] diff --git a/doc/src/sgml/ref/create_view.sgml b/doc/src/sgml/ref/create_view.sgml index 8bfb4f16636..42a69f5fcc2 100644 --- a/doc/src/sgml/ref/create_view.sgml +++ b/doc/src/sgml/ref/create_view.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_view.sgml,v 1.22 2003/04/22 10:08:08 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_view.sgml,v 1.22.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a new view</refpurpose> </refnamediv> + <indexterm zone="sql-createview"> + <primary>CREATE VIEW</primary> + </indexterm> + <refsynopsisdiv> <synopsis> CREATE [ OR REPLACE ] VIEW <replaceable class="PARAMETER">name</replaceable> [ ( <replaceable diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index 0ad159842a3..4f432a8dd91 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.33 2003/05/26 17:50:09 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.33.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>create a new <productname>PostgreSQL</productname> database</refpurpose> </refnamediv> + <indexterm zone="app-createdb"> + <primary>createdb</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>createdb</command> diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml index be86e7c1c79..e2fcee63e08 100644 --- a/doc/src/sgml/ref/createlang.sgml +++ b/doc/src/sgml/ref/createlang.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.31 2003/03/24 14:32:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.31.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>define a new <productname>PostgreSQL</productname> procedural language</refpurpose> </refnamediv> + <indexterm zone="app-createlang"> + <primary>createlang</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>createlang</command> diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index ba882776878..0b07662819b 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.34 2003/06/06 15:31:46 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.34.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>define a new <productname>PostgreSQL</productname> user account</refpurpose> </refnamediv> + <indexterm zone="app-createuser"> + <primary>createuser</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>createuser</command> @@ -276,7 +280,7 @@ PostgreSQL documentation <term><computeroutput>CREATE USER</computeroutput></term> <listitem> <para> - All is well. + The user was successfully created. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/deallocate.sgml b/doc/src/sgml/ref/deallocate.sgml index 008a6262e12..91355ce61a6 100644 --- a/doc/src/sgml/ref/deallocate.sgml +++ b/doc/src/sgml/ref/deallocate.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.2 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.2.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>deallocate a prepared statement</refpurpose> </refnamediv> + <indexterm zone="sql-deallocate"> + <primary>DEALLOCATE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DEALLOCATE [ PREPARE ] <replaceable class="parameter">plan_name</replaceable> diff --git a/doc/src/sgml/ref/declare.sgml b/doc/src/sgml/ref/declare.sgml index 0aaf0dde43d..3585a71f79f 100644 --- a/doc/src/sgml/ref/declare.sgml +++ b/doc/src/sgml/ref/declare.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/declare.sgml,v 1.24 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/declare.sgml,v 1.24.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define a cursor</refpurpose> </refnamediv> + <indexterm zone="sql-declare"> + <primary>DECLARE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DECLARE <replaceable class="parameter">cursorname</replaceable> [ BINARY ] [ INSENSITIVE ] [ [ NO ] SCROLL ] @@ -202,11 +206,10 @@ DECLARE <replaceable class="parameter">cursorname</replaceable> [ BINARY ] [ INS </varlistentry> <varlistentry> - <term><computeroutput>WARNING: Closing pre-existing portal "<replaceable class="parameter">cursorname</replaceable>"</computeroutput></term> + <term><computeroutput>ERROR: cursor "<replaceable class="parameter">cursorname</replaceable>" already exists</computeroutput></term> <listitem> <para> - This message is reported if a cursor with the same name already - exists. The previous definition is discarded. + This error occurs if a cursor with the same name already exists. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/delete.sgml b/doc/src/sgml/ref/delete.sgml index b04b86c8887..c5c75459860 100644 --- a/doc/src/sgml/ref/delete.sgml +++ b/doc/src/sgml/ref/delete.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/delete.sgml,v 1.17 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/delete.sgml,v 1.17.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>delete rows of a table</refpurpose> </refnamediv> + <indexterm zone="sql-delete"> + <primary>DELETE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DELETE FROM [ ONLY ] <replaceable class="PARAMETER">table</replaceable> [ WHERE <replaceable class="PARAMETER">condition</replaceable> ] diff --git a/doc/src/sgml/ref/drop_aggregate.sgml b/doc/src/sgml/ref/drop_aggregate.sgml index 49915626a5c..4dcb29eee61 100644 --- a/doc/src/sgml/ref/drop_aggregate.sgml +++ b/doc/src/sgml/ref/drop_aggregate.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.23 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.23.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a user-defined aggregate function</refpurpose> </refnamediv> + <indexterm zone="sql-dropaggregate"> + <primary>DROP AGGREGATE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP AGGREGATE <replaceable class="PARAMETER">name</replaceable> ( <replaceable class="PARAMETER">type</replaceable> ) [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_cast.sgml b/doc/src/sgml/ref/drop_cast.sgml index 427796e56bf..c25e2ab1db5 100644 --- a/doc/src/sgml/ref/drop_cast.sgml +++ b/doc/src/sgml/ref/drop_cast.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_cast.sgml,v 1.3 2003/05/04 02:23:16 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_cast.sgml,v 1.3.2.1 2003/09/07 04:36:45 momjian Exp $ --> <refentry id="SQL-DROPCAST"> <refmeta> @@ -11,6 +11,10 @@ <refpurpose>remove a user-defined cast</refpurpose> </refnamediv> + <indexterm zone="sql-dropcast"> + <primary>DROP CAST</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP CAST (<replaceable>sourcetype</replaceable> AS <replaceable>targettype</replaceable>) [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_conversion.sgml b/doc/src/sgml/ref/drop_conversion.sgml index d9c795c445a..b225e2b1cea 100644 --- a/doc/src/sgml/ref/drop_conversion.sgml +++ b/doc/src/sgml/ref/drop_conversion.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_conversion.sgml,v 1.5 2003/06/27 14:45:26 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_conversion.sgml,v 1.5.2.1 2003/09/07 04:36:45 momjian Exp $ --> <refentry id="SQL-DROPCONVERSION"> <refmeta> @@ -11,6 +11,10 @@ <refpurpose>remove a user-defined conversion</refpurpose> </refnamediv> + <indexterm zone="sql-dropconversion"> + <primary>DROP CONVERSION</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP CONVERSION <replaceable>conversion_name</replaceable> [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_database.sgml b/doc/src/sgml/ref/drop_database.sgml index fb77f53c67c..4c71b3cf680 100644 --- a/doc/src/sgml/ref/drop_database.sgml +++ b/doc/src/sgml/ref/drop_database.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_database.sgml,v 1.16 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_database.sgml,v 1.16.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a database</refpurpose> </refnamediv> + <indexterm zone="sql-dropdatabase"> + <primary>DROP DATABASE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP DATABASE <replaceable class="PARAMETER">name</replaceable> diff --git a/doc/src/sgml/ref/drop_domain.sgml b/doc/src/sgml/ref/drop_domain.sgml index 99c8ec7d44e..81271c88bf1 100644 --- a/doc/src/sgml/ref/drop_domain.sgml +++ b/doc/src/sgml/ref/drop_domain.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_domain.sgml,v 1.10 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_domain.sgml,v 1.10.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a domain</refpurpose> </refnamediv> + <indexterm zone="sql-dropdomain"> + <primary>DROP DOMAIN</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP DOMAIN <replaceable class="PARAMETER">domainname</replaceable> [, ...] [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_function.sgml b/doc/src/sgml/ref/drop_function.sgml index 1a62a00f482..005c8a1567b 100644 --- a/doc/src/sgml/ref/drop_function.sgml +++ b/doc/src/sgml/ref/drop_function.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_function.sgml,v 1.25 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_function.sgml,v 1.25.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a user-defined function</refpurpose> </refnamediv> + <indexterm zone="sql-dropfunction"> + <primary>DROP FUNCTION</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceable class="parameter">type</replaceable> [, ...] ] ) [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_group.sgml b/doc/src/sgml/ref/drop_group.sgml index c6c6907e751..bf83d1e0221 100644 --- a/doc/src/sgml/ref/drop_group.sgml +++ b/doc/src/sgml/ref/drop_group.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_group.sgml,v 1.5 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_group.sgml,v 1.5.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a user group</refpurpose> </refnamediv> + <indexterm zone="sql-dropgroup"> + <primary>DROP GROUP</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP GROUP <replaceable class="PARAMETER">name</replaceable> diff --git a/doc/src/sgml/ref/drop_index.sgml b/doc/src/sgml/ref/drop_index.sgml index 4185a4158c2..5b33121c468 100644 --- a/doc/src/sgml/ref/drop_index.sgml +++ b/doc/src/sgml/ref/drop_index.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_index.sgml,v 1.18 2003/06/24 23:29:25 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_index.sgml,v 1.18.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove an index</refpurpose> </refnamediv> + <indexterm zone="sql-dropindex"> + <primary>DROP INDEX</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP INDEX <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_language.sgml b/doc/src/sgml/ref/drop_language.sgml index ad67a95d442..f1f50a1772e 100644 --- a/doc/src/sgml/ref/drop_language.sgml +++ b/doc/src/sgml/ref/drop_language.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_language.sgml,v 1.17 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_language.sgml,v 1.17.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a user-defined procedural language</refpurpose> </refnamediv> + <indexterm zone="sql-droplanguage"> + <primary>DROP LANGUAGE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP [ PROCEDURAL ] LANGUAGE <replaceable class="PARAMETER">name</replaceable> [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_opclass.sgml b/doc/src/sgml/ref/drop_opclass.sgml index cb0aebd7103..0c5413c8e63 100644 --- a/doc/src/sgml/ref/drop_opclass.sgml +++ b/doc/src/sgml/ref/drop_opclass.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_opclass.sgml,v 1.4 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_opclass.sgml,v 1.4.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a user-defined operator class</refpurpose> </refnamediv> + <indexterm zone="sql-dropopclass"> + <primary>DROP OPERATOR CLASS</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP OPERATOR CLASS <replaceable class="PARAMETER">name</replaceable> USING <replaceable class="PARAMETER">index_method</replaceable> [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_operator.sgml b/doc/src/sgml/ref/drop_operator.sgml index 8f3b1e069c6..feae97f5f0d 100644 --- a/doc/src/sgml/ref/drop_operator.sgml +++ b/doc/src/sgml/ref/drop_operator.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_operator.sgml,v 1.19 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_operator.sgml,v 1.19.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a user-defined operator</refpurpose> </refnamediv> + <indexterm zone="sql-dropoperator"> + <primary>DROP OPERATOR</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP OPERATOR <replaceable class="PARAMETER">name</replaceable> ( <replaceable class="PARAMETER">lefttype</replaceable> | NONE , <replaceable class="PARAMETER">righttype</replaceable> | NONE ) [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_rule.sgml b/doc/src/sgml/ref/drop_rule.sgml index 0276621c575..6824cd268b8 100644 --- a/doc/src/sgml/ref/drop_rule.sgml +++ b/doc/src/sgml/ref/drop_rule.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_rule.sgml,v 1.17 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_rule.sgml,v 1.17.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a rewrite rule</refpurpose> </refnamediv> + <indexterm zone="sql-droprule"> + <primary>DROP RULE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP RULE <replaceable class="PARAMETER">name</replaceable> ON <replaceable class="PARAMETER">relation</replaceable> [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_schema.sgml b/doc/src/sgml/ref/drop_schema.sgml index b8f706b0c77..61c8fbc9421 100644 --- a/doc/src/sgml/ref/drop_schema.sgml +++ b/doc/src/sgml/ref/drop_schema.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_schema.sgml,v 1.3 2003/06/27 14:45:26 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_schema.sgml,v 1.3.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a schema</refpurpose> </refnamediv> + <indexterm zone="sql-dropschema"> + <primary>DROP SCHEMA</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP SCHEMA <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_sequence.sgml b/doc/src/sgml/ref/drop_sequence.sgml index fe77e2a3d69..8aeeb80fd70 100644 --- a/doc/src/sgml/ref/drop_sequence.sgml +++ b/doc/src/sgml/ref/drop_sequence.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_sequence.sgml,v 1.17 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_sequence.sgml,v 1.17.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a sequence</refpurpose> </refnamediv> + <indexterm zone="sql-dropsequence"> + <primary>DROP SEQUENCE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP SEQUENCE <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_table.sgml b/doc/src/sgml/ref/drop_table.sgml index 4ebda8787e6..7671f9dbf03 100644 --- a/doc/src/sgml/ref/drop_table.sgml +++ b/doc/src/sgml/ref/drop_table.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_table.sgml,v 1.18 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_table.sgml,v 1.18.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a table</refpurpose> </refnamediv> + <indexterm zone="sql-droptable"> + <primary>DROP TABLE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP TABLE <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_trigger.sgml b/doc/src/sgml/ref/drop_trigger.sgml index 5a33d033c24..92307dc7459 100644 --- a/doc/src/sgml/ref/drop_trigger.sgml +++ b/doc/src/sgml/ref/drop_trigger.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_trigger.sgml,v 1.15 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_trigger.sgml,v 1.15.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a trigger</refpurpose> </refnamediv> + <indexterm zone="sql-droptrigger"> + <primary>DROP TRIGGER</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP TRIGGER <replaceable class="PARAMETER">name</replaceable> ON <replaceable class="PARAMETER">table</replaceable> [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_type.sgml b/doc/src/sgml/ref/drop_type.sgml index 4267efcb0bd..ccbdea350de 100644 --- a/doc/src/sgml/ref/drop_type.sgml +++ b/doc/src/sgml/ref/drop_type.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_type.sgml,v 1.21 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_type.sgml,v 1.21.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a user-defined data type</refpurpose> </refnamediv> + <indexterm zone="sql-droptype"> + <primary>DROP TYPE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP TYPE <replaceable class="PARAMETER">typename</replaceable> [, ...] [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/drop_user.sgml b/doc/src/sgml/ref/drop_user.sgml index 7d094b993d3..41040fe7a35 100644 --- a/doc/src/sgml/ref/drop_user.sgml +++ b/doc/src/sgml/ref/drop_user.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_user.sgml,v 1.16 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_user.sgml,v 1.16.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a database user account</refpurpose> </refnamediv> + <indexterm zone="sql-dropuser"> + <primary>DROP USER</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP USER <replaceable class="PARAMETER">name</replaceable> diff --git a/doc/src/sgml/ref/drop_view.sgml b/doc/src/sgml/ref/drop_view.sgml index fd32f92f8ac..4238a61cc83 100644 --- a/doc/src/sgml/ref/drop_view.sgml +++ b/doc/src/sgml/ref/drop_view.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_view.sgml,v 1.17 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_view.sgml,v 1.17.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove a view</refpurpose> </refnamediv> + <indexterm zone="sql-dropview"> + <primary>DROP VIEW</primary> + </indexterm> + <refsynopsisdiv> <synopsis> DROP VIEW <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ] diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml index e029b1a6a36..b21ad29a91b 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.22 2003/05/26 17:50:09 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.22.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>remove a <productname>PostgreSQL</productname> database</refpurpose> </refnamediv> + <indexterm zone="app-dropdb"> + <primary>dropdb</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>dropdb</command> diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml index 6bddf1a5ba5..6d4f181feeb 100644 --- a/doc/src/sgml/ref/droplang.sgml +++ b/doc/src/sgml/ref/droplang.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.23 2003/03/24 14:32:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.23.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>remove a <productname>PostgreSQL</productname> procedural language</refpurpose> </refnamediv> + <indexterm zone="app-droplang"> + <primary>droplang</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>droplang</command> diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml index 24e8d8ecf45..d1d8d10289d 100644 --- a/doc/src/sgml/ref/dropuser.sgml +++ b/doc/src/sgml/ref/dropuser.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.26 2003/06/18 12:19:11 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.26.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>remove a <productname>PostgreSQL</productname> user account</refpurpose> </refnamediv> + <indexterm zone="app-dropuser"> + <primary>dropuser</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>dropuser</command> @@ -180,7 +184,7 @@ PostgreSQL documentation <term><computeroutput>DROP USER</computeroutput></term> <listitem> <para> - All is well. + The user was successfully removed. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml index ffb5ed41945..4fb4d72c5ad 100644 --- a/doc/src/sgml/ref/ecpg-ref.sgml +++ b/doc/src/sgml/ref/ecpg-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.26 2003/03/25 16:15:39 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.26.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>embedded SQL C preprocessor</refpurpose> </refnamediv> + <indexterm zone="app-ecpg"> + <primary>ecpg</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>ecpg</command> diff --git a/doc/src/sgml/ref/end.sgml b/doc/src/sgml/ref/end.sgml index b672319479e..82274be3e5c 100644 --- a/doc/src/sgml/ref/end.sgml +++ b/doc/src/sgml/ref/end.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/end.sgml,v 1.9 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/end.sgml,v 1.9.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>commit the current transaction</refpurpose> </refnamediv> + <indexterm zone="sql-end"> + <primary>END</primary> + </indexterm> + <refsynopsisdiv> <synopsis> END [ WORK | TRANSACTION ] diff --git a/doc/src/sgml/ref/execute.sgml b/doc/src/sgml/ref/execute.sgml index 7704b8ce27b..d5e29a07a1e 100644 --- a/doc/src/sgml/ref/execute.sgml +++ b/doc/src/sgml/ref/execute.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/execute.sgml,v 1.5 2003/07/01 00:04:31 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/execute.sgml,v 1.5.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>execute a prepared statement</refpurpose> </refnamediv> + <indexterm zone="sql-execute"> + <primary>EXECUTE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> EXECUTE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable class="PARAMETER">parameter</replaceable> [, ...] ) ] diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index 2ac74e8a383..5078d8fcc84 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.26 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.26.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>show the execution plan of a statement</refpurpose> </refnamediv> + <indexterm zone="sql-explain"> + <primary>EXPLAIN</primary> + </indexterm> + <refsynopsisdiv> <synopsis> EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="parameter">statement</replaceable> diff --git a/doc/src/sgml/ref/fetch.sgml b/doc/src/sgml/ref/fetch.sgml index 305e5fc02cc..682a4a68378 100644 --- a/doc/src/sgml/ref/fetch.sgml +++ b/doc/src/sgml/ref/fetch.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/fetch.sgml,v 1.29 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/fetch.sgml,v 1.29.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>retrieve rows from a query using a cursor</refpurpose> </refnamediv> + <indexterm zone="sql-fetch"> + <primary>FETCH</primary> + </indexterm> + <refsynopsisdiv> <synopsis> FETCH [ <replaceable class="PARAMETER">direction</replaceable> { FROM | IN } ] <replaceable class="PARAMETER">cursor</replaceable> @@ -281,7 +285,7 @@ where <replaceable class="PARAMETER">direction</replaceable> can be empty or one <variablelist> <varlistentry> - <term><computeroutput>WARNING: PerformPortalFetch: portal "<replaceable class="PARAMETER">cursor</replaceable>" not found</computeroutput></term> + <term><computeroutput>ERROR: cursor "<replaceable class="PARAMETER">cursor</replaceable>" does not exist</computeroutput></term> <listitem> <para> There is no cursor with the specified name. diff --git a/doc/src/sgml/ref/grant.sgml b/doc/src/sgml/ref/grant.sgml index 7ba370d6598..10ec3ca1027 100644 --- a/doc/src/sgml/ref/grant.sgml +++ b/doc/src/sgml/ref/grant.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/grant.sgml,v 1.33 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/grant.sgml,v 1.33.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>define access privileges</refpurpose> </refnamediv> + <indexterm zone="sql-grant"> + <primary>GRANT</primary> + </indexterm> + <refsynopsisdiv> <synopsis> GRANT { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER } diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index ccab2e94422..1ab6d7f48d3 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.26 2003/03/25 16:15:41 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.26.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>create a new <productname>PostgreSQL</productname> database cluster</refpurpose> </refnamediv> + <indexterm zone="app-initdb"> + <primary>initdb</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>initdb</command> diff --git a/doc/src/sgml/ref/initlocation.sgml b/doc/src/sgml/ref/initlocation.sgml index 8211e635cd2..938994e6953 100644 --- a/doc/src/sgml/ref/initlocation.sgml +++ b/doc/src/sgml/ref/initlocation.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.20 2003/03/25 16:15:42 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.20.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>create a secondary <productname>PostgreSQL</productname> database storage area</refpurpose> </refnamediv> + <indexterm zone="app-initlocation"> + <primary>initlocation</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>initlocation</command> diff --git a/doc/src/sgml/ref/insert.sgml b/doc/src/sgml/ref/insert.sgml index cbb0d279bd2..12f6d70384e 100644 --- a/doc/src/sgml/ref/insert.sgml +++ b/doc/src/sgml/ref/insert.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.23 2003/07/03 16:32:03 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.23.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>create new rows in a table</refpurpose> </refnamediv> + <indexterm zone="sql-insert"> + <primary>INSERT</primary> + </indexterm> + <refsynopsisdiv> <synopsis> INSERT INTO <replaceable class="PARAMETER">table</replaceable> [ ( <replaceable class="PARAMETER">column</replaceable> [, ...] ) ] diff --git a/doc/src/sgml/ref/ipcclean.sgml b/doc/src/sgml/ref/ipcclean.sgml index 85ca334c178..48efbd67590 100644 --- a/doc/src/sgml/ref/ipcclean.sgml +++ b/doc/src/sgml/ref/ipcclean.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/ipcclean.sgml,v 1.8 2003/03/24 14:32:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/ipcclean.sgml,v 1.8.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>remove shared memory and semaphores from an aborted <productname>PostgreSQL</productname> server</refpurpose> </refnamediv> + <indexterm zone="app-ipcclean"> + <primary>ipcclean</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>ipcclean</command> diff --git a/doc/src/sgml/ref/listen.sgml b/doc/src/sgml/ref/listen.sgml index 154224d0d20..733d34bda58 100644 --- a/doc/src/sgml/ref/listen.sgml +++ b/doc/src/sgml/ref/listen.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/listen.sgml,v 1.16 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/listen.sgml,v 1.16.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>listen for a notification</refpurpose> </refnamediv> + <indexterm zone="sql-listen"> + <primary>LISTEN</primary> + </indexterm> + <refsynopsisdiv> <synopsis> LISTEN <replaceable class="PARAMETER">name</replaceable> diff --git a/doc/src/sgml/ref/load.sgml b/doc/src/sgml/ref/load.sgml index 056322f58ed..ee0bf007d6a 100644 --- a/doc/src/sgml/ref/load.sgml +++ b/doc/src/sgml/ref/load.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.17 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.17.2.1 2003/09/07 04:36:45 momjian Exp $ --> <refentry id="SQL-LOAD"> @@ -13,6 +13,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.17 2003/04/26 23:56:51 pe <refpurpose>load or reload a shared library file</refpurpose> </refnamediv> + <indexterm zone="sql-load"> + <primary>LOAD</primary> + </indexterm> + <refsynopsisdiv> <synopsis> LOAD '<replaceable class="PARAMETER">filename</replaceable>' diff --git a/doc/src/sgml/ref/lock.sgml b/doc/src/sgml/ref/lock.sgml index c39cb154b8e..8dfb661ba80 100644 --- a/doc/src/sgml/ref/lock.sgml +++ b/doc/src/sgml/ref/lock.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/lock.sgml,v 1.35 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/lock.sgml,v 1.35.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>lock a table</refpurpose> </refnamediv> + <indexterm zone="sql-lock"> + <primary>LOCK</primary> + </indexterm> + <refsynopsisdiv> <synopsis> LOCK [ TABLE ] <replaceable class="PARAMETER">name</replaceable> [, ...] [ IN <replaceable class="PARAMETER">lockmode</replaceable> MODE ] diff --git a/doc/src/sgml/ref/move.sgml b/doc/src/sgml/ref/move.sgml index d60ec29c3b5..b21f0244a70 100644 --- a/doc/src/sgml/ref/move.sgml +++ b/doc/src/sgml/ref/move.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/move.sgml,v 1.22 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/move.sgml,v 1.22.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>reposition a cursor</refpurpose> </refnamediv> + <indexterm zone="sql-move"> + <primary>MOVE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> MOVE [ <replaceable class="PARAMETER">direction</replaceable> { FROM | IN } ] <replaceable class="PARAMETER">cursor</replaceable> diff --git a/doc/src/sgml/ref/notify.sgml b/doc/src/sgml/ref/notify.sgml index 82cd1531790..37e6f8babc2 100644 --- a/doc/src/sgml/ref/notify.sgml +++ b/doc/src/sgml/ref/notify.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/notify.sgml,v 1.20 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/notify.sgml,v 1.20.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>generate a notification</refpurpose> </refnamediv> + <indexterm zone="sql-notify"> + <primary>NOTIFY</primary> + </indexterm> + <refsynopsisdiv> <synopsis> NOTIFY <replaceable class="PARAMETER">name</replaceable> diff --git a/doc/src/sgml/ref/pg_config-ref.sgml b/doc/src/sgml/ref/pg_config-ref.sgml index 084d78b95d0..cb27d5c902a 100644 --- a/doc/src/sgml/ref/pg_config-ref.sgml +++ b/doc/src/sgml/ref/pg_config-ref.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.15 2003/03/25 16:15:42 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.15.2.1 2003/09/07 04:36:45 momjian Exp $ --> <refentry id="app-pgconfig"> <refmeta> @@ -12,6 +12,10 @@ <refpurpose>retrieve information about the installed version of <productname>PostgreSQL</></refpurpose> </refnamediv> + <indexterm zone="app-pgconfig"> + <primary>pg_config</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>pg_config</command> diff --git a/doc/src/sgml/ref/pg_controldata.sgml b/doc/src/sgml/ref/pg_controldata.sgml index 314022eb925..42d767846e2 100644 --- a/doc/src/sgml/ref/pg_controldata.sgml +++ b/doc/src/sgml/ref/pg_controldata.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.5 2003/03/24 14:32:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.5.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>display control information of a <productname>PostgreSQL</productname> database cluster</refpurpose> </refnamediv> + <indexterm zone="app-pgcontroldata"> + <primary>pg_controldata</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>pg_controldata</command> diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml index 8aabb33934f..812e76e650e 100644 --- a/doc/src/sgml/ref/pg_ctl-ref.sgml +++ b/doc/src/sgml/ref/pg_ctl-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.22 2003/03/25 16:15:42 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.22.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>start, stop, or restart a <productname>PostgreSQL</productname> server</refpurpose> </refnamediv> + <indexterm zone="app-pg-ctl"> + <primary>pg_ctl</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>pg_ctl</command> diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 5b9e2d4c40e..23ef56858f9 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.62 2003/06/11 16:29:42 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.62.2.1 2003/09/07 04:36:45 momjian Exp $ PostgreSQL documentation --> @@ -18,6 +18,10 @@ PostgreSQL documentation </refpurpose> </refnamediv> + <indexterm zone="app-pgdump"> + <primary>pg_dump</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>pg_dump</command> diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index 500336e9196..e0ac946472a 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.39 2003/05/30 23:55:10 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.39.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>extract a <productname>PostgreSQL</productname> database cluster into a script file</refpurpose> </refnamediv> + <indexterm zone="app-pg-dumpall"> + <primary>pg_dumpall</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>pg_dumpall</command> diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index cf028b93e59..a04427a7cbd 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.39 2003/06/11 16:29:42 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.39.2.1 2003/09/07 04:36:46 momjian Exp $ --> <refentry id="APP-PGRESTORE"> <refmeta> @@ -15,6 +15,10 @@ </refpurpose> </refnamediv> + <indexterm zone="app-pgrestore"> + <primary>pg_restore</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>pg_restore</command> @@ -42,8 +46,8 @@ <para> <application>pg_restore</application> can operate in two modes: If a database name is specified, the archive is restored directly into - the database. Large objects can only be restored by using a direct - database connection. Otherwise, a script containing the SQL + the database. (Large objects can only be restored by using such a direct + database connection.) Otherwise, a script containing the SQL commands necessary to rebuild the database is created (and written to a file or standard output), similar to the ones created by the <application>pg_dump</application> plain text format. Some of the @@ -228,11 +232,13 @@ <term><option>--orig-order</option></term> <listitem> <para> - Restore items in the original dump order. By default - <application>pg_dump</application> will dump items in an order - convenient to <application>pg_dump</application>, then save the - archive in a modified OID order. This option overrides the OID - ordering. + Restore items in the order they were originally generated within + <application>pg_dump</application>. This option has no known + practical use, since <application>pg_dump</application> generates + the items in an order convenient to it, which is unlikely to be a + safe order for restoring them. (This is <emphasis>not</> the order + in which the items are ultimately listed in the archive's table of + contents.) See also <option>-r</>. </para> </listitem> </varlistentry> @@ -242,11 +248,10 @@ <term><option>--oid-order</option></term> <listitem> <para> - Restore items in the OID order. By default - <application>pg_dump</application> will dump items in an order - convenient to <application>pg_dump</application>, then save the - archive in a modified OID order. This option enforces strict - OID ordering. + Restore items in order by OID. This option is of limited usefulness, + since OID is only an approximate indication of original creation + order. This option overrides <option>-N</> if both are specified. + See also <option>-r</>. </para> </listitem> </varlistentry> @@ -281,13 +286,22 @@ <term><option>--rearrange</option></term> <listitem> <para> - Restore items in modified OID order. By default - <application>pg_dump</application> will dump items in an order - convenient to <application>pg_dump</application>, then save the - archive in a modified OID order. Most objects will be restored - in OID order, but some things (e.g., rules and indexes) will - be restored at the end of the process irrespective of their - OIDs. This option is the default. + Rearrange items by object type (this occurs after the sorting + specified by <option>-N</option> or <option>-o</option>, if + given). The rearrangement is intended to give the best possible + restore performance. + </para> + + <para> + When none of <option>-N</option>, <option>-o</option>, and + <option>-r</> appear, <application>pg_restore</application> restores + items in the order they appear in the dump's table of contents, + or in the order they appear in the <REPLACEABLE + CLASS="PARAMETER">list-file</REPLACEABLE> if <option>-L</> is + given. The combination of <option>-o</> and <option>-r</> + duplicates the sorting done by <application>pg_dump</application> + before creating the dump's table of contents, + and so it is normally unnecessary to specify it. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/pgtclsh.sgml b/doc/src/sgml/ref/pgtclsh.sgml index 2a32d6305e0..f7b52a7cc08 100644 --- a/doc/src/sgml/ref/pgtclsh.sgml +++ b/doc/src/sgml/ref/pgtclsh.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.8 2003/03/25 16:15:43 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.8.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -17,6 +17,10 @@ PostgreSQL documentation </refpurpose> </refnamediv> + <indexterm zone="app-pgtclsh"> + <primary>pgtclsh</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>pgtclsh</command> diff --git a/doc/src/sgml/ref/pgtksh.sgml b/doc/src/sgml/ref/pgtksh.sgml index bcc052bfdbf..c04f219c3f8 100644 --- a/doc/src/sgml/ref/pgtksh.sgml +++ b/doc/src/sgml/ref/pgtksh.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.8 2003/03/25 16:15:43 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.8.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -17,6 +17,10 @@ PostgreSQL documentation </refpurpose> </refnamediv> + <indexterm zone="app-pgtksh"> + <primary>pgtksh</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>pgtksh</command> diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index 073b83fd7d9..66e5e02502b 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.34 2003/07/29 00:03:17 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.34.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>run a <productname>PostgreSQL</productname> server in single-user mode</refpurpose> </refnamediv> + <indexterm zone="app-postgres"> + <primary>postgres (the program)</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <!-- standalone call --> diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index ed431c6b54b..d68827c6e1e 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.36 2003/03/25 16:15:43 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.36.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose><productname>PostgreSQL</productname> multiuser database server</refpurpose> </refnamediv> + <indexterm zone="app-postmaster"> + <primary>postmaster</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>postmaster</command> diff --git a/doc/src/sgml/ref/prepare.sgml b/doc/src/sgml/ref/prepare.sgml index 9f58b7a5ce8..22f9067dd0d 100644 --- a/doc/src/sgml/ref/prepare.sgml +++ b/doc/src/sgml/ref/prepare.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/prepare.sgml,v 1.4 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/prepare.sgml,v 1.4.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>prepare a statement for execution</refpurpose> </refnamediv> + <indexterm zone="sql-prepare"> + <primary>PREPARE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> PREPARE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable class="PARAMETER">datatype</replaceable> [, ...] ) ] AS <replaceable class="PARAMETER">statement</replaceable> @@ -130,7 +134,7 @@ PREPARE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable c In some situations, the query plan produced by for a prepared statement may be inferior to the plan produced if the statement were submitted and executed normally. This is because when the - statement is planned and the planer attempts to determine the + statement is planned and the planner attempts to determine the optimal query plan, the actual values of any parameters specified in the statement are unavailable. <productname>PostgreSQL</productname> collects diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 3969a1ad641..251f67fa5cd 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.94 2003/08/02 02:44:38 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.94.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -17,6 +17,10 @@ PostgreSQL documentation </refpurpose> </refnamediv> + <indexterm zone="app-psql"> + <primary>psql</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>psql</command> @@ -2210,8 +2214,14 @@ testdb=> <userinput>\set content '\'' `sed -e "s/'/\\\\\\'/g" < my_file.txt` '\' <varlistentry> <term><literal>%n</literal></term> - <listitem><para>The user name you are connected as (not your local system - user name).</para></listitem> + <listitem> + <para> + The database session user name. (The expansion of this + value might change during a database session as the result + of the command <command>SET SESSION + AUTHORIZATION</command>.) + </para> + </listitem> </varlistentry> <varlistentry> @@ -2227,8 +2237,15 @@ testdb=> <userinput>\set content '\'' `sed -e "s/'/\\\\\\'/g" < my_file.txt` '\' <varlistentry> <term><literal>%#</literal></term> - <listitem><para>If the current user is a database superuser, then a - <literal>#</literal>, otherwise a <literal>></literal>.</para></listitem> + <listitem> + <para> + If the session user is a database superuser, then a + <literal>#</literal>, otherwise a <literal>></literal>. + (The expansion of this value might change during a database + session as the result of the command <command>SET SESSION + AUTHORIZATION</command>.) + </para> + </listitem> </varlistentry> <varlistentry> diff --git a/doc/src/sgml/ref/reindex.sgml b/doc/src/sgml/ref/reindex.sgml index 591542ac1e0..c18950d0d29 100644 --- a/doc/src/sgml/ref/reindex.sgml +++ b/doc/src/sgml/ref/reindex.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/reindex.sgml,v 1.17 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/reindex.sgml,v 1.17.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>rebuild indexes</refpurpose> </refnamediv> + <indexterm zone="sql-reindex"> + <primary>REINDEX</primary> + </indexterm> + <refsynopsisdiv> <synopsis> REINDEX { DATABASE | TABLE | INDEX } <replaceable class="PARAMETER">name</replaceable> [ FORCE ] diff --git a/doc/src/sgml/ref/reset.sgml b/doc/src/sgml/ref/reset.sgml index 87d9de30974..71a2bf01b68 100644 --- a/doc/src/sgml/ref/reset.sgml +++ b/doc/src/sgml/ref/reset.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.20 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.20.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>restore the value of a run-time parameter to the default value</refpurpose> </refnamediv> + <indexterm zone="sql-reset"> + <primary>RESET</primary> + </indexterm> + <refsynopsisdiv> <synopsis> RESET <replaceable class="PARAMETER">parameter</replaceable> diff --git a/doc/src/sgml/ref/revoke.sgml b/doc/src/sgml/ref/revoke.sgml index 22cb395a75d..6f7eb06deb2 100644 --- a/doc/src/sgml/ref/revoke.sgml +++ b/doc/src/sgml/ref/revoke.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/revoke.sgml,v 1.26 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/revoke.sgml,v 1.26.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>remove access privileges</refpurpose> </refnamediv> + <indexterm zone="sql-revoke"> + <primary>REVOKE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> REVOKE [ GRANT OPTION FOR ] diff --git a/doc/src/sgml/ref/rollback.sgml b/doc/src/sgml/ref/rollback.sgml index dc5b063c495..3a6026fee2a 100644 --- a/doc/src/sgml/ref/rollback.sgml +++ b/doc/src/sgml/ref/rollback.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/rollback.sgml,v 1.14 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/rollback.sgml,v 1.14.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>abort the current transaction</refpurpose> </refnamediv> + <indexterm zone="sql-rollback"> + <primary>ROLLBACK</primary> + </indexterm> + <refsynopsisdiv> <synopsis> ROLLBACK [ WORK | TRANSACTION ] diff --git a/doc/src/sgml/ref/select.sgml b/doc/src/sgml/ref/select.sgml index f983b2a8213..2353bb540cd 100644 --- a/doc/src/sgml/ref/select.sgml +++ b/doc/src/sgml/ref/select.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.67 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.67.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>retrieve rows from a table or view</refpurpose> </refnamediv> + <indexterm zone="sql-select"> + <primary>SELECT</primary> + </indexterm> + <refsynopsisdiv> <synopsis> SELECT [ ALL | DISTINCT [ ON ( <replaceable class="parameter">expression</replaceable> [, ...] ) ] ] @@ -660,8 +664,11 @@ SELECT name FROM distributors ORDER BY code; <literal>ORDER BY</> clause. If not specified, <literal>ASC</> is assumed by default. Alternatively, a specific ordering operator name may be specified in the <literal>USING</> clause. - <literal>ASC</> is equivalent to <literal>USING <</> and - <literal>DESC</> is equivalent to <literal>USING ></>. + <literal>ASC</> is usually equivalent to <literal>USING <</> and + <literal>DESC</> is usually equivalent to <literal>USING ></>. + (But the creator of a user-defined datatype can define exactly what the + default sort ordering is, and it might correspond to operators with other + names.) </para> <para> @@ -671,7 +678,7 @@ SELECT name FROM distributors ORDER BY code; </para> <para> - Data of character types is sorted according to the locale-specific + Character-string data is sorted according to the locale-specific collation order that was established when the database cluster was initialized. </para> @@ -1003,7 +1010,9 @@ SELECT distributors.* FROM distributors d, distributors distributors; that he will actually get. To help detect this sort of mistake, PostgreSQL will warn if the implicit-<literal>FROM</literal> feature is used in a <command>SELECT</command> statement that also - contains an explicit <literal>FROM</literal> clause. + contains an explicit <literal>FROM</literal> clause. Also, it is + possible to disable the implicit-<literal>FROM</literal> feature + by setting the <varname>ADD_MISSING_FROM</> parameter to false. </para> </refsect2> @@ -1015,7 +1024,7 @@ SELECT distributors.* FROM distributors d, distributors distributors; noise and can be omitted without affecting the meaning. The <productname>PostgreSQL</productname> parser requires this key word when renaming output columns because the type extensibility - features lead to parsing ambiguities in this context. + features lead to parsing ambiguities without it. <literal>AS</literal> is optional in <literal>FROM</literal> items, however. </para> @@ -1025,7 +1034,7 @@ SELECT distributors.* FROM distributors d, distributors distributors; <title>Namespace Available to <literal>GROUP BY</literal> and <literal>ORDER BY</literal></title> <para> - In the SQL standard, an <literal>ORDER BY</literal> clause may + In the SQL92 standard, an <literal>ORDER BY</literal> clause may only use result column names or numbers, while a <literal>GROUP BY</literal> clause may only use expressions based on input column names. <productname>PostgreSQL</productname> extends each of @@ -1036,6 +1045,13 @@ SELECT distributors.* FROM distributors d, distributors distributors; expression will always be taken as input-column names, not as result-column names. </para> + + <para> + SQL99 uses a slightly different definition which is not upward compatible + with SQL92. In most cases, however, <productname>PostgreSQL</productname> + will interpret an <literal>ORDER BY</literal> or <literal>GROUP + BY</literal> expression the same way SQL99 does. + </para> </refsect2> <refsect2> diff --git a/doc/src/sgml/ref/select_into.sgml b/doc/src/sgml/ref/select_into.sgml index 131bb6e1a2f..b7263025170 100644 --- a/doc/src/sgml/ref/select_into.sgml +++ b/doc/src/sgml/ref/select_into.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/select_into.sgml,v 1.22 2003/05/04 02:23:16 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/select_into.sgml,v 1.22.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>create a new table from the results of a query</refpurpose> </refnamediv> + <indexterm zone="sql-selectinto"> + <primary>SELECT INTO</primary> + </indexterm> + <refsynopsisdiv> <synopsis> SELECT [ ALL | DISTINCT [ ON ( <replaceable class="PARAMETER">expression</replaceable> [, ...] ) ] ] diff --git a/doc/src/sgml/ref/set.sgml b/doc/src/sgml/ref/set.sgml index bb1ddd22759..57c491d6df5 100644 --- a/doc/src/sgml/ref/set.sgml +++ b/doc/src/sgml/ref/set.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v 1.80 2003/07/29 00:03:17 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v 1.80.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>change a run-time parameter</refpurpose> </refnamediv> + <indexterm zone="sql-set"> + <primary>SET</primary> + </indexterm> + <refsynopsisdiv> <synopsis> SET [ SESSION | LOCAL ] <replaceable class="PARAMETER">variable</replaceable> { TO | = } { <replaceable class="PARAMETER">value</replaceable> | '<replaceable class="PARAMETER">value</replaceable>' | DEFAULT } diff --git a/doc/src/sgml/ref/set_constraints.sgml b/doc/src/sgml/ref/set_constraints.sgml index 3d5b58bee2e..3e89f60769d 100644 --- a/doc/src/sgml/ref/set_constraints.sgml +++ b/doc/src/sgml/ref/set_constraints.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_constraints.sgml,v 1.6 2003/05/04 02:23:16 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_constraints.sgml,v 1.6.2.1 2003/09/07 04:36:46 momjian Exp $ --> <refentry id="SQL-SET-CONSTRAINTS"> <refmeta> <refentrytitle id="SQL-SET-CONSTRAINTS-title">SET CONSTRAINTS</refentrytitle> @@ -10,6 +10,10 @@ <refpurpose>set the constraint mode of the current transaction</refpurpose> </refnamediv> + <indexterm zone="sql-set-constraints"> + <primary>SET CONSTRAINTS</primary> + </indexterm> + <refsynopsisdiv> <synopsis> SET CONSTRAINTS { ALL | <replaceable class="parameter">constraint</replaceable> [, ...] } { DEFERRED | IMMEDIATE } diff --git a/doc/src/sgml/ref/set_session_auth.sgml b/doc/src/sgml/ref/set_session_auth.sgml index f8c0297adad..ba2c27acbe9 100644 --- a/doc/src/sgml/ref/set_session_auth.sgml +++ b/doc/src/sgml/ref/set_session_auth.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_session_auth.sgml,v 1.9 2003/05/04 02:23:16 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_session_auth.sgml,v 1.9.2.1 2003/09/07 04:36:46 momjian Exp $ --> <refentry id="SQL-SET-SESSION-AUTHORIZATION"> <refmeta> <refentrytitle id="sql-set-session-authorization-title">SET SESSION AUTHORIZATION</refentrytitle> @@ -10,6 +10,10 @@ <refpurpose>set the session user identifier and the current user identifier of the current session</refpurpose> </refnamediv> + <indexterm zone="sql-set-session-authorization"> + <primary>SET SESSION AUTHORIZATION</primary> + </indexterm> + <refsynopsisdiv> <synopsis> SET [ SESSION | LOCAL ] SESSION AUTHORIZATION <replaceable class="parameter">username</replaceable> diff --git a/doc/src/sgml/ref/set_transaction.sgml b/doc/src/sgml/ref/set_transaction.sgml index 2ff29bc3d5f..d531d8f43af 100644 --- a/doc/src/sgml/ref/set_transaction.sgml +++ b/doc/src/sgml/ref/set_transaction.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.14 2003/05/04 02:23:16 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.14.2.1 2003/09/07 04:36:46 momjian Exp $ --> <refentry id="SQL-SET-TRANSACTION"> <refmeta> <refentrytitle id="SQL-SET-TRANSACTION-TITLE">SET TRANSACTION</refentrytitle> @@ -10,6 +10,10 @@ <refpurpose>set the characteristics of the current transaction</refpurpose> </refnamediv> + <indexterm zone="sql-set-transaction"> + <primary>SET TRANSACTION</primary> + </indexterm> + <refsynopsisdiv> <synopsis> SET TRANSACTION diff --git a/doc/src/sgml/ref/show.sgml b/doc/src/sgml/ref/show.sgml index 1f0f52735a0..3bb52cce54b 100644 --- a/doc/src/sgml/ref/show.sgml +++ b/doc/src/sgml/ref/show.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.30 2003/07/29 00:03:17 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.30.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>show the value of a run-time parameter</refpurpose> </refnamediv> + <indexterm zone="sql-show"> + <primary>SHOW</primary> + </indexterm> + <refsynopsisdiv> <synopsis> SHOW <replaceable class="PARAMETER">name</replaceable> diff --git a/doc/src/sgml/ref/start_transaction.sgml b/doc/src/sgml/ref/start_transaction.sgml index 5b9abefddd8..8b8690c0f29 100644 --- a/doc/src/sgml/ref/start_transaction.sgml +++ b/doc/src/sgml/ref/start_transaction.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/start_transaction.sgml,v 1.5 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/start_transaction.sgml,v 1.5.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>start a transaction block</refpurpose> </refnamediv> + <indexterm zone="sql-start-transaction"> + <primary>START TRANSACTION</primary> + </indexterm> + <refsynopsisdiv> <synopsis> START TRANSACTION [ ISOLATION LEVEL { READ COMMITTED | SERIALIZABLE } ] [ READ WRITE | READ ONLY ] diff --git a/doc/src/sgml/ref/truncate.sgml b/doc/src/sgml/ref/truncate.sgml index b5b9d84ddc8..f10d0a4456c 100644 --- a/doc/src/sgml/ref/truncate.sgml +++ b/doc/src/sgml/ref/truncate.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/truncate.sgml,v 1.10 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/truncate.sgml,v 1.10.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>empty a table</refpurpose> </refnamediv> + <indexterm zone="sql-truncate"> + <primary>TRUNCATE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> TRUNCATE [ TABLE ] <replaceable class="PARAMETER">name</replaceable> diff --git a/doc/src/sgml/ref/unlisten.sgml b/doc/src/sgml/ref/unlisten.sgml index 4c3799177b2..54e857b3c9b 100644 --- a/doc/src/sgml/ref/unlisten.sgml +++ b/doc/src/sgml/ref/unlisten.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/unlisten.sgml,v 1.21 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/unlisten.sgml,v 1.21.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>stop listening for a notification</refpurpose> </refnamediv> + <indexterm zone="sql-unlisten"> + <primary>UNLISTEN</primary> + </indexterm> + <refsynopsisdiv> <synopsis> UNLISTEN { <replaceable class="PARAMETER">name</replaceable> | * } diff --git a/doc/src/sgml/ref/update.sgml b/doc/src/sgml/ref/update.sgml index 1fe85b995ed..c7020e85a7a 100644 --- a/doc/src/sgml/ref/update.sgml +++ b/doc/src/sgml/ref/update.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/update.sgml,v 1.23 2003/07/03 16:32:12 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/update.sgml,v 1.23.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>update rows of a table</refpurpose> </refnamediv> + <indexterm zone="sql-update"> + <primary>UPDATE</primary> + </indexterm> + <refsynopsisdiv> <synopsis> UPDATE [ ONLY ] <replaceable class="PARAMETER">table</replaceable> SET <replaceable class="PARAMETER">column</replaceable> = { <replaceable class="PARAMETER">expression</replaceable> | DEFAULT } [, ...] diff --git a/doc/src/sgml/ref/vacuum.sgml b/doc/src/sgml/ref/vacuum.sgml index 3f532c02448..3cfba61f445 100644 --- a/doc/src/sgml/ref/vacuum.sgml +++ b/doc/src/sgml/ref/vacuum.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.31 2003/04/26 23:56:51 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.31.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -14,6 +14,10 @@ PostgreSQL documentation <refpurpose>garbage-collect and optionally analyze a database</refpurpose> </refnamediv> + <indexterm zone="sql-vacuum"> + <primary>VACUUM</primary> + </indexterm> + <refsynopsisdiv> <synopsis> VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ <replaceable class="PARAMETER">table</replaceable> ] diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index e04cf16c3fe..5bc236ccd8b 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.29 2003/06/18 12:19:11 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.29.2.1 2003/09/07 04:36:46 momjian Exp $ PostgreSQL documentation --> @@ -15,6 +15,10 @@ PostgreSQL documentation <refpurpose>garbage-collect and analyze a <productname>PostgreSQL</productname> database</refpurpose> </refnamediv> + <indexterm zone="app-vacuumdb"> + <primary>vacuumdb</primary> + </indexterm> + <refsynopsisdiv> <cmdsynopsis> <command>vacuumdb</command> @@ -59,10 +63,11 @@ PostgreSQL documentation <para> - <application>vacuumdb</application> might need to connect several - times to the <productname>PostgreSQL</productname> server, asking for - a password each time. It is convenient to have a - <filename>$HOME/.pgpass</> file in such cases. + <application>vacuumdb</application> might need to connect several + times to the <productname>PostgreSQL</productname> server, asking + for a password each time. It is convenient to have a + <filename>$HOME/.pgpass</> file in such cases. See <xref + linkend="libpq-pgpass"> for more information. </para> </refsect1> @@ -234,7 +239,7 @@ PostgreSQL documentation <term><computeroutput>VACUUM</computeroutput></term> <listitem> <para> - Everything went well. + The database was successfully vacuumed. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml index a5dac7a1411..52ea13fae0e 100644 --- a/doc/src/sgml/regress.sgml +++ b/doc/src/sgml/regress.sgml @@ -1,8 +1,16 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/regress.sgml,v 1.32 2003/04/06 17:47:24 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/regress.sgml,v 1.32.2.1 2003/09/07 04:36:43 momjian Exp $ --> <chapter id="regress"> <title id="regress-title">Regression Tests</title> + <indexterm zone="regress"> + <primary>regression tests</primary> + </indexterm> + + <indexterm zone="regress"> + <primary>test</primary> + </indexterm> + <para> The regression tests are a comprehensive set of tests for the SQL implementation in <productname>PostgreSQL</productname>. They test diff --git a/doc/src/sgml/release.sgml b/doc/src/sgml/release.sgml index 1f4538c7c87..9ff2cb05cce 100644 --- a/doc/src/sgml/release.sgml +++ b/doc/src/sgml/release.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/release.sgml,v 1.204 2003/07/31 04:48:15 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/release.sgml,v 1.204.2.1 2003/09/07 04:36:43 momjian Exp $ --> <appendix id="release"> @@ -456,8 +456,8 @@ Properly escape jdbc setObject() strings to improve security (Barry) application examines the system catalogs, additional changes will be required due to the introduction of schemas in 7.3; for more information, see: <ulink - url="http://www.ca.postgresql.org/docs/momjian/upgrade_tips_7.3"> - http://www.ca.postgresql.org/docs/momjian/upgrade_tips_7.3</>. + url="http://developer.postgresql.org/~momjian/upgrade_tips_7.3"> + http://developer.postgresql.org/~momjian/upgrade_tips_7.3</>. </para> <para> @@ -4901,7 +4901,7 @@ Contributors (appologies to any missed) * david bennett <dave@bensoft.com> * ernst.molitor@uni-bonn.de * Julian Assange <proff@suburbia.net> - * Bruce Momjian <maillist@candle.pha.pa.us> + * Bruce Momjian <pgman@candle.pha.pa.us> * Paul "Shag" Walmsley <ccshag@cclabs.missouri.edu> * "Alistair G. Crooks" <azcb0@sde.uts.amdahl.com> --> diff --git a/doc/src/sgml/rules.sgml b/doc/src/sgml/rules.sgml index 66d20cb11b7..2d485b4d595 100644 --- a/doc/src/sgml/rules.sgml +++ b/doc/src/sgml/rules.sgml @@ -1,10 +1,10 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/rules.sgml,v 1.28 2003/04/11 13:22:35 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/rules.sgml,v 1.28.2.1 2003/09/07 04:36:43 momjian Exp $ --> <Chapter Id="rules"> <Title>The Rule System</Title> <indexterm zone="rules"> - <primary>rules</primary> + <primary>rule</primary> </indexterm> <Para> @@ -35,6 +35,10 @@ <Sect1 id="querytree"> <Title>The Query Tree</Title> +<indexterm zone="querytree"> + <primary>query tree</primary> +</indexterm> + <Para> To understand how the rule system works it is necessary to know when it is invoked and what its input and results are. @@ -146,6 +150,7 @@ <Term> the target list </Term> + <indexterm><primary>target list</></> <ListItem> <Para> The target list is a list of expressions that define the @@ -258,7 +263,16 @@ <Sect1 id="rules-views"> <Title>Views and the Rule System</Title> -<indexterm zone="rules-views"><primary>rules</><secondary>and views</></> + +<indexterm zone="rules-views"> + <primary>rule</primary> + <secondary>and views</secondary> +</indexterm> + +<indexterm zone="rules-views"> + <primary>view</> + <secondary>implementation through rules</> +</indexterm> <Para> Views in <ProductName>PostgreSQL</ProductName> are implemented @@ -286,9 +300,14 @@ CREATE RULE "_RETURN" AS ON SELECT TO myview DO INSTEAD same thing: relations. </Para> -<Sect2> +<Sect2 id="rules-select"> <Title>How <command>SELECT</command> Rules Work</Title> +<indexterm zone="rules-select"> + <primary>rule</primary> + <secondary sortas="SELECT">for SELECT</secondary> +</indexterm> + <Para> Rules <literal>ON SELECT</> are applied to all queries as the last step, even if the command given is an <command>INSERT</command>, @@ -736,7 +755,7 @@ SELECT t1.a, t2.b FROM t1, t2 WHERE t1.a = t2.a; To resolve this problem, another entry is added to the target list in <command>UPDATE</command> (and also in <command>DELETE</command>) statements: the current tuple ID - (<acronym>CTID</>). This is a system column containing the + (<acronym>CTID</>).<indexterm><primary>CTID</></> This is a system column containing the file block number and position in the block for the row. Knowing the table, the <acronym>CTID</> can be used to retrieve the original row of <literal>t1</> to be updated. After adding the <acronym>CTID</> @@ -817,6 +836,21 @@ SELECT t1.a, t2.b, t1.ctid FROM t1, t2 WHERE t1.a = t2.a; <Sect1 id="rules-update"> <Title>Rules on <command>INSERT</>, <command>UPDATE</>, and <command>DELETE</></Title> +<indexterm zone="rules-update"> + <primary>rule</primary> + <secondary sortas="INSERT">for INSERT</secondary> +</indexterm> + +<indexterm zone="rules-update"> + <primary>rule</primary> + <secondary sortas="UPDATE">for UPDATE</secondary> +</indexterm> + +<indexterm zone="rules-update"> + <primary>rule</primary> + <secondary sortas="DELETE">for DELETE</secondary> +</indexterm> + <Para> Rules that are defined on <command>INSERT</>, <command>UPDATE</>, and <command>DELETE</> are significantly different from the view rules @@ -1243,7 +1277,7 @@ SELECT shoelace_data.sl_name, 0, <Sect2 id="rules-update-views"> <Title>Cooperation with Views</Title> -<indexterm zone="rules-update-views"><primary>views</><secondary>updating</></> +<indexterm zone="rules-update-views"><primary>view</><secondary>updating</></> <Para> A simple way to protect view relations from the mentioned @@ -1654,6 +1688,16 @@ SELECT * FROM shoelace; <Sect1 id="rules-privileges"> <Title>Rules and Privileges</Title> +<indexterm zone="rules-privileges"> + <primary>privilege</primary> + <secondary sortas="Regeln">with rules</secondary> +</indexterm> + +<indexterm zone="rules-privileges"> + <primary>privilege</primary> + <secondary sortas="Sichten">with views</secondary> +</indexterm> + <Para> Due to rewriting of queries by the <ProductName>PostgreSQL</ProductName> rule system, other tables/views than those used in the original @@ -1796,6 +1840,16 @@ GRANT SELECT ON phone_number TO secretary; <Sect1 id="rules-triggers"> <Title>Rules versus Triggers</Title> +<indexterm zone="rules-triggers"> + <primary>rule</primary> + <secondary sortas="Trigger">compared with triggers</secondary> +</indexterm> + +<indexterm zone="rules-triggers"> + <primary>trigger</primary> + <secondary sortas="Regeln">compared with rules</secondary> +</indexterm> + <Para> Many things that can be done using triggers can also be implemented using the <ProductName>PostgreSQL</ProductName> diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml index 6adfd85df0f..37168a47b0b 100644 --- a/doc/src/sgml/runtime.sgml +++ b/doc/src/sgml/runtime.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/runtime.sgml,v 1.199 2003/08/10 01:20:34 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/runtime.sgml,v 1.199.2.1 2003/09/07 04:36:43 momjian Exp $ --> <Chapter Id="runtime"> @@ -69,7 +69,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/runtime.sgml,v 1.199 2003/08/10 01:20:34 tg default, although locations such as <filename>/usr/local/pgsql/data</filename> or <filename>/var/lib/pgsql/data</filename> are popular. To initialize a - database cluster, use the command <command>initdb</command>, which is + database cluster, use the command <command>initdb</command>,<indexterm><primary>initdb</></> which is installed with <productname>PostgreSQL</productname>. The desired file system location of your database system is indicated by the <option>-D</option> option, for example @@ -120,11 +120,13 @@ postgres$ <userinput>initdb -D /usr/local/pgsql/data</userinput> <para> However, while the directory contents are secure, the default client authentication setup allows any local user to connect to the - database and even become the database superuser. If you do not trust - other local users, we recommend you use <command>initdb</command>'s - <option>-W</option> or <option>--pwprompt</option> option to assign a - password to the database superuser. After <command>initdb</command>, - modify the <filename>pg_hba.conf</filename> file to use <literal>md5</> or + database and even become the database superuser. If you do not + trust other local users, we recommend you use + <command>initdb</command>'s <option>-W</option> or + <option>--pwprompt</option> option to assign a password to the + database superuser.<indexterm><primary>password</><secondary>of the + superuser</></indexterm> After <command>initdb</command>, modify + the <filename>pg_hba.conf</filename> file to use <literal>md5</> or <literal>password</> instead of <literal>trust</> authentication <emphasis>before</> you start the server for the first time. (Other approaches include using <literal>ident</literal> authentication or @@ -207,8 +209,9 @@ pg_ctl start -l logfile <para> Normally, you will want to start the database server when the - computer boots. Autostart scripts are operating system-specific. - There are a few distributed with + computer boots.<indexterm><primary>booting</><secondary>starting + the server during</></> Autostart scripts are operating + system-specific. There are a few distributed with <productname>PostgreSQL</productname> in the <filename>contrib/start-scripts</> directory. This may require root privileges. @@ -240,7 +243,7 @@ su -c 'pg_ctl start -D /usr/local/pgsql/data -l serverlog' postgres For <productname>FreeBSD</productname>, look at the file <filename>contrib/start-scripts/freebsd</filename> in the <productname>PostgreSQL</productname> source distribution. - <indexterm><primary>FreeBSD</></> + <indexterm><primary>FreeBSD</><secondary>start script</secondary></> </para> </listitem> @@ -248,7 +251,7 @@ su -c 'pg_ctl start -D /usr/local/pgsql/data -l serverlog' postgres <para> On <productname>OpenBSD</productname>, add the following lines to the file <filename>/etc/rc.local</filename>: - <indexterm><primary>OpenBSD</></> + <indexterm><primary>OpenBSD</><secondary>start script</secondary></> <programlisting> if [ -x /usr/local/pgsql/bin/pg_ctl -a -x /usr/local/pgsql/bin/postmaster ]; then su - -c '/usr/local/pgsql/bin/pg_ctl start -l /var/postgresql/log -s' postgres @@ -261,7 +264,7 @@ fi <listitem> <para> On <productname>Linux</productname> systems either add - <indexterm><primary>Linux</></> + <indexterm><primary>Linux</><secondary>start script</secondary></> <programlisting> /usr/local/pgsql/bin/pg_ctl start -l logfile -D /usr/local/pgsql/data </programlisting> @@ -276,7 +279,7 @@ fi On <productname>NetBSD</productname>, either use the <productname>FreeBSD</productname> or <productname>Linux</productname> start scripts, depending on - preference. <indexterm><primary>NetBSD</></> + preference. <indexterm><primary>NetBSD</><secondary>start script</secondary></> </para> </listitem> @@ -285,7 +288,7 @@ fi On <productname>Solaris</productname>, create a file called <filename>/etc/init.d/postgresql</filename> that contains the following line: - <indexterm><primary>Solaris</></> + <indexterm><primary>Solaris</><secondary>start script</secondary></> <programlisting> su - postgres -c "/usr/local/pgsql/bin/pg_ctl start -l logfile -D /usr/local/pgsql/data" </programlisting> @@ -441,7 +444,7 @@ psql: could not connect to server: Connection refused <indexterm> <primary>configuration</primary> - <secondary>server</secondary> + <secondary>of the server</secondary> </indexterm> <para> @@ -462,7 +465,7 @@ psql: could not connect to server: Connection refused <para> One way to set these options is to edit the file - <filename>postgresql.conf</filename> in the data directory. (A + <filename>postgresql.conf</filename><indexterm><primary>postgresql.conf</></> in the data directory. (A default file is installed there.) An example of what this file might look like is: <programlisting> @@ -626,7 +629,7 @@ SET ENABLE_SEQSCAN TO OFF; <term><varname>TCPIP_SOCKET</varname> (<type>boolean</type>)</term> <listitem> <para> - If this is true, then the server will accept TCP/IP connections. + If this is true, then the server will accept TCP/IP connections.<indexterm><primary>TCP/IP</></> Otherwise only local Unix domain socket connections are accepted. It is off by default. This option can only be set at server start. @@ -781,7 +784,8 @@ SET ENABLE_SEQSCAN TO OFF; <variablelist> <varlistentry> <term><varname>AUTHENTICATION_TIMEOUT</varname> (<type>integer</type>)</term> - <indexterm><primary>timeout</><secondary>authentication</></indexterm> + <indexterm><primary>timeout</><secondary>client authentication</></indexterm> + <indexterm><primary>client authentication</><secondary>timeout during</></indexterm> <listitem> <para> Maximum time to complete client authentication, in seconds. If a @@ -1514,8 +1518,17 @@ SET ENABLE_SEQSCAN TO OFF; <sect2 id="runtime-config-logging"> <title>Error Reporting and Logging</title> + <indexterm zone="runtime-config-logging"> + <primary>server log</primary> + </indexterm> + <sect3 id="runtime-config-logging-syslog"> <title>Syslog</title> + + <indexterm zone="runtime-config-logging-syslog"> + <primary>syslog</primary> + </indexterm> + <variablelist> <varlistentry> @@ -2137,7 +2150,7 @@ SET ENABLE_SEQSCAN TO OFF; <varlistentry> <term><varname>AUSTRALIAN_TIMEZONES</varname> (<type>boolean</type>)</term> - <indexterm><primary>Australian time zones</></> + <indexterm><primary>time zone</><secondary>Australian</></> <listitem> <para> If set to true, <literal>ACST</literal>, @@ -2154,8 +2167,8 @@ SET ENABLE_SEQSCAN TO OFF; <primary>significant digits</primary> </indexterm> <indexterm> - <primary>display</primary> - <secondary>of float numbers</secondary> + <primary>floating-point</primary> + <secondary>display</secondary> </indexterm> <term><varname>EXTRA_FLOAT_DIGITS</varname> (<type>integer</type>)</term> @@ -2175,7 +2188,7 @@ SET ENABLE_SEQSCAN TO OFF; <varlistentry> <term><varname>CLIENT_ENCODING</varname> (<type>string</type>)</term> - <indexterm><primary>character set encoding</></> + <indexterm><primary>character set</></> <listitem> <para> Sets the client-side encoding (character set). @@ -2338,7 +2351,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' <varlistentry> <indexterm> <primary>deadlock</primary> - <secondary>timeout</secondary> + <secondary>timeout during</secondary> </indexterm> <indexterm> <primary>timeout</primary> @@ -2388,14 +2401,22 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir' <title>Version and Platform Compatibility</title> <sect3 id="runtime-config-compatible-version"> - <title>Previous Postgres Versions</title> + <title>Previous PostgreSQL Versions</title> <variablelist> <varlistentry> <term><varname>ADD_MISSING_FROM</varname> (<type>boolean</type>)</term> - <indexterm><primary>missing from</></> + <indexterm><primary>FROM</><secondary>missing</></> <listitem> <para> + When <literal>true</>, tables that are referenced by a query will be + automatically added to the <literal>FROM</> clause if not already + present. The default is <literal>true</> for compatibility with + previous releases of <productname>PostgreSQL</>. However, this + behavior is not SQL-standard, and many people dislike it because it + can mask mistakes. Set to <literal>false</> for the SQL-standard + behavior of rejecting references to tables that are not listed in + <literal>FROM</>. </para> </listitem> </varlistentry> @@ -2905,7 +2926,7 @@ $ <userinput>postmaster -o '-S 1024 -s'</userinput> <varlistentry> <term><systemitem class="osname">BSD/OS</></term> - <indexterm><primary>BSD/OS</></> + <indexterm><primary>BSD/OS</><secondary>IPC configuration</></> <listitem> <formalpara> <title>Shared Memory</> @@ -2966,9 +2987,9 @@ options "SEMMNS=240" <term><systemitem class="osname">FreeBSD</></term> <term><systemitem class="osname">NetBSD</></term> <term><systemitem class="osname">OpenBSD</></term> - <indexterm><primary>FreeBSD</></> - <indexterm><primary>NetBSD</></> - <indexterm><primary>OpenBSD</></> + <indexterm><primary>FreeBSD</><secondary>IPC configuration</></> + <indexterm><primary>NetBSD</><secondary>IPC configuration</></> + <indexterm><primary>OpenBSD</><secondary>IPC configuration</></> <listitem> <para> The options <varname>SYSVSHM</> and <varname>SYSVSEM</> need @@ -3002,7 +3023,7 @@ options SEMMAP=256 <varlistentry> <term><systemitem class="osname">HP-UX</></term> - <indexterm><primary>HP-UX</></> + <indexterm><primary>HP-UX</><secondary>IPC configuration</></> <listitem> <para> The default settings tend to suffice for normal installations. @@ -3023,7 +3044,7 @@ options SEMMAP=256 <varlistentry> <term><systemitem class="osname">Linux</></term> - <indexterm><primary>Linux</></> + <indexterm><primary>Linux</><secondary>IPC configuration</></> <listitem> <para> The default shared memory limit (both @@ -3060,14 +3081,61 @@ kernel.shmmax = 134217728 </para> <para> - Linux has poor default memory overcommit behavior. Rather than - failing if it can not reserve enough memory, it returns success, - but later fails when the memory can't be mapped and terminates - the application with <literal>kill -9</>. To prevent unpredictable - process termination, use: + Linux kernel version 2.4.* has poor default memory overcommit + behavior, which can result in the postmaster being killed by the + kernel due to memory demands by another process if the system + runs out of memory. + </para> + + <para> + The symptom of this occuring is a kernel message looking like + this (consult your system documentation and configuration on + where to look for such a message): +<programlisting> + Out of Memory: Killed process 12345 (postmaster). +</programlisting> + </para> + + <para> + To avoid this situation, run <productname>PostgreSQL</productname> + on a machine where you + can be sure that other processes will not run the machine out + of memory. If your kernel supports strict and/or paranoid modes + of overcommit handling, you can also relieve this problem by + altering the system's default behaviour. This can be determined + by examining the function <function>vm_enough_memory</> + in the file <filename>mm/mmap.c</> in the kernel source. + If this file reveals that strict and/or paranoid modes are + supported by your kernel, turn one of these modes on by using +<programlisting> +sysctl -w vm.overcommit_memory=2 +</programlisting> + for strict mode or <programlisting> sysctl -w vm.overcommit_memory=3 </programlisting> + for paranoid mode, or placing an equivalent entry in + <filename>/etc/sysctl.conf</>. + </para> + + <note> + <para> + Warning: using these settings in a kernel which does not support + these modes will almost certainly increase the danger of the + kernel killing the postmaster, rather than reducing it. + If in any doubt, consult a kernel expert or your kernel vendor. + </para> + </note> + + <para> + These modes are expected to be supported in all 2.6 and later + kernels. Some vendor 2.4 kernels may also support these modes. + However, it is known that some vendor documents suggest that + they support them while examination of the kernel source reveals + that they do not. + </para> + + <para> Note, you will need enough swap space to cover all your memory needs. </para> </listitem> @@ -3076,7 +3144,7 @@ sysctl -w vm.overcommit_memory=3 <varlistentry> <term><systemitem class="osname">MacOS X</></term> - <indexterm><primary>MacOS X</></> + <indexterm><primary>MacOS X</><secondary>IPC configuration</></> <listitem> <para> Edit the file @@ -3096,7 +3164,7 @@ sysctl -w kern.sysv.shmall <varlistentry> <term><systemitem class="osname">SCO OpenServer</></term> - <indexterm><primary>SCO OpenServer</></> + <indexterm><primary>SCO OpenServer</><secondary>IPC configuration</></> <listitem> <para> In the default configuration, only 512 kB of shared memory per @@ -3124,7 +3192,7 @@ sysctl -w kern.sysv.shmall <varlistentry> <term><systemitem class="osname">Solaris</></term> - <indexterm><primary>Solaris</></> + <indexterm><primary>Solaris</><secondary>IPC configuration</></> <listitem> <para> At least in version 2.6, the default maximum size of a shared @@ -3157,7 +3225,7 @@ set semsys:seminfo_semmsl=32 <varlistentry> <term><systemitem class="osname">UnixWare</></term> - <indexterm><primary>UnixWare</></> + <indexterm><primary>UnixWare</><secondary>IPC configuration</></> <listitem> <para> On <productname>UnixWare</> 7, the maximum size for shared @@ -3277,13 +3345,17 @@ default:\ <sect1 id="postmaster-shutdown"> <title>Shutting Down the Server</title> + <indexterm zone="postmaster-shutdown"> + <primary>shutdown</> + </indexterm> + <para> There are several ways to shut down the database server. You control the type of shutdown by sending different signals to the server process. <variablelist> <varlistentry> - <term><systemitem>SIGTERM</systemitem></term> + <term><systemitem>SIGTERM</systemitem><indexterm><primary>SIGTERM</></></term> <listitem> <para> After receiving <systemitem>SIGTERM</systemitem>, the server @@ -3296,7 +3368,7 @@ default:\ </varlistentry> <varlistentry> - <term><systemitem>SIGINT</systemitem></term> + <term><systemitem>SIGINT</systemitem><indexterm><primary>SIGINT</></></term> <listitem> <para> The server disallows new connections and sends all existing @@ -3309,7 +3381,7 @@ default:\ </varlistentry> <varlistentry> - <term><systemitem>SIGQUIT</systemitem></term> + <term><systemitem>SIGQUIT</systemitem><indexterm><primary>SIGQUIT</></></term> <listitem> <para> This is the <firstterm>Immediate Shutdown</firstterm>, which diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml index b3c65204c44..795db64a6bf 100644 --- a/doc/src/sgml/spi.sgml +++ b/doc/src/sgml/spi.sgml @@ -1,3821 +1,2462 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/spi.sgml,v 1.25 2003/01/21 22:06:11 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/spi.sgml,v 1.25.2.1 2003/09/07 04:36:44 momjian Exp $ --> -<Chapter id="spi"> -<DocInfo> -<AuthorGroup> -<Author> -<FirstName>Vadim</FirstName> -<Surname>Mikheev</Surname> -</Author> -</AuthorGroup> -<Date>Transcribed 1998-01-16</Date> -</DocInfo> - -<Title>Server Programming Interface</Title> - -<Para> -The <FirstTerm>Server Programming Interface</FirstTerm> -(<Acronym>SPI</Acronym>) gives users the -ability to run <Acronym>SQL</Acronym> queries inside user-defined -<Acronym>C</Acronym> functions. -</Para> - -<note> -<para> -The available Procedural Languages (<Acronym>PL</Acronym>) give an alternate -means to build functions that can execute queries. -</para> -</note> - -<Para> -In fact, <Acronym>SPI</Acronym> is just a set of native interface functions -to simplify access to the Parser, Planner, Optimizer and Executor. -<Acronym>SPI</Acronym> also does some memory management. -</Para> - -<Para> -To avoid misunderstanding we'll use <FirstTerm>function</FirstTerm> -to mean <Acronym>SPI</Acronym> interface functions and -<FirstTerm>procedure</FirstTerm> for user-defined C-functions -using <Acronym>SPI</Acronym>. -</Para> - -<Para> -Procedures which use <Acronym>SPI</Acronym> are called by the -Executor. The <Acronym>SPI</Acronym> calls recursively invoke the -Executor in turn to run queries. When the Executor is invoked -recursively, it may itself call procedures which may make -<Acronym>SPI</Acronym> calls. -</Para> - -<Para> -Note that if during execution of a query from a procedure the transaction is -aborted, then control will not be returned to your procedure. Rather, all work -will be rolled back and the server will wait for the next command from the -client. This will probably be changed in future versions. -</Para> - -<Para> -A related restriction is the inability to execute BEGIN, END and ABORT -(transaction control statements). This will also be -changed in the future. -</Para> - -<Para> -If successful, <Acronym>SPI</Acronym> functions return a non-negative result (either via -a returned integer value or in SPI_result global variable, as described below). -On error, a negative or NULL result will be returned. -</Para> - -<Sect1 id="spi-interface"> -<Title>Interface Functions</Title> - -<REFENTRY ID="SPI-SPICONNECT"> -<REFMETA> -<REFENTRYTITLE>SPI_connect</REFENTRYTITLE> -<REFMISCINFO>SPI - Connection Management</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_connect -</REFNAME> -<REFPURPOSE> - Connects your procedure to the SPI manager. -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPICONNECT-1"><PRIMARY>SPI</PRIMARY><SECONDARY>connecting</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPICONNECT-2"><PRIMARY>SPI_connect</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> +<chapter id="spi"> + <title>Server Programming Interface</title> + + <indexterm zone="spi"> + <primary>SPI</primary> + </indexterm> + + <para> + The <firstterm>Server Programming Interface</firstterm> + (<acronym>SPI</acronym>) gives users the ability to run + <acronym>SQL</acronym> commands inside user-defined + <acronym>C</acronym> functions. <acronym>SPI</acronym> is a set of + interface functions to simplify access to the parser, planner, + optimizer, and executor. <acronym>SPI</acronym> also does some + memory management. + </para> + + <para> + To avoid misunderstanding we'll use the term <quote>function</quote> + when we speak of <acronym>SPI</acronym> interface functions and + <quote>procedure</quote> for user-defined C-functions, which may be + using <acronym>SPI</acronym>. + </para> + + <para> + Note that if during the execution of a procedure the transaction is + aborted because of an error in a command, then control will not be + returned to your procedure. Rather, all work will be rolled back + and the server will wait for the next command from the client. A + related restriction is the inability to execute + <command>BEGIN</command>, <command>COMMIT</command>, and + <command>ROLLBACK</command> (transaction control statements) inside + a procedure. Both of these restrictions will probably be changed in + the future. + </para> + + <para> + <acronym>SPI</acronym> functions return a nonnegative result on + success (either via a returned integer value or in the global + variable <varname>SPI_result</varname>, as described below). On + error, a negative result or <symbol>NULL</symbol> will be returned. + </para> + + <para> + Source code files that use SPI must include the header file + <filename>executor/spi.h</filename>. + </para> + + <note> + <para> + The available procedural languages provide different means to + execute SQL commands from procedures. Some of these are modelled + after SPI, so this documentation might be of use for those users as + well. + </para> + </note> + + +<sect1 id="spi-interface"> + <title>Interface Functions</title> + + <refentry id="spi-spi-connect"> + <refmeta> + <refentrytitle>SPI_connect</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_connect</refname> + <refpurpose>connect a procedure to the SPI manager</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_connect</primary></indexterm> + + <refsynopsisdiv> +<synopsis> int SPI_connect(void) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPICONNECT-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<PARA>None -</PARA> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPICONNECT-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>int -</TERM> -<LISTITEM> -<PARA> -Return status -<VARIABLELIST> -<VARLISTENTRY> -<TERM><ReturnValue>SPI_OK_CONNECT</ReturnValue> -</TERM> -<LISTITEM> -<PARA> - if connected -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM><ReturnValue>SPI_ERROR_CONNECT</ReturnValue> -</TERM> -<LISTITEM> -<PARA> - if not connected -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPICONNECT-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_connect</FUNCTION> opens a connection from a procedure -invocation to the SPI manager. - You must call this function if you will need to execute queries. Some - utility SPI functions may be called from un-connected procedures. -</PARA> -<PARA> - If your procedure is already connected, - <Function>SPI_connect</Function> will return an - <ReturnValue>SPI_ERROR_CONNECT</ReturnValue> error. Note that this - may happen if a procedure which has called - <Function>SPI_connect</Function> directly calls another procedure - which itself calls <Function>SPI_connect</Function>. While - recursive calls to the <Acronym>SPI</Acronym> manager are permitted - when an <Acronym>SPI</Acronym> query invokes another function which - uses <Acronym>SPI</Acronym>, directly nested calls to - <Function>SPI_connect</Function> and - <Function>SPI_finish</Function> are forbidden. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPICONNECT-2"> -<TITLE>Usage -</TITLE> -<PARA> -<!-- -XXX thomas 1997-12-24 ---> -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPICONNECT-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_connect</FUNCTION> performs the following: - Initializes the SPI internal - structures for query execution and memory management. -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPICONNECT-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIFINISH"> -<REFMETA> -<REFENTRYTITLE>SPI_finish</REFENTRYTITLE> -<REFMISCINFO>SPI - Connection Management</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_finish -</REFNAME> -<REFPURPOSE> - Disconnects your procedure from the SPI manager. -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIFINISH-1"><PRIMARY>SPI</PRIMARY><SECONDARY>disconnecting</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIFINISH-2"><PRIMARY>SPI_finish</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_finish(void) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIFINISH-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<PARA>None -</PARA> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIFINISH-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>int -</TERM> -<LISTITEM> -<PARA> -<SimpleList> -<Member> -<ReturnValue>SPI_OK_FINISH</ReturnValue> - if properly disconnected -</Member> -<Member> -<ReturnValue>SPI_ERROR_UNCONNECTED</ReturnValue> - if called from an un-connected procedure -</Member> -</SimpleList> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIFINISH-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_finish</FUNCTION> closes an existing connection to the -SPI manager. - You must call this function after completing the SPI operations needed - during your procedure's current invocation. -</para> -<PARA> - You may get the error return <ReturnValue>SPI_ERROR_UNCONNECTED</ReturnValue> if <Function>SPI_finish</Function> is - called without having a current valid connection. - There is no fundamental problem - with this; it means that nothing was done by the SPI manager. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIFINISH-2"> -<TITLE>Usage -</TITLE> -<PARA> - <Function>SPI_finish</Function> <Emphasis>must</Emphasis> be called as a final step by a connected procedure, - or you may get - unpredictable results! However, you do not need to worry about making -this happen if the transaction is aborted via elog(ERROR). In that case -SPI will clean itself up. - -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIFINISH-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_finish</FUNCTION> performs the following: - Disconnects your procedure from the SPI manager and frees all memory - allocations made by your procedure via <Function>palloc</Function> since - the <Function>SPI_connect</Function>. - These allocations can't be used any more! See Memory management. -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIFINISH-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIEXEC"> -<REFMETA> -<REFENTRYTITLE>SPI_exec</REFENTRYTITLE> -<REFMISCINFO>SPI - Connection Management</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_exec -</REFNAME> -<REFPURPOSE> - Creates an execution plan (parser+planner+optimizer) and executes a query. -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIEXEC-1"><PRIMARY>SPI</PRIMARY><SECONDARY>executing</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIEXEC-2"><PRIMARY>SPI_exec</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_exec(<REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIEXEC-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -const char * <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -String containing query plan -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Maximum number of tuples to return -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIEXEC-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>int -</TERM> -<LISTITEM> -<PARA> -<SimpleList> -<Member> - <ReturnValue>SPI_ERROR_UNCONNECTED</ReturnValue> if called from an un-connected procedure -</Member> -<Member> - <ReturnValue>SPI_ERROR_ARGUMENT</ReturnValue> if query is NULL or <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE> < 0. -</Member> -<Member> - <ReturnValue>SPI_ERROR_UNCONNECTED</ReturnValue> if procedure is unconnected. -</Member> -<Member> - <ReturnValue>SPI_ERROR_COPY</ReturnValue> if COPY TO/FROM stdin. -</Member> -<Member> - <ReturnValue>SPI_ERROR_CURSOR</ReturnValue> if DECLARE/CLOSE CURSOR, FETCH. -</Member> -<Member> - <ReturnValue>SPI_ERROR_TRANSACTION</ReturnValue> if BEGIN/ABORT/END. -</Member> -<Member> - <ReturnValue>SPI_ERROR_OPUNKNOWN</ReturnValue> if type of query is unknown (this shouldn't occur). -</Member> -</SimpleList> -</para> -<Para> - If execution of your query was successful then one of the following - (non-negative) values will be returned: -<SimpleList> -<Member> - <ReturnValue>SPI_OK_UTILITY</ReturnValue> if some utility (e.g. CREATE TABLE ...) was executed -</Member> -<Member> - <ReturnValue>SPI_OK_SELECT</ReturnValue> if SELECT (but not SELECT ... INTO!) was executed -</Member> -<Member> - <ReturnValue>SPI_OK_SELINTO</ReturnValue> if SELECT ... INTO was executed -</Member> -<Member> - <ReturnValue>SPI_OK_INSERT</ReturnValue> if INSERT (or INSERT ... SELECT) was executed -</Member> -<Member> - <ReturnValue>SPI_OK_DELETE</ReturnValue> if DELETE was executed -</Member> -<Member> - <ReturnValue>SPI_OK_UPDATE</ReturnValue> if UPDATE was executed -</Member> -</SimpleList> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIEXEC-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_exec</FUNCTION> creates an execution plan (parser+planner+optimizer) - and executes the query for <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE> tuples. - -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIEXEC-2"> -<TITLE>Usage -</TITLE> -<PARA> - This should only be called from a connected procedure. - If <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE> is zero then it executes the query for all tuples returned by the - query scan. Using <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE> > 0 you may restrict the number of tuples for - which the query will be executed (much like a LIMIT clause). For example, - -<ProgramListing> -SPI_exec ("INSERT INTO tab SELECT * FROM tab", 5); -</ProgramListing> - -will allow at most 5 tuples to be inserted into table. - - If execution of your query was successful then a non-negative value will be returned. - -<Note> -<Para> -You may pass multiple queries in one string or query string may be - re-written by RULEs. <Function>SPI_exec</Function> returns the result for the last query - executed. -</Para> -</Note> -</para> -<Para> - The actual number of tuples for which the (last) query was executed is - returned in the global variable SPI_processed (if not <ReturnValue>SPI_OK_UTILITY</ReturnValue>). - - If <ReturnValue>SPI_OK_SELECT</ReturnValue> is returned then you may use global - pointer SPITupleTable *SPI_tuptable to access the result tuples. -</Para> - -<Para> - <Function>SPI_exec</Function> may return one of the following (negative) values: -<SimpleList> -<Member> - <ReturnValue>SPI_ERROR_ARGUMENT</ReturnValue> if query is NULL or <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE> < 0. -</Member> -<Member> - <ReturnValue>SPI_ERROR_UNCONNECTED</ReturnValue> if procedure is unconnected. -</Member> -<Member> - <ReturnValue>SPI_ERROR_COPY</ReturnValue> if COPY TO/FROM stdin. -</Member> -<Member> - <ReturnValue>SPI_ERROR_CURSOR</ReturnValue> if DECLARE/CLOSE CURSOR, FETCH. -</Member> -<Member> - <ReturnValue>SPI_ERROR_TRANSACTION</ReturnValue> if BEGIN/ABORT/END. -</Member> -<Member> - <ReturnValue>SPI_ERROR_OPUNKNOWN</ReturnValue> if type of query is unknown (this shouldn't occur). -</Member> -</SimpleList> - -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIEXEC-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -</PARA> -</REFSECT1> ---> -<REFSECT1 ID="R1-SPI-SPIEXEC-4"> -<TITLE>Structures -</TITLE> -<Para> - If <ReturnValue>SPI_OK_SELECT</ReturnValue> is returned then you may use the global - pointer SPITupleTable *SPI_tuptable to access the selected tuples. -</Para> - -<Para> - Structure SPITupleTable is defined in spi.h: -<ProgramListing> - typedef struct - { - MemoryContext tuptabcxt; /* memory context of result table */ - uint32 alloced; /* # of alloced vals */ - uint32 free; /* # of free vals */ - TupleDesc tupdesc; /* tuple descriptor */ - HeapTuple *vals; /* tuples */ - } SPITupleTable; -</ProgramListing> -</Para> - -<Para> - <structfield>vals</> is an array of pointers to tuples (the number of useful entries - is given by SPI_processed). <structfield>tupdesc</> is - a tuple descriptor which you may pass to SPI functions dealing with - tuples. <structfield>tuptabcxt</>, <structfield>alloced</>, and <structfield>free</> are internal fields not intended - for use by SPI callers. -</Para> - -<note> -<Para> - Functions <Function>SPI_exec</Function>, <Function>SPI_execp</Function> and - <Function>SPI_prepare</Function> change both SPI_processed and SPI_tuptable - (just the pointer, not the contents of the structure). - Save these two global variables into local procedure variables if you need - to access the result of one <Function>SPI_exec</Function> or - <Function>SPI_execp</Function> across later calls. -</Para> -</note> - -<Para> - <Function>SPI_finish</Function> frees all SPITupleTables allocated during - the current procedure. You can free a particular result table earlier, - if you are done with it, by calling <Function>SPI_freetuptable</Function>. -</Para> -</REFSECT1> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIPREPARE"> -<REFMETA> -<REFENTRYTITLE>SPI_prepare</REFENTRYTITLE> -<REFMISCINFO>SPI - Plan Preparation</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_prepare -</REFNAME> -<REFPURPOSE> - Prepares a plan for a query, without executing it yet -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIPREPARE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>connecting</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIPREPARE-2"><PRIMARY>SPI_prepare</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_prepare(<REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">nargs</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">argtypes</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIPREPARE-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -const char * <REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Query string -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">nargs</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Number of input parameters ($1 ... $nargs - as in SQL-functions) -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -Oid * <REPLACEABLE CLASS="PARAMETER">argtypes</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Pointer to array of type <Acronym>OID</Acronym>s for input parameter types -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIPREPARE-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>void * -</TERM> -<LISTITEM> -<PARA> -Pointer to an execution plan (parser+planner+optimizer) -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIPREPARE-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_prepare</FUNCTION> - creates and returns an execution plan (parser+planner+optimizer) but doesn't - execute the query. Should only be called from a connected procedure. - -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIPREPARE-2"> -<TITLE>Usage -</TITLE> -<Para> - When the same or similar query is to be executed repeatedly, it may - be advantageous to perform query planning only once. - <FUNCTION>SPI_prepare</FUNCTION> converts a query string into an execution - plan that can be passed repeatedly to <FUNCTION>SPI_execp</FUNCTION>. -</para> -<PARA> - A prepared query can be generalized by writing parameters ($1, $2, etc) - in place of what would be constants in a normal query. The values of - the parameters are then specified when <FUNCTION>SPI_execp</FUNCTION> - is called. This allows the prepared query to be used over a wider - range of situations than would be possible without parameters. -</para> -<note> -<PARA> - However, there is a disadvantage: since the planner does not know the - values that will be supplied for the parameters, it may make worse - query planning choices than it would make for a simple query with - all constants visible. -</para> -</note> -<PARA> - If the query uses parameters, their number and data types must be - specified in the call to <FUNCTION>SPI_prepare</FUNCTION>. -</para> -<Para> -The plan returned by <Function>SPI_prepare</Function> may be used only in current - invocation of the procedure since <Function>SPI_finish</Function> frees memory allocated for a plan. - But see <Function>SPI_saveplan</Function> to save a plan for longer. -</para> -<Para> - If successful, a non-null pointer will be returned. Otherwise, you'll get - a NULL plan. In both cases SPI_result will be set like the value returned - by SPI_exec, except that it is set to - <ReturnValue>SPI_ERROR_ARGUMENT</ReturnValue> if query is NULL or nargs < 0 or nargs > 0 && argtypes - is NULL. - -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIPREPARE-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_prepare</FUNCTION> performs the following: -TBD -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPIPREPARE-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> +</synopsis> + </refsynopsisdiv> -<REFENTRY ID="SPI-SPIEXECP"> -<REFMETA> -<REFENTRYTITLE>SPI_execp</REFENTRYTITLE> -<REFMISCINFO>SPI - Plan Execution</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_execp -</REFNAME> -<REFPURPOSE> -Executes a plan from <Function>SPI_prepare</Function> -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIEXECP-1"><PRIMARY>SPI</PRIMARY><SECONDARY>connecting</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIEXECP-2"><PRIMARY>SPI_execp</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_execp(<REPLACEABLE CLASS="PARAMETER">plan</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">values</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">nulls</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIEXECP-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -void *<REPLACEABLE CLASS="PARAMETER">plan</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Execution plan -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -Datum *<REPLACEABLE CLASS="PARAMETER">values</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Actual parameter values -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -const char *<REPLACEABLE CLASS="PARAMETER">nulls</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Array describing which parameters are NULLs -<SimpleList> -<Member><literal>n</literal> indicates NULL (values[] entry ignored)</Member> -<Member>space indicates not NULL (values[] entry is valid)</Member> -</SimpleList> -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Number of tuples for which plan is to be executed -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIEXECP-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>int -</TERM> -<LISTITEM> -<PARA> - Returns the same value as <Function>SPI_exec</Function> as well as -<SimpleList> -<Member> - <ReturnValue>SPI_ERROR_ARGUMENT</ReturnValue> - if <REPLACEABLE CLASS="PARAMETER">plan</REPLACEABLE> - is NULL or <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE> < 0 -</Member> -<Member> - <ReturnValue>SPI_ERROR_PARAM</ReturnValue> - if <REPLACEABLE CLASS="PARAMETER">values</REPLACEABLE> - is NULL - and <REPLACEABLE CLASS="PARAMETER">plan</REPLACEABLE> - was prepared with some parameters. -</Member> -</SimpleList> -</para> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM>SPI_tuptable -</TERM> -<LISTITEM> -<PARA> -initialized as in - <Function>SPI_exec</Function> if successful -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM>SPI_processed -</TERM> -<LISTITEM> -<PARA> -initialized as in - <Function>SPI_exec</Function> if successful -</para> -</listitem> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIEXECP-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_execp</FUNCTION> - executes a plan prepared by <Function>SPI_prepare</Function>. - <REPLACEABLE CLASS="PARAMETER">tcount</REPLACEABLE> has the same - interpretation as in <Function>SPI_exec</Function>. -</para> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIEXECP-2"> -<TITLE>Usage -</TITLE> -<Para> - If <REPLACEABLE CLASS="PARAMETER">nulls</REPLACEABLE> -is NULL then - <Function>SPI_execp</Function> -assumes that all parameters (if any) are NOT NULL. - -<Note> -<Para> - If one of the objects (a relation, function, etc.) referenced by the prepared - plan is dropped during your session (by your backend or another process) then the - results of <Function>SPI_execp</Function> for this plan will be unpredictable. -</Para> -</Note> - -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIEXECP-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_execp</FUNCTION> performs the following: -TBD -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPIEXECP-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> + <refsect1> + <title>Description</title> -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> + <para> + <function>SPI_connect</function> opens a connection from a + procedure invocation to the SPI manager. You must call this + function if you want to execute commands through SPI. Some utility + SPI functions may be called from unconnected procedures. + </para> -<REFENTRY ID="SPI-SPICURSOR-OPEN"> -<REFMETA> -<REFENTRYTITLE>SPI_cursor_open</REFENTRYTITLE> -<REFMISCINFO>SPI - Cursor Support</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_cursor_open -</REFNAME> -<REFPURPOSE> -Sets up a cursor using a plan created with <Function>SPI_prepare</Function> -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPICURSOR-OPEN-1"><PRIMARY>SPI</PRIMARY><SECONDARY>cursors</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPICURSOR-OPEN-2"><PRIMARY>SPI_cursor_open</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>2001-11-14</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_cursor_open(<REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">plan</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">values</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">nulls</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPICURSOR-OPEN-1"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -const char *<REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Name for portal, or NULL to let the system select a name -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -void *<REPLACEABLE CLASS="PARAMETER">plan</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Execution plan -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -Datum *<REPLACEABLE CLASS="PARAMETER">values</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Actual parameter values -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -const char *<REPLACEABLE CLASS="PARAMETER">nulls</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Array describing which parameters are NULLs -<SimpleList> -<Member><literal>n</literal> indicates NULL (values[] entry ignored)</Member> -<Member>space indicates not NULL (values[] entry is valid)</Member> -</SimpleList> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPICURSOR-OPEN-2"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>Portal -</TERM> -<LISTITEM> -<PARA> - Pointer to Portal containing cursor, or NULL on error -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPICURSOR-OPEN-1"> -<REFSECT1INFO> -<DATE>2001-11-14</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_cursor_open</FUNCTION> - sets up a cursor (internally, a Portal) that will execute a plan - prepared by <Function>SPI_prepare</Function>. -</para> -<para> + <para> + If your procedure is already connected, + <function>SPI_connect</function> will return the error code + <returnvalue>SPI_ERROR_CONNECT</returnvalue>. This could happen if + a procedure that has called <function>SPI_connect</function> + directly calls another procedure that calls + <function>SPI_connect</function>. While recursive calls to the + <acronym>SPI</acronym> manager are permitted when an SQL command + called through SPI invokes another function that uses + <acronym>SPI</acronym>, directly nested calls to + <function>SPI_connect</function> and + <function>SPI_finish</function> are forbidden. + </para> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <variablelist> + <varlistentry> + <term><symbol>SPI_OK_CONNECT</symbol></term> + <listitem> + <para> + on success + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_CONNECT</symbol></term> + <listitem> + <para> + on error + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-finish"> + <refmeta> + <refentrytitle>SPI_finish</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_finish</refname> + <refpurpose>disconnect a procedure from the SPI manager</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_finish</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +int SPI_finish(void) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_finish</function> closes an existing connection to + the SPI manager. You must call this function after completing the + SPI operations needed during your procedure's current invocation. + You do not need to worry about making this happen, however, if you + abort the transaction via <literal>elog(ERROR)</literal>. In that + case SPI will clean itself up automatically. + </para> + + <para> + If <function>SPI_finish</function> is called without having a valid + connection, it will return <symbol>SPI_ERROR_UNCONNECTED</symbol>. + There is no fundamental problem with this; it means that the SPI + manager has nothing to do. + </para> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <variablelist> + <varlistentry> + <term><symbol>SPI_OK_FINISH</symbol></term> + <listitem> + <para> + if properly disconnected + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_UNCONNECTED</symbol></term> + <listitem> + <para> + if called from an unconnected procedure + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-exec"> + <refmeta> + <refentrytitle>SPI_exec</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_exec</refname> + <refpurpose>execute a command</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_exec</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +int SPI_exec(const char * <parameter>command</parameter>, int <parameter>count</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_exec</function> executes the specified SQL command + for <parameter>count</parameter> rows. + </para> + + <para> + This function should only be called from a connected procedure. If + <parameter>count</parameter> is zero then it executes the command + for all rows that it applies to. If <parameter>count</parameter> + is greater than 0, then the number of rows for which the command + will be executed is restricted (much like a + <literal>LIMIT</literal> clause). For example, +<programlisting> +SPI_exec("INSERT INTO tab SELECT * FROM tab", 5); +</programlisting> + will allow at most 5 rows to be inserted into the table. + </para> + + <para> + You may pass multiple commands in one string, and the command may + be rewritten by rules. <function>SPI_exec</function> returns the + result for the command executed last. + </para> + + <para> + The actual number of rows for which the (last) command was executed + is returned in the global variable <varname>SPI_processed</varname> + (unless the return value of the function is + <symbol>SPI_OK_UTILITY</symbol>). If the return value of the + function is <symbol>SPI_OK_SELECT</symbol> then you may the use + global pointer <literal>SPITupleTable *SPI_tuptable</literal> to + access the result rows. + </para> + + <para> + The structure <structname>SPITupleTable</structname> is defined + thus: +<programlisting> +typedef struct +{ + MemoryContext tuptabcxt; /* memory context of result table */ + uint32 alloced; /* number of alloced vals */ + uint32 free; /* number of free vals */ + TupleDesc tupdesc; /* row descriptor */ + HeapTuple *vals; /* rows */ +} SPITupleTable; +</programlisting> + <structfield>vals</> is an array of pointers to rows. (The number + of valid entries is given by <varname>SPI_processed</varname>). + <structfield>tupdesc</> is a row descriptor which you may pass to + SPI functions dealing with rows. <structfield>tuptabcxt</>, + <structfield>alloced</>, and <structfield>free</> are internal + fields not intended for use by SPI callers. + </para> + + <para> + <function>SPI_finish</function> frees all + <structname>SPITupleTable</>s allocated during the current + procedure. You can free a particular result table earlier, if you + are done with it, by calling <function>SPI_freetuptable</function>. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>const char * <parameter>command</parameter></literal></term> + <listitem> + <para> + string containing command to execute + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>count</parameter></literal></term> + <listitem> + <para> + maximum number of rows to process or return + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + If the execution of the command was successful then one of the + following (nonnegative) values will be returned: + + <variablelist> + <varlistentry> + <term><symbol>SPI_OK_SELECT</symbol></term> + <listitem> + <para> + if a <command>SELECT</command> (but not <command>SELECT + ... INTO</>) was executed + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_OK_SELINTO</symbol></term> + <listitem> + <para> + if a <command>SELECT ... INTO</command> was executed + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_OK_DELETE</symbol></term> + <listitem> + <para> + if a <command>DELETE</command> was executed + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_OK_INSERT</symbol></term> + <listitem> + <para> + if an <command>INSERT</command> was executed + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_OK_UPDATE</symbol></term> + <listitem> + <para> + if an <command>UPDATE</command> was executed + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_OK_UTILITY</symbol></term> + <listitem> + <para> + if a utility command (e.g., <command>CREATE TABLE</command>) + was executed + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + <para> + On error, one of the following negative values is returned: + + <variablelist> + <varlistentry> + <term><symbol>SPI_ERROR_ARGUMENT</symbol></term> + <listitem> + <para> + if <parameter>command</parameter> is <symbol>NULL</symbol> or + <parameter>count</parameter> is less than 0 + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_COPY</symbol></term> + <listitem> + <para> + if <command>COPY TO stdout</> or <command>COPY FROM stdin</> + was attempted + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_CURSOR</symbol></term> + <listitem> + <para> + if <command>DECLARE</>, <command>CLOSE</>, or <command>FETCH</> + was attempted + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_TRANSACTION</symbol></term> + <listitem> + <para> + if <command>BEGIN</>, <command>COMMIT</>, or + <command>ROLLBACK</> was attempted + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_OPUNKNOWN</symbol></term> + <listitem> + <para> + if the command type is unknown (shouldn't happen) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_UNCONNECTED</symbol></term> + <listitem> + <para> + if called from an unconnected procedure + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title>Notes</title> + + <para> + The functions <function>SPI_exec</function>, + <function>SPI_execp</function>, and + <function>SPI_prepare</function> change both + <varname>SPI_processed</varname> and + <varname>SPI_tuptable</varname> (just the pointer, not the contents + of the structure). Save these two global variables into local + procedure variables if you need to access the result of + <function>SPI_exec</function> or <function>SPI_execp</function> + across later calls. + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-prepare"> + <refmeta> + <refentrytitle>SPI_prepare</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_prepare</refname> + <refpurpose>prepare a plan for a command, without executing it yet</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_prepare</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void * SPI_prepare(const char * <parameter>command</parameter>, int <parameter>nargs</parameter>, Oid * <parameter>argtypes</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_prepare</function> creates and returns an execution + plan for the specified command but doesn't execute the command. + This function should only be called from a connected procedure. + </para> + + <para> + When the same or a similar command is to be executed repeatedly, it + may be advantageous to perform the planning only once. + <function>SPI_prepare</function> converts a command string into an + execution plan that can be executed repeatedly using + <function>SPI_execp</function>. + </para> + + <para> + A prepared command can be generalized by writing parameters + (<literal>$1</>, <literal>$2</>, etc.) in place of what would be + constants in a normal command. The actual values of the parameters + are then specified when <function>SPI_execp</function> is called. + This allows the prepared command to be used over a wider range of + situations than would be possible without parameters. + </para> + + <para> + The plan returned by <function>SPI_prepare</function> can be used + only in the current invocation of the procedure since + <function>SPI_finish</function> frees memory allocated for a plan. + But a plan can be saved for longer using the function + <function>SPI_saveplan</function>. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>const char * <parameter>command</parameter></literal></term> + <listitem> + <para> + command string + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>nargs</parameter></literal></term> + <listitem> + <para> + number of input parameters (<literal>$1</>, <literal>$2</>, etc.) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>Oid * <parameter>argtypes</parameter></literal></term> + <listitem> + <para> + pointer to an array containing the <acronym>OID</acronym>s of + the data types of the parameters + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + <function>SPI_prepare</function> returns non-null pointer to an + execution plan. On error, <symbol>NULL</symbol> will be returned. + In both cases, <varname>SPI_result</varname> will be set analogous + to the value returned by <function>SPI_exec</function>, except that + it is set to <symbol>SPI_ERROR_ARGUMENT</symbol> if + <parameter>command</parameter> is <symbol>NULL</symbol>, or if + <parameter>nargs</> is less than 0, or if <parameter>nargs</> is + greater than 0 and <parameter>argtypes</> is <symbol>NULL</symbol>. + </para> + </refsect1> + + <refsect1> + <title>Notes</title> + + <para> + There is a disadvantage to using parameters: since the planner does + not know the values that will be supplied for the parameters, it + may make worse planning choices than it would make for a normal + command with all constants visible. + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-execp"> + <refmeta> + <refentrytitle>SPI_execp</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_execp</refname> + <refpurpose>executes a plan prepared by <function>SPI_prepare</function></refpurpose> + </refnamediv> + + <indexterm><primary>SPI_execp</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +int SPI_execp(void * <parameter>plan</parameter>, Datum * <parameter>values</parameter>, const char * <parameter>nulls</parameter>, int <parameter>count</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_execp</function> executes a plan prepared by + <function>SPI_prepare</function>. <parameter>tcount</parameter> + has the same interpretation as in <function>SPI_exec</function>. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>void * <parameter>plan</parameter></literal></term> + <listitem> + <para> + execution plan (returned by <function>SPI_prepare</function>) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>Datum *<parameter>values</parameter></literal></term> + <listitem> + <para> + actual parameter values + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>const char * <parameter>nulls</parameter></literal></term> + <listitem> + <para> + An array describing which parameters are null. + <literal>n</literal> indicates a null value (entry in + <parameter>values</> will be ignored); a space indicates a + nonnull value (entry in <parameter>values</> is valid). + </para> + + <para> + If <parameter>nulls</parameter> is <symbol>NULL</symbol> then + <function>SPI_execp</function> assumes that no parameters are + null. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>count</parameter></literal></term> + <listitem> + <para> + number of row for which plan is to be executed + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + The return value is the same as for <function>SPI_exec</function> + or one of the following: + + <variablelist> + <varlistentry> + <term><symbol>SPI_ERROR_ARGUMENT</symbol></term> + <listitem> + <para> + if <parameter>plan</parameter> is <symbol>NULL</symbol> or + <parameter>count</parameter> is less than 0 + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_PARAM</symbol></term> + <listitem> + <para> + if <parameter>values</parameter> is <symbol>NULL</symbol> and + <parameter>plan</parameter> was prepared with some parameters + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + <para> + <varname>SPI_processed</varname> and + <varname>SPI_tuptable</varname> are set as in + <function>SPI_exec</function> if successful. + </para> + </refsect1> + + <refsect1> + <title>Notes</title> + + <para> + If one of the objects (a table, function, etc.) referenced by the + prepared plan is dropped during the session then the result of + <function>SPI_execp</function> for this plan will be unpredictable. + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-cursor-open"> + <refmeta> + <refentrytitle>SPI_cursor_open</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_cursor_open</refname> + <refpurpose>set up a cursor using a plan created with <function>SPI_prepare</function></refpurpose> + </refnamediv> + + <indexterm><primary>SPI_cursor_open</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +Portal SPI_cursor_open(const char * <parameter>name</parameter>, void * <parameter>plan</parameter>, Datum * <parameter>values</parameter>, const char * <parameter>nulls</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_cursor_open</function> sets up a cursor (internally, + a portal) that will execute a plan prepared by + <function>SPI_prepare</function>. + </para> + + <para> Using a cursor instead of executing the plan directly has two benefits. First, the result rows can be retrieved a few at a time, avoiding memory overrun for queries that return many rows. Second, - a Portal can outlive the current procedure (it can, in fact, live to - the end of the current transaction). Returning the portal name to - the procedure's caller provides a way of returning a rowset result. -</para> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPICURSOR-OPEN-2"> -<TITLE>Usage -</TITLE> -<Para> - If <REPLACEABLE CLASS="PARAMETER">nulls</REPLACEABLE> -is NULL then - <Function>SPI_cursor_open</Function> -assumes that all parameters (if any) are NOT NULL. -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPICURSOR-OPEN-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_cursor_open</FUNCTION> performs the following: -TBD -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPICURSOR-FIND"> -<REFMETA> -<REFENTRYTITLE>SPI_cursor_find</REFENTRYTITLE> -<REFMISCINFO>SPI - Cursor Support</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_cursor_find -</REFNAME> -<REFPURPOSE> -Finds an existing cursor (Portal) by name -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPICURSOR-FIND-1"><PRIMARY>SPI</PRIMARY><SECONDARY>cursors</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPICURSOR-FIND-2"><PRIMARY>SPI_cursor_find</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>2001-11-14</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_cursor_find(<REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPICURSOR-FIND-1"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -const char *<REPLACEABLE CLASS="PARAMETER">name</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Name of portal -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPICURSOR-FIND-2"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>Portal -</TERM> -<LISTITEM> -<PARA> - Pointer to Portal with given name, or NULL if not found -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPICURSOR-FIND-1"> -<REFSECT1INFO> -<DATE>2001-11-14</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_cursor_find</FUNCTION> - finds a pre-existing Portal by name. This is primarily useful - to resolve a cursor name returned as text by some other function. -</para> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPICURSOR-FIND-2"> -<TITLE>Usage -</TITLE> -<Para> -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPICURSOR-FIND-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_cursor_find</FUNCTION> performs the following: -TBD -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPICURSOR-FETCH"> -<REFMETA> -<REFENTRYTITLE>SPI_cursor_fetch</REFENTRYTITLE> -<REFMISCINFO>SPI - Cursor Support</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_cursor_fetch -</REFNAME> -<REFPURPOSE> -Fetches some rows from a cursor -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPICURSOR-FETCH-1"><PRIMARY>SPI</PRIMARY><SECONDARY>cursors</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPICURSOR-FETCH-2"><PRIMARY>SPI_cursor_fetch</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>2001-11-14</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_cursor_fetch(<REPLACEABLE CLASS="PARAMETER">portal</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">forward</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">count</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPICURSOR-FETCH-1"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -Portal <REPLACEABLE CLASS="PARAMETER">portal</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Portal containing cursor -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -bool <REPLACEABLE CLASS="PARAMETER">forward</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -True for fetch forward, false for fetch backward -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">count</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Maximum number of rows to fetch -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPICURSOR-FETCH-2"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>SPI_tuptable -</TERM> -<LISTITEM> -<PARA> -initialized as in - <Function>SPI_exec</Function> if successful -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM>SPI_processed -</TERM> -<LISTITEM> -<PARA> -initialized as in - <Function>SPI_exec</Function> if successful -</para> -</listitem> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPICURSOR-FETCH-1"> -<REFSECT1INFO> -<DATE>2001-11-14</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_cursor_fetch</FUNCTION> - fetches some (more) rows from a cursor. This is equivalent to the - SQL command <command>FETCH</>. -</para> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPICURSOR-FETCH-2"> -<TITLE>Usage -</TITLE> -<Para> -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPICURSOR-FETCH-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_cursor_fetch</FUNCTION> performs the following: -TBD -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPICURSOR-MOVE"> -<REFMETA> -<REFENTRYTITLE>SPI_cursor_move</REFENTRYTITLE> -<REFMISCINFO>SPI - Cursor Support</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_cursor_move -</REFNAME> -<REFPURPOSE> -Moves a cursor -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPICURSOR-MOVE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>cursors</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPICURSOR-MOVE-2"><PRIMARY>SPI_cursor_move</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>2001-11-14</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_cursor_move(<REPLACEABLE CLASS="PARAMETER">portal</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">forward</REPLACEABLE>, -<REPLACEABLE CLASS="PARAMETER">count</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPICURSOR-MOVE-1"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -Portal <REPLACEABLE CLASS="PARAMETER">portal</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Portal containing cursor -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -bool <REPLACEABLE CLASS="PARAMETER">forward</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -True for move forward, false for move backward -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">count</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Maximum number of rows to move -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPICURSOR-MOVE-2"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>None -</TERM> -<LISTITEM> -<PARA> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPICURSOR-MOVE-1"> -<REFSECT1INFO> -<DATE>2001-11-14</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_cursor_move</FUNCTION> - skips over some number of rows in a cursor. This is equivalent to the - SQL command <command>MOVE</>. -</para> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPICURSOR-MOVE-2"> -<TITLE>Usage -</TITLE> -<Para> -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPICURSOR-MOVE-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_cursor_move</FUNCTION> performs the following: -TBD -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPICURSOR-CLOSE"> -<REFMETA> -<REFENTRYTITLE>SPI_cursor_close</REFENTRYTITLE> -<REFMISCINFO>SPI - Cursor Support</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_cursor_close -</REFNAME> -<REFPURPOSE> -Closes a cursor -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPICURSOR-CLOSE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>cursors</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPICURSOR-CLOSE-2"><PRIMARY>SPI_cursor_close</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>2001-11-14</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_cursor_close(<REPLACEABLE CLASS="PARAMETER">portal</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPICURSOR-CLOSE-1"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -Portal <REPLACEABLE CLASS="PARAMETER">portal</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Portal containing cursor -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPICURSOR-CLOSE-2"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>None -</TERM> -<LISTITEM> -<PARA> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPICURSOR-CLOSE-1"> -<REFSECT1INFO> -<DATE>2001-11-14</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_cursor_close</FUNCTION> - closes a previously created cursor and releases its Portal storage. -</para> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPICURSOR-CLOSE-2"> -<TITLE>Usage -</TITLE> -<Para> - All open cursors are closed implicitly at transaction end. - <FUNCTION>SPI_cursor_close</FUNCTION> need only be invoked if - it is desirable to release resources sooner. -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPICURSOR-CLOSE-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_cursor_close</FUNCTION> performs the following: -TBD -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPISAVEPLAN"> -<REFMETA> -<REFENTRYTITLE>SPI_saveplan</REFENTRYTITLE> -<REFMISCINFO>SPI - Plan Storage</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_saveplan -</REFNAME> -<REFPURPOSE> - Saves a passed plan -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPISAVEPLAN-1"><PRIMARY>SPI</PRIMARY><SECONDARY>connecting</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPISAVEPLAN-2"><PRIMARY>SPI_saveplan</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_saveplan(<REPLACEABLE CLASS="PARAMETER">plan</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPISAVEPLAN-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -void *<REPLACEABLE CLASS="PARAMETER">query</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Passed plan -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPISAVEPLAN-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>void * -</TERM> -<LISTITEM> -<PARA> -Execution plan location. NULL if unsuccessful. -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM>SPI_result -</TERM> -<LISTITEM> -<PARA> -<SimpleList> -<Member> - <ReturnValue>SPI_ERROR_ARGUMENT</ReturnValue> if plan is NULL -</Member> -<Member> - <ReturnValue>SPI_ERROR_UNCONNECTED</ReturnValue> if procedure is un-connected -</Member> -</SimpleList> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPISAVEPLAN-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_saveplan</FUNCTION> - stores a plan prepared by <Function>SPI_prepare</Function> in safe memory - protected from freeing by <Function>SPI_finish</Function> or the transaction manager. -</para> -<Para> - In the current version of <ProductName>PostgreSQL</ProductName> there is no ability to - store prepared plans in the system - catalog and fetch them from there for execution. This will be implemented - in future versions. - - As an alternative, there is the ability to reuse prepared plans in the - subsequent invocations of your procedure in the current session. - Use <Function>SPI_execp</Function> to execute this saved plan. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPISAVEPLAN-2"> -<TITLE>Usage -</TITLE> -<Para> - <Function>SPI_saveplan</Function> saves a passed plan (prepared by <Function>SPI_prepare</Function>) in memory - protected from freeing by <Function>SPI_finish</Function> and by the transaction manager and - returns a pointer to the saved plan. You may save the pointer returned in - a local variable. Always check if this pointer is NULL or not either when - preparing a plan or using an already prepared plan in SPI_execp (see below). - -<Note> -<Para> - If one of the objects (a relation, function, etc.) referenced by the prepared - plan is dropped during your session (by your backend or another process) then the - results of <Function>SPI_execp</Function> for this plan will be unpredictable. -</Para> -</Note> - -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPISAVEPLAN-3"> -<TITLE>Algorithm -</TITLE> -<PARA><FUNCTION>SPI_saveplan</FUNCTION> performs the following: -TBD -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPISAVEPLAN-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -</Sect1> - -<Sect1 id="spi-interface-support"> -<Title>Interface Support Functions</Title> - -<Para> -The functions described here provide convenient interfaces for extracting -information from tuple sets returned by <function>SPI_exec</> and other -SPI interface functions. -</Para> - -<Para> -All functions described in this section may be used by both connected and -unconnected procedures. -</Para> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIFNUMBER"> -<REFMETA> -<REFENTRYTITLE>SPI_fnumber</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Information</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_fnumber -</REFNAME> -<REFPURPOSE> -Finds the attribute number for specified attribute name -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIFNUMBER-1"><PRIMARY>SPI</PRIMARY><SECONDARY>decoding tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIFNUMBER-2"><PRIMARY>SPI_fnumber</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_fnumber(<REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">fname</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIFNUMBER-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -TupleDesc <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple description -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -const char * <REPLACEABLE CLASS="PARAMETER">fname</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Field name -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIFNUMBER-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -int -</TERM> -<LISTITEM> -<PARA> -Attribute number -<SimpleList> -<Member> -Valid one-based index number of attribute -</Member> -<Member> -<ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> if the named attribute is not found -</Member> -</SimpleList> -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIFNUMBER-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_fnumber</FUNCTION> - returns the attribute number for the attribute with name in fname. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIFNUMBER-2"> -<TITLE>Usage -</TITLE> -<Para> -Attribute numbers are 1 based. -</Para> -<Para> -If the given fname refers to a system attribute (eg, <literal>oid</>) -then the appropriate negative attribute number will be returned. -The caller should be careful to test for exact equality to -<ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> to detect error; -testing for result <= 0 is not correct unless system attributes -should be rejected. -</Para> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIFNUMBER-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPIFNUMBER-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIFNAME"> -<REFMETA> -<REFENTRYTITLE>SPI_fname</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Information</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_fname -</REFNAME> -<REFPURPOSE> -Finds the attribute name for the specified attribute number -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIFNAME-1"><PRIMARY>SPI</PRIMARY><SECONDARY>decoding tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIFNAME-2"><PRIMARY>SPI_fname</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_fname(<REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIFNAME-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -TupleDesc <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple description -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Attribute number -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIFNAME-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -char * -</TERM> -<LISTITEM> -<PARA> -Attribute name -<SimpleList> -<Member> -NULL if fnumber is out of range -</Member> -<Member> -SPI_result set to -<ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> on error -</Member> -</SimpleList> -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIFNAME-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_fname</FUNCTION> - returns the attribute name for the specified attribute. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIFNAME-2"> -<TITLE>Usage -</TITLE> -<Para> -Attribute numbers are 1 based. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIFNAME-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -Returns a newly-allocated copy of the attribute name. -(Use pfree() to release the copy when done with it.) -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIFNAME-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIGETVALUE"> -<REFMETA> -<REFENTRYTITLE>SPI_getvalue</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Information</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_getvalue -</REFNAME> -<REFPURPOSE> -Returns the string value of the specified attribute -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIGETVALUE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>decoding tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIGETVALUE-2"><PRIMARY>SPI_getvalue</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_getvalue(<REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIGETVALUE-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -HeapTuple <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple to be examined -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -TupleDesc <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple description -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Attribute number -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIGETVALUE-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -char * -</TERM> -<LISTITEM> -<PARA> -Attribute value or NULL if -<SimpleList> -<Member> -attribute is NULL -</Member> -<Member> -fnumber is out of range -(SPI_result set to -<ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue>) -</Member> -<Member> -no output function available -(SPI_result set to -<ReturnValue>SPI_ERROR_NOOUTFUNC</ReturnValue>) -</Member> -</SimpleList> -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIGETVALUE-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_getvalue</FUNCTION> - returns an external (string) representation of the value of the specified attribute. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIGETVALUE-2"> -<TITLE>Usage -</TITLE> -<Para> -Attribute numbers are 1 based. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIGETVALUE-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -The result is returned as a palloc'd string. -(Use pfree() to release the string when done with it.) -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIGETVALUE-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIGETBINVAL"> -<REFMETA> -<REFENTRYTITLE>SPI_getbinval</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Information</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_getbinval -</REFNAME> -<REFPURPOSE> -Returns the binary value of the specified attribute -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIGETBINVAL-1"><PRIMARY>SPI</PRIMARY><SECONDARY>decoding tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIGETBINVAL-2"><PRIMARY>SPI_getbinval</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_getbinval(<REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">isnull</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIGETBINVAL-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -HeapTuple <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple to be examined -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -TupleDesc <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple description -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Attribute number -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIGETBINVAL-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -Datum -</TERM> -<LISTITEM> -<PARA> -Attribute binary value -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -bool * <REPLACEABLE CLASS="PARAMETER">isnull</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -flag for null value in attribute -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -SPI_result -</TERM> -<LISTITEM> -<PARA> -<SimpleList> -<Member> -<ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> -</Member> -</SimpleList> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIGETBINVAL-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_getbinval</FUNCTION> - returns the specified attribute's value in internal form (as a Datum). -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIGETBINVAL-2"> -<TITLE>Usage -</TITLE> -<Para> -Attribute numbers are 1 based. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIGETBINVAL-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -Does not allocate new space for the datum. In the case of a pass-by- -reference data type, the Datum will be a pointer into the given tuple. -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIGETBINVAL-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIGETTYPE"> -<REFMETA> -<REFENTRYTITLE>SPI_gettype</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Information</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_gettype -</REFNAME> -<REFPURPOSE> -Returns the type name of the specified attribute -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIGETTYPE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>decoding tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIGETTYPE-2"><PRIMARY>SPI_gettype</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_gettype(<REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIGETTYPE-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -TupleDesc <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple description -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Attribute number -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIGETTYPE-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -char * -</TERM> -<LISTITEM> -<PARA> -The type name for the specified attribute number -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -SPI_result -</TERM> -<LISTITEM> -<PARA> -<SimpleList> -<Member> -<ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> -</Member> -</SimpleList> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIGETTYPE-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_gettype</FUNCTION> - returns a copy of the type name for the specified attribute, - or NULL on error. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIGETTYPE-2"> -<TITLE>Usage -</TITLE> -<Para> -Attribute numbers are 1 based. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIGETTYPE-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -Returns a newly-allocated copy of the type name. -(Use pfree() to release the copy when done with it.) -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIGETTYPE-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIGETTYPEID"> -<REFMETA> -<REFENTRYTITLE>SPI_gettypeid</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Information</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_gettypeid -</REFNAME> -<REFPURPOSE> -Returns the type <Acronym>OID</Acronym> of the specified attribute -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIGETTYPEID-1"><PRIMARY>SPI</PRIMARY><SECONDARY>decoding tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIGETTYPEID-2"><PRIMARY>SPI_gettypeid</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_gettypeid(<REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIGETTYPEID-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -TupleDesc <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple description -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">fnumber</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Attribute number -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIGETTYPEID-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -<Acronym>OID</Acronym> -</TERM> -<LISTITEM> -<PARA> -The type <Acronym>OID</Acronym> for the specified attribute number -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -SPI_result -</TERM> -<LISTITEM> -<PARA> -<SimpleList> -<Member> -<ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> -</Member> -</SimpleList> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIGETTYPEID-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_gettypeid</FUNCTION> - returns the type <Acronym>OID</Acronym> for the specified attribute. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIGETTYPEID-2"> -<TITLE>Usage -</TITLE> -<Para> -Attribute numbers are 1 based. -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIGETTYPEID-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -TBD -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPIGETTYPEID-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIGETRELNAME"> -<REFMETA> -<REFENTRYTITLE>SPI_getrelname</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Information</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_getrelname -</REFNAME> -<REFPURPOSE> -Returns the name of the specified relation -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIGETRELNAME-1"><PRIMARY>SPI</PRIMARY><SECONDARY>decoding tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIGETRELNAME-2"><PRIMARY>SPI_getrelname</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_getrelname(<REPLACEABLE CLASS="PARAMETER">rel</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIGETRELNAME-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -Relation <REPLACEABLE CLASS="PARAMETER">rel</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input relation -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIGETRELNAME-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -char * -</TERM> -<LISTITEM> -<PARA> -The name of the specified relation -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIGETRELNAME-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_getrelname</FUNCTION> - returns the name of the specified relation. -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIGETRELNAME-2"> -<TITLE>Usage -</TITLE> -<Para> -TBD -</PARA> -</REFSECT1> ---> -<REFSECT1 ID="R1-SPI-SPIGETRELNAME-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -Returns a newly-allocated copy of the rel name. -(Use pfree() to release the copy when done with it.) -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIGETRELNAME-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -</Sect1> - -<Sect1 id="spi-memory"> -<Title>Memory Management</Title> - -<Para> -<ProductName>PostgreSQL</ProductName> allocates memory within memory -<firstterm>contexts</firstterm>, which provide a convenient method of -managing allocations made in many different places that need to live -for differing amounts of time. Destroying a context releases all the -memory that was allocated in it. Thus, it is not necessary to keep track -of individual objects to avoid memory leaks --- only a relatively small number -of contexts have to be managed. <Function>palloc</Function> and related -functions allocate memory from the <quote>current</> context. -</Para> -<Para> -<Function>SPI_connect</Function> creates a new memory context and makes -it current. <Function>SPI_finish</Function> restores the previous -current memory context and destroys the context created by -<Function>SPI_connect</Function>. These actions ensure that transient -memory allocations made inside your procedure are reclaimed at procedure -exit, avoiding memory leakage. -</Para> -<Para> -However, if your procedure needs to return an allocated memory object -(such as a value of a pass-by-reference data type), you can't allocate -the return object using <Function>palloc</Function>, at least not while -you are connected to SPI. If you try, the object will be deallocated -during <Function>SPI_finish</Function>, and your procedure will not -work reliably! -</Para> -<Para> -To solve this problem, use <Function>SPI_palloc</Function> to allocate -your return object. <Function>SPI_palloc</Function> allocates space -from <quote>upper Executor</> memory --- that is, the memory context -that was current when <Function>SPI_connect</Function> was called, -which is precisely the right context for return values of your procedure. -</Para> -<Para> -If called while not connected to SPI, <Function>SPI_palloc</Function> -acts the same as plain <Function>palloc</Function>. -</Para> -<Para> - Before a procedure connects to the SPI manager, the current memory context -is the upper Executor context, so all allocations made by the procedure via -<Function>palloc</Function> or by SPI utility functions are -made in this context. -</Para> -<Para> - After <Function>SPI_connect</Function> is called, the current context is - the procedure's private context made by <Function>SPI_connect</Function>. - All allocations made via -<Function>palloc</Function>/<Function>repalloc</Function> or by SPI utility -functions (except for <Function>SPI_copytuple</Function>, -<Function>SPI_copytupledesc</Function>, -<Function>SPI_copytupleintoslot</Function>, -<Function>SPI_modifytuple</Function>, -and <Function>SPI_palloc</Function>) are -made in this context. -</Para> -<Para> -When a procedure disconnects from the SPI manager (via -<Function>SPI_finish</Function>) the -current context is restored to the upper Executor context, and all allocations -made in the procedure memory context are freed and can't be used any more! -</Para> - -<Para> -All functions described in this section may be used by both connected and -unconnected procedures. In an unconnected procedure, they act the same -as the underlying ordinary backend functions (<function>palloc</> etc). -</Para> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPICOPYTUPLE"> -<REFMETA> -<REFENTRYTITLE>SPI_copytuple</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Copy</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_copytuple -</REFNAME> -<REFPURPOSE> -Makes copy of tuple in upper Executor context -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPICOPYTUPLE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>copying tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPICOPYTUPLE-2"><PRIMARY>SPI_copytuple</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_copytuple(<REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPICOPYTUPLE-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -HeapTuple <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple to be copied -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPICOPYTUPLE-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -HeapTuple -</TERM> -<LISTITEM> -<PARA> -Copied tuple -<SimpleList> -<Member> - <ReturnValue>non-NULL</ReturnValue> - if <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> - is not NULL and the copy was successful -</Member> -<Member> - <ReturnValue>NULL</ReturnValue> - only if <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> - is NULL -</Member> -</SimpleList> -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPICOPYTUPLE-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_copytuple</FUNCTION> - makes a copy of tuple in upper Executor context. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPICOPYTUPLE-2"> -<TITLE>Usage -</TITLE> -<Para> -TBD -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPICOPYTUPLE-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPICOPYTUPLE-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPICOPYTUPLEDESC"> -<REFMETA> -<REFENTRYTITLE>SPI_copytupledesc</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Descriptor Copy</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_copytupledesc -</REFNAME> -<REFPURPOSE> -Makes copy of tuple descriptor in upper Executor context -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPICOPYTUPLEDESC-1"><PRIMARY>SPI</PRIMARY><SECONDARY>copying tuple descriptors</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPICOPYTUPLEDESC-2"><PRIMARY>SPI_copytupledesc</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>2001-08-02</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_copytupledesc(<REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPICOPYTUPLEDESC-1"> -<REFSECT2INFO> -<DATE>2001-08-02</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -TupleDesc <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple descriptor to be copied -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPICOPYTUPLEDESC-2"> -<REFSECT2INFO> -<DATE>2001-08-02</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -TupleDesc -</TERM> -<LISTITEM> -<PARA> -Copied tuple descriptor -<SimpleList> -<Member> - <ReturnValue>non-NULL</ReturnValue> - if <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> - is not NULL and the copy was successful -</Member> -<Member> - <ReturnValue>NULL</ReturnValue> - only if <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> - is NULL -</Member> -</SimpleList> -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPICOPYTUPLEDESC-1"> -<REFSECT1INFO> -<DATE>2001-08-02</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_copytupledesc</FUNCTION> - makes a copy of tupdesc in upper Executor context. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPICOPYTUPLEDESC-2"> -<TITLE>Usage -</TITLE> -<Para> -TBD -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPICOPYTUPLEDESC-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPICOPYTUPLEDESC-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPICOPYTUPLEINTOSLOT"> -<REFMETA> -<REFENTRYTITLE>SPI_copytupleintoslot</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple and Descriptor Copy</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_copytupleintoslot -</REFNAME> -<REFPURPOSE> -Makes copy of tuple and descriptor in upper Executor context -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPICOPYTUPLEINTOSLOT-1"><PRIMARY>SPI</PRIMARY><SECONDARY>copying tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPICOPYTUPLEINTOSLOT-2"><PRIMARY>SPI_copytupleintoslot</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_copytupleintoslot(<REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPICOPYTUPLEINTOSLOT-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -HeapTuple <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple to be copied -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -TupleDesc <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple descriptor to be copied -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPICOPYTUPLEINTOSLOT-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -TupleTableSlot * -</TERM> -<LISTITEM> -<PARA> -Tuple slot containing copied tuple and descriptor -<SimpleList> -<Member> - <ReturnValue>non-NULL</ReturnValue> - if <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> - and <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> - are not NULL and the copy was successful -</Member> -<Member> - <ReturnValue>NULL</ReturnValue> - only if <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> - or <REPLACEABLE CLASS="PARAMETER">tupdesc</REPLACEABLE> - is NULL -</Member> -</SimpleList> -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPICOPYTUPLEINTOSLOT-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_copytupleintoslot</FUNCTION> - makes a copy of tuple in upper Executor context, returning it in the - form of a filled-in TupleTableSlot. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPICOPYTUPLEINTOSLOT-2"> -<TITLE>Usage -</TITLE> -<Para> -TBD -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPICOPYTUPLEINTOSLOT-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPICOPYTUPLEINTOSLOT-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIMODIFYTUPLE"> -<REFMETA> -<REFENTRYTITLE>SPI_modifytuple</REFENTRYTITLE> -<REFMISCINFO>SPI - Tuple Modify</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_modifytuple -</REFNAME> -<REFPURPOSE> -Creates a tuple by replacing selected fields of a given tuple -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIMODIFYTUPLE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>modifying tuples</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIMODIFYTUPLE-2"><PRIMARY>SPI_modifytuple</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_modifytuple(<REPLACEABLE CLASS="PARAMETER">rel</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">nattrs</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">attnum</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">Values</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">Nulls</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIMODIFYTUPLE-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -Relation <REPLACEABLE CLASS="PARAMETER">rel</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Used only as source of tuple descriptor for tuple. (Passing a relation -rather than a tuple descriptor is a misfeature.) -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -HeapTuple <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Input tuple to be modified -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int <REPLACEABLE CLASS="PARAMETER">nattrs</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Number of attribute numbers in attnum array -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -int * <REPLACEABLE CLASS="PARAMETER">attnum</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Array of numbers of the attributes that are to be changed -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -Datum * <REPLACEABLE CLASS="PARAMETER">Values</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -New values for the attributes specified -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -const char * <REPLACEABLE CLASS="PARAMETER">Nulls</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Which new values are NULL, if any -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIMODIFYTUPLE-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -HeapTuple -</TERM> -<LISTITEM> -<PARA> -New tuple with modifications -<SimpleList> -<Member> - <ReturnValue>non-NULL</ReturnValue> - if <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> - is not NULL and the modify was successful -</Member> -<Member> - <ReturnValue>NULL</ReturnValue> - only if <REPLACEABLE CLASS="PARAMETER">tuple</REPLACEABLE> - is NULL -</Member> -</SimpleList> -</para> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -SPI_result -</TERM> -<LISTITEM> -<PARA> -<SimpleList> -<Member> - <ReturnValue>SPI_ERROR_ARGUMENT</ReturnValue> if rel is NULL or tuple is NULL or natts <= 0 or - attnum is NULL or Values is NULL. -</Member> -<Member> - <ReturnValue>SPI_ERROR_NOATTRIBUTE</ReturnValue> if there is an invalid - attribute number in attnum (attnum <= 0 or > number of - attributes in tuple) -</Member> -</SimpleList> -</para> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIMODIFYTUPLE-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_modifytuple</FUNCTION> -creates a new tuple by substituting new values for selected attributes, -copying the original tuple's attributes at other positions. The input -tuple is not modified. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIMODIFYTUPLE-2"> -<TITLE>Usage -</TITLE> -<Para> -If successful, a pointer to the new tuple is returned. The new tuple is -allocated in upper Executor context. -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIMODIFYTUPLE-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPIMODIFYTUPLE-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIPALLOC"> -<REFMETA> -<REFENTRYTITLE>SPI_palloc</REFENTRYTITLE> -<REFMISCINFO>SPI - Memory Management</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_palloc -</REFNAME> -<REFPURPOSE> -Allocates memory in upper Executor context -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIPALLOC-1"><PRIMARY>SPI</PRIMARY><SECONDARY>allocating space</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIPALLOC-2"><PRIMARY>SPI_palloc</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_palloc(<REPLACEABLE CLASS="PARAMETER">size</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIPALLOC-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -Size <REPLACEABLE CLASS="PARAMETER">size</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Octet size of storage to allocate -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIPALLOC-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -void * -</TERM> -<LISTITEM> -<PARA> -New storage space of specified size -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIPALLOC-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_palloc</FUNCTION> - allocates memory in upper Executor context. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIPALLOC-2"> -<TITLE>Usage -</TITLE> -<Para> -TBD -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIPALLOC-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -TBD -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPIPALLOC-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIREPALLOC"> -<REFMETA> -<REFENTRYTITLE>SPI_repalloc</REFENTRYTITLE> -<REFMISCINFO>SPI - Memory Management</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_repalloc -</REFNAME> -<REFPURPOSE> -Re-allocates memory in upper Executor context -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIREPALLOC-1"><PRIMARY>SPI</PRIMARY><SECONDARY>allocating space</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIREPALLOC-2"><PRIMARY>SPI_repalloc</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_repalloc(<REPLACEABLE CLASS="PARAMETER">pointer</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">size</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIREPALLOC-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -void * <REPLACEABLE CLASS="PARAMETER">pointer</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Pointer to existing storage -</PARA> -</LISTITEM> -</VARLISTENTRY> -<VARLISTENTRY> -<TERM> -Size <REPLACEABLE CLASS="PARAMETER">size</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Octet size of storage to allocate -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIREPALLOC-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -void * -</TERM> -<LISTITEM> -<PARA> -New storage space of specified size with contents copied from existing area -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIREPALLOC-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_repalloc</FUNCTION> - re-allocates memory in upper Executor context. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIREPALLOC-2"> -<TITLE>Usage -</TITLE> -<Para> -This function is no longer different from plain <FUNCTION>repalloc</FUNCTION>. -It's kept just for backward compatibility of existing code. -</PARA> -</REFSECT1> -<!-- -<REFSECT1 ID="R1-SPI-SPIREPALLOC-3"> -<TITLE>Algorithm -</TITLE> -<PARA> -TBD -</PARA> -</REFSECT1> ---> -<!-- -<REFSECT1 ID="R1-SPI-SPIREPALLOC-4"> -<TITLE>Structures -</TITLE> -<PARA>None -</PARA> -</REFSECT1> ---> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIPFREE"> -<REFMETA> -<REFENTRYTITLE>SPI_pfree</REFENTRYTITLE> -<REFMISCINFO>SPI - Memory Management</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_pfree -</REFNAME> -<REFPURPOSE> -Frees memory in upper Executor context -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIPFREE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>allocating space</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIPFREE-2"><PRIMARY>SPI_pfree</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_pfree(<REPLACEABLE CLASS="PARAMETER">pointer</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIPFREE-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -void * <REPLACEABLE CLASS="PARAMETER">pointer</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Pointer to existing storage -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIPFREE-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -None -</TERM> -<LISTITEM> -<PARA> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIPFREE-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_pfree</FUNCTION> - frees memory in upper Executor context. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIPFREE-2"> -<TITLE>Usage -</TITLE> -<Para> -This function is no longer different from plain <FUNCTION>pfree</FUNCTION>. -It's kept just for backward compatibility of existing code. -</PARA> -</REFSECT1> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIFREETUPLE"> -<REFMETA> -<REFENTRYTITLE>SPI_freetuple</REFENTRYTITLE> -<REFMISCINFO>SPI - Memory Management</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_freetuple -</REFNAME> -<REFPURPOSE> -Frees a tuple allocated in upper Executor context -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIFREETUPLE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>allocating space</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIFREETUPLE-2"><PRIMARY>SPI_freetuple</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1997-12-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_freetuple(<REPLACEABLE CLASS="PARAMETER">pointer</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIFREETUPLE-1"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -HeapTuple <REPLACEABLE CLASS="PARAMETER">pointer</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Pointer to allocated tuple -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIFREETUPLE-2"> -<REFSECT2INFO> -<DATE>1997-12-24</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -None -</TERM> -<LISTITEM> -<PARA> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIFREETUPLE-1"> -<REFSECT1INFO> -<DATE>1997-12-24</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_freetuple</FUNCTION> - frees a tuple previously allocated in upper Executor context. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIFREETUPLE-2"> -<TITLE>Usage -</TITLE> -<Para> -This function is no longer different from plain <FUNCTION>heap_freetuple</FUNCTION>. -It's kept just for backward compatibility of existing code. -</PARA> -</REFSECT1> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIFREETUPTABLE"> -<REFMETA> -<REFENTRYTITLE>SPI_freetuptable</REFENTRYTITLE> -<REFMISCINFO>SPI - Memory Management</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_freetuptable -</REFNAME> -<REFPURPOSE> -Frees a tuple set created by <function>SPI_exec</> or similar function -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIFREETUPTABLE-1"><PRIMARY>SPI</PRIMARY><SECONDARY>allocating space</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIFREETUPTABLE-2"><PRIMARY>SPI_freetuptable</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>2001-11-14</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_freetuptable(<REPLACEABLE CLASS="PARAMETER">tuptable</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIFREETUPTABLE-1"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -SPITupleTable * <REPLACEABLE CLASS="PARAMETER">tuptable</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Pointer to tuple table -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIFREETUPTABLE-2"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -None -</TERM> -<LISTITEM> -<PARA> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIFREETUPTABLE-1"> -<REFSECT1INFO> -<DATE>2001-11-14</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_freetuptable</FUNCTION> - frees a tuple set created by a prior SPI query function, such as - <function>SPI_exec</>. -</PARA> -</REFSECT1> -<REFSECT1 ID="R1-SPI-SPIFREETUPTABLE-2"> -<TITLE>Usage -</TITLE> -<Para> -This function is useful if a SPI procedure needs to execute multiple -queries and does not want to keep the results of earlier queries around -until it ends. Note that any unfreed tuple sets will be freed anyway -at <function>SPI_finish</>. -</PARA> -</REFSECT1> -</REFENTRY> - -<!-- *********************************************** --> -<!-- *********************************************** --> -<!-- *********************************************** --> - -<REFENTRY ID="SPI-SPIFREEPLAN"> -<REFMETA> -<REFENTRYTITLE>SPI_freeplan</REFENTRYTITLE> -<REFMISCINFO>SPI - Memory Management</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME>SPI_freeplan -</REFNAME> -<REFPURPOSE> - Releases a previously saved plan -</REFPURPOSE> -<INDEXTERM ID="IX-SPI-SPIFREEPLAN-1"><PRIMARY>SPI</PRIMARY><SECONDARY>allocating space</SECONDARY></INDEXTERM> -<INDEXTERM ID="IX-SPI-SPIFREEPLAN-2"><PRIMARY>SPI_freeplan</PRIMARY></INDEXTERM> -</REFNAMEDIV> -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>2001-11-14</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -SPI_freeplan(<REPLACEABLE CLASS="PARAMETER">plan</REPLACEABLE>) -</SYNOPSIS> - -<REFSECT2 ID="R2-SPI-SPIFREEPLAN-1"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Inputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -void *<REPLACEABLE CLASS="PARAMETER">plan</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Passed plan -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> - -<REFSECT2 ID="R2-SPI-SPIFREEPLAN-2"> -<REFSECT2INFO> -<DATE>2001-11-14</DATE> -</REFSECT2INFO> -<TITLE>Outputs -</TITLE> -<VARIABLELIST> -<VARLISTENTRY> -<TERM>int -</TERM> -<LISTITEM> -<PARA> -<SimpleList> -<Member> - <ReturnValue>SPI_ERROR_ARGUMENT</ReturnValue> if plan is NULL -</Member> -</SimpleList> -</PARA> -</LISTITEM> -</VARLISTENTRY> -</VARIABLELIST> -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SPI-SPIFREEPLAN-1"> -<REFSECT1INFO> -<DATE>2001-11-14</DATE> -</REFSECT1INFO> -<TITLE>Description -</TITLE> -<PARA> -<FUNCTION>SPI_freeplan</FUNCTION> - releases a query plan previously returned by - <Function>SPI_prepare</Function> or saved by - <Function>SPI_saveplan</Function>. -</para> -</REFSECT1> -</REFENTRY> - -</Sect1> - -<Sect1 id="spi-visibility"> -<Title>Visibility of Data Changes</Title> - -<Para> -<ProductName>PostgreSQL</ProductName> data changes visibility rule: during a query execution, data -changes made by the query itself (via SQL-function, SPI-function, triggers) -are invisible to the query scan. For example, in query + a portal can outlive the current procedure (it can, in fact, live + to the end of the current transaction). Returning the portal name + to the procedure's caller provides a way of returning a row set as + result. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>const char * <parameter>name</parameter></literal></term> + <listitem> + <para> + name for portal, or <symbol>NULL</symbol> to let the system + select a name + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>void * <parameter>plan</parameter></literal></term> + <listitem> + <para> + execution plan (returned by <function>SPI_prepare</function>) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>Datum * <parameter>values</parameter></literal></term> + <listitem> + <para> + actual parameter values + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>const char *<parameter>nulls</parameter></literal></term> + <listitem> + <para> + An array describing which parameters are null values. + <literal>n</literal> indicates a null value (entry in + <parameter>values</> will be ignored); a space indicates a + nonnull value (entry in <parameter>values</> is valid). If + <parameter>nulls</parameter> is <symbol>NULL</> then + <function>SPI_cursor_open</function> assumes that no parameters + are null. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + pointer to portal containing the cursor, or <symbol>NULL</symbol> + on error + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-cursor-find"> + <refmeta> + <refentrytitle>SPI_cursor_find</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_cursor_find</refname> + <refpurpose>find an existing cursor by name</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_cursor_find</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +Portal SPI_cursor_find(const char * <parameter>name</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_cursor_find</function> finds an existing portal by + name. This is primarily useful to resolve a cursor name returned + as text by some other function. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>const char * <parameter>name</parameter></literal></term> + <listitem> + <para> + name of the portal + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + pointer to the portal with the specified name, or + <symbol>NULL</symbol> if none was found + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-cursor-fetch"> + <refmeta> + <refentrytitle>SPI_cursor_fetch</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_cursor_fetch</refname> + <refpurpose>fetch some rows from a cursor</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_cursor_fetch</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void SPI_cursor_fetch(Portal <parameter>portal</parameter>, bool <parameter>forward</parameter>, int <parameter>count</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_cursor_fetch</function> fetches some rows from a + cursor. This is equivalent to the SQL command <command>FETCH</>. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>Portal <parameter>portal</parameter></literal></term> + <listitem> + <para> + portal containing the cursor + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>bool <parameter>forward</parameter></literal></term> + <listitem> + <para> + true for fetch forward, false for fetch backward + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>count</parameter></literal></term> + <listitem> + <para> + maximum number of rows to fetch + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + <varname>SPI_processed</varname> and + <varname>SPI_tuptable</varname> are set as in + <function>SPI_exec</function> if successful. + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-cursor-move"> + <refmeta> + <refentrytitle>SPI_cursor_move</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_cursor_move</refname> + <refpurpose>move a cursor</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_cursor_move</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void SPI_cursor_move(Portal <parameter>portal</parameter>, bool <parameter>forward</parameter>, int <parameter>count</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_cursor_move</function> skips over some number of rows + in a cursor. This is equivalent to the SQL command + <command>MOVE</>. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>Portal <parameter>portal</parameter></literal></term> + <listitem> + <para> + portal containing the cursor + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>bool <parameter>forward</parameter></literal></term> + <listitem> + <para> + true for move forward, false for move backward + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>count</parameter></literal></term> + <listitem> + <para> + maximum number of rows to move + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-cursor-close"> + <refmeta> + <refentrytitle>SPI_cursor_close</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_cursor_close</refname> + <refpurpose>close a cursor</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_cursor_close</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void SPI_cursor_close(Portal <parameter>portal</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_cursor_close</function> closes a previously created + cursor and releases its portal storage. + </para> + + <para> + All open cursors are closed automatically at the end of a + transaction. <function>SPI_cursor_close</function> need only be + invoked if it is desirable to release resources sooner. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>Portal <parameter>portal</parameter></literal></term> + <listitem> + <para> + portal containing the cursor + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-saveplan"> + <refmeta> + <refentrytitle>SPI_saveplan</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_saveplan</refname> + <refpurpose>save a plan</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_saveplan</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void * SPI_saveplan(void * <parameter>plan</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_saveplan</function> saves a passed plan (prepared by + <function>SPI_prepare</function>) in memory protected from freeing + by <function>SPI_finish</function> and by the transaction manager + and returns a pointer to the saved plan. This gives you the + ability to reuse prepared plans in the subsequent invocations of + your procedure in the current session. You may save the pointer + returned in a local variable. Always check if this pointer is + <symbol>NULL</symbol> or not either when preparing a plan or using + an already prepared plan in <function>SPI_execp</function>. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>void * <parameter>plan</parameter></literal></term> + <listitem> + <para> + the plan to be saved + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + Pointer to the saved plan; <symbol>NULL</symbol> if unsuccessful. + On error, <varname>SPI_result</varname> is set thus: + + <variablelist> + <varlistentry> + <term><symbol>SPI_ERROR_ARGUMENT</symbol></term> + <listitem> + <para> + if <parameter>plan</parameter> is <symbol>NULL</symbol> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_UNCONNECTED</symbol></term> + <listitem> + <para> + if called from an unconnected procedure + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title>Notes</title> + + <para> + If one of the objects (a table, function, etc.) referenced by the + prepared plan is dropped during the session then the results of + <function>SPI_execp</function> for this plan will be unpredictable. + </para> + </refsect1> +</refentry> + +</sect1> + +<sect1 id="spi-interface-support"> + <title>Interface Support Functions</title> + + <para> + The functions described here provide an interface for extracting + information from result sets returned by <function>SPI_exec</> and + other SPI functions. + </para> + + <para> + All functions described in this section may be used by both + connected and unconnected procedures. + </para> + +<!-- *********************************************** --> + +<refentry id="spi-spi-fname"> + <refmeta> + <refentrytitle>SPI_fname</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_fname</refname> + <refpurpose>determine the column name for the specified column number</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_fname</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +char * SPI_fname(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_fname</function> returns the column name of the + specified column. (You can use <function>pfree</function> to + release the copy of the name when you don't need it anymore.) + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>TupleDesc <parameter>rowdesc</parameter></literal></term> + <listitem> + <para> + input row description + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>colnumber</parameter></literal></term> + <listitem> + <para> + column number (count starts at 1) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + The column name; <symbol>NULL</symbol> if + <parameter>colnumber</parameter> is out of range. + <varname>SPI_result</varname> set to + <symbol>SPI_ERROR_NOATTRIBUTE</symbol> on error. + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-fnumber"> + <refmeta> + <refentrytitle>SPI_fnumber</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_fnumber</refname> + <refpurpose>determine the column number for the specified column name</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_fnumber</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +int SPI_fnumber(TupleDesc <parameter>rowdesc</parameter>, const char * <parameter>colname</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_fnumber</function> returns the column number for the + column with the specified name. + </para> + + <para> + If <parameter>colname</parameter> refers to a system column (e.g., + <literal>oid</>) then the appropriate negative column number will + be returned. The caller should be careful to test the return value + for exact equality to <symbol>SPI_ERROR_NOATTRIBUTE</symbol> to + detect an error; testing the result for less than or equal to 0 is + not correct unless system columns should be rejected. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>TupleDesc <parameter>rowdesc</parameter></literal></term> + <listitem> + <para> + input row description + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>const char * <parameter>colname</parameter></literal></term> + <listitem> + <para> + column name + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + Column number (count starts at 1), or + <symbol>SPI_ERROR_NOATTRIBUTE</symbol> if the named column was not + found. + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-getvalue"> + <refmeta> + <refentrytitle>SPI_getvalue</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_getvalue</refname> + <refpurpose>return the string value of the specified column</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_getvalue</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +char * SPI_getvalue(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_getvalue</function> returns the string representation + of the value of the specified column. + </para> + + <para> + The result is returned in memory allocated using + <function>palloc</function>. (You can use + <function>pfree</function> to release the memory when you don't + need it anymore.) + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>HeapTuple <parameter>row</parameter></literal></term> + <listitem> + <para> + input row to be examined + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>TupleDesc <parameter>rowdesc</parameter></literal></term> + <listitem> + <para> + input row description + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>colnumber</parameter></literal></term> + <listitem> + <para> + column number (count starts at 1) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + Column value, or <symbol>NULL</symbol> if the column is null, + <parameter>colnumber</parameter> is out of range + (<varname>SPI_result</varname> is set to + <symbol>SPI_ERROR_NOATTRIBUTE</symbol>), or no no output function + available (<varname>SPI_result</varname> is set to + <symbol>SPI_ERROR_NOOUTFUNC</symbol>). + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-getbinval"> + <refmeta> + <refentrytitle>SPI_getbinval</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_getbinval</refname> + <refpurpose>return the binary value of the specified column</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_getbinval</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +Datum SPI_getbinval(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>, bool * <parameter>isnull</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_getbinval</function> returns the value of the + specified column in the internal form (as type <type>Datum</type>). + </para> + + <para> + This function does not allocate new space for the datum. In the + case of a pass-by-reference data type, the return value will be a + pointer into the passed row. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>HeapTuple <parameter>row</parameter></literal></term> + <listitem> + <para> + input row to be examined + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>TupleDesc <parameter>rowdesc</parameter></literal></term> + <listitem> + <para> + input row description + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>rownumber</parameter></literal></term> + <listitem> + <para> + column number (count starts at 1) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>bool * <parameter>isnull</parameter></literal></term> + <listitem> + <para> + flag for a null value in the column + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + The binary value of the column is returned. The variable pointed + to by <parameter>isnull</parameter> is set to true if the column is + null, else to false. + </para> + + <para> + <varname>SPI_result</varname> is set to + <symbol>SPI_ERROR_NOATTRIBUTE</symbol> on error. + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-gettype"> + <refmeta> + <refentrytitle>SPI_gettype</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_gettype</refname> + <refpurpose>return the data type name of the specified column</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_gettype</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +char * SPI_gettype(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_gettype</function> returns the data type name of the + specified column. (You can use <function>pfree</function> to + release the copy of the name when you don't need it anymore.) + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>TupleDesc <parameter>rowdesc</parameter></literal></term> + <listitem> + <para> + input row description + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>colnumber</parameter></literal></term> + <listitem> + <para> + column number (count starts at 1) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + The data type name of the specified column, or + <symbol>NULL</symbol> on error. <varname>SPI_result</varname> is + set to <symbol>SPI_ERROR_NOATTRIBUTE</symbol> on error. + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-gettypeid"> + <refmeta> + <refentrytitle>SPI_gettypeid</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_gettypeid</refname> + <refpurpose>return the data type <acronym>OID</acronym> of the specified column</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_gettypeid</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +Oid SPI_gettypeid(TupleDesc <parameter>rowdesc</parameter>, int <parameter>colnumber</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_gettypeid</function> returns the + <acronym>OID</acronym> of the data type of the specified column. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>TupleDesc <parameter>rowdesc</parameter></literal></term> + <listitem> + <para> + input row description + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>colnumber</parameter></literal></term> + <listitem> + <para> + column number (count starts at 1) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + The <acronym>OID</acronym> of the data type of the specified column + or <symbol>InvalidOid</symbol> on error. On error, + <varname>SPI_result</varname> is set to + <symbol>SPI_ERROR_NOATTRIBUTE</symbol>. + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-getrelname"> + <refmeta> + <refentrytitle>SPI_getrelname</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_getrelname</refname> + <refpurpose>return the name of the specified relation</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_getrelname</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +char * SPI_getrelname(Relation <parameter>rel</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_getrelname</function> returns the name of the + specified relation. (You can use <function>pfree</function> to + release the copy of the name when you don't need it anymore.) + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>Relation <parameter>rel</parameter></literal></term> + <listitem> + <para> + input relation + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + The name of the specified relation. + </para> + </refsect1> +</refentry> + + </sect1> + + <sect1 id="spi-memory"> + <title>Memory Management</title> + + <para> + <productname>PostgreSQL</productname> allocates memory within + <firstterm>memory contexts</firstterm><indexterm><primary>memory + context</primary><secondary>in SPI</secondary></indexterm>, which provide a convenient method of + managing allocations made in many different places that need to + live for differing amounts of time. Destroying a context releases + all the memory that was allocated in it. Thus, it is not necessary + to keep track of individual objects to avoid memory leaks; instead + only a relatively small number of contexts have to be managed. + <function>palloc</function> and related functions allocate memory + from the <quote>current</> context. + </para> + + <para> + <function>SPI_connect</function> creates a new memory context and + makes it current. <function>SPI_finish</function> restores the + previous current memory context and destroys the context created by + <function>SPI_connect</function>. These actions ensure that + transient memory allocations made inside your procedure are + reclaimed at procedure exit, avoiding memory leakage. + </para> + + <para> + However, if your procedure needs to return an object in allocated + memory (such as a value of a pass-by-reference data type), you + cannot allocate that memory using <function>palloc</function>, at + least not while you are connected to SPI. If you try, the object + will be deallocated by <function>SPI_finish</function>, and your + procedure will not work reliably. To solve this problem, use + <function>SPI_palloc</function> to allocate memory for your return + object. <function>SPI_palloc</function> allocates memory in the + <quote>upper executor context</quote>, that is, the memory context + that was current when <function>SPI_connect</function> was called, + which is precisely the right context for return a value from your + procedure. + </para> + + <para> + If <function>SPI_palloc</function> is called while the procedure is + not connected to SPI, then it acts the same as a normal + <function>palloc</function>. Before a procedure connects to the + SPI manager, the current memory context is the upper executor + context, so all allocations made by the procedure via + <function>palloc</function> or by SPI utility functions are made in + this context. + </para> + + <para> + When <function>SPI_connect</function> is called, the private + context of the procedure, which is created by + <function>SPI_connect</function>, is made the current context. All + allocations made by <function>palloc</function>, + <function>repalloc</function>, or SPI utility functions (except for + <function>SPI_copytuple</function>, + <function>SPI_copytupledesc</function>, + <function>SPI_copytupleintoslot</function>, + <function>SPI_modifytuple</function>, and + <function>SPI_palloc</function>) are made in this context. When a + procedure disconnects from the SPI manager (via + <function>SPI_finish</function>) the current context is restored to + the upper executor context, and all allocations made in the + procedure memory context are freed and cannot be used any more. + </para> + + <para> + All functions described in this section may be used by both + connected and unconnected procedures. In an unconnected procedure, + they act the same as the underlying ordinary server functions + (<function>palloc</>, etc.). + </para> + +<!-- *********************************************** --> + +<refentry id="spi-spi-palloc"> + <refmeta> + <refentrytitle>SPI_palloc</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_palloc</refname> + <refpurpose>allocate memory in the upper executor context</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_palloc</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void * SPI_palloc(Size <parameter>size</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_palloc</function> allocates memory in the upper + executor context. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>Size <parameter>size</parameter></literal></term> + <listitem> + <para> + size in bytes of storage to allocate + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + pointer to new storage space of the specified size + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-realloc"> + <refmeta> + <refentrytitle>SPI_repalloc</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_repalloc</refname> + <refpurpose>reallocate memory in the upper executor context</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_repalloc</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void * SPI_repalloc(void * <parameter>pointer</parameter>, Size <parameter>size</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_repalloc</function> changes the size of a memory + segment previously allocated using <function>SPI_palloc</function>. + </para> + + <para> + This function is no longer different from plain + <function>repalloc</function>. It's kept just for backward + compatibility of existing code. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>void * <parameter>pointer</parameter></literal></term> + <listitem> + <para> + pointer to existing storage to change + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>Size <parameter>size</parameter></literal></term> + <listitem> + <para> + size in bytes of storage to allocate + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + pointer to new storage space of specified size with the contents + copied from the existing area + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-pfree"> + <refmeta> + <refentrytitle>SPI_pfree</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_pfree</refname> + <refpurpose>free memory in the upper executor context</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_pfree</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void SPI_pfree(void * <parameter>pointer</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_pfree</function> frees memory previously allocated + using <function>SPI_palloc</function> or + <function>SPI_repalloc</function>. + </para> + + <para> + This function is no longer different from plain + <function>pfree</function>. It's kept just for backward + compatibility of existing code. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>void * <parameter>pointer</parameter></literal></term> + <listitem> + <para> + pointer to existing storage to free + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-copytuple"> + <refmeta> + <refentrytitle>SPI_copytuple</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_copytuple</refname> + <refpurpose>make a copy of a row in the upper executor context</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_copytuple</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +HeapTuple SPI_copytuple(HeapTuple <parameter>row</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_copytuple</function> makes a copy of a row in the + upper executor context. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>HeapTuple <parameter>row</parameter></literal></term> + <listitem> + <para> + row to be copied + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + the copied row; <symbol>NULL</symbol> only if + <parameter>tuple</parameter> is <symbol>NULL</symbol> + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-copytupledesc"> + <refmeta> + <refentrytitle>SPI_copytupledesc</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_copytupledesc</refname> + <refpurpose>make a copy of a row descriptor in the upper executor context</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_copytupledesc</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +TupleDesc SPI_copytupledesc(TupleDesc <parameter>tupdesc</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_copytupledesc</function> makes a copy of a row + descriptor in the upper executor context. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>TupleDesc <parameter>tupdesc</parameter></literal></term> + <listitem> + <para> + row descriptor to be copied + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + the copied row descriptor; <symbol>NULL</symbol> only if + <parameter>tupdesc</parameter> is <symbol>NULL</symbol> + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-copytupleintoslot"> + <refmeta> + <refentrytitle>SPI_copytupleintoslot</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_copytupleintoslot</refname> + <refpurpose>make a copy of a row and descriptor in the upper executor context</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_copytupleintoslot</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +TupleTableSlot * SPI_copytupleintoslot(HeapTuple <parameter>row</parameter>, TupleDesc <parameter>rowdesc</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_copytupleintoslot</function> makes a copy of a row in + the upper executor context, returning it in the form of a filled-in + <type>TupleTableSlot</type> structure. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>HeapTuple <parameter>row</parameter></literal></term> + <listitem> + <para> + row to be copied + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>TupleDesc <parameter>rowdesc</parameter></literal></term> + <listitem> + <para> + row descriptor to be copied + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + <type>TupleTableSlot</type> containing the copied row and + descriptor; <symbol>NULL</symbol> only if + <parameter>row</parameter> or <parameter>rowdesc</parameter> are + <symbol>NULL</symbol> + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-modifytuple"> + <refmeta> + <refentrytitle>SPI_modifytuple</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_modifytuple</refname> + <refpurpose>create a row by replacing selected fields of a given row</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_modifytuple</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +HeapTuple SPI_modifytuple(Relation <parameter>rel</parameter>, HeapTuple <parameter>row</parameter>, <parameter>ncols</parameter>, <parameter>colnum</parameter>, Datum * <parameter>values</parameter>, const char * <parameter>nulls</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_modifytuple</function> creates a new row by + substituting new values for selected columns, copying the original + row's columns at other positions. The input row is not modified. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>Relation <parameter>rel</parameter></literal></term> + <listitem> + <para> + Used only as the source of the row descriptor for the row. + (Passing a relation rather than a row descriptor is a + misfeature.) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>HeapTuple <parameter>row</parameter></literal></term> + <listitem> + <para> + row to be modified + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int <parameter>ncols</parameter></literal></term> + <listitem> + <para> + number of column numbers in the array + <parameter>colnum</parameter> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>int * <parameter>colnum</parameter></literal></term> + <listitem> + <para> + array of the numbers of the columns that are to be changed + (count starts at 1) + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>Datum * <parameter>values</parameter></literal></term> + <listitem> + <para> + new values for the specified columns + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>const char * <parameter>Nulls</parameter></literal></term> + <listitem> + <para> + which new values are null, if any (see <function>SPI_execp</function> for the format) + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + new row with modifications, allocated in the upper executor + context; <symbol>NULL</symbol> only if <parameter>row</parameter> + is <symbol>NULL</symbol> + </para> + + <para> + On error, <varname>SPI_result</varname> is set as follows: + <variablelist> + <varlistentry> + <term><symbol>SPI_ERROR_ARGUMENT</symbol></term> + <listitem> + <para> + if <parameter>rel</> is <symbol>NULL</>, or if + <parameter>row</> is <symbol>NULL</>, or if <parameter>ncols</> + is less than or equal to 0, or if <parameter>colnum</> is + <symbol>NULL</>, or if <parameter>values</> is <symbol>NULL</>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><symbol>SPI_ERROR_NOATTRIBUTE</symbol></term> + <listitem> + <para> + if <parameter>colnum</> contains an invalid column number (less + than or equal to 0 or greater than the number of column in + <parameter>row</>) + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-freetuple"> + <refmeta> + <refentrytitle>SPI_freetuple</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_freetuple</refname> + <refpurpose>frees a row allocated in the upper executor context</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_freetuple</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void SPI_freetuple(HeapTuple <parameter>row</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_freetuple</function> frees a row previously allocated + in the upper executor context. + </para> + + <para> + This function is no longer different from plain + <function>heap_freetuple</function>. It's kept just for backward + compatibility of existing code. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>HeapTuple <parameter>row</parameter></literal></term> + <listitem> + <para> + row to free + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-freetupletable"> + <refmeta> + <refentrytitle>SPI_freetuptable</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_freetuptable</refname> + <refpurpose>free a row set created by <function>SPI_exec</> or a similar function</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_freetuptable</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +void SPI_freetuptable(SPITupleTable * <parameter>tuptable</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_freetuptable</function> frees a row set created by a + prior SPI command execution function, such as + <function>SPI_exec</>. Therefore, this function is usually called + with the global variable <varname>SPI_tupletable</varname> as + argument. + </para> + + <para> + This function is useful if a SPI procedure needs to execute + multiple commands and does not want to keep the results of earlier + commands around until it ends. Note that any unfreed row sets will + be freed anyway at <function>SPI_finish</>. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>SPITupleTable * <parameter>tuptable</parameter></literal></term> + <listitem> + <para> + pointer to row set to free + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> + +<!-- *********************************************** --> + +<refentry id="spi-spi-freeplan"> + <refmeta> + <refentrytitle>SPI_freeplan</refentrytitle> + </refmeta> + + <refnamediv> + <refname>SPI_freeplan</refname> + <refpurpose>free a previously saved plan</refpurpose> + </refnamediv> + + <indexterm><primary>SPI_freeplan</primary></indexterm> + + <refsynopsisdiv> +<synopsis> +int SPI_freeplan(void *<parameter>plan</parameter>) +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_freeplan</function> releases a command execution plan + previously returned by <function>SPI_prepare</function> or saved by + <function>SPI_saveplan</function>. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>void * <parameter>plan</parameter></literal></term> + <listitem> + <para> + pointer to plan to free + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + <symbol>SPI_ERROR_ARGUMENT</symbol> if <parameter>plan</parameter> + is <symbol>NULL</symbol>. + </para> + </refsect1> +</refentry> + + </sect1> + + <sect1 id="spi-visibility"> + <title>Visibility of Data Changes</title> + + <para> + The following two rules govern the visibility of data changes in + functions that use SPI (or any other C function): + + <itemizedlist> + <listitem> + <para> + During the execution of an SQL command, any data changes made by + the command (or by function called by the command, including + trigger functions) are invisible to the command. For + example, in command <programlisting> - INSERT INTO a SELECT * FROM a +INSERT INTO a SELECT * FROM a; </programlisting> - tuples inserted are invisible for SELECT's scan. In effect, this -duplicates the database table within itself (subject to unique index -rules, of course) without recursing. -</Para> - -<Para> - Changes made by query Q are visible to queries that are started after -query Q, no matter whether they are started inside Q (during the execution -of Q) or after Q is done. -</Para> -</Sect1> - -<Sect1 id="spi-examples"> -<Title>Examples</Title> - -<Para> - This example of SPI usage demonstrates the visibility rule. - There are more complex examples in src/test/regress/regress.c and -in contrib/spi. -</Para> - -<Para> - This is a very simple example of SPI usage. The procedure execq accepts -an SQL-query in its first argument and tcount in its second, executes the -query using SPI_exec and returns the number of tuples for which the query -executed: - -<ProgramListing> -#include "executor/spi.h" /* this is what you need to work with SPI */ + the inserted rows are invisible to the <command>SELECT</command> + part. + </para> + </listitem> + + <listitem> + <para> + Changes made by a command C are visible to all commands that are + started after C, no matter whether they are started inside C + (during the execution of C) or after C is done. + </para> + </listitem> + </itemizedlist> + </para> + + <para> + The next section contains an example that illustrates the + application of these rules. + </para> + </sect1> + + <sect1 id="spi-examples"> + <title>Examples</title> + + <para> + This section contains a very simple example of SPI usage. The + procedure <function>execq</function> takes an SQL command as its + first argument and a row count as its second, executes the command + using <function>SPI_exec</function> and returns the number of rows + that were processed by the command. You can find more complex + examples for SPI in the source tree in + <filename>src/test/regress/regress.c</filename> and in + <filename>contrib/spi</filename>. + </para> + +<programlisting> +#include "executor/spi.h" int execq(text *sql, int cnt); int execq(text *sql, int cnt) { - char *query; + char *command; int ret; int proc; - /* Convert given TEXT object to a C string */ - query = DatumGetCString(DirectFunctionCall1(textout, - PointerGetDatum(sql))); + /* Convert given text object to a C string */ + command = DatumGetCString(DirectFunctionCall1(textout, + PointerGetDatum(sql))); SPI_connect(); - ret = SPI_exec(query, cnt); + ret = SPI_exec(command, cnt); proc = SPI_processed; /* - * If this is SELECT and some tuple(s) fetched - - * returns tuples to the caller via elog (INFO). + * If this is a SELECT and some rows were fetched, + * then the rows are printed via elog(INFO). */ - if ( ret == SPI_OK_SELECT && SPI_processed > 0 ) + if (ret == SPI_OK_SELECT && SPI_processed > 0) { TupleDesc tupdesc = SPI_tuptable->tupdesc; SPITupleTable *tuptable = SPI_tuptable; char buf[8192]; - int i,j; + int i, j; for (j = 0; j < proc; j++) { HeapTuple tuple = tuptable->vals[j]; for (i = 1, buf[0] = 0; i <= tupdesc->natts; i++) - snprintf(buf + strlen (buf), sizeof(buf) - strlen(buf)," %s%s", + snprintf(buf + strlen (buf), sizeof(buf) - strlen(buf), " %s%s", SPI_getvalue(tuple, tupdesc, i), (i == tupdesc->natts) ? " " : " |"); elog (INFO, "EXECQ: %s", buf); @@ -3823,99 +2464,105 @@ execq(text *sql, int cnt) } SPI_finish(); - - pfree(query); + pfree(command); return (proc); } -</ProgramListing> -</Para> +</programlisting> + + <para> + (This function uses call convention version 0, to make the example + easier to understand. In real applications you should user the new + version 1 interface.) + </para> -<Para> - Now, compile and create the function: + <para> + This is how you declare the function after having compiled it into + a shared library: -<ProgramListing> -CREATE FUNCTION execq (text, integer) RETURNS integer - AS '...path_to_so' +<programlisting> +CREATE FUNCTION execq(text, integer) RETURNS integer + AS '<replaceable>filename</replaceable>' LANGUAGE C; -</ProgramListing> +</programlisting> + </para> + + <para> + Here is a sample session: -<ProgramListing> -vac=> SELECT execq('CREATE TABLE a (x INTEGER)', 0); -execq ------ - 0 +<programlisting> +=> SELECT execq('CREATE TABLE a (x integer)', 0); + execq +------- + 0 (1 row) -vac=> INSERT INTO a VALUES (execq('INSERT INTO a VALUES (0)',0)); +=> INSERT INTO a VALUES (execq('INSERT INTO a VALUES (0)', 0)); INSERT 167631 1 -vac=> SELECT execq('SELECT * FROM a',0); -INFO: EXECQ: 0 <<< inserted by execq - -INFO: EXECQ: 1 <<< value returned by execq and inserted by upper INSERT +=> SELECT execq('SELECT * FROM a', 0); +INFO: EXECQ: 0 -- inserted by execq +INFO: EXECQ: 1 -- returned by execq and inserted by upper INSERT -execq ------ - 2 + execq +------- + 2 (1 row) -vac=> SELECT execq('INSERT INTO a SELECT x + 2 FROM a',1); -execq ------ - 1 +=> SELECT execq('INSERT INTO a SELECT x + 2 FROM a', 1); + execq +------- + 1 (1 row) -vac=> SELECT execq('SELECT * FROM a', 10); -INFO: EXECQ: 0 +=> SELECT execq('SELECT * FROM a', 10); +INFO: EXECQ: 0 +INFO: EXECQ: 1 +INFO: EXECQ: 2 -- 0 + 2, only one row inserted - as specified -INFO: EXECQ: 1 - -INFO: EXECQ: 2 <<< 0 + 2, only one tuple inserted - as specified - -execq ------ - 3 <<< 10 is max value only, 3 is real # of tuples + execq +------- + 3 -- 10 is the max value only, 3 is the real number of rows (1 row) -vac=> DELETE FROM a; +=> DELETE FROM a; DELETE 3 -vac=> INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1); +=> INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1); INSERT 167712 1 -vac=> SELECT * FROM a; -x -- -1 <<< no tuples in a (0) + 1 +=> SELECT * FROM a; + x +--- + 1 -- no rows in a (0) + 1 (1 row) -vac=> INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1); -INFO: EXECQ: 0 +=> INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1); +INFO: EXECQ: 0 INSERT 167713 1 -vac=> SELECT * FROM a; -x -- -1 -2 <<< there was single tuple in a + 1 +=> SELECT * FROM a; + x +--- + 1 + 2 -- there was one row in a + 1 (2 rows) --- This demonstrates data changes visibility rule: +-- This demonstrates the data changes visibility rule: -vac=> INSERT INTO a SELECT execq('SELECT * FROM a', 0) * x FROM a; -INFO: EXECQ: 1 -INFO: EXECQ: 2 -INFO: EXECQ: 1 -INFO: EXECQ: 2 -INFO: EXECQ: 2 +=> INSERT INTO a SELECT execq('SELECT * FROM a', 0) * x FROM a; +INFO: EXECQ: 1 +INFO: EXECQ: 2 +INFO: EXECQ: 1 +INFO: EXECQ: 2 +INFO: EXECQ: 2 INSERT 0 2 -vac=> SELECT * FROM a; -x -- -1 -2 -2 <<< 2 tuples * 1 (x in first tuple) -6 <<< 3 tuples (2 + 1 just inserted) * 2 (x in second tuple) -(4 rows) ^^^^^^^^ - tuples visible to execq() in different invocations -</ProgramListing> -</Para> -</Sect1> -</Chapter> +=> SELECT * FROM a; + x +--- + 1 + 2 + 2 -- 2 rows * 1 (x in first row) + 6 -- 3 rows (2 + 1 just inserted) * 2 (x in second row) +(4 rows) ^^^^^^ + rows visible to execq() in different invocations +</programlisting> + </para> + </sect1> +</chapter> diff --git a/doc/src/sgml/syntax.sgml b/doc/src/sgml/syntax.sgml index 8151c63c8c3..774de140223 100644 --- a/doc/src/sgml/syntax.sgml +++ b/doc/src/sgml/syntax.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/syntax.sgml,v 1.82 2003/08/14 23:13:27 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/syntax.sgml,v 1.82.2.1 2003/09/07 04:36:44 momjian Exp $ --> <chapter id="sql-syntax"> @@ -26,6 +26,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/syntax.sgml,v 1.82 2003/08/14 23:13:27 tgl <sect1 id="sql-syntax-lexical"> <title>Lexical Structure</title> + <indexterm> + <primary>token</primary> + </indexterm> + <para> SQL input consists of a sequence of <firstterm>commands</firstterm>. A command is composed of a @@ -80,12 +84,18 @@ INSERT INTO MY_TABLE VALUES (3, 'hi there'); <title>Identifiers and Key Words</title> <indexterm zone="sql-syntax-identifiers"> - <primary>identifiers</primary> + <primary>identifier</primary> + <secondary>syntax of</secondary> </indexterm> <indexterm zone="sql-syntax-identifiers"> - <primary>key words</primary> - <secondary>syntax</secondary> + <primary>name</primary> + <secondary>syntax of</secondary> + </indexterm> + + <indexterm zone="sql-syntax-identifiers"> + <primary>key word</primary> + <secondary>syntax of</secondary> </indexterm> <para> @@ -121,6 +131,7 @@ INSERT INTO MY_TABLE VALUES (3, 'hi there'); </para> <para> + <indexterm><primary>identifier</primary><secondary>length</secondary></indexterm> The system uses no more than <symbol>NAMEDATALEN</symbol>-1 characters of an identifier; longer names can be written in commands, but they will be truncated. By default, @@ -133,7 +144,7 @@ INSERT INTO MY_TABLE VALUES (3, 'hi there'); <para> <indexterm> <primary>case sensitivity</primary> - <secondary>SQL commands</secondary> + <secondary>of SQL commands</secondary> </indexterm> Identifier and key word names are case insensitive. Therefore <programlisting> @@ -152,7 +163,7 @@ UPDATE my_table SET a = 5; <para> <indexterm> - <primary>quotes</primary> + <primary>quotation marks</primary> <secondary>and identifiers</secondary> </indexterm> There is a second kind of identifier: the <firstterm>delimited @@ -207,7 +218,7 @@ UPDATE "my_table" SET "a" = 5; <title>Constants</title> <indexterm zone="sql-syntax-constants"> - <primary>constants</primary> + <primary>constant</primary> </indexterm> <para> @@ -224,13 +235,13 @@ UPDATE "my_table" SET "a" = 5; <title>String Constants</title> <indexterm zone="sql-syntax-strings"> - <primary>character strings</primary> - <secondary>constants</secondary> + <primary>character string</primary> + <secondary>constant</secondary> </indexterm> <para> <indexterm> - <primary>quotes</primary> + <primary>quotation marks</primary> <secondary>escaping</secondary> </indexterm> A string constant in SQL is an arbitrary sequence of characters @@ -286,8 +297,8 @@ SELECT 'foo' 'bar'; <title>Bit-String Constants</title> <indexterm zone="sql-syntax-bit-strings"> - <primary>bit strings</primary> - <secondary>constants</secondary> + <primary>bit string</primary> + <secondary>constant</secondary> </indexterm> <para> @@ -316,8 +327,8 @@ SELECT 'foo' 'bar'; <title>Numeric Constants</title> <indexterm> - <primary>numeric</primary> - <secondary>constants</secondary> + <primary>number</primary> + <secondary>constant</secondary> </indexterm> <para> @@ -351,6 +362,9 @@ SELECT 'foo' 'bar'; </para> <para> + <indexterm><primary>integer</primary></indexterm> + <indexterm><primary>bigint</primary></indexterm> + <indexterm><primary>numeric</primary></indexterm> A numeric constant that contains neither a decimal point nor an exponent is initially presumed to be type <type>integer</> if its value fits in type <type>integer</> (32 bits); otherwise it is @@ -363,13 +377,13 @@ SELECT 'foo' 'bar'; <para> The initially assigned data type of a numeric constant is just a - starting point for the type resolution algorithms. In most - cases the constant will be automatically coerced to the most - appropriate type depending on context. When necessary, you - can force a numeric value to be interpreted as a specific - data type by casting it. For example, you can force a numeric - value to be treated as type <type>real</> (<type>float4</>) - by writing + starting point for the type resolution algorithms. In most cases + the constant will be automatically coerced to the most + appropriate type depending on context. When necessary, you can + force a numeric value to be interpreted as a specific data type + by casting it.<indexterm><primary>type cast</primary></indexterm> + For example, you can force a numeric value to be treated as type + <type>real</> (<type>float4</>) by writing <programlisting> REAL '1.23' -- string style @@ -382,8 +396,8 @@ REAL '1.23' -- string style <title>Constants of Other Types</title> <indexterm> - <primary>data types</primary> - <secondary>constants</secondary> + <primary>data type</primary> + <secondary>constant</secondary> </indexterm> <para> @@ -431,8 +445,8 @@ CAST ( '<replaceable>string</replaceable>' AS <replaceable>type</replaceable> ) <title>Array constants</title> <indexterm> - <primary>arrays</primary> - <secondary>constants</secondary> + <primary>array</primary> + <secondary>constant</secondary> </indexterm> <para> @@ -468,7 +482,7 @@ CAST ( '<replaceable>string</replaceable>' AS <replaceable>type</replaceable> ) <title>Operators</title> <indexterm zone="sql-syntax-operators"> - <primary>operators</primary> + <primary>operator</primary> <secondary>syntax</secondary> </indexterm> @@ -600,8 +614,8 @@ CAST ( '<replaceable>string</replaceable>' AS <replaceable>type</replaceable> ) <title>Comments</title> <indexterm zone="sql-syntax-comments"> - <primary>comments</primary> - <secondary>in SQL</secondary> + <primary>comment</primary> + <secondary sortas="SQL">in SQL</secondary> </indexterm> <para> @@ -636,7 +650,7 @@ CAST ( '<replaceable>string</replaceable>' AS <replaceable>type</replaceable> ) <title>Lexical Precedence</title> <indexterm zone="sql-precedence"> - <primary>operators</primary> + <primary>operator</primary> <secondary>precedence</secondary> </indexterm> @@ -828,6 +842,20 @@ SELECT 3 OPERATOR(pg_catalog.+) 4; <sect1 id="sql-expressions"> <title>Value Expressions</title> + <indexterm zone="sql-expressions"> + <primary>expression</primary> + <secondary>syntax</secondary> + </indexterm> + + <indexterm zone="sql-expressions"> + <primary>value expression</primary> + </indexterm> + + <indexterm> + <primary>scalar</primary> + <see>expression</see> + </indexterm> + <para> Value expressions are used in a variety of contexts, such as in the target list of the <command>SELECT</command> command, as @@ -903,7 +931,9 @@ SELECT 3 OPERATOR(pg_catalog.+) 4; <listitem> <para> - Another value expression in parentheses, useful to group subexpressions and override precedence. + Another value expression in parentheses, useful to group + subexpressions and override + precedence.<indexterm><primary>parenthesis</></> </para> </listitem> </itemizedlist> @@ -927,6 +957,10 @@ SELECT 3 OPERATOR(pg_catalog.+) 4; <sect2> <title>Column References</title> + <indexterm> + <primary>column reference</primary> + </indexterm> + <para> A column can be referenced in the form <synopsis> @@ -962,6 +996,15 @@ SELECT 3 OPERATOR(pg_catalog.+) 4; <sect2> <title>Positional Parameters</title> + <indexterm> + <primary>parameter</primary> + <secondary>syntax</secondary> + </indexterm> + + <indexterm> + <primary>$</primary> + </indexterm> + <para> A positional parameter reference is used to indicate a value that is supplied externally to an SQL statement. Parameters are @@ -993,6 +1036,11 @@ CREATE FUNCTION dept(text) RETURNS dept <sect2> <title>Operator Invocations</title> + <indexterm> + <primary>operator</primary> + <secondary>invocation</secondary> + </indexterm> + <para> There are three possible syntaxes for an operator invocation: <simplelist> @@ -1017,6 +1065,11 @@ CREATE FUNCTION dept(text) RETURNS dept <sect2> <title>Function Calls</title> + <indexterm> + <primary>function</primary> + <secondary>invocation</secondary> + </indexterm> + <para> The syntax for a function call is the name of a function (possibly qualified with a schema name), followed by its argument list @@ -1044,7 +1097,8 @@ sqrt(2) <title>Aggregate Expressions</title> <indexterm zone="syntax-aggregates"> - <primary>aggregate functions</primary> + <primary>aggregate function</primary> + <secondary>invocation</secondary> </indexterm> <para> @@ -1123,10 +1177,14 @@ sqrt(2) <sect2 id="sql-syntax-type-casts"> <title>Type Casts</title> - <indexterm> - <primary>data types</primary> - <secondary>type casts</secondary> - </indexterm> + <indexterm> + <primary>data type</primary> + <secondary>type cast</secondary> + </indexterm> + + <indexterm> + <primary>type cast</primary> + </indexterm> <para> A type cast specifies a conversion from one data type to another. @@ -1193,6 +1251,10 @@ CAST ( <replaceable>expression</replaceable> AS <replaceable>type</replaceable> <sect2 id="sql-syntax-scalar-subqueries"> <title>Scalar Subqueries</title> + <indexterm> + <primary>subquery</primary> + </indexterm> + <para> A scalar subquery is an ordinary <command>SELECT</command> query in parentheses that returns exactly one @@ -1221,10 +1283,10 @@ SELECT name, (SELECT max(pop) FROM cities WHERE cities.state = states.name) <sect2 id="sql-syntax-array-constructors"> <title>Array Constructors</title> - <indexterm> - <primary>arrays</primary> - <secondary>constructors</secondary> - </indexterm> + <indexterm> + <primary>array</primary> + <secondary>constructor</secondary> + </indexterm> <para> An <firstterm>array constructor</> is an expression that builds an @@ -1271,6 +1333,23 @@ SELECT ARRAY[[1,2],[3,4]]; </para> <para> + Multidimensional array constructor elements can be anything yielding + an array of the proper kind, not only a sub-<literal>ARRAY</> construct. + For example: +<programlisting> +create table arr(f1 int[], f2 int[]); +CREATE TABLE +insert into arr values (ARRAY[[1,2],[3,4]],ARRAY[[5,6],[7,8]]); +INSERT 2635544 1 +select ARRAY[f1, f2, '{{9,10},{11,12}}'::int[]] from arr; + array +------------------------------------------------ + {{{1,2},{3,4}},{{5,6},{7,8}},{{9,10},{11,12}}} +(1 row) +</programlisting> + </para> + + <para> It is also possible to construct an array from the results of a subquery. In this form, the array constructor is written with the keyword <literal>ARRAY</literal> followed by a parenthesized (not @@ -1299,6 +1378,11 @@ SELECT ARRAY(SELECT oid FROM pg_proc WHERE proname LIKE 'bytea%'); <sect2 id="syntax-express-eval"> <title>Expression Evaluation Rules</title> + <indexterm> + <primary>expression</primary> + <secondary>order of evaluation</secondary> + </indexterm> + <para> The order of evaluation of subexpressions is not defined. In particular, the inputs of an operator or function are not necessarily diff --git a/doc/src/sgml/trigger.sgml b/doc/src/sgml/trigger.sgml index d9ee33a2963..c3cc7fe020d 100644 --- a/doc/src/sgml/trigger.sgml +++ b/doc/src/sgml/trigger.sgml @@ -1,10 +1,14 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/trigger.sgml,v 1.29 2003/08/10 01:20:34 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/trigger.sgml,v 1.29.2.1 2003/09/07 04:36:44 momjian Exp $ --> <chapter id="triggers"> <title>Triggers</title> + <indexterm zone="triggers"> + <primary>trigger</primary> + </indexterm> + <para> This chapter describes how to write trigger functions. In particular, it describes the C-language interface for trigger @@ -98,18 +102,20 @@ $Header: /cvsroot/pgsql/doc/src/sgml/trigger.sgml,v 1.29 2003/08/10 01:20:34 tgl <para> When a trigger is being defined, arguments can be specified for - it. The purpose of including arguments in the trigger definition - is to allow different triggers with similar requirements to call - the same function. As an example, there could be a generalized - trigger function that takes as its arguments two column names and - puts the current user in one and the current time stamp in the - other. Properly written, this trigger function would be - independent of the specific table it is triggering on. So the - same function could be used for <command>INSERT</command> events - on any table with suitable columns, to automatically track creation - of records in a transaction table for example. It could also be - used to track last-update events if defined as an - <command>UPDATE</command> trigger. + it.<indexterm><primary>trigger</><secondary>arguments for trigger + functions</></indexterm> The purpose of including arguments in the + trigger definition is to allow different triggers with similar + requirements to call the same function. As an example, there + could be a generalized trigger function that takes as its + arguments two column names and puts the current user in one and + the current time stamp in the other. Properly written, this + trigger function would be independent of the specific table it is + triggering on. So the same function could be used for + <command>INSERT</command> events on any table with suitable + columns, to automatically track creation of records in a + transaction table for example. It could also be used to track + last-update events if defined as an <command>UPDATE</command> + trigger. </para> </sect1> @@ -117,6 +123,11 @@ $Header: /cvsroot/pgsql/doc/src/sgml/trigger.sgml,v 1.29 2003/08/10 01:20:34 tgl <sect1 id="trigger-manager"> <title>Interaction with the Trigger Manager</title> + <indexterm zone="trigger-manager"> + <primary>trigger</primary> + <secondary>in C</secondary> + </indexterm> + <para> This section describes the low-level details of the interface to a trigger function. This information is only needed when writing a diff --git a/doc/src/sgml/typeconv.sgml b/doc/src/sgml/typeconv.sgml index 18bad527ff7..82c8fa6a6a0 100644 --- a/doc/src/sgml/typeconv.sgml +++ b/doc/src/sgml/typeconv.sgml @@ -1,10 +1,15 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/typeconv.sgml,v 1.32 2003/08/14 23:13:27 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/typeconv.sgml,v 1.32.2.1 2003/09/07 04:36:44 momjian Exp $ --> <chapter Id="typeconv"> <title>Type Conversion</title> +<indexterm zone="typeconv"> + <primary>data type</primary> + <secondary>conversion</secondary> +</indexterm> + <para> <acronym>SQL</acronym> statements can, intentionally or not, require mixing of different data types in the same expression. @@ -139,6 +144,11 @@ between the built-in types has been carefully crafted and is best not altered.) </para> +<indexterm> + <primary>data type</primary> + <secondary>category</secondary> +</indexterm> + <para> An additional heuristic is provided in the parser to allow better guesses at proper behavior for <acronym>SQL</acronym> standard types. There are @@ -204,6 +214,11 @@ should use this new function and will no longer do the implicit conversion using <sect1 id="typeconv-oper"> <title>Operators</title> +<indexterm zone="typeconv-oper"> + <primary>operator</primary> + <secondary>type resolution in an invocation</secondary> +</indexterm> + <para> The specific operator to be used in an operator invocation is determined by following @@ -452,6 +467,11 @@ SELECT CAST('20' AS int8) ! AS "factorial"; <sect1 id="typeconv-func"> <title>Functions</title> +<indexterm zone="typeconv-func"> + <primary>function</primary> + <secondary>type resolution in an invocation</secondary> +</indexterm> + <para> The specific function to be used in a function invocation is determined according to the following steps. @@ -755,8 +775,22 @@ padding spaces. </sect1> <sect1 id="typeconv-union-case"> -<title><literal>UNION</literal>, <literal>CASE</literal>, and -<literal>ARRAY</literal> Constructs</title> +<title><literal>UNION</literal>, <literal>CASE</literal>, and <literal>ARRAY</literal> Constructs</title> + +<indexterm zone="typeconv-union-case"> + <primary>UNION</primary> + <secondary>determination of result type</secondary> +</indexterm> + +<indexterm zone="typeconv-union-case"> + <primary>CASE</primary> + <secondary>determination of result type</secondary> +</indexterm> + +<indexterm zone="typeconv-union-case"> + <primary>ARRAY</primary> + <secondary>determination of result type</secondary> +</indexterm> <para> SQL <literal>UNION</> constructs must match up possibly dissimilar types to diff --git a/doc/src/sgml/user-manag.sgml b/doc/src/sgml/user-manag.sgml index 660d1ccd75d..82481084ee2 100644 --- a/doc/src/sgml/user-manag.sgml +++ b/doc/src/sgml/user-manag.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/user-manag.sgml,v 1.21 2003/08/10 01:20:34 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/user-manag.sgml,v 1.21.2.1 2003/09/07 04:36:44 momjian Exp $ --> <chapter id="user-manag"> @@ -22,6 +22,18 @@ $Header: /cvsroot/pgsql/doc/src/sgml/user-manag.sgml,v 1.21 2003/08/10 01:20:34 <sect1 id="database-users"> <title>Database Users</title> + <indexterm zone="database-users"> + <primary>user</primary> + </indexterm> + + <indexterm> + <primary>CREATE USER</primary> + </indexterm> + + <indexterm> + <primary>DROP USER</primary> + </indexterm> + <para> Database users are conceptually completely separate from operating system users. In practice it might be convenient to @@ -41,6 +53,14 @@ DROP USER <replaceable>name</replaceable>; </synopsis> </para> + <indexterm> + <primary>createuser</primary> + </indexterm> + + <indexterm> + <primary>dropuser</primary> + </indexterm> + <para> For convenience, the programs <command>createuser</command> and <command>dropuser</command> are provided as wrappers @@ -99,7 +119,7 @@ dropuser <replaceable>name</replaceable> <variablelist> <varlistentry> - <term>superuser</term> + <term>superuser<indexterm><primary>superuser</></></term> <listitem> <para> A database superuser bypasses all permission checks. Also, @@ -111,7 +131,7 @@ dropuser <replaceable>name</replaceable> </varlistentry> <varlistentry> - <term>database creation</term> + <term>database creation<indexterm><primary>database</><secondary>privilege to create</></></term> <listitem> <para> A user must be explicitly given permission to create databases @@ -123,7 +143,7 @@ dropuser <replaceable>name</replaceable> </varlistentry> <varlistentry> - <term>password</term> + <term>password<indexterm><primary>password</></></term> <listitem> <para> A password is only significant if the client authentication @@ -140,7 +160,7 @@ dropuser <replaceable>name</replaceable> </variablelist> A user's attributes can be modified after creation with - <command>ALTER USER</command>. + <command>ALTER USER</command>.<indexterm><primary>ALTER USER</></> See the reference pages for <command>CREATE USER</command> and <command>ALTER USER</command> for details. </para> @@ -166,6 +186,10 @@ ALTER USER myname SET enable_indexscan TO off; <sect1 id="groups"> <title>Groups</title> + <indexterm zone="groups"> + <primary>group</primary> + </indexterm> + <para> As in Unix, groups are a way of logically grouping users to ease management of privileges: privileges can be granted to, or revoked @@ -184,6 +208,22 @@ ALTER GROUP <replaceable>name</replaceable> DROP USER <replaceable>uname1</repla <sect1 id="privileges"> <title>Privileges</title> + <indexterm zone="privileges"> + <primary>privilege</primary> + </indexterm> + + <indexterm zone="privileges"> + <primary>owner</primary> + </indexterm> + + <indexterm zone="privileges"> + <primary>GRANT</primary> + </indexterm> + + <indexterm zone="privileges"> + <primary>REVOKE</primary> + </indexterm> + <comment>Being moved to the DDL chapter. Will eventually disappear here.</comment> <para> diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index 279364a65d8..8a957b546e8 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -1,8 +1,17 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/wal.sgml,v 1.23 2003/03/24 14:32:51 petere Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/wal.sgml,v 1.23.2.1 2003/09/07 04:36:44 momjian Exp $ --> <chapter id="wal"> <title>Write-Ahead Logging (<acronym>WAL</acronym>)</title> + <indexterm zone="wal"> + <primary>WAL</primary> + </indexterm> + + <indexterm> + <primary>transaction log</primary> + <see>WAL</see> + </indexterm> + <para> <firstterm>Write-Ahead Logging</firstterm> (<acronym>WAL</acronym>) is a standard approach to transaction logging. Its detailed @@ -24,6 +33,10 @@ <sect1 id="wal-benefits-now"> <title>Benefits of <acronym>WAL</acronym></title> + <indexterm zone="wal-benefits-now"> + <primary>fsync</primary> + </indexterm> + <para> The first obvious benefit of using <acronym>WAL</acronym> is a significantly reduced number of disk writes, since only the log @@ -86,7 +99,7 @@ <para> With UNDO, it will also be possible to implement - <firstterm>savepoints</firstterm> to allow partial rollback of + <firstterm>savepoints</firstterm><indexterm><primary>savepoint</></> to allow partial rollback of invalid transaction operations (parser errors caused by mistyping commands, insertion of duplicate primary/unique keys and so on) with the ability to continue or commit valid operations made by @@ -133,7 +146,7 @@ </para> <para> - <firstterm>Checkpoints</firstterm> are points in the sequence of + <firstterm>Checkpoints</firstterm><indexterm><primary>checkpoint</></> are points in the sequence of transactions at which it is guaranteed that the data files have been updated with all information logged before the checkpoint. At checkpoint time, all dirty data pages are flushed to disk and a @@ -301,7 +314,7 @@ <para> The aim of <acronym>WAL</acronym>, to ensure that the log is written before database records are altered, may be subverted by - disk drives that falsely report a successful write to the kernel, + disk drives<indexterm><primary>disk drive</></> that falsely report a successful write to the kernel, when, in fact, they have only cached the data and not yet stored it on the disk. A power failure in such a situation may still lead to irrecoverable data corruption. Administrators should try to ensure diff --git a/doc/src/sgml/xaggr.sgml b/doc/src/sgml/xaggr.sgml index 7b82af322ea..cb6f0b58f15 100644 --- a/doc/src/sgml/xaggr.sgml +++ b/doc/src/sgml/xaggr.sgml @@ -1,13 +1,13 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/xaggr.sgml,v 1.21 2003/08/09 22:50:22 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/xaggr.sgml,v 1.21.2.1 2003/09/07 04:36:44 momjian Exp $ --> <sect1 id="xaggr"> <title>User-Defined Aggregates</title> <indexterm zone="xaggr"> - <primary>aggregate functions</primary> - <secondary>extending</secondary> + <primary>aggregate function</primary> + <secondary>user-defined</secondary> </indexterm> <para> @@ -115,7 +115,7 @@ CREATE AGGREGATE avg ( Aggregate functions may use polymorphic state transition functions or final functions, so that the same functions can be used to implement multiple aggregates. - See <xref linkend="types-polymorphic"> + See <xref linkend="extend-types-polymorphic"> for an explanation of polymorphic functions. Going a step further, the aggregate function itself may be specified with a polymorphic base type and state type, allowing a single diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index 0193691a08e..00fb6118329 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -1,11 +1,14 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/xfunc.sgml,v 1.72 2003/08/10 01:20:34 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/xfunc.sgml,v 1.72.2.1 2003/09/07 04:36:44 momjian Exp $ --> <sect1 id="xfunc"> <title>User-Defined Functions</title> - <indexterm zone="xfunc"><primary>function</></> + <indexterm zone="xfunc"> + <primary>function</primary> + <secondary>user-defined</secondary> + </indexterm> <para> <productname>PostgreSQL</productname> provides four kinds of @@ -70,7 +73,11 @@ $Header: /cvsroot/pgsql/doc/src/sgml/xfunc.sgml,v 1.72 2003/08/10 01:20:34 tgl E <sect1 id="xfunc-sql"> <title>Query Language (<acronym>SQL</acronym>) Functions</title> - <indexterm zone="xfunc-sql"><primary>function</><secondary>SQL</></> + <indexterm zone="xfunc-sql"> + <primary>function</primary> + <secondary>user-defined</secondary> + <tertiary>in SQL</tertiary> + </indexterm> <para> SQL functions execute an arbitrary list of SQL statements, returning @@ -84,12 +91,12 @@ $Header: /cvsroot/pgsql/doc/src/sgml/xfunc.sgml,v 1.72 2003/08/10 01:20:34 tgl E </para> <para> - <indexterm><primary>SETOF</><seealso>function</></> - Alternatively, an SQL function may be declared to return a set, - by specifying the function's return type - as <literal>SETOF <replaceable>sometype</></literal>. In this case - all rows of the last query's result are returned. Further details - appear below. + <indexterm><primary>SETOF</><seealso>function</></> Alternatively, + an SQL function may be declared to return a set, by specifying the + function's return type as <literal>SETOF + <replaceable>sometype</></literal>.<indexterm><primary>SETOF</></> + In this case all rows of the last query's result are returned. + Further details appear below. </para> <para> @@ -523,7 +530,7 @@ SELECT name, listchildren(name) FROM nodes; <acronym>SQL</acronym> functions may be declared to accept and return the <quote>polymorphic</> types <type>anyelement</type> and <type>anyarray</type>. - See <xref linkend="types-polymorphic"> for a more detailed explanation + See <xref linkend="extend-types-polymorphic"> for a more detailed explanation of polymorphic functions. Here is a polymorphic function <function>make_array</function> that builds up an array from two arbitrary data type elements: @@ -644,6 +651,12 @@ CREATE FUNCTION square_root(double precision) RETURNS double precision <sect1 id="xfunc-c"> <title>C-Language Functions</title> + <indexterm zone="xfunc-sql"> + <primary>function</primary> + <secondary>user-defined</secondary> + <tertiary>in C</tertiary> + </indexterm> + <para> User-defined functions can be written in C (or a language that can be made compatible with C, such as C++). Such functions are @@ -670,6 +683,10 @@ CREATE FUNCTION square_root(double precision) RETURNS double precision <sect2 id="xfunc-c-dynload"> <title>Dynamic Loading</title> + <indexterm zone="xfunc-c-dynload"> + <primary>dynamic loading</primary> + </indexterm> + <para> The first time a user-defined function in a particular loadable object file is called in a session, @@ -787,9 +804,14 @@ CREATE FUNCTION square_root(double precision) RETURNS double precision </sect2> - <sect2> + <sect2 id="xfunc-c-basetype"> <title>Base Types in C-Language Functions</title> + <indexterm zone="xfunc-c-basetype"> + <primary>data type</primary> + <secondary>internal organisation</secondary> + </indexterm> + <para> To know how to write C-language functions, you need to know how PostgreSQL internally represents base data types and how they can @@ -1479,7 +1501,7 @@ concat_text(PG_FUNCTION_ARGS) <listitem> <para> Use <literal>pg_config - --includedir-server</literal><indexterm><primary>pg_config</></> + --includedir-server</literal><indexterm><primary>pg_config</><secondary>with user-defined C functions</></> to find out where the <productname>PostgreSQL</> server header files are installed on your system (or the system that your users will be running on). This option is new with @@ -1498,7 +1520,7 @@ concat_text(PG_FUNCTION_ARGS) <para> When allocating memory, use the <productname>PostgreSQL</productname> functions - <function>palloc</function> and <function>pfree</function> + <function>palloc</function><indexterm><primary>palloc</></> and <function>pfree</function><indexterm><primary>pfree</></> instead of the corresponding C library functions <function>malloc</function> and <function>free</function>. The memory allocated by <function>palloc</function> will be @@ -2075,7 +2097,7 @@ CREATE OR REPLACE FUNCTION testpassbyval(integer, integer) RETURNS SETOF __testp C-language functions may be declared to accept and return the <quote>polymorphic</> types <type>anyelement</type> and <type>anyarray</type>. - See <xref linkend="types-polymorphic"> for a more detailed explanation + See <xref linkend="extend-types-polymorphic"> for a more detailed explanation of polymorphic functions. When function arguments or return types are defined as polymorphic types, the function author cannot know in advance what data type it will be called with, or @@ -2155,7 +2177,10 @@ CREATE FUNCTION make_array(anyelement) <sect1 id="xfunc-overload"> <title>Function Overloading</title> - <indexterm zone="xfunc-overload"><primary>overloading</></> + <indexterm zone="xfunc-overload"> + <primary>overloading</primary> + <secondary>functions</secondary> + </indexterm> <para> More than one function may be defined with the same SQL name, so long @@ -2216,6 +2241,11 @@ CREATE FUNCTION test(int, int) RETURNS int <sect1 id="xfunc-plhandler"> <title>Procedural Language Handlers</title> + <indexterm zone="xfunc-plhandler"> + <primary>procedural language</primary> + <secondary>handler for</secondary> + </indexterm> + <para> All calls to functions that are written in a language other than the current <quote>version 1</quote> interface for compiled diff --git a/doc/src/sgml/xindex.sgml b/doc/src/sgml/xindex.sgml index 6416183c95a..b0b870bcb44 100644 --- a/doc/src/sgml/xindex.sgml +++ b/doc/src/sgml/xindex.sgml @@ -1,10 +1,15 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/xindex.sgml,v 1.30 2003/04/13 09:57:35 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/xindex.sgml,v 1.30.2.1 2003/09/07 04:36:44 momjian Exp $ --> <sect1 id="xindex"> <title>Interfacing Extensions To Indexes</title> + <indexterm zone="xindex"> + <primary>index</primary> + <secondary>for user-defined data type</secondary> + </indexterm> + <para> The procedures described thus far let you define new types, new functions, and new operators. However, we cannot yet define an @@ -43,15 +48,18 @@ $Header: /cvsroot/pgsql/doc/src/sgml/xindex.sgml,v 1.30 2003/04/13 09:57:35 pete <para> The routines for an index method do not directly know anything - about the data types that the index method will operate on. Instead, an - <firstterm>operator class</> identifies the set of operations that the - index method needs to use to work with a particular data type. - Operator classes are so called because one thing they specify is the set - of <literal>WHERE</>-clause operators that can be used with an index (i.e., can be - converted into an index-scan qualification). An operator class may also - specify some <firstterm>support procedures</> that are needed by the - internal operations of the index method, but do not directly - correspond to any <literal>WHERE</>-clause operator that can be used with the index. + about the data types that the index method will operate on. + Instead, an <firstterm>operator + class</><indexterm><primary>operator class</></indexterm> + identifies the set of operations that the index method needs to use + to work with a particular data type. Operator classes are so + called because one thing they specify is the set of + <literal>WHERE</>-clause operators that can be used with an index + (i.e., can be converted into an index-scan qualification). An + operator class may also specify some <firstterm>support + procedures</> that are needed by the internal operations of the + index method, but do not directly correspond to any + <literal>WHERE</>-clause operator that can be used with the index. </para> <para> @@ -452,7 +460,7 @@ CREATE OPERATOR = ( </programlisting> It is important to specify the restriction and join selectivity functions, otherwise the optimizer will be unable to make effective - use of the index. Note that there less-than, equal, and + use of the index. Note that the less-than, equal, and greater-than cases should use different selectivity functions. </para> @@ -551,13 +559,68 @@ CREATE OPERATOR CLASS complex_abs_ops </para> </sect2> + <sect2 id="xindex-opclass-dependencies"> + <title>System Dependencies on Operator Classes</title> + + <indexterm> + <primary>ordering operator</primary> + </indexterm> + + <para> + <productname>PostgreSQL</productname> uses operator classes to infer the + properties of operators in more ways than just whether they can be used + with indexes. Therefore, you might want to create operator classes + even if you have no intention of indexing any columns of your datatype. + </para> + + <para> + In particular, there are SQL features such as <literal>ORDER BY</> and + <literal>DISTINCT</> that require comparison and sorting of values. + To implement these features on a user-defined datatype, + <productname>PostgreSQL</productname> looks for the default B-tree operator + class for the datatype. The <quote>equals</> member of this operator + class defines the system's notion of equality of values for + <literal>GROUP BY</> and <literal>DISTINCT</>, and the sort ordering + imposed by the operator class defines the default <literal>ORDER BY</> + ordering. + </para> + + <para> + Comparison of arrays of user-defined types also relies on the semantics + defined by the default B-tree operator class. + </para> + + <para> + If there is no default B-tree operator class for a datatype, the system + will look for a default hash operator class. But since that kind of + operator class only provides equality, in practice it is only enough + to support array equality. + </para> + + <para> + When there is no default operator class for a datatype, you will get + errors like <quote>could not identify an ordering operator</> if you + try to use these SQL features with the datatype. + </para> + + <note> + <para> + In <ProductName>PostgreSQL</ProductName> versions before 7.4, + sorting and grouping operations would implicitly use operators named + <literal>=</>, <literal><</>, and <literal>></>. The new + behavior of relying on default operator classes avoids having to make + any assumption about the behavior of operators with particular names. + </para> + </note> + </sect2> + <sect2 id="xindex-opclass-features"> <title>Special Features of Operator Classes</title> <para> There are two special features of operator classes that we have - not discussed yet, mainly because they are not very useful - with the default B-tree index method. + not discussed yet, mainly because they are not useful + with the most commonly used index methods. </para> <para> diff --git a/doc/src/sgml/xoper.sgml b/doc/src/sgml/xoper.sgml index a2705eb6636..bb04e2854d1 100644 --- a/doc/src/sgml/xoper.sgml +++ b/doc/src/sgml/xoper.sgml @@ -1,10 +1,15 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/xoper.sgml,v 1.24 2003/06/22 22:04:54 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/xoper.sgml,v 1.24.2.1 2003/09/07 04:36:44 momjian Exp $ --> <sect1 id="xoper"> <title>User-defined Operators</title> + <indexterm zone="xoper"> + <primary>operator</primary> + <secondary>user-defined</secondary> + </indexterm> + <Para> Every operator is <quote>syntactic sugar</quote> for a call to an underlying function that does the real work; so you must @@ -18,9 +23,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/xoper.sgml,v 1.24 2003/06/22 22:04:54 tgl E <Para> <productname>PostgreSQL</productname> supports left unary, right - unary, and binary operators. Operators can be overloaded; that is, - the same operator name can be used for different operators that - have different numbers and types of operands. When a query is + unary, and binary operators. Operators can be + overloaded;<indexterm><primary>overloading</primary><secondary>operators</secondary></indexterm> + that is, the same operator name can be used for different operators + that have different numbers and types of operands. When a query is executed, the system determines the operator to call from the number and types of the provided operands. </Para> @@ -473,17 +479,6 @@ table1.column1 OP table2.column2 <note> <para> - <literal>GROUP BY</> and <literal>DISTINCT</> operations require each - datatype being grouped or compared to have a mergejoinable - equality operator named <literal>=</>. The equality operator and its - associated <literal>SORT1</> operator are used to implement these - operations. Also, the associated <literal>SORT1</> operator is the - default ordering operator for <literal>ORDER BY</>. - </para> - </note> - - <note> - <para> In <ProductName>PostgreSQL</ProductName> versions before 7.3, the <literal>MERGES</> shorthand was not available: to make a merge-joinable operator one had to write both <literal>SORT1</> and diff --git a/doc/src/sgml/xplang.sgml b/doc/src/sgml/xplang.sgml index d350ba25ea8..b0b1622fa9a 100644 --- a/doc/src/sgml/xplang.sgml +++ b/doc/src/sgml/xplang.sgml @@ -1,10 +1,14 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/xplang.sgml,v 1.22 2003/06/30 18:31:42 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/xplang.sgml,v 1.22.2.1 2003/09/07 04:36:44 momjian Exp $ --> <chapter id="xplang"> <title id="xplang-title">Procedural Languages</title> + <indexterm zone="xplang"> + <primary>procedural language</primary> + </indexterm> + <para> <productname>PostgreSQL</productname> allows users to add new programming languages to be available for writing functions and diff --git a/doc/src/sgml/xtypes.sgml b/doc/src/sgml/xtypes.sgml index 74ced8cd83e..2816f59baf8 100644 --- a/doc/src/sgml/xtypes.sgml +++ b/doc/src/sgml/xtypes.sgml @@ -1,13 +1,13 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/xtypes.sgml,v 1.19 2003/08/10 01:20:34 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/xtypes.sgml,v 1.19.2.1 2003/09/07 04:36:44 momjian Exp $ --> <sect1 id="xtypes"> <title>User-Defined Types</title> <indexterm zone="xtypes"> - <primary>data types</primary> - <secondary>extending</secondary> + <primary>data type</primary> + <secondary>user-defined</secondary> </indexterm> <comment> @@ -34,13 +34,17 @@ $Header: /cvsroot/pgsql/doc/src/sgml/xtypes.sgml,v 1.19 2003/08/10 01:20:34 tgl <indexterm> <primary>output function</primary> </indexterm> - A user-defined type must always have input and output functions. + A user-defined type must always have input and output + functions.<indexterm><primary>input function</primary><secondary>of + a data type</secondary></indexterm><indexterm><primary>output + function</primary><secondary>of a data type</secondary></indexterm> These functions determine how the type appears in strings (for input by the user and output to the user) and how the type is organized in memory. The input function takes a null-terminated character string - as its argument and returns the internal (in memory) representation of - the type. The output function takes the internal representation of - the type as argument and returns a null-terminated character string. + as its argument and returns the internal (in memory) representation + of the type. The output function takes the internal representation + of the type as argument and returns a null-terminated character + string. </para> <para> |