database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-06-29 10:41:53 +03:00
Code Activity

Merge documentation into one book. (Build with "make html".) Replace

Browse Source 
vague cross-references with real links.
This commit is contained in:
Peter Eisentraut
2003-03-25 16:15:44 +00:00
parent 685a4934d2
commit 5e5c5cd31a
93 changed files with 548 additions and 1049 deletions
Download Patch File Download Diff File Expand all files Collapse all files

292
doc/src/sgml/postgres.sgml
View File

@ -1,61 +1,273 @@
<!--
$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;
&notation;
&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;
&regress;
</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>
<part id="internals">
<title>Internals</title>
<!-- 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:
-->
<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>