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   &alterProcedure;
58   &alterPublication;
59   &alterRole;
60   &alterRoutine;
61   &alterRule;
62   &alterSchema;
63   &alterSequence;
64   &alterServer;
65   &alterStatistics;
66   &alterSubscription;
67   &alterSystem;
68   &alterTable;
69   &alterTableSpace;
70   &alterTSConfig;
71   &alterTSDictionary;
72   &alterTSParser;
73   &alterTSTemplate;
74   &alterTrigger;
75   &alterType;
76   &alterUser;
77   &alterUserMapping;
78   &alterView;
79   &analyze;
80   &begin;
81   &call;
82   &checkpoint;
83   &close;
84   &cluster;
85   &commentOn;
86   &commit;
87   &commitPrepared;
88   &copyTable;
89   &createAccessMethod;
90   &createAggregate;
91   &createCast;
92   &createCollation;
93   &createConversion;
94   &createDatabase;
95   &createDomain;
96   &createEventTrigger;
97   &createExtension;
98   &createForeignDataWrapper;
99   &createForeignTable;
100   &createFunction;
101   &createGroup;
102   &createIndex;
103   &createLanguage;
104   &createMaterializedView;
105   &createOperator;
106   &createOperatorClass;
107   &createOperatorFamily;
108   &createPolicy;
109   &createProcedure;
110   &createPublication;
111   &createRole;
112   &createRule;
113   &createSchema;
114   &createSequence;
115   &createServer;
116   &createStatistics;
117   &createSubscription;
118   &createTable;
119   &createTableAs;
120   &createTableSpace;
121   &createTSConfig;
122   &createTSDictionary;
123   &createTSParser;
124   &createTSTemplate;
125   &createTransform;
126   &createTrigger;
127   &createType;
128   &createUser;
129   &createUserMapping;
130   &createView;
131   &deallocate;
132   &declare;
133   &delete;
134   &discard;
135   &do;
136   &dropAccessMethod;
137   &dropAggregate;
138   &dropCast;
139   &dropCollation;
140   &dropConversion;
141   &dropDatabase;
142   &dropDomain;
143   &dropEventTrigger;
144   &dropExtension;
145   &dropForeignDataWrapper;
146   &dropForeignTable;
147   &dropFunction;
148   &dropGroup;
149   &dropIndex;
150   &dropLanguage;
151   &dropMaterializedView;
152   &dropOperator;
153   &dropOperatorClass;
154   &dropOperatorFamily;
155   &dropOwned;
156   &dropPolicy;
157   &dropProcedure;
158   &dropPublication;
159   &dropRole;
160   &dropRoutine;
161   &dropRule;
162   &dropSchema;
163   &dropSequence;
164   &dropServer;
165   &dropStatistics;
166   &dropSubscription;
167   &dropTable;
168   &dropTableSpace;
169   &dropTSConfig;
170   &dropTSDictionary;
171   &dropTSParser;
172   &dropTSTemplate;
173   &dropTransform;
174   &dropTrigger;
175   &dropType;
176   &dropUser;
177   &dropUserMapping;
178   &dropView;
179   &end;
180   &execute;
181   &explain;
182   &fetch;
183   &grant;
184   &importForeignSchema;
185   &insert;
186   &listen;
187   &load;
188   &lock;
189   &move;
190   &notify;
191   &prepare;
192   &prepareTransaction;
193   &reassignOwned;
194   &refreshMaterializedView;
195   &reindex;
196   &releaseSavepoint;
197   &reset;
198   &revoke;
199   &rollback;
200   &rollbackPrepared;
201   &rollbackTo;
202   &savepoint;
203   &securityLabel;
204   &select;
205   &selectInto;
206   &set;
207   &setConstraints;
208   &setRole;
209   &setSessionAuth;
210   &setTransaction;
211   &show;
212   &startTransaction;
213   &truncate;
214   &unlisten;
215   &update;
216   &vacuum;
217   &values;
218
219 </reference>
220
221 <reference id="reference-client">
222  <title>PostgreSQL Client Applications</title>
223
224  <partintro>
225   <para>
226    This part contains reference information for
227    <productname>PostgreSQL</productname> client applications and
228    utilities.  Not all of these commands are of general utility; some
229    might require special privileges.  The common feature of these
230    applications is that they can be run on any host, independent of
231    where the database server resides.
232   </para>
233
234   <para>
235    When specified on the command line, user and database names have
236    their case preserved &mdash; the presence of spaces or special
237    characters might require quoting.  Table names and other identifiers
238    do not have their case preserved, except where documented, and
239    might require quoting.
240   </para>
241  </partintro>
242
243   &clusterdb;
244   &createdb;
245   &createuser;
246   &dropdb;
247   &dropuser;
248   &ecpgRef;
249   &pgBasebackup;
250   &pgbench;
251   &pgConfig;
252   &pgDump;
253   &pgDumpall;
254   &pgIsready;
255   &pgReceivewal;
256   &pgRecvlogical;
257   &pgRestore;
258   &psqlRef;
259   &reindexdb;
260   &vacuumdb;
261
262 </reference>
263
264 <reference id="reference-server">
265  <title>PostgreSQL Server Applications</title>
266
267  <partintro>
268   <para>
269    This part contains reference information for
270    <productname>PostgreSQL</productname> server applications and
271    support utilities.  These commands can only be run usefully on the
272    host where the database server resides.  Other utility programs
273    are listed in <xref linkend="reference-client"/>.
274   </para>
275  </partintro>
276
277   &initdb;
278   &pgarchivecleanup;
279   &pgChecksums;
280   &pgControldata;
281   &pgCtl;
282   &pgResetwal;
283   &pgRewind;
284   &pgtestfsync;
285   &pgtesttiming;
286   &pgupgrade;
287   &pgwaldump;
288   &postgres;
289   &postmaster;
290
291 </reference>
292
293</part>
294