vague cross-references with real links.
# Postgres documentation makefile
-# $Header: /cvsroot/pgsql/doc/src/Makefile,v 1.30 2002/11/30 00:22:39 tgl Exp $
+# $Header: /cvsroot/pgsql/doc/src/Makefile,v 1.31 2003/03/25 16:15:35 petere Exp $
subdir = doc/src
top_builddir = ../..
include $(top_builddir)/src/Makefile.global
-ZIPSUFFIX= gz
-
-BOOKS = admin developer reference programmer tutorial user postgres
-
-TARGETS= $(BOOKS:%=%.tar.$(ZIPSUFFIX))
-
-.PRECIOUS:
-.PHONY: install all sources clean distclean maintainer-clean
-
-install: all
- cp -f *.$(ZIPSUFFIX) ..
-
clean distclean maintainer-clean:
- rm -f *.tar *.$(ZIPSUFFIX)
+ rm -f *.tar *.gz
$(MAKE) -C sgml $@
-all: $(TARGETS)
-
-sources:
- $(MAKE) sources.tar.$(ZIPSUFFIX)
-
-sources.tar:
- $(TAR) -cf $@ sgml graphics
-
# Build twice to resolve index entries
-$(addsuffix .tar, $(BOOKS)):
+postgres.tar:
$(MAKE) -C sgml clean
- $(MAKE) -C sgml $(basename $@).html
- $(MAKE) -C sgml $(basename $@).html JADEFLAGS='-V html-manifest'
+ $(MAKE) -C sgml html
+ $(MAKE) -C sgml html JADEFLAGS='-V html-manifest'
cd sgml && $(TAR) -cf ../$@ `cat HTML.manifest` `echo *.gif | grep -v '\*'` *.css
man.tar:
#----------------------------------------------------------------------------
#
-# Makefile
-# Postgres documentation makefile
-# Thomas Lockhart
+# PostgreSQL documentation makefile
#
-# Copyright (c) 1994, Regents of the University of California
-#
-#
-# IDENTIFICATION
-# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.55 2003/01/14 23:19:34 petere Exp $
+# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.56 2003/03/25 16:15:35 petere Exp $
#
#----------------------------------------------------------------------------
ifndef JADE
JADE = jade
endif
-SGMLINCLUDE = -D $(srcdir) -D $(srcdir)/ref
+SGMLINCLUDE = -D $(srcdir)
ifndef NSGMLS
NSGMLS = nsgmls
CONVERT = convert
EPSTOPDF = epstopdf
-
# docbook2man generates man pages from docbook refentry source code.
-
-ifndef D2MDIR
-# This is where the (patched) docbook2man perl scripts reside on hub.org.
-D2MDIR= /home/users/t/thomas/d2x/docbook2man
-endif
D2MSCRIPT= $(D2MDIR)/docbook2man-spec.pl
-vpath %.sgml ./ref
-
-ALLBOOKS = admin developer programmer reference tutorial user
-GENERATED_SGML = bookindex.sgml setindex.sgml version.sgml \
+GENERATED_SGML = bookindex.sgml version.sgml \
features-supported.sgml features-unsupported.sgml
ALLSGML := $(wildcard $(srcdir)/*.sgml $(srcdir)/ref/*.sgml) $(GENERATED_SGML)
DEFAULTSECTION := $(sqlmansect_dummy)
-man: $(ALLSGML)
- $(NSGMLS) $(NSGMLS_FLAGS) $(srcdir)/book-decl.sgml $(srcdir)/reference.sgml \
- | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`"
+man: postgres.sgml $(ALLSGML)
+ $(NSGMLS) $(NSGMLS_FLAGS) $< | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`"
# One more time, to resolve cross-references
- $(NSGMLS) $(NSGMLS_FLAGS) $(srcdir)/book-decl.sgml $(srcdir)/reference.sgml \
- | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`"
+ $(NSGMLS) $(NSGMLS_FLAGS) $< | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`"
$(mkinstalldirs) man1 man$(DEFAULTSECTION)
mv *.1 man1/
mv *.$(DEFAULTSECTION) man$(DEFAULTSECTION)/
## HTML
##
-JADE.html = $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -i output-html -t sgml
+all: html
-postgres.html: postgres.sgml $(ALLSGML) stylesheet.dsl
- @rm -f *.html
- $(JADE.html) $<
- ln -sf index.html $@
+.PHONY: html
-$(addsuffix .html, $(ALLBOOKS)): %.html: %.sgml $(ALLSGML) stylesheet.dsl
+html: postgres.sgml $(ALLSGML) stylesheet.dsl catalogs.gif connections.gif
@rm -f *.html
- $(JADE.html) book-decl.sgml $<
- ln -sf index.html $@
+ $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -i output-html -t sgml $<
-programmer.html: catalogs.gif connections.gif
-postgres.html: catalogs.gif connections.gif
-
-COLLATEINDEX := $(PERL) $(COLLATEINDEX) -f -g -t 'Index'
+COLLATEINDEX := $(PERL) $(COLLATEINDEX) -f -g
ifeq (,$(wildcard HTML.index))
bookindex.sgml:
$(COLLATEINDEX) -o $@ -N
-
-setindex.sgml:
- $(COLLATEINDEX) -x -o $@ -N
else
bookindex.sgml: HTML.index
$(COLLATEINDEX) -i 'bookindex' -o $@ $<
-
-setindex.sgml: HTML.index
- $(COLLATEINDEX) -i 'setindex' -x -o $@ $<
endif
version.sgml: $(top_builddir)/src/Makefile.global
##
# RTF to allow minor editing for hardcopy
-$(addsuffix .rtf, $(ALLBOOKS)): %.rtf: %.sgml $(ALLSGML) stylesheet.dsl
- $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t rtf -V rtf-backend -i output-print book-decl.sgml $<
+
+%.rtf: %.sgml $(ALLSGML) stylesheet.dsl
+ $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t rtf -V rtf-backend -i output-print $<
+
+postgres.rtf: catalogs.gif connections.gif
# TeX
# Regular TeX and pdfTeX have slightly differing requirements, so we
# need to distinguish the path we're taking.
-$(addsuffix .tex-ps, $(ALLBOOKS)): %.tex-ps: %.sgml $(ALLSGML) stylesheet.dsl
- $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t tex -V tex-backend -i output-print -V texdvi-output -o $@ book-decl.sgml $<
+%.tex-ps: %.sgml $(ALLSGML) stylesheet.dsl
+ $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t tex -V tex-backend -i output-print -V texdvi-output -o $@ $<
-programmer.tex-ps: catalogs.eps connections.eps
+postgres.tex-ps: catalogs.eps connections.eps
-$(addsuffix .tex-pdf, $(ALLBOOKS)): %.tex-pdf: %.sgml $(ALLSGML) stylesheet.dsl
- $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t tex -V tex-backend -i output-print -V texpdf-output -o $@ book-decl.sgml $<
+%.tex-pdf: %.sgml $(ALLSGML) stylesheet.dsl
+ $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t tex -V tex-backend -i output-print -V texpdf-output -o $@ $<
-programmer.tex-pdf: catalogs.pdf connections.pdf
+postgres.tex-pdf: catalogs.pdf connections.pdf
%.dvi: %.tex-ps
@rm -f $*.aux $*.log
# This generates an XML version of the flow-object tree. It's useful
# for debugging DSSSL code, and possibly to interface to some other
# tools that can make use of this.
-$(addsuffix .fot, $(ALLBOOKS)): %.fot: %.sgml $(ALLSGML) stylesheet.dsl
- $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t fot -i output-print -o $@ book-decl.sgml $<
+%.fot: %.sgml $(ALLSGML) stylesheet.dsl
+ $(JADE) $(JADEFLAGS) $(SGMLINCLUDE) $(CATALOG) -d stylesheet.dsl -t fot -i output-print -o $@ $<
# Graphics
## Check
##
-check: $(addprefix check-, $(ALLBOOKS)) check-postgres
-
# Quick syntax check without style processing
-$(addprefix check-, $(ALLBOOKS)): check-%: %.sgml $(ALLSGML)
- $(NSGMLS) $(SGMLINCLUDE) -s book-decl.sgml $<
-
-check-postgres: postgres.sgml $(ALLSGML)
+check: postgres.sgml $(ALLSGML)
$(NSGMLS) $(SGMLINCLUDE) -s $<
+++ /dev/null
-<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/Attic/admin.sgml,v 1.41 2002/11/15 03:11:15 momjian Exp $
--->
-
-<book id="admin">
-
-<!-- Title information -->
-
- <title>PostgreSQL &version; Administrator's Guide</title>
-
- <bookinfo>
- <corpauthor>The PostgreSQL Global Development Group</corpauthor>
- &legal;
- </bookinfo>
-
- <preface id="admin-preface">
- <title>Preface</title>
-
-<![%single-book;[
- &intro;
- &history;
-]]>
-
- <sect1 id="admin-preface-thisbook">
- <title>What's In This Book</title>
-
- <para>
- This book covers topics that are of interest to a
- <productname>PostgreSQL</> database administrator. This includes
- installation of the software, set up and configuration of the
- server, management of users and databases, and maintenance tasks.
- Anyone who runs a <productname>PostgreSQL</> server, either for
- personal use, but especially in production, should be familiar
- with the topics covered in this book.
- </para>
-
- <para>
- The information in this book is arranged approximately in the
- order in which a new user should read it. But the chapters are
- self-contained and can be read individually as desired. The
- information in this book is presented in a narrative fashion in
- topical units. Readers looking for a complete description of a
- particular command should look into the &cite-reference;.
- </para>
-
- <para>
- The first few chapters are written so that they can be understood
- without prerequisite knowledge, so that new users who need to set
- up their own server can begin their exploration with this book.
- The rest of this book which is about tuning and management
- presupposes that the reader is familiar with the general use of
- the <productname>PostgreSQL</> database system. Readers are
- encouraged to look at the &cite-tutorial; and the &cite-user; for
- additional information.
- </para>
-
- <para>
- This book covers <productname>PostgreSQL &version;</productname>
- only. For information on other versions, please read the
- documentation that accompanies that release.
- </para>
- </sect1>
-
-<![%single-book;[
- &info;
- ¬ation;
- &problems;
-]]>
- </preface>
-
- &installation;
- &installw;
- &runtime;
- &user-manag;
- &manage-ag;
- &client-auth;
- &charset;
- &maintenance;
- &backup;
- &monitoring;
- &diskusage;
- &wal;
- ®ress;
- &release;
-
-<![%single-book;[
- &biblio;
- &bookindex;
-]]>
-</book>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode:sgml
-sgml-omittag:nil
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-default-dtd-file:"./reference.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:("/usr/lib/sgml/catalog")
-sgml-local-ecat-files:nil
-End:
--->
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/advanced.sgml,v 1.33 2003/03/13 01:30:24 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/advanced.sgml,v 1.34 2003/03/25 16:15:35 petere Exp $
-->
<chapter id="tutorial-advanced">
<para>
The behavior of foreign keys can be finely tuned to your
application. We will not go beyond this simple example in this
- tutorial, but just refer you to the &cite-user;
+ tutorial, but just refer you to <xref linkend="ddl">
for more information. Making correct use of
foreign keys will definitely improve the quality of your database
applications, so you are strongly encouraged to learn about them.
<productname>PostgreSQL</productname> has many features not
touched upon in this tutorial introduction, which has been
oriented toward newer users of <acronym>SQL</acronym>. These
- features are discussed in more detail in both the &cite-user;
- and the &cite-programmer;.
+ features are discussed in more detail in the remainder of this
+ book.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/arch-dev.sgml,v 2.18 2003/02/19 04:06:27 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/arch-dev.sgml,v 2.19 2003/03/25 16:15:35 petere Exp $
-->
<chapter id="overview">
<para>
For information on the syntax and creation of rules in the
- <productname>PostgreSQL</productname> system refer to the
- &cite-user;.
+ <productname>PostgreSQL</productname> system refer to <xref linkend="sql">.
</para>
<sect2>
<!--
Documentation of the system catalogs, directed toward PostgreSQL developers
- $Header: /cvsroot/pgsql/doc/src/sgml/catalogs.sgml,v 2.67 2003/03/23 05:14:36 tgl Exp $
+ $Header: /cvsroot/pgsql/doc/src/sgml/catalogs.sgml,v 2.68 2003/03/25 16:15:35 petere Exp $
-->
<chapter id="catalogs">
<para>
New aggregate functions are registered with the <command>CREATE
- AGGREGATE</command> command. See the &cite-programmer; for more
+ AGGREGATE</command> command. See <xref linkend="xaggr"> for more
information about writing aggregate functions and the meaning of
the transition functions, etc.
</para>
<para>
The <structname>pg_database</structname> catalog stores information
about the available databases. Databases are created with the
- <command>CREATE DATABASE</command> command. Consult the
- &cite-admin; for details about the meaning of some of the
+ <command>CREATE DATABASE</command> command. Consult
+ <xref linkend="managing-databases"> for details about the meaning of some of the
parameters.
</para>
<para>
This catalog defines groups and stores what users belong to what
groups. Groups are created with the <command>CREATE
- GROUP</command> command. Consult the &cite-admin; for information
+ GROUP</command> command. Consult <xref linkend="user-manag"> for information
about user permission management.
</para>
<para>
<structname>pg_language</structname> registers call interfaces or
languages in which you can write functions or stored procedures.
- See under <command>CREATE LANGUAGE</command> and in the
- &cite-programmer; for more information about language handlers.
+ See under <command>CREATE LANGUAGE</command> and in
+ <xref linkend="server-programming"> for more information about language handlers.
</para>
<table>
</para>
<para>
- Operator classes are described at length in the &cite-programmer;.
+ Operator classes are described at length in <xref linkend="server-programming">.
</para>
<table>
<title>pg_operator</title>
<para>
- See <command>CREATE OPERATOR</command> and the &cite-programmer;
+ See <command>CREATE OPERATOR</command> and <xref linkend="xoper">
for details on these operator parameters.
</para>
<para>
This catalog stores information about functions (or procedures).
- The description of <command>CREATE FUNCTION</command> and the
- &cite-programmer; contain more information about the meaning of
+ The description of <command>CREATE FUNCTION</command> and
+ <xref linkend="xfunc"> contain more information about the meaning of
some fields.
</para>
</para>
<para>
- The &cite-admin; contains detailed information about user and
+ <xref linkend="user-manag"> contains detailed information about user and
permission management.
</para>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/charset.sgml,v 2.33 2003/03/24 14:32:50 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/charset.sgml,v 2.34 2003/03/25 16:15:35 petere Exp $ -->
<chapter id="charset">
<title>Localization</>
<productname>PostgreSQL</> speak their preferred language well.
If messages in your language is currently not available or fully
translated, your assistance would be appreciated. If you want to
- help, refer to the &cite-developer; or write to the developers'
+ help, refer to the <xref linkend="nls"> or write to the developers'
mailing list.
</para>
</sect2>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.13 2003/03/13 01:30:28 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.14 2003/03/25 16:15:35 petere Exp $ -->
<chapter id="ddl">
<title>Data Definition</title>
schemas, and how privileges can be assigned to tables. Finally,
we will briefly look at other features that affect the data storage,
such as views, functions, and triggers. Detailed information on
- these topics is found in the &cite-programmer;.
+ these topics is found in <xref linkend="server-programming">.
</para>
<sect1 id="ddl-basics">
Transaction identifiers are also 32-bit quantities. In a long-lived
database it is possible for transaction IDs to wrap around. This
is not a fatal problem given appropriate maintenance procedures;
- see the &cite-admin; for details. However, it is
+ see <xref linkend="maintenance"> for details. However, it is
unwise to depend on uniqueness of transaction IDs over the long term
(more than one billion transactions).
</para>
If the foreign key references a unique constraint, there are some
additional possibilities regarding how null values are matched.
These are explained in the <literal>CREATE TABLE</literal> entry
- in the &cite-reference;.
+ in <xref linkend="reference">.
</para>
</sect2>
</sect1>
+++ /dev/null
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/Attic/developer.sgml,v 1.7 2002/09/21 18:32:52 petere Exp $ -->
-<!-- PostgreSQL Developer's Guide -->
-
-<book id="developer">
- <title>PostgreSQL &version; Developer's Guide</title>
-
- <bookinfo>
- <corpauthor>The PostgreSQL Global Development Group</corpauthor>
- &legal;
-
- <abstract>
- <para>
- This document contains assorted information that can be of use to
- <productname>PostgreSQL</> developers.
- </para>
- </abstract>
- </bookinfo>
-
- &sources;
- &arch-dev;
- &catalogs;
- &protocol;
- &compiler;
- &bki;
- &page;
- &geqo;
- &gist;
- &nls;
-<!-- appendices -->
- &cvs;
- &docguide;
-<![%single-book;[
- &biblio;
-]]>
-</book>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.23 2003/01/19 00:13:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/dfunc.sgml,v 1.24 2003/03/25 16:15:35 petere Exp $
-->
<sect2 id="dfunc">
-bI:.../lib/postgres.exp -bE:foo.exp foo.o \e
-lm -lc 2>/dev/null
.fi
-You should look at the &cite-user; for an explanation of
-this procedure.
-
-->
</sect2>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/dml.sgml,v 1.3 2002/11/11 20:14:02 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/dml.sgml,v 1.4 2003/03/25 16:15:35 petere Exp $ -->
<chapter id="dml">
<title>Data Manipulation</title>
<para>
To do <quote>bulk loads</quote>, that is, inserting a lot of data,
take a look at the <command>COPY</command> command (see
- &cite-reference;). It is not as flexible as the
+ <xref linkend="reference">). It is not as flexible as the
<command>INSERT</command> command, but more efficient.
</para>
</tip>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.42 2003/03/13 01:30:28 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.43 2003/03/25 16:15:35 petere Exp $
-->
<chapter id="ecpg">
<para>
The complete syntax of the <command>ecpg</command> command is
- detailed in the &cite-reference;.
+ detailed in <xref linkend="app-ecpg">.
</para>
</sect1>
+++ /dev/null
-<![%single-book;[
-
-<!entity cite-admin "<citetitle>PostgreSQL Administrator's Guide</citetitle>">
-<!entity cite-developer "<citetitle>PostgreSQL Developer's Guide</citetitle>">
-<!entity cite-programmer "<citetitle>PostgreSQL Programmer's Guide</citetitle>">
-<!entity cite-reference "<citetitle>PostgreSQL Reference Manual</citetitle>">
-<!entity cite-tutorial "<citetitle>PostgreSQL Tutorial</citetitle>">
-<!entity cite-user "<citetitle>PostgreSQL User's Guide</citetitle>">
-
-]]>
-<![%set-of-books;[
-
-<!entity cite-admin "<xref linkend='admin'>">
-<!entity cite-developer "<xref linkend='developer'>">
-<!entity cite-programmer "<xref linkend='programmer'>">
-<!entity cite-reference "<xref linkend='reference'>">
-<!entity cite-tutorial "<xref linkend='tutorial'>">
-<!entity cite-user "<xref linkend='user'>">
-
-]]>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.19 2003/01/19 00:13:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.20 2003/03/25 16:15:36 petere Exp $
-->
<chapter id="extend">
</mediaobject>
</figure>
- The &cite-developer; gives a more detailed explanation of these
+ <xref linkend="catalogs"> gives a more detailed explanation of these
catalogs and their columns. However,
<xref linkend="EXTEND-CATALOGS">
shows the major entities and their relationships
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/filelist.sgml,v 1.26 2003/01/14 23:19:34 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/filelist.sgml,v 1.27 2003/03/25 16:15:36 petere Exp $ -->
<!entity history SYSTEM "history.sgml">
<!entity info SYSTEM "info.sgml">
<!entity problems SYSTEM "problems.sgml">
<!entity bookindex SYSTEM "bookindex.sgml">
-<!entity setindex SYSTEM "setindex.sgml">
<!-- tutorial -->
<!entity advanced SYSTEM "advanced.sgml">
+++ /dev/null
-<Chapter Id="func-ref">
-<Title>Functions</Title>
-
-<Abstract>
-<Para>
-Reference information for user-callable functions.
-</Para>
-</Abstract>
-
-<Note>
-<Para>
-This section needs to be written. Volunteers?
-</Para>
-</Note>
-
-<Para>
-</Para>
-
-</Chapter>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/func.sgml,v 1.147 2003/03/24 14:32:50 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/func.sgml,v 1.148 2003/03/25 16:15:36 petere Exp $
PostgreSQL documentation
-->
<para>
<productname>PostgreSQL</productname> provides a large number of
functions and operators for the built-in data types. Users can also
- define their own functions and operators, as described in the
- &cite-programmer;. The
+ define their own functions and operators, as described in
+ <xref linkend="server-programming">. The
<application>psql</application> commands <command>\df</command> and
<command>\do</command> can be used to show the list of all actually
available functions and operators, respectively.
<note>
<para>
The form of regular expressions accepted by <productname>PostgreSQL</>
- can be chosen by setting the <varname>REGEX_FLAVOR</> run-time parameter
- (described in the &cite-admin;). The usual setting is
+ can be chosen by setting the <varname>regex_flavor</> run-time parameter
+ (described in <xref linkend="runtime-config">). The usual setting is
<literal>advanced</>, but one might choose <literal>extended</> for
maximum backwards compatibility with pre-7.4 releases of
<productname>PostgreSQL</>.
linkend="functions-aggregate-table"> shows the built-in aggregate
functions. The special syntax considerations for aggregate
functions are explained in <xref linkend="syntax-aggregates">.
- Consult the &cite-tutorial; for additional introductory
+ Consult <xref linkend="tutorial"> for additional introductory
information.
</para>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/indices.sgml,v 1.39 2003/03/13 01:30:28 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/indices.sgml,v 1.40 2003/03/25 16:15:36 petere Exp $ -->
<chapter id="indexes">
<title id="indexes-title">Indexes</title>
<para>
When indexes are not used, it can be useful for testing to force
their use. There are run-time parameters that can turn off
- various plan types (described in the &cite-admin;).
+ various plan types (described in <xref linkend="runtime-config">).
For instance, turning off sequential scans
(<varname>enable_seqscan</>) and nested-loop joins
(<varname>enable_nestloop</>), which are the most basic plans,
again, two possibilities. The total cost is computed from the
per-row costs of each plan node times the selectivity estimate of
the plan node. The costs of the plan nodes can be tuned with
- run-time parameters (described in the &cite-admin;).
+ run-time parameters (described in <xref linkend="runtime-config">).
An inaccurate selectivity estimate is due to
insufficient statistics. It may be possible to help this by
tuning the statistics-gathering parameters (see <command>ALTER
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.131 2003/03/25 15:11:53 momjian Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.132 2003/03/25 16:15:36 petere Exp $ -->
<chapter id="installation">
<title><![%standalone-include[<productname>PostgreSQL</>]]>
<para>
<command>pg_dumpall</command> does not
save large objects. Check
- <![%standalone-include[the <citetitle>Administrator's Guide</>]]>
+ <![%standalone-include[the documentation]]>
<![%standalone-ignore[<xref linkend="backup-dump-caveats">]]>
if you need to do this.
</para>
<para>
These topics are discussed at length in <![%standalone-include[the
- <citetitle>Administrator's Guide</>,]]> <![%standalone-ignore[<xref
+ documentation,]]> <![%standalone-ignore[<xref
linkend="migration">,]]> which you are encouraged to read in any
case.
</para>
internal header files and the server header files are installed
into private directories under
<varname>includedir</varname>.
- See the &cite-programmer; for information about how to get at
- the header files for each interface.
+ See the documentation of each interface for information about how to get at
+ the its header files.
Finally, a private subdirectory will also be created, if appropriate,
under <varname>libdir</varname> for dynamically loadable modules.
</para>
<listitem>
<para>
Enables single-byte character set recode support. See
- <![%standalone-include[the <citetitle>Administrator's
- Guide</citetitle>]]> <![%standalone-ignore[<xref
+ <![%standalone-include[the documentation]]> <![%standalone-ignore[<xref
linkend="recode">]]> about this feature. Note that a more
general form of character set conversion is supported in the
default configuration; this feature is obsolete.
message wording or floating point results.
<![%standalone-include[The file
<filename>src/test/regress/README</> and the
- <citetitle>Administrator's Guide</citetitle> contain]]>
+ documentation contain]]>
<![%standalone-ignore[<xref linkend="regress"> contains]]>
detailed information about interpreting the test results. You can
repeat this test at any later time by issuing the same command.
<para>
The following is a quick summary of how to get <productname>PostgreSQL</> up and
- running once installed. The &cite-admin; contains more information.
+ running once installed. The main documentation contains more information.
</para>
<procedure>
</para>
<para>
- The &cite-tutorial; should be your first reading if you are
- completely new to <acronym>SQL</> databases. If you are
- familiar with database concepts then you want to proceed with
- the &cite-admin;, which contains information about how to set up
+ The first few chapters of the main documentation are the Tutorial,
+ which should be your first reading if you are completely new to
+ <acronym>SQL</> databases. If you are familiar with database
+ concepts then you want to proceed with part on server
+ administration, which contains information about how to set up
the database server, database users, and authentication.
</para>
</listitem>
<para>
Usually, you will want to modify your computer so that it will
automatically start the database server whenever it boots. Some
- suggestions for this are in the &cite-admin;.
+ suggestions for this are in the documentation.
</para>
</listitem>
Run the regression tests against the installed server (using the
sequential test method). If you didn't run the tests before
installation, you should definitely do it now. This is also
- explained in the &cite-admin;.
+ explained in the documentation.
</para>
</listitem>
<para>
The documentation is also available in Postscript format. If you
have a Postscript printer, or have your machine already set up to
- accept Postscript files using a print filter, then to print, for
- example the <citetitle>User's Guide</> simply type
+ accept Postscript files using a print filter, then to print, the
+ documentation simply type
<programlisting>
cd /usr/local/pgsql/doc
-gunzip -c user.ps.gz | lpr
+gunzip -c postgres.ps.gz | lpr
</programlisting>
Here is how you might do it if you have <productname>Ghostscript</>
installed on your system and are writing to a Laserjet printer.
<programlisting>
-gunzip -c user.ps.gz \
+gunzip -c postgres.ps.gz \
| gs -sDEVICE=laserjet -r300 -q -dNOPAUSE -sOutputFile=- \
| lpr
</programlisting>
Dave Page (<email>dpage@vale-housing.co.uk</email>)</entry>
<entry>
native is client-side only;
-<![%standalone-include[see Administrator's Guide]]>
+<![%standalone-include[see documentation]]>
<![%standalone-ignore[see <xref linkend="install-win32">]]>
</entry>
</row>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.42 2003/01/19 00:13:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/Attic/jdbc.sgml,v 1.43 2003/03/25 16:15:37 petere Exp $
-->
<chapter id="jdbc">
<para>
Also, the client authentication setup in the
<filename>pg_hba.conf</filename> file may need to be configured.
- Refer to the &cite-admin; for details. The
+ Refer to <xref linkend="client-authentication"> for details. The
<acronym>JDBC</acronym> Driver supports the trust, ident,
password, md5, and crypt authentication methods.
</para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/legal.sgml,v 1.14 2002/06/20 20:29:24 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/legal.sgml,v 1.15 2003/03/25 16:15:37 petere Exp $
-->
<copyright>
- <year>1996-2002</year>
+ <year>1996-2003</year>
<holder>The PostgreSQL Global Development Group</holder>
</copyright>
-<legalnotice>
+<legalnotice id="legalnotice">
<title>Legal Notice</title>
<para>
UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
</para>
-<!--
-How to keep track of all the trademarks? I'll try the strategy used at
-www.qnx.com - thomas
---
-
---
-There is no legal requirement to make trademark acknowledgements in
-references to third party products that happen to have trademarked
-names.
-
-The exception would be if <productname>PostgreSQL</>
- were to license a particular
-trademark and the trademark holder makes this requirement (as in the
-case of UNIX and Java).
-
-What is not allowed, however, is to use a trademark name in a way that
-could lead people to believe that they label <productname>PostgreSQL</> products.
-E.g., "the <productname>PostgreSQL</> UNIX database system" would probably be illegal,
-whereas "<productname>PostgreSQL</>, which runs on many UNIX computer systems" is
-fine. This is independent of whether a trademark acknowledgement is
-made.
-
-- petere
-
- <para>
- <acronym>Unix</acronym> is a trademark of X/Open, Ltd. Sun4, SPARC, SunOS
- and Solaris are trademarks of Sun Microsystems, Inc. DEC,
- DECstation, Alpha AXP and ULTRIX are trademarks of Compaq, formerly Digital
- Equipment Corp. PA-RISC and HP-UX are trademarks of
- Hewlett-Packard Co. OSF/1 is a trademark of the Open
- Software Foundation.
- </para>
--->
-
-<!--
- <para>
- All trademarks are the property of their respective owners.
- </para>
--->
</legalnotice>
<!-- Keep this comment at the end of the file
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/libpq.sgml,v 1.116 2003/03/25 02:44:36 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/libpq.sgml,v 1.117 2003/03/25 16:15:37 petere Exp $
-->
<chapter id="libpq">
three digit octal number equal to the octet value, and preceded by
two backslashes. The single quote (<literal>'</>) and backslash
(<literal>\</>) characters have special alternative escape
- sequences. See the &cite-user; for more
+ sequences. See <xref linkend="datatype-binary"> for more
information. <function>PQescapeBytea</function> performs this
operation, escaping only the minimally required bytes.
</para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/maintenance.sgml,v 1.21 2003/03/24 14:32:50 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/maintenance.sgml,v 1.22 2003/03/25 16:15:37 petere Exp $
-->
<chapter id="maintenance">
<command>UPDATE</> or <command>DELETE</> of a row does not
immediately remove the old <firstterm>tuple</> (version of the row).
This approach is necessary to gain the benefits of multiversion
- concurrency control (see the &cite-user;): the tuple
+ concurrency control (see <xref linkend="mvcc">): the tuple
must not be deleted while it is still potentially visible to other
transactions. But eventually, an outdated or deleted tuple is no
longer of interest to any transaction. The space it occupies must be
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.26 2003/03/18 22:19:46 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.27 2003/03/25 16:15:37 petere Exp $
-->
<chapter id="managing-databases">
or users are interrelated and should be able to use each other's
resources they should be put in the same databases but possibly
into separate schemas. More information about managing schemas is
- in the &cite-user;.
+ in <xref linkend="ddl-schemas">.
</para>
<note>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/monitoring.sgml,v 1.18 2003/03/24 14:32:50 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/monitoring.sgml,v 1.19 2003/03/25 16:15:37 petere Exp $
-->
<chapter id="monitoring">
<command>ps</> and <command>top</>. Also, once one has identified a
poorly-performing query, further investigation may be needed using
<productname>PostgreSQL</productname>'s <command>EXPLAIN</> command.
- The &cite-user; discusses <command>EXPLAIN</>
+ <xref linkend="using-explain"> discusses <command>EXPLAIN</>
and other methods for understanding the behavior of an individual
query.
</para>
</itemizedlist>
For more information on locking and managing concurrency with
- <productname>PostgreSQL</productname>, refer to the &cite-user;.
+ <productname>PostgreSQL</productname>, refer to <xref linkend="mvcc">.
</para>
<note>
The mode of the requested or held lock on the lockable
object. For more information on the different lock modes
available in <productname>PostgreSQL</productname>, refer to
- the &cite-user;.
+ <xref linkend="mvcc">.
</entry>
</row>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.34 2003/03/13 01:30:29 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/mvcc.sgml,v 2.35 2003/03/25 16:15:37 petere Exp $
-->
<chapter id="mvcc">
To examine a list of the currently outstanding locks in a database
server, use the <literal>pg_locks</literal> system view. For more
information on monitoring the status of the lock manager
- subsystem, refer to the &cite-admin;.
+ subsystem, refer to <xref linkend="monitoring">.
</para>
<variablelist>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/notation.sgml,v 1.21 2003/01/19 00:13:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/notation.sgml,v 1.22 2003/03/25 16:15:37 petere Exp $
-->
<sect1 id="notation">
We use <filename>/usr/local/pgsql/</filename> as the root
directory of the installation and <filename>/usr/local/pgsql/data</filename>
as the directory with the database files. These directories may vary
- on your site, details can be derived in the &cite-admin;.
+ on your site, details can be derived in <xref linkend="installation">.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.27 2003/03/13 01:30:29 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/perform.sgml,v 1.28 2003/03/25 16:15:37 petere Exp $
-->
<chapter id="performance-tips">
The costs are measured in units of disk page fetches. (CPU effort
estimates are converted into disk-page units using some
fairly arbitrary fudge factors. If you want to experiment with these
- factors, see the list of run-time configuration parameters in the
- &cite-admin;.)
+ factors, see the list of run-time configuration parameters in
+ <xref linkend="runtime-config">.)
</para>
<para>
search to a <firstterm>genetic</firstterm> probabilistic search
through a limited number of possibilities. (The switch-over threshold is
set by the <varname>geqo_threshold</varname> run-time
- parameter described in the &cite-admin;.)
+ parameter.)
The genetic search takes less time, but it won't
necessarily find the best possible plan.
</para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/plpgsql.sgml,v 1.15 2003/02/19 04:06:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/plpgsql.sgml,v 1.16 2003/03/25 16:15:37 petere Exp $
-->
<chapter id="plpgsql">
written to the server log, or both is controlled by the
<option>LOG_MIN_MESSAGES</option> and
<option>CLIENT_MIN_MESSAGES</option> configuration variables. See
- the &cite-admin; for more information.
+ <xref linkend="runtime-config"> for more information.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.48 2002/08/05 19:43:31 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/postgres.sgml,v 1.49 2003/03/25 16:15:38 petere Exp $
-->
-<!doctype set PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!entity % version SYSTEM "version.sgml">
%version;
<!entity % filelist SYSTEM "filelist.sgml">
%filelist;
-<!entity % set-of-books "INCLUDE">
-<!entity % single-book "IGNORE">
-
-<!entity % entities SYSTEM "entities.sgml">
-%entities;
-
-<!entity admin SYSTEM "admin.sgml">
-<!entity developer SYSTEM "developer.sgml">
-<!entity programmer SYSTEM "programmer.sgml">
<!entity reference SYSTEM "reference.sgml">
-<!entity tutorial SYSTEM "tutorial.sgml">
-<!entity user SYSTEM "user.sgml">
]>
-<set id="postgres">
+<book id="postgres">
<title>PostgreSQL &version; Documentation</title>
- <setinfo>
+ <bookinfo>
<corpauthor>The PostgreSQL Global Development Group</corpauthor>
&legal;
- </setinfo>
+ </bookinfo>
+
+ <preface id="preface">
+ <title>Preface</title>
+
+ &intro;
+ &history;
+ ¬ation;
+ &problems;
+
+ </preface>
+
+ <part id="tutorial">
+ <title>Tutorial</title>
+
+ <partintro>
+ <para>
+ Welcome to <productname>PostgreSQL</productname> Tutorial. The
+ following few chapters are intended to give a simple introduction
+ to <productname>PostgreSQL</productname>, relational database
+ concepts, and the SQL language to those who are new to any one of
+ these aspects. We only assume some general knowledge about how to
+ use computers. No particular Unix or programming experience is
+ required. This part is mainly intended to give you a hands-on
+ experience with important aspects of the
+ <productname>PostgreSQL</productname> system. It makes no attempt
+ to be a complete or thorough treatment of the topics it covers.
+ </para>
+
+ <para>
+ After you have worked through this tutorial you might want to move
+ on to reading <xref linkend="sql"> to gain a more formal knowledge
+ of the SQL language, or <xref linkend="client-interfaces"> for
+ information about developing applications for
+ <productname>PostgreSQL</productname>. Those who set up and
+ manage their own server should also read <xref linkend="admin">.
+ </para>
+ </partintro>
+
+ &start;
+ &query;
+ &advanced;
+
+ </part>
+
+ <part id="sql">
+ <title>The SQL Language</title>
+
+ <partintro>
+ <para>
+ This part describes the use of the <acronym>SQL</acronym> language
+ in <productname>PostgreSQL</productname>. We start with
+ describing the general syntax of <acronym>SQL</acronym>, then
+ explain how to create the structures to hold data, how to populate
+ the database, and how to query it. The middle part lists the
+ available data types and functions for use in
+ <acronym>SQL</acronym> data commands. The rest treats several
+ aspects that are important for tuning a database for optimal
+ performance.
+ </para>
+
+ <para>
+ The information in this part is arranged so that a novice user can
+ follow it start to end to gain a full understanding of the topics
+ without having to refer forward too many times. The chapters are
+ intended to be self-contained, so that advanced users can read the
+ chapters individually as they choose. The information in this
+ part is presented in a narrative fashion in topical units.
+ Readers looking for a complete description of a particular command
+ should look into <xref linkend="reference">.
+ </para>
+
+ <para>
+ Readers of this book should know how to connect to a
+ <productname>PostgreSQL</> database and issue
+ <acronym>SQL</acronym> commands. Readers that are unfamiliar with
+ these issues are encouraged to read <xref linkend="tutorial">
+ first. <acronym>SQL</acronym> commands are typically entered
+ using the <productname>PostgreSQL</> interactive terminal
+ <application>psql</application>, but other programs that have
+ similar functionality can be used as well.
+ </para>
+ </partintro>
+
+ &syntax;
+ &ddl;
+ &dml;
+ &queries;
+ &datatype;
+ &func;
+ &typeconv;
+ &indices;
+ &mvcc;
+ &perform;
+
+ </part>
+
+ <part id="admin">
+ <title>Server Administration</title>
+
+ <partintro>
+ <para>
+ This part covers topics that are of interest to a
+ <productname>PostgreSQL</> database administrator. This includes
+ installation of the software, set up and configuration of the
+ server, management of users and databases, and maintenance tasks.
+ Anyone who runs a <productname>PostgreSQL</> server, either for
+ personal use, but especially in production, should be familiar
+ with the topics covered in this part.
+ </para>
+
+ <para>
+ The information in this part is arranged approximately in the
+ order in which a new user should read it. But the chapters are
+ self-contained and can be read individually as desired. The
+ information in this part is presented in a narrative fashion in
+ topical units. Readers looking for a complete description of a
+ particular command should look into <xref linkend="reference">.
+ </para>
+
+ <para>
+ The first few chapters are written so that they can be understood
+ without prerequisite knowledge, so that new users who need to set
+ up their own server can begin their exploration with this part.
+ The rest of this part which is about tuning and management
+ presupposes that the reader is familiar with the general use of
+ the <productname>PostgreSQL</> database system. Readers are
+ encouraged to look at <xref linkend="tutorial"> and <xref
+ linkend="sql"> for additional information.
+ </para>
+ </partintro>
+
+ &installation;
+ &installw;
+ &runtime;
+ &user-manag;
+ &manage-ag;
+ &client-auth;
+ &charset;
+ &maintenance;
+ &backup;
+ &monitoring;
+ &diskusage;
+ &wal;
+ ®ress;
+
+ </part>
+
+ <part id="client-interfaces">
+ <title>Client Interfaces</title>
+
+ <partintro>
+ <para>
+ This part describes the client programming interfaces distributed
+ with <productname>PostgreSQL</>. Each of these chapters can be
+ read independently. Note that there are many other programming
+ interfaces for client programs that are distributed separately and
+ contain their own documentation. Readers of this part should be
+ familiar with using <acronym>SQL</acronym> commands to manipulate
+ and query the database (see <xref linkend="sql">) and of course
+ with the programming language that the interface uses.
+ </para>
+ </partintro>
+
+ &libpq;
+ &lobj;
+ &libpgtcl;
+ &ecpg;
+ &jdbc;
+ &pygresql;
+
+ </part>
+
+ <part id="server-programming">
+ <title>Server Programming</title>
+
+ <partintro>
+ <para>
+ This part is about extending the server functionality with
+ user-defined functions, data types, triggers, etc. These are
+ advanced topics which should probably be approached only after all
+ the other user documentation about <productname>PostgreSQL</> has
+ been understood. This part also describes the server-side
+ programming languages available in the
+ <productname>PostgreSQL</productname> distribution as well as
+ general issues concerning server-side programming languages. This
+ information is only useful to readers that have read at least the
+ first few chapters of this part.
+ </para>
+ </partintro>
+
+ &arch-pg;
+ &extend;
+ &xfunc;
+ &xtypes;
+ &xoper;
+ &xaggr;
+ &rules;
+ &xindex;
+ &indexcost;
+ &trigger;
+ &spi;
+
+ &xplang;
+ &plsql;
+ &pltcl;
+ &plperl;
+ &plpython;
+
+ </part>
- &tutorial;
- &user;
- &admin;
- &programmer;
&reference;
- &developer;
- &setindex;
-
-</set>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode:sgml
-sgml-omittag:nil
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-tabs-mode:nil
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-default-dtd-file:"./reference.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:("/usr/share/sgml/catalog")
-sgml-local-ecat-files:nil
-End:
--->
+
+ <part id="internals">
+ <title>Internals</title>
+
+ <partintro>
+ <para>
+ This part contains assorted information that can be of use to
+ <productname>PostgreSQL</> developers.
+ </para>
+ </partintro>
+
+ &sources;
+ &arch-dev;
+ &catalogs;
+ &protocol;
+ &compiler;
+ &bki;
+ &page;
+ &geqo;
+ &gist;
+ &nls;
+
+ </part>
+
+ <part id="appendixes">
+ <title>Appendixes</title>
+
+ &datetime;
+ &keywords;
+ &features;
+ &release;
+ &cvs;
+ &docguide;
+
+ </part>
+
+ &biblio;
+ &bookindex;
+
+</book>
+++ /dev/null
-<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/Attic/programmer.sgml,v 1.44 2002/11/15 03:11:17 momjian Exp $
-
-PostgreSQL Programmer's Guide.
--->
-
-<book id="programmer">
-
- <title>PostgreSQL &version; Programmer's Guide</title>
- <bookinfo>
- <corpauthor>The PostgreSQL Global Development Group</corpauthor>
- &legal;
- </bookinfo>
-
- <preface id="programmer-preface">
- <title>Preface</title>
-
-<![%single-book;[
- &intro;
- &history;
-]]>
-
- <sect1 id="programmer-preface-thisbook">
- <title>What's In This Book</title>
-
- <para>
- This book is for <productname>PostgreSQL</> application
- programmers. It is divided into three parts.
- </para>
-
- <para>
- The first part of this book describes the client programming
- interfaces distributed with <productname>PostgreSQL</>. Each of
- these chapters can be read independently. Note that there are
- many other programming interfaces for client programs that are
- distributed separately and contain their own documentation.
- Readers of the first part should be familiar with using
- <acronym>SQL</acronym> commands to manipulate and query the
- database (see the &cite-user;) and of course with the programming
- language that the interface uses.
- </para>
-
- <para>
- The second part of this book is about extending the server
- functionality with user-defined functions, data types, triggers,
- etc. These are advanced topics which should probably be
- approached only after all the other user documentation about
- <productname>PostgreSQL</> has been understood.
- </para>
-
- <para>
- The third part of this book described the available server-side
- programming languages. This information is related to the second
- part and is only useful to readers that have read at least the
- first few chapters thereof.
- </para>
-
- <para>
- This book covers <productname>PostgreSQL &version;</productname>
- only. For information on other versions, please read the
- documentation that accompanies that release.
- </para>
- </sect1>
-
-<![%single-book[
- &info;
- ¬ation;
- &problems;
-]]>
- </preface>
-
- <part id="programmer-client">
- <title>Client Interfaces</title>
-
- <partintro>
- <para>
- This part of the manual is the description of the client-side
- programming interfaces and support libraries for various
- languages.
- </para>
- </partintro>
-
- &libpq;
- &lobj;
- &libpgtcl;
- &ecpg;
- &jdbc;
- &pygresql;
- </part>
-
- <part id="programmer-server">
- <title>Server Programming</title>
-
- <partintro>
- <para>
- This second part of the manual explains the
- <productname>PostgreSQL</productname> approach to extensibility
- and describe how users can extend
- <productname>PostgreSQL</productname> by adding user-defined
- types, operators, aggregates, and both query language and
- programming language functions. After a discussion of the
- <productname>PostgreSQL</productname> rule system, we discuss the
- trigger and SPI interfaces.
- </para>
- </partintro>
-
- &arch-pg;
- &extend;
- &xfunc;
- &xtypes;
- &xoper;
- &xaggr;
- &rules;
- &xindex;
- &indexcost;
- &trigger;
- &spi;
- </part>
-
- <part id="programmer-pl">
- <title>Procedural Languages</title>
-
- <partintro>
- <para>
- This part documents the procedural languages available in the
- <productname>PostgreSQL</productname> distribution as well as
- general issues concerning procedural languages.
- </para>
- </partintro>
-
- &xplang;
- &plsql;
- &pltcl;
- &plperl;
- &plpython;
- </part>
-
-<![%single-book;[
- &biblio;
- &bookindex;
-]]>
-
-</book>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode:sgml
-sgml-omittag:nil
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-default-dtd-file:"./reference.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:("/usr/lib/sgml/catalog")
-sgml-local-ecat-files:nil
-End:
--->
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/query.sgml,v 1.29 2003/03/13 01:30:29 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/query.sgml,v 1.30 2003/03/25 16:15:38 petere Exp $
-->
<chapter id="tutorial-sql">
where the file name for the source file must be available to the
backend server machine, not the client, since the backend server
reads the file directly. You can read more about the
- <command>COPY</command> command in the &cite-reference;.
+ <command>COPY</command> command in <xref linkend="sql-copy">.
</para>
</sect1>
<callout arearefs="co.tutorial-agg-like">
<para>
The <literal>LIKE</literal> operator does pattern matching and
- is explained in the &cite-user;.
+ is explained in <xref linkend="functions-matching">.
</para>
</callout>
</calloutlist>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.4 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_database.sgml,v 1.5 2003/03/25 16:15:38 petere Exp $
PostgreSQL documentation
-->
</para>
<para>
- See <xref linkend="sql-set" endterm="sql-set-title"> and the
- &cite-admin; for more information about allowed variable names
+ See <xref linkend="sql-set" endterm="sql-set-title"> and <xref linkend="runtime-config">
+ for more information about allowed variable names
and values.
</para>
</listitem>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.57 2003/03/20 18:52:47 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.58 2003/03/25 16:15:38 petere Exp $
PostgreSQL documentation
-->
<para>
Refer to <command>CREATE TABLE</command> for a further description
- of valid arguments. The &cite-user; has further information on
+ of valid arguments. <xref linkend="ddl"> has further information on
inheritance.
</para>
</refsect2>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.25 2003/03/20 20:05:32 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.26 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
</para>
<para>
- See <xref linkend="sql-set" endterm="sql-set-title"> and the
- &cite-admin; for more information about allowed variable names
+ See <xref linkend="sql-set" endterm="sql-set-title"> and <xref linkend="runtime-config">
+ for more information about allowed variable names
and values.
</para>
</listitem>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.10 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/analyze.sgml,v 1.11 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<command>ANALYZE</command> deems them uninteresting (for example, in
a unique-key column, there are no common values) or if the column
data type does not support the appropriate operators. There is more
- information about the statistics in the &cite-user;.
+ information about the statistics in <xref linkend="maintenance">.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.21 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.22 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<command>SET TRANSACTION ISOLATION LEVEL SERIALIZABLE</command>
just after <command>BEGIN</command> if you need more rigorous transaction
isolation. (Alternatively, you can change the default transaction
- isolation level; see the &cite-admin; for details.)
+ isolation level; see <xref linkend="runtime-config"> for details.)
In SERIALIZABLE mode queries will see only changes committed before
the entire
transaction began (actually, before execution of the first <acronym>DML</> statement
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.7 2003/01/19 00:13:29 momjian Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/checkpoint.sgml,v 1.8 2003/03/25 16:15:39 petere Exp $ -->
<refentry id="sql-checkpoint">
<refmeta>
A checkpoint is a point in the transaction log sequence at which
all data files have been updated to reflect the information in the
log. All data files will be flushed to disk. Refer to the
- &cite-admin; for more information about the WAL system.
+ <xref linkend="wal"> for more information about the WAL system.
</para>
<para>
</refsect1>
<refsect1>
- <title>See Also</title>
-
- <para>
- &cite-admin;
- </para>
- </refsect1>
-
- <refsect1>
<title>Compatibility</title>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/cluster.sgml,v 1.24 2003/02/19 04:06:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/cluster.sgml,v 1.25 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
When a table is being clustered, an <literal>ACCESS
EXCLUSIVE</literal> lock is acquired on it. This prevents any other
database operations (both reads and writes) from preceding on the
- table until the <command>CLUSTER</command> is finished. See the
- &cite-user; for more information on database locking.
+ table until the <command>CLUSTER</command> is finished. See
+ <xref linkend="explicit-locking"> for more information on database locking.
</para>
<refsect2 id="R2-SQL-CLUSTER-3">
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_aggregate.sgml,v 1.23 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_aggregate.sgml,v 1.24 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
</refsect1>
<refsect1 id="R1-SQL-CREATEAGGREGATE-2">
- <title>
- Usage
- </title>
+ <title>Examples</title>
+
<para>
- Refer to the chapter on aggregate functions in the
- &cite-programmer; for complete examples of usage.
+ See <xref linkend="xaggr">.
</para>
</refsect1>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.9 2003/02/01 22:09:25 tgl Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_cast.sgml,v 1.10 2003/03/25 16:15:39 petere Exp $ -->
<refentry id="SQL-CREATECAST">
<refmeta>
<para>
<xref linkend="sql-createfunction" endterm="sql-createfunction-title">,
<xref linkend="sql-createtype" endterm="sql-createtype-title">,
- <xref linkend="sql-dropcast" endterm="sql-dropcast-title">,
- &cite-programmer;
+ <xref linkend="sql-dropcast" endterm="sql-dropcast-title">
</para>
</refsect1>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.6 2003/01/19 00:13:29 momjian Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_conversion.sgml,v 1.7 2003/03/25 16:15:39 petere Exp $ -->
<refentry id="SQL-CREATECONVERSION">
<refmeta>
<para>
<xref linkend="sql-createfunction" endterm="sql-createfunction-title">,
- <xref linkend="sql-dropconversion" endterm="sql-dropconversion-title">,
- &cite-programmer;
+ <xref linkend="sql-dropconversion" endterm="sql-dropconversion-title">
</para>
</refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.32 2003/02/13 05:37:43 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.33 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
specified with absolute path names, and by default
only an environment variable known to the backend may be
specified for an alternate location.
- See the Administrator's Guide for more information.
+ See <xref linkend="manage-ag-alternate-locs"> for more information.
</para>
<!--
by specifying its name as the template, this is not (yet) intended as
a general-purpose COPY DATABASE facility.
We recommend that databases used as templates be treated as read-only.
- See the &cite-admin; for more information.
+ See <xref linkend="user-manag"> for more information.
</para>
</refsect2>
</refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_domain.sgml,v 1.11 2003/02/13 05:32:42 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_domain.sgml,v 1.12 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<para>
The underlying data type of the domain. This may include array
specifiers.
- Refer to the &cite-user; for further
- information about data types and arrays.
</para>
</listitem>
</varlistentry>
<simplelist type="inline">
<member><xref linkend="sql-dropdomain" endterm="sql-dropdomain-title"></member>
- <member>&cite-programmer;</member>
</simplelist>
</refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.45 2003/03/20 04:41:13 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.46 2003/03/25 16:15:39 petere Exp $
-->
<refentry id="SQL-CREATEFUNCTION">
<title>Notes</title>
<para>
- Refer to the chapter in the &cite-programmer;
- on the topic of extending
- <productname>PostgreSQL</productname> via functions
- for further information on writing external functions.
+ Refer to <xref linkend="xfunc"> for further information on writing
+ external functions.
</para>
<para>
<xref linkend="sql-grant" endterm="sql-grant-title">,
<xref linkend="sql-load" endterm="sql-load-title">,
<xref linkend="sql-revoke" endterm="sql-revoke-title">,
- <xref linkend="app-createlang">,
- &cite-programmer;
+ <xref linkend="app-createlang">
</para>
</refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_group.sgml,v 1.9 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_group.sgml,v 1.10 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
</title>
<para>
<command>CREATE GROUP</command> will create a new group in the
- database installation. Refer to the &cite-admin; for information
- about using groups for authentication. You must be a database
+ database installation. You must be a database
superuser to use this command.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.30 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.31 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<para>
<command>CREATE LANGUAGE</command> effectively associates the
language name with a call handler that is responsible for executing
- functions written in the language. Refer to the &cite-programmer;
+ functions written in the language. Refer to <xref linkend="xfunc">
for more information about language call handlers.
</para>
<member><xref linkend="sql-droplanguage" endterm="sql-droplanguage-title"></member>
<member><xref linkend="sql-grant" endterm="sql-grant-title"></member>
<member><xref linkend="sql-revoke" endterm="sql-revoke-title"></member>
- <member>&cite-programmer;</member>
</simplelist>
</para>
</refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_opclass.sgml,v 1.5 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_opclass.sgml,v 1.6 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
</para>
<para>
- Refer to the chapter on interfacing extensions to indexes in the
- &cite-programmer; for further information.
+ Refer to <xref linkend="xindex"> for further information.
</para>
<refsect2 id="R2-SQL-CREATEOPCLASS-3">
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.33 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.34 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
Notes
</title>
<para>
- Refer to the chapter on operators in the &cite-user;
- for further information.
- Refer to <command>DROP OPERATOR</command> to delete
+ Refer to <xref linkend="xoper"> for further information.
+ Use <command>DROP OPERATOR</command> to delete
user-defined operators from a database.
</para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.31 2003/03/20 07:02:07 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.32 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<function>currval</function> and
<function>setval</function>
to operate on the sequence. These functions are documented in
- the &cite-user;.
+ <xref linkend="functions-sequence">.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.62 2003/02/19 03:13:25 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.63 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<listitem>
<para>
The data type of the column. This may include array specifiers.
- Refer to the &cite-user; for further information about data
- types and arrays.
</para>
</listitem>
</varlistentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.32 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.33 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
</para>
<para>
- Refer to the chapters on SPI and Triggers in the &cite-programmer;
- for more information.
+ Refer to <xref linkend="server-programming"> for more information.
</para>
</refsect1>
<member><xref linkend="sql-createfunction" endterm="sql-createfunction-title"></member>
<member><xref linkend="sql-altertrigger" endterm="sql-altertrigger-title"></member>
<member><xref linkend="sql-droptrigger" endterm="sql-droptrigger-title"></member>
- <member>&cite-programmer;</member>
</simplelist>
</refsect1>
</refentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.39 2003/02/19 03:13:25 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.40 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<simplelist type="inline">
<member><xref linkend="sql-createfunction" endterm="sql-createfunction-title"></member>
<member><xref linkend="sql-droptype" endterm="sql-droptype-title"></member>
- <member>&cite-programmer;</member>
</simplelist>
</refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.24 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_user.sgml,v 1.25 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<para>
<command>CREATE USER</command> will add a new user to an instance
- of <productname>PostgreSQL</productname>. Refer to the &cite-admin;
+ of <productname>PostgreSQL</productname>. Refer to <xref linkend="user-manag">
for information about managing users and authentication. You must
be a database superuser to use this command.
</para>
</para>
<para>
- See the chapter on client authentication in the &cite-admin;
+ See <xref linkend="client-authentication">
for details on how to set up authentication mechanisms. Note
that older clients may lack support for the MD5 authentication
mechanism that is needed to work with passwords that are
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.20 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.21 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<para>
The input data type of the aggregate function,
or <literal>*</literal> if the function accepts any input type.
- (Refer to the &cite-user; for further information about data types.)
</para>
</listitem>
</varlistentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.25 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.26 2003/03/25 16:15:39 petere Exp $
PostgreSQL documentation
-->
<para>
This reference page does not describe the embedded SQL language.
- See the &cite-programmer; for more information on that topic.
+ See <xref linkend="ecpg"> for more information on that topic.
</para>
</refsect1>
</para>
</refsect1>
-
- <refsect1>
- <title>See Also</title>
-
- <para>
- &cite-programmer; for a more detailed description of the embedded
- SQL interface
- </para>
- </refsect1>
-
</refentry>
<!-- Keep this comment at the end of the file
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.24 2003/03/10 03:53:49 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.25 2003/03/25 16:15:41 petere Exp $
PostgreSQL documentation
-->
<para>
There is only sparse documentation on the optimizer's use of cost
information in <productname>PostgreSQL</productname>.
- Refer to the &cite-user; and &cite-programmer; for more information.
+ Refer to <xref linkend="using-explain"> for more information.
</para>
</refsect2>
</refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.25 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.26 2003/03/25 16:15:41 petere Exp $
PostgreSQL documentation
-->
<simplelist type="inline">
<member><xref linkend="app-postgres"></member>
<member><xref linkend="app-postmaster"></member>
- <member>&cite-admin;</member>
</simplelist>
</refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.19 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.20 2003/03/25 16:15:42 petere Exp $
PostgreSQL documentation
-->
</para>
</refsect1>
- <refsect1>
- <title>See Also</title>
-
- <simplelist type="inline">
- <member>&cite-admin;</member>
- </simplelist>
- </refsect1>
-
</refentry>
<!-- Keep this comment at the end of the file
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.20 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.21 2003/03/25 16:15:42 petere Exp $
PostgreSQL documentation
-->
</para>
<para>
- Insert into arrays (refer to the &cite-user; for further
- information about arrays):
+ Insert into arrays:
<programlisting>
-- Create an empty 3x3 gameboard for noughts-and-crosses
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.15 2003/01/19 00:13:29 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.16 2003/03/25 16:15:42 petere Exp $
-->
<refentry id="SQL-LOAD">
The file name is specified in the same way as for shared library
names in <xref linkend="sql-createfunction" endterm="sql-createfunction-title">; in particular, one
may rely on a search path and automatic addition of the system's standard
- shared library file name extension. See the &cite-programmer; for
+ shared library file name extension. See <xref linkend="xfunc"> for
more information on this topic.
</para>
</refsect1>
<title>See Also</title>
<para>
- <xref linkend="sql-createfunction" endterm="sql-createfunction-title">,
- &cite-programmer;
+ <xref linkend="sql-createfunction" endterm="sql-createfunction-title">
</para>
</refsect1>
</refentry>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.14 2003/03/24 14:32:51 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.15 2003/03/25 16:15:42 petere Exp $ -->
<refentry id="app-pgconfig">
<refmeta>
<productname>PostgreSQL</> 7.1.
</para>
</refsect1>
-
-
- <refsect1>
- <title>See Also</title>
-
- <para>
- &cite-programmer;
- </para>
- </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.21 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.22 2003/03/25 16:15:42 petere Exp $
PostgreSQL documentation
-->
<title>See Also</title>
<para>
- <xref linkend="app-postmaster">, &cite-admin;
+ <xref linkend="app-postmaster">
</para>
</refsect1>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.59 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.60 2003/03/25 16:15:42 petere Exp $
PostgreSQL documentation
-->
<member><xref linkend="app-pg-dumpall"></member>
<member><xref linkend="app-pgrestore"></member>
<member><xref linkend="app-psql"></member>
- <member>&cite-admin;</member>
</simplelist>
</refsect1>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.37 2003/03/24 14:32:51 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.38 2003/03/25 16:15:43 petere Exp $ -->
<refentry id="APP-PGRESTORE">
<refmeta>
<member><xref linkend="app-pgdump"></member>
<member><xref linkend="app-pg-dumpall"></member>
<member><xref linkend="app-psql"></member>
- <member>&cite-admin;</member>
</simplelist>
</refsect1>
</refentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.7 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.8 2003/03/25 16:15:43 petere Exp $
PostgreSQL documentation
-->
<simplelist type="inline">
<member><xref linkend="app-pgtksh"></member>
<member>
- &cite-programmer; (description of <filename>libpgtcl</filename>)
+ <xref linkend="pgtcl"> (description of <filename>libpgtcl</filename>)
</member>
<member>
<citerefentry><refentrytitle>tclsh</refentrytitle> <manvolnum>1</manvolnum></citerefentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.7 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.8 2003/03/25 16:15:43 petere Exp $
PostgreSQL documentation
-->
<simplelist type="inline">
<member><xref linkend="app-pgtclsh"></member>
<member>
- &cite-programmer; (description of <filename>libpgtcl</filename>)
+ <xref linkend="pgtcl"> (description of <filename>libpgtcl</filename>)
</member>
<member>
<citerefentry><refentrytitle>tclsh</refentrytitle> <manvolnum>1</manvolnum></citerefentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.31 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.32 2003/03/25 16:15:43 petere Exp $
PostgreSQL documentation
-->
<para>
You can avoid having to type these options by setting up a
- configuration file. See the &cite-admin; for details. Some
+ configuration file. See <xref linkend="runtime-config"> for details. Some
(safe) options can also be set from the connecting client in an
application-dependent way. For example, if the environment
variable <envar>PGOPTIONS</envar> is set, then
means that the <quote>day before month</quote> (rather than
month before day) rule is used to interpret ambiguous date
input, and that the day is printed before the month in certain
- date output formats. See the &cite-user; for more information.
+ date output formats. See <xref linkend="datatype-datetime"> for more information.
</para>
</listitem>
</varlistentry>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.35 2003/03/24 14:32:51 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.36 2003/03/25 16:15:43 petere Exp $
PostgreSQL documentation
-->
<para>
<command>postmaster</command> accepts the following
command line arguments. For a detailed discussion of the options
- consult the &cite-admin;. You can also save typing most of these
+ consult <xref linkend="runtime-config">. You can also save typing most of these
options by setting up a configuration file.
<variablelist>
<term><option>-c <replaceable>name</replaceable>=<replaceable>value</replaceable></option></term>
<listitem>
<para>
- Sets a named run-time parameter. Consult the &cite-admin; for
+ Sets a named run-time parameter. Consult <xref linkend="runtime-config"> for
a list and descriptions. Most of the other command line
options are in fact short forms of such a parameter
assignment. <option>-c</> can appear multiple times to set
default, this value is 32, but it can be set as high as your
system will support. (Note that
<option>-B</option> is required to be at least twice
- <option>-N</option>. See the &cite-admin; for a discussion of
+ <option>-N</option>. See <xref linkend="kernel-resources"> for a discussion of
system resource requirements for large numbers of client
connections.)
</para>
<listitem>
<para>
Other environment variables may be used to designate alternative
- data storage locations. See the &cite-admin; for more
+ data storage locations. See <xref linkend="manage-ag-alternate-locs"> for more
information.
</para>
</listitem>
<listitem>
<para>
If you see this message, you probably need to configure
- your kernel for shared memory and semaphores as described in the &cite-admin;.
+ your kernel for shared memory and semaphores as described in <xref linkend="kernel-resources">.
If you run multiple instances of
<command>postmaster</command>
on a single host, or have a kernel with particularly small shared memory
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.87 2003/03/24 18:33:52 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.88 2003/03/25 16:15:43 petere Exp $
PostgreSQL documentation
-->
<refsect1 id="APP-PSQL-examples">
<title id="APP-PSQL-examples-title">Examples</title>
- <note>
- <para>
- This section only shows a few examples specific to
- <application>psql</application>. If you want to learn
- <acronym>SQL</acronym> or get familiar with
- <productname>PostgreSQL</productname>, you might wish to read the
- &cite-tutorial;.
- </para>
- </note>
-
<para>
The first example shows how to spread a command over several lines of
input. Notice the changing prompt:
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/reindex.sgml,v 1.15 2003/02/19 04:06:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/reindex.sgml,v 1.16 2003/03/25 16:15:43 petere Exp $
PostgreSQL documentation
-->
under certain access patterns. <command>REINDEX</command>
provides a way to reduce the space consumption of the index by
writing a new version of the index without the dead pages. See
- the <quote>Routine Reindexing</quote> section in the
- &cite-admin; for more information. The rest of this section
+ <xref linkend="routine-reindex"> for more information. The rest of this reference page
mostly discusses how to use <command>REINDEX</command> to
recover from index corruption.
</para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.18 2003/01/19 00:13:31 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.19 2003/03/25 16:15:44 petere Exp $
PostgreSQL documentation
-->
have had, had no <command>SET</> ever been issued for it in the
current session. The actual source of this value might be a
compiled-in default, the postmaster's configuration file or command-line
- switches, or per-database or per-user default settings. See the
- &cite-admin; for details.
+ switches, or per-database or per-user default settings. See
+ <xref linkend="runtime-config"> for details.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.65 2003/03/20 19:00:01 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.66 2003/03/25 16:15:44 petere Exp $
PostgreSQL documentation
-->
already locked a selected row or rows, <command>SELECT FOR
UPDATE</command> will wait for the other transaction to complete,
and will then lock and return the updated row (or no row, if the
- row was deleted). For further discussion see the concurrency
- chapter of the &cite-user;.
+ row was deleted). For further discussion see <xref linkend="mvcc">.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v 1.72 2003/01/19 00:13:31 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v 1.73 2003/03/25 16:15:44 petere Exp $
PostgreSQL documentation
-->
<para>
The <command>SET</command> command changes run-time configuration
parameters. Many of the run-time parameters listed in the
- &cite-admin; can be changed on-the-fly with <command>SET</command>.
+ <xref linkend="runtime-config"> can be changed on-the-fly with <command>SET</command>.
(But some require superuser privileges to change, and others cannot
be changed after server or session start.) Note that
<command>SET</command> only affects the value used by the current
<para>
Even with <varname>autocommit</> set to <literal>off</>, <command>SET</>
does not start a new transaction block. See the
- <varname>autocommit</> section of the &cite-admin; for details.
+ <varname>autocommit</> section in <xref linkend="runtime-config"> for details.
</para>
<para>
</para>
</refsect1>
+ <refsect1>
+ <title>Notes</title>
+
+ <para>
+ The function <function>set_config</function> provides the equivalent
+ capability. See <xref linkend="functions-misc">.
+ </para>
+ </refsect1>
<refsect1>
<title>Examples</title>
<xref linkend="sql-set-session-authorization" endterm="sql-set-session-authorization-title">,
<xref linkend="sql-set-transaction" endterm="sql-set-transaction-title">
</simpara>
-
- <para>
- The function <function>set_config</function> provides the equivalent
- capability. See <citetitle>Miscellaneous Functions</citetitle> in
- the &cite-user;.
- </para>
</refsect1>
</refentry>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.12 2003/01/19 00:13:31 momjian Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_transaction.sgml,v 1.13 2003/03/25 16:15:44 petere Exp $ -->
<refentry id="SQL-SET-TRANSACTION">
<docinfo>
<date>2000-11-24</date>
<programlisting>
SET default_transaction_isolation = '<replaceable>value</replaceable>'
</programlisting>
- and in the configuration file. Consult the &cite-admin; for more
+ and in the configuration file. Consult <xref linkend="runtime-config"> for more
information.
</para>
</refsect1>
not provide the isolation levels <option>READ UNCOMMITTED</option>
and <option>REPEATABLE READ</option>. Because of multiversion
concurrency control, the <option>SERIALIZABLE</option> level is not
- truly serializable. See the &cite-user; for details.
+ truly serializable. See <xref linkend="mvcc"> for details.
</para>
<para>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.23 2003/01/19 00:13:31 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.24 2003/03/25 16:15:44 petere Exp $
PostgreSQL documentation
-->
<para>
Even with <varname>autocommit</> set to <literal>off</>, <command>SHOW</>
does not start a new transaction block. See the
- <varname>autocommit</> section of the &cite-admin; for details.
+ <varname>autocommit</> section in <xref linkend="runtime-config"> for details.
</para>
</refsect1>
</para>
</refsect1>
+ <refsect1>
+ <title>Notes</title>
+
+ <para>
+ The function <function>current_setting</function> produces
+ equivalent output. See <xref linkend="functions-misc">.
+ </para>
+ </refsect1>
+
<refsect1 id="R1-SQL-SHOW-2">
<title>Examples</title>
<para>
<productname>PostgreSQL</productname> extension.
</para>
</refsect1>
-
- <refsect1>
- <title>See Also</title>
-
- <para>
- The function <function>current_setting</function> produces equivalent
- output. See <citetitle>Miscellaneous Functions</citetitle> in the
- &cite-user;.
- </para>
- </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.29 2003/02/19 04:06:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuum.sgml,v 1.30 2003/03/25 16:15:44 petere Exp $
PostgreSQL documentation
-->
intended usage is in connection with preparation of user-defined template
databases, or other databases that are completely read-only and will not
receive routine maintenance <command>VACUUM</> operations.
- See the &cite-admin; for details.
+ See <xref linkend="maintenance"> for details.
</para>
<refsect2 id="R2-SQL-VACUUM-3">
<!-- reference.sgml
-$Header: /cvsroot/pgsql/doc/src/sgml/reference.sgml,v 1.43 2003/03/24 14:32:50 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/reference.sgml,v 1.44 2003/03/25 16:15:38 petere Exp $
PostgreSQL Reference Manual
-->
-<book id="reference">
-
- <title>PostgreSQL &version; Reference Manual</title>
- <bookinfo>
- <corpauthor>The PostgreSQL Global Development Group</corpauthor>
- &legal;
- </bookinfo>
-
- <preface id="reference-preface">
- <title>Preface</title>
+<part id="reference">
+ <title>Reference</title>
+ <partintro>
<para>
- The entries in this <citetitle>Reference Manual</citetitle> are
- meant to provide in reasonable length an authoritative, complete, and
- formal summary about their respective subjects. More information
- about the use of <productname>PostgreSQL</productname>, in
- narrative, tutorial, or example form, may be found in other parts
- of the <productname>PostgreSQL</productname> documentation set.
- See the cross-references listed on each reference page.
+ The entries in this Reference are meant to provide in reasonable
+ length an authoritative, complete, and formal summary about their
+ respective subjects. More information about the use of
+ <productname>PostgreSQL</productname>, in narrative, tutorial, or
+ example form, may be found in other parts of this book. See the
+ cross-references listed on each reference page.
</para>
<para>
- The <citetitle>Reference Manual</citetitle> entries are also
- available as traditional <quote>man</quote> pages.
+ The reference entries are also available as traditional
+ <quote>man</quote> pages.
</para>
- </preface>
+ </partintro>
<reference id="sql-commands">
<title>SQL Commands</title>
</reference>
-</book>
+</part>
<!-- Keep this comment at the end of the file
Local variables:
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/runtime.sgml,v 1.173 2003/03/24 14:32:50 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/runtime.sgml,v 1.174 2003/03/25 16:15:38 petere Exp $
-->
<Chapter Id="runtime">
The database cluster will be initialized with locale de_DE.
This locale setting will prevent the use of indexes for pattern matching
operations. If that is a concern, rerun initdb with the collation order
-set to "C". For more information see the Administrator's Guide.
+set to "C". For more information see the documentation.
</screen>
This is intended to warn you that the currently selected locale
will cause indexes to be sorted in an order that prevents them from
visible to the superuser, so it should not represent a
security risk. This data can be accessed via the
<structname>pg_stat_activity</structname> system view; refer
- to the &cite-admin; for more information.
+ to <xref linkend="monitoring"> for more information.
</para>
</listitem>
</varlistentry>
default. This data can be accessed via the
<structname>pg_stat</structname> and
<structname>pg_statio</structname> family of system views;
- refer to the &cite-admin; for more information.
+ refer to <xref linkend="monitoring"> for more information.
</para>
</listitem>
</varlistentry>
</para>
<para>
- Consult the &cite-user; and
- the command <command>SET TRANSACTION</command> for more
+ Consult <xref linkend="mvcc"> and <xref linkend="sql-set-transaction"> for more
information.
</para>
</listitem>
</para>
<para>
- For more information on schema handling, see the &cite-user;.
+ For more information on schema handling, see <xref linkend="ddl-schemas">.
</para>
</listitem>
</varlistentry>
not included in versions prior to 7.1. If you need the old
behavior you can set this variable to off, but in the long run
you are encouraged to change your applications to use the
- <literal>ONLY</literal> key word to exclude subtables. See the
- SQL language reference and the &cite-user; for more information about inheritance.
+ <literal>ONLY</literal> key word to exclude subtables. See
+ <xref linkend="sql"> for more information about inheritance.
</para>
</listitem>
</varlistentry>
</para>
<para>
- Refer to the &cite-user; for related information.
+ Refer to <xref linkend="functions-comparison"> for related information.
</para>
</listitem>
</varlistentry>
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/standalone-install.sgml,v 2.3 2001/09/21 18:37:05 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/standalone-install.sgml,v 2.4 2003/03/25 16:15:38 petere Exp $ -->
<!--
This file helps in generating the INSTALL text file that lives in the
<!--
The standalone version has some portions that are different from the
-version that is integrated into the Administrator's Guide, in
+version that is integrated into the full documentation set, in
particular as regards links. The following are essentially SGML's
equivalent of C's #ifdef and friends. The other end of this is in
installation.sgml.
<!entity % standalone-include "INCLUDE">
<!--
-When you're building the Administrator's Guide, you want to flip the
+When you're building the full documentation set, you want to flip the
IGNORE and INCLUDE.
-->
]>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/start.sgml,v 1.28 2003/02/19 04:06:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/start.sgml,v 1.29 2003/03/25 16:15:38 petere Exp $
-->
<chapter id="tutorial-start">
<para>
If you are installing <productname>PostgreSQL</productname>
- yourself, then refer to the &cite-admin;
+ yourself, then refer to <xref linkend="installation">
for instructions on installation, and return to
this guide when the installation is complete. Be sure to follow
closely the section about setting up the appropriate environment
<para>
Writing a custom application, using one of the several
available language bindings. These possibilities are discussed
- further in the &cite-programmer;.
+ further in <xref linkend="client-interfaces">.
</para>
</listitem>
</itemizedlist>
command shell. (For more internal commands, type
<literal>\?</literal> at the <command>psql</command> prompt.) The
full capabilities of <command>psql</command> are documented in
-
the &cite-reference;. If <productname>PostgreSQL</> is
+
<xref linkend="reference">. If <productname>PostgreSQL</> is
installed correctly you can also type <literal>man psql</literal>
at the operating system shell prompt to see the documentation. In
this tutorial we will not use these features explicitly, but you
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/stylesheet.dsl,v 1.22 2002/10/12 16:33:43 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/stylesheet.dsl,v 1.23 2003/03/25 16:15:38 petere Exp $ -->
<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
<!-- must turn on one of these with -i on the jade command line -->
;; Returns the depth of auto TOC that should be made at the nd-level
(define (toc-depth nd)
- (cond ((string=? (gi nd) (normalize "book")) 3)
+ (cond ((string=? (gi nd) (normalize "book")) 2)
((string=? (gi nd) (normalize "set")) 2)
((string=? (gi nd) (normalize "part")) 2)
((string=? (gi nd) (normalize "chapter")) 2)
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/syntax.sgml,v 1.76 2003/03/13 01:30:29 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/syntax.sgml,v 1.77 2003/03/25 16:15:38 petere Exp $
-->
<chapter id="sql-syntax">
a <token>SET</token> token to appear in a certain position, and
this particular variation of <command>INSERT</command> also
requires a <token>VALUES</token> in order to be complete. The
- precise syntax rules for each command are described in the
- &cite-reference;.
+ precise syntax rules for each command are described in <xref linkend="reference">.
</para>
<sect2 id="sql-syntax-identifiers">
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/trigger.sgml,v 1.26 2002/11/23 03:59:06 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/trigger.sgml,v 1.27 2003/03/25 16:15:38 petere Exp $
-->
<chapter id="triggers">
</para>
<para>
- The syntax for creating triggers is described in &cite-reference;.
+ The syntax for creating triggers is described in <xref linkend="reference">.
</para>
<para>
+++ /dev/null
-<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/Attic/tutorial.sgml,v 1.18 2002/11/15 03:11:17 momjian Exp $
--->
-
-<book id="tutorial">
-
- <title>PostgreSQL &version; Tutorial</title>
- <bookinfo>
- <corpauthor>The PostgreSQL Global Development Group</corpauthor>
- &legal;
- </bookinfo>
-
- <preface id="tutorial-preface">
- <title>Preface</title>
-
-<![%single-book;[
- &intro;
- &history;
-]]>
-
- <sect1 id="tutorial-preface-thisbook">
- <title>What's In This Book</title>
-
- <para>
- Welcome to <productname>PostgreSQL</productname> and the
- <citetitle>PostgreSQL Tutorial</citetitle>. The following few
- chapters are intended to give a simple introduction to
- <productname>PostgreSQL</productname>, relational database
- concepts, and the SQL language to those who are new to any one of
- these aspects. We only assume some general knowledge about how to
- use computers. No particular Unix or programming experience is
- required. This book is mainly intended to give you a hands-on
- experience with important aspects of the
- <productname>PostgreSQL</productname> system. It makes no attempt
- to be a complete or thorough treatment of the topics it covers.
- </para>
-
- <para>
- After you have worked through this tutorial you might want to move
- on to reading the &cite-user; to gain a more formal knowledge of
- the SQL language, or the &cite-programmer; for information about
- developing applications for <productname>PostgreSQL</productname>.
- Those who set up and manage their own server should also read the
- &cite-admin;.
- </para>
- </sect1>
-
-<![%single-book;[
- &info;
- ¬ation;
- &problems;
-]]>
- </preface>
-
- &start;
- &query;
- &advanced;
-<![%single-book;[
- &biblio;
- &bookindex;
-]]>
-
-</book>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode:sgml
-sgml-omittag:nil
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-default-dtd-file:"./reference.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:("/usr/lib/sgml/catalog")
-sgml-local-ecat-files:nil
-End:
--->
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/typeconv.sgml,v 1.29 2003/03/20 16:17:32 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/typeconv.sgml,v 1.30 2003/03/25 16:15:38 petere Exp $
-->
<chapter Id="typeconv">
operators.
</para>
-<para>
-The &cite-programmer; has more details on the exact algorithms used for
-implicit type conversion and conversion.
-</para>
-
<sect1 id="typeconv-overview">
<title>Overview</title>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/user-manag.sgml,v 1.19 2003/03/13 01:30:29 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/user-manag.sgml,v 1.20 2003/03/25 16:15:38 petere Exp $
-->
<chapter id="user-manag">
<para>
This chapter describes how to create and manage users and introduces
the privilege system. More information about the various types of
- database objects and the effects of privileges can be found in the
- &cite-user;.
+ database objects and the effects of privileges can be found in <xref linkend="ddl">.
</para>
<sect1 id="database-users">
<sect1 id="privileges">
<title>Privileges</title>
- <comment>Being moved to User's Guide. Will eventually disappear here.</comment>
+ <comment>Being moved to the DDL chapter. Will eventually disappear here.</comment>
<para>
When a database object is created, it is assigned an owner. The
<literal>USAGE</>, and <literal>ALL PRIVILEGES</>. For more
information on the different types of privileges support by
<productname>PostgreSQL</productname>, refer to the
- <command>GRANT</command> page in the &cite-reference;. The right to modify or
+ <command>GRANT</command> page in <xref linkend="reference">. The right to modify or
destroy an object is always the privilege of the owner only. To
assign privileges, the <command>GRANT</command> command is
used. So, if <literal>joe</literal> is an existing user, and
+++ /dev/null
-<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/Attic/user.sgml,v 1.35 2002/11/15 03:11:17 momjian Exp $
--->
-
-<book id="user">
-
-<!-- Title information -->
-
- <title>PostgreSQL &version; User's Guide</title>
-
- <bookinfo>
- <corpauthor>The PostgreSQL Global Development Group</corpauthor>
- &legal;
- </bookinfo>
-
- <preface id="user-preface">
- <title>Preface</title>
-
- &intro;
- &history;
-
- <sect1 id="user-preface-thisbook">
- <title>What's In This Book</title>
-
- <para>
- This book describes the use of the <acronym>SQL</acronym> language
- in <productname>PostgreSQL</productname>. We start with
- describing the general syntax of <acronym>SQL</acronym>, then
- explain how to create the structures to hold data, how to populate
- the database, and how to query it. The middle part lists the
- available data types and functions for use in
- <acronym>SQL</acronym> data commands. The rest of the book treats
- several aspects that are important for tuning a database for
- optimal performance.
- </para>
-
- <para>
- The information in this book is arranged so that a novice user can
- follow it start to end to gain a full understanding of the topics
- without having to refer forward too many times. The chapters are
- intended to be self-contained, so that advanced users can read the
- chapters individually as they choose. The information in this
- book is presented in a narrative fashion in topical units.
- Readers looking for a complete description of a particular command
- should look into the &cite-reference;.
- </para>
-
- <para>
- Readers of this book should know how to connect to a <productname>PostgreSQL</>
- database and issue <acronym>SQL</acronym> commands. Readers that are unfamiliar with
- these issues are encouraged to read the &cite-tutorial; first. <acronym>SQL</acronym>
- commands are typically entered using the <productname>PostgreSQL</> interactive
- terminal <application>psql</application>, but other programs that
- have similar functionality can be used as well.
- </para>
-
- <para>
- This book covers <productname>PostgreSQL &version;</productname>
- only. For information on other versions, please read the
- documentation that accompanies that release.
- </para>
- </sect1>
-
- &info;
- ¬ation;
- &problems;
- </preface>
-
- &syntax;
- &ddl;
- &dml;
- &queries;
- &datatype;
- &func;
- &typeconv;
- &indices;
- &mvcc;
- &perform;
-
- <!-- appendices -->
-
- &datetime;
- &keywords;
- &features;
-
- &biblio;
-
- <![%single-book;[
- &bookindex;
- ]]>
-
-</book>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode:sgml
-sgml-omittag:nil
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-default-dtd-file:"./reference.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:("/usr/lib/sgml/catalog")
-sgml-local-ecat-files:nil
-End:
--->
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/xaggr.sgml,v 1.18 2003/01/19 00:13:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/xaggr.sgml,v 1.19 2003/03/25 16:15:38 petere Exp $
-->
<chapter id="xaggr">
<para>
For further details see the description of the <command>CREATE
- AGGREGATE</command> command in the &cite-reference;.
+ AGGREGATE</command> command in <xref linkend="reference">.
</para>
</chapter>
<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/xfunc.sgml,v 1.65 2003/02/19 04:06:28 momjian Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/xfunc.sgml,v 1.66 2003/03/25 16:15:38 petere Exp $
-->
<chapter id="xfunc">
it is not immediately clear which function would be called with
some trivial input like <literal>test(1, 1.5)</literal>. The
currently implemented resolution rules are described in the
- &cite-user;, but it is unwise to design a system that subtly
+ <xref linkend="typeconv">, but it is unwise to design a system that subtly
relies on this behavior.
</para>
* Portions Copyright (c) 1994, Regents of the University of California
*
* IDENTIFICATION
- * $Header: /cvsroot/pgsql/src/backend/port/sysv_sema.c,v 1.4 2002/09/04 20:31:24 momjian Exp $
+ * $Header: /cvsroot/pgsql/src/backend/port/sysv_sema.c,v 1.5 2003/03/25 16:15:44 petere Exp $
*
*-------------------------------------------------------------------------
*/
"consumption of semaphores by reducing its max_connections parameter\n"
"(currently %d).\n"
"\n"
- "The PostgreSQL Administrator's Guide contains more information about\n"
+ "The PostgreSQL documentation contains more information about\n"
"configuring your system for PostgreSQL.\n\n",
MaxBackends);
* Portions Copyright (c) 1994, Regents of the University of California
*
* IDENTIFICATION
- * $Header: /cvsroot/pgsql/src/backend/port/sysv_shmem.c,v 1.4 2002/09/04 20:31:24 momjian Exp $
+ * $Header: /cvsroot/pgsql/src/backend/port/sysv_shmem.c,v 1.5 2003/03/25 16:15:44 petere Exp $
*
*-------------------------------------------------------------------------
*/
"\nThis error usually means that PostgreSQL's request for a shared memory\n"
"segment exceeded your kernel's SHMMAX parameter. You can either\n"
"reduce the request size or reconfigure the kernel with larger SHMMAX.\n"
- "To reduce the request size (currently %u bytes), reduce\n"
+ "To reduce the request size (currently %u bytes), reduce\n"
"PostgreSQL's shared_buffers parameter (currently %d) and/or\n"
"its max_connections parameter (currently %d).\n"
"\n"
"your kernel's SHMMIN parameter, in which case raising the request size or\n"
"reconfiguring SHMMIN is called for.\n"
"\n"
- "The PostgreSQL Administrator's Guide contains more information about\n"
- "shared memory configuration.\n\n",
+ "The PostgreSQL documentation contains more information about shared\n"
+ "memory configuration.\n\n",
size, NBuffers, MaxBackends);
else if (errno == ENOMEM)
fprintf(stderr,
"\nThis error usually means that PostgreSQL's request for a shared\n"
- "memory segment exceeded available memory or swap space.\n"
- "To reduce the request size (currently %u bytes), reduce\n"
+ "memory segment exceeded available memory or swap space.\n"
+ "To reduce the request size (currently %u bytes), reduce\n"
"PostgreSQL's shared_buffers parameter (currently %d) and/or\n"
"its max_connections parameter (currently %d).\n"
"\n"
- "The PostgreSQL Administrator's Guide contains more information about\n"
- "shared memory configuration.\n\n",
+ "The PostgreSQL documentation contains more information about shared\n"
+ "memory configuration.\n\n",
size, NBuffers, MaxBackends);
else if (errno == ENOSPC)
"by reducing its shared_buffers parameter (currently %d) and/or\n"
"its max_connections parameter (currently %d).\n"
"\n"
- "The PostgreSQL Administrator's Guide contains more information about\n"
- "shared memory configuration.\n\n",
+ "The PostgreSQL documentation contains more information about shared\n"
+ "memory configuration.\n\n",
size, NBuffers, MaxBackends);
proc_exit(1);
# Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
# Portions Copyright (c) 1994, Regents of the University of California
#
-# $Header: /cvsroot/pgsql/src/bin/initdb/Attic/initdb.sh,v 1.186 2003/03/20 03:34:56 momjian Exp $
+# $Header: /cvsroot/pgsql/src/bin/initdb/Attic/initdb.sh,v 1.187 2003/03/25 16:15:44 petere Exp $
#
#-------------------------------------------------------------------------
if test x`pg_getlocale COLLATE` != xC && test x`pg_getlocale COLLATE` != xPOSIX; then
echo "This locale setting will prevent the use of indexes for pattern matching"
echo "operations. If that is a concern, rerun $CMDNAME with the collation order"
- echo "set to \"C\". For more information see the Administrator's Guide."
+ echo "set to \"C\". For more information see the documentation."
fi
echo
OSDN Git Service
