1<!-- doc/src/sgml/reference.sgml -->
2
3<part id="reference">
4 <title>Reference</title>
5
6 <partintro>
7  <para>
8   The entries in this Reference are meant to provide in reasonable
9   length an authoritative, complete, and formal summary about their
10   respective subjects.  More information about the use of
11   <productname>PostgreSQL</productname>, in narrative, tutorial, or
12   example form, can be found in other parts of this book.  See the
13   cross-references listed on each reference page.
14  </para>
15
16  <para>
17   The reference entries are also available as traditional
18   <quote>man</quote> pages.
19  </para>
20 </partintro>
21
22 <reference id="sql-commands">
23  <title>SQL Commands</title>
24
25  <partintro>
26   <para>
27    This part contains reference information for the
28    <acronym>SQL</acronym> commands supported by
29    <productname>PostgreSQL</productname>.  By <quote>SQL</quote> the
30    language in general is meant; information about the standards
31    conformance and compatibility of each command can be found on the
32    respective reference page.
33   </para>
34  </partintro>
35
36   &abort;
37   &alterAggregate;
38   &alterCollation;
39   &alterConversion;
40   &alterDatabase;
41   &alterDefaultPrivileges;
42   &alterDomain;
43   &alterEventTrigger;
44   &alterExtension;
45   &alterForeignDataWrapper;
46   &alterForeignTable;
47   &alterFunction;
48   &alterGroup;
49   &alterIndex;
50   &alterLanguage;
51   &alterLargeObject;
52   &alterMaterializedView;
53   &alterOperator;
54   &alterOperatorClass;
55   &alterOperatorFamily;
56   &alterPolicy;
57   &alterPublication;
58   &alterRole;
59   &alterRule;
60   &alterSchema;
61   &alterSequence;
62   &alterServer;
63   &alterStatistics;
64   &alterSubscription;
65   &alterSystem;
66   &alterTable;
67   &alterTableSpace;
68   &alterTSConfig;
69   &alterTSDictionary;
70   &alterTSParser;
71   &alterTSTemplate;
72   &alterTrigger;
73   &alterType;
74   &alterUser;
75   &alterUserMapping;
76   &alterView;
77   &analyze;
78   &begin;
79   &checkpoint;
80   &close;
81   &cluster;
82   &commentOn;
83   &commit;
84   &commitPrepared;
85   &copyTable;
86   &createAccessMethod;
87   &createAggregate;
88   &createCast;
89   &createCollation;
90   &createConversion;
91   &createDatabase;
92   &createDomain;
93   &createEventTrigger;
94   &createExtension;
95   &createForeignDataWrapper;
96   &createForeignTable;
97   &createFunction;
98   &createGroup;
99   &createIndex;
100   &createLanguage;
101   &createMaterializedView;
102   &createOperator;
103   &createOperatorClass;
104   &createOperatorFamily;
105   &createPolicy;
106   &createPublication;
107   &createRole;
108   &createRule;
109   &createSchema;
110   &createSequence;
111   &createServer;
112   &createStatistics;
113   &createSubscription;
114   &createTable;
115   &createTableAs;
116   &createTableSpace;
117   &createTSConfig;
118   &createTSDictionary;
119   &createTSParser;
120   &createTSTemplate;
121   &createTransform;
122   &createTrigger;
123   &createType;
124   &createUser;
125   &createUserMapping;
126   &createView;
127   &deallocate;
128   &declare;
129   &delete;
130   &discard;
131   &do;
132   &dropAccessMethod;
133   &dropAggregate;
134   &dropCast;
135   &dropCollation;
136   &dropConversion;
137   &dropDatabase;
138   &dropDomain;
139   &dropEventTrigger;
140   &dropExtension;
141   &dropForeignDataWrapper;
142   &dropForeignTable;
143   &dropFunction;
144   &dropGroup;
145   &dropIndex;
146   &dropLanguage;
147   &dropMaterializedView;
148   &dropOperator;
149   &dropOperatorClass;
150   &dropOperatorFamily;
151   &dropOwned;
152   &dropPolicy;
153   &dropPublication;
154   &dropRole;
155   &dropRule;
156   &dropSchema;
157   &dropSequence;
158   &dropServer;
159   &dropStatistics;
160   &dropSubscription;
161   &dropTable;
162   &dropTableSpace;
163   &dropTSConfig;
164   &dropTSDictionary;
165   &dropTSParser;
166   &dropTSTemplate;
167   &dropTransform;
168   &dropTrigger;
169   &dropType;
170   &dropUser;
171   &dropUserMapping;
172   &dropView;
173   &end;
174   &execute;
175   &explain;
176   &fetch;
177   &grant;
178   &importForeignSchema;
179   &insert;
180   &listen;
181   &load;
182   &lock;
183   &move;
184   &notify;
185   &prepare;
186   &prepareTransaction;
187   &reassignOwned;
188   &refreshMaterializedView;
189   &reindex;
190   &releaseSavepoint;
191   &reset;
192   &revoke;
193   &rollback;
194   &rollbackPrepared;
195   &rollbackTo;
196   &savepoint;
197   &securityLabel;
198   &select;
199   &selectInto;
200   &set;
201   &setConstraints;
202   &setRole;
203   &setSessionAuth;
204   &setTransaction;
205   &show;
206   &startTransaction;
207   &truncate;
208   &unlisten;
209   &update;
210   &vacuum;
211   &values;
212
213 </reference>
214
215 <reference id="reference-client">
216  <title>PostgreSQL Client Applications</title>
217
218  <partintro>
219   <para>
220    This part contains reference information for
221    <productname>PostgreSQL</productname> client applications and
222    utilities.  Not all of these commands are of general utility; some
223    might require special privileges.  The common feature of these
224    applications is that they can be run on any host, independent of
225    where the database server resides.
226   </para>
227
228   <para>
229    When specified on the command line, user and database names have
230    their case preserved &mdash; the presence of spaces or special
231    characters might require quoting.  Table names and other identifiers
232    do not have their case preserved, except where documented, and
233    might require quoting.
234   </para>
235  </partintro>
236
237   &clusterdb;
238   &createdb;
239   &createuser;
240   &dropdb;
241   &dropuser;
242   &ecpgRef;
243   &pgBasebackup;
244   &pgbench;
245   &pgConfig;
246   &pgDump;
247   &pgDumpall;
248   &pgIsready;
249   &pgReceivewal;
250   &pgRecvlogical;
251   &pgRestore;
252   &psqlRef;
253   &reindexdb;
254   &vacuumdb;
255
256 </reference>
257
258 <reference id="reference-server">
259  <title>PostgreSQL Server Applications</title>
260
261  <partintro>
262   <para>
263    This part contains reference information for
264    <productname>PostgreSQL</productname> server applications and
265    support utilities.  These commands can only be run usefully on the
266    host where the database server resides.  Other utility programs
267    are listed in <xref linkend="reference-client">.
268   </para>
269  </partintro>
270
271   &initdb;
272   &pgarchivecleanup;
273   &pgControldata;
274   &pgCtl;
275   &pgResetwal;
276   &pgRewind;
277   &pgtestfsync;
278   &pgtesttiming;
279   &pgupgrade;
280   &pgwaldump;
281   &postgres;
282   &postmaster;
283
284 </reference>
285
286</part>
287