doc/src/sgml/postgres.sgml

   1 <!-- doc/src/sgml/postgres.sgml -->
   2
   3 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   4           "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
   5 [
   6
   7 <!ENTITY % version SYSTEM "version.sgml">
   8 %version;
   9 <!ENTITY % filelist SYSTEM "filelist.sgml">
  10 %filelist;
  11
  12 <!ENTITY reference  SYSTEM "reference.sgml">
  13
  14 <!--
  15 Zero-width space.  Use this to allow line breaks at desirable places in
  16 table cells, examples, etc. without causing an unwanted space when the
  17 break is not needed in a wider output rendering.
  18 -->
  19 <!ENTITY zwsp "&#x200B;">
  20
  21 ]>
  22
  23 <book id="postgres">
  24  <title>PostgreSQL &version; Documentation</title>
  25
  26  <bookinfo>
  27   <corpauthor>The PostgreSQL Global Development Group</corpauthor>
  28   <productname>PostgreSQL</productname>
  29   <productnumber>&version;</productnumber>
  30   &legal;
  31  </bookinfo>
  32
  33  &intro;
  34
  35  <part id="tutorial">
  36   <title>Tutorial</title>
  37
  38   <partintro>
  39    <para>
  40     Welcome to the <productname>PostgreSQL</productname> Tutorial.  The
  41     tutorial is intended to give an introduction
  42     to <productname>PostgreSQL</productname>, relational database
  43     concepts, and the SQL language. We assume some general knowledge about
  44     how to use computers and no particular Unix or programming experience is
  45     required.  This tutorial is intended to provide hands-on experience with
  46     important aspects of the <productname>PostgreSQL</productname> system.
  47     It makes no attempt to be a comprehensive treatment of the topics it covers.
  48    </para>
  49
  50    <para>
  51     After you have successfully completed this tutorial you will want to
  52     read the <xref linkend="sql"/> section to gain a better understanding
  53     of the SQL language, or <xref linkend="client-interfaces"/> for
  54     information about developing applications with
  55     <productname>PostgreSQL</productname>.  Those who provision and
  56     manage their own PostgreSQL installation should also read <xref linkend="admin"/>.
  57    </para>
  58   </partintro>
  59
  60   &start;
  61   &query;
  62   &advanced;
  63
  64  </part>
  65
  66  <part id="sql">
  67   <title>The SQL Language</title>
  68
  69   <partintro>
  70    <para>
  71     This part describes the use of the <acronym>SQL</acronym> language
  72     in <productname>PostgreSQL</productname>.  We start with
  73     describing the general syntax of <acronym>SQL</acronym>, then
  74     how to create tables, how to populate the database, and how to
  75     query it.  The middle part lists the available data types and
  76     functions for use in <acronym>SQL</acronym> commands.  Lastly,
  77     we address several aspects of importance for tuning a database.
  78    </para>
  79
  80    <para>
  81     The information is arranged so that a novice user can
  82     follow it from start to end and gain a full understanding of the topics
  83     without having to refer forward too many times.  The chapters are
  84     intended to be self-contained, so that advanced users can read the
  85     chapters individually as they choose.  The information is presented
  86     in narrative form with topical units. Readers looking for a complete
  87     description of a particular command are encouraged to review
  88     the <xref linkend="reference"/>.
  89    </para>
  90
  91    <para>
  92     Readers should know how to connect to a
  93     <productname>PostgreSQL</productname> database and issue
  94     <acronym>SQL</acronym> commands.  Readers that are unfamiliar with
  95     these issues are encouraged to read <xref linkend="tutorial"/>
  96     first.  <acronym>SQL</acronym> commands are typically entered
  97     using the <productname>PostgreSQL</productname> interactive terminal
  98     <application>psql</application>, but other programs that have
  99     similar functionality can be used as well.
 100    </para>
 101   </partintro>
 102
 103   &syntax;
 104   &ddl;
 105   &dml;
 106   &queries;
 107   &datatype;
 108   &func;
 109   &typeconv;
 110   &indices;
 111   &textsearch;
 112   &mvcc;
 113   &perform;
 114   &parallel;
 115
 116  </part>
 117
 118  <part id="admin">
 119   <title>Server Administration</title>
 120
 121   <partintro>
 122    <para>
 123     This part covers topics that are of interest to a
 124     <productname>PostgreSQL</productname> administrator.  This includes
 125     installation, configuration of the server, management of users
 126     and databases, and maintenance tasks. Anyone running
 127     <productname>PostgreSQL</productname> server, even for
 128     personal use, but especially in production, should be familiar
 129     with these topics.
 130    </para>
 131
 132    <para>
 133     The information attempts to be in the order in which
 134     a new user should read it.  The chapters are self-contained and
 135     can be read individually as desired.  The information is presented
 136     in a narrative form in topical units.  Readers looking for a complete
 137     description of a command are encouraged to review the
 138     <xref linkend="reference"/>.
 139    </para>
 140
 141    <para>
 142     The first few chapters are written so they can be understood
 143     without prerequisite knowledge, so new users who need to set
 144     up their own server can begin their exploration. The rest of this
 145     part is about tuning and management; that material
 146     assumes that the reader is familiar with the general use of
 147     the <productname>PostgreSQL</productname> database system.  Readers are
 148     encouraged review the <xref linkend="tutorial"/> and <xref
 149     linkend="sql"/> parts for additional information.
 150    </para>
 151   </partintro>
 152
 153   &installbin;
 154   &installation;
 155   &runtime;
 156   &config;
 157   &client-auth;
 158   &user-manag;
 159   &manage-ag;
 160   &charset;
 161   &maintenance;
 162   &backup;
 163   &high-availability;
 164   &monitoring;
 165   &wal;
 166   &logical-replication;
 167   &jit;
 168   &regress;
 169
 170  </part>
 171
 172  <part id="client-interfaces">
 173   <title>Client Interfaces</title>
 174
 175   <partintro>
 176    <para>
 177     This part describes the client programming interfaces distributed
 178     with <productname>PostgreSQL</productname>.  Each of these chapters can be
 179     read independently.  There are many external programming
 180     interfaces for client programs that are distributed separately. They
 181     contain their own documentation (<xref linkend="external-projects"/>
 182     lists some of the more popular ones).  Readers of this part should be
 183     familiar with using <acronym>SQL</acronym> to manipulate
 184     and query the database (see <xref linkend="sql"/>) and of course
 185     with the programming language of their choice.
 186    </para>
 187   </partintro>
 188
 189   &libpq;
 190   &lobj;
 191   &ecpg;
 192   &infoschema;
 193
 194  </part>
 195
 196  <part id="server-programming">
 197   <title>Server Programming</title>
 198
 199   <partintro>
 200    <para>
 201     This part is about extending the server functionality with
 202     user-defined functions, data types, triggers, etc.  These are
 203     advanced topics which should be approached only after all
 204     the other user documentation about <productname>PostgreSQL</productname> has
 205     been understood.  Later chapters in this part describe the server-side
 206     programming languages available in the
 207     <productname>PostgreSQL</productname> distribution as well as
 208     general issues concerning server-side programming.  It
 209     is essential to read at least the earlier sections of <xref
 210     linkend="extend"/> (covering functions) before diving into the
 211     material about server-side programming.
 212    </para>
 213   </partintro>
 214
 215   &extend;
 216   &trigger;
 217   &event-trigger;
 218   &rules;
 219
 220   &xplang;
 221   &plsql;
 222   &pltcl;
 223   &plperl;
 224   &plpython;
 225
 226   &spi;
 227   &bgworker;
 228   &logicaldecoding;
 229   &replication-origins;
 230   &archive-modules;
 231
 232  </part>
 233
 234  &reference;
 235
 236  <part id="internals">
 237   <title>Internals</title>
 238
 239   <partintro>
 240    <para>
 241     This part contains assorted information that might be of use to
 242     <productname>PostgreSQL</productname> developers.
 243    </para>
 244   </partintro>
 245
 246   &arch-dev;
 247   &catalogs;
 248   &system-views;
 249   &protocol;
 250   &sources;
 251   &nls;
 252   &plhandler;
 253   &fdwhandler;
 254   &tablesample-method;
 255   &custom-scan;
 256   &geqo;
 257   &tableam;
 258   &indexam;
 259   &wal-for-extensions;
 260   &indextypes;
 261   &storage;
 262   &transaction;
 263   &bki;
 264   &planstats;
 265   &backup-manifest;
 266
 267  </part>
 268
 269  <part id="appendixes">
 270   <title>Appendixes</title>
 271
 272   &errcodes;
 273   &datetime;
 274   &keywords;
 275   &features;
 276   &release;
 277   &contrib;
 278   &external-projects;
 279   &sourcerepo;
 280   &docguide;
 281   &limits;
 282   &acronyms;
 283   &glossary;
 284   &color;
 285   &obsolete;
 286
 287  </part>
 288
 289  &biblio;
 290  <index id="bookindex"></index>
 291
 292 </book>