| 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 |
©Table; |
| 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 |
&merge; |
| 190 |
&move; |
| 191 |
¬ify; |
| 192 |
&prepare; |
| 193 |
&prepareTransaction; |
| 194 |
&reassignOwned; |
| 195 |
&refreshMaterializedView; |
| 196 |
&reindex; |
| 197 |
&releaseSavepoint; |
| 198 |
&reset; |
| 199 |
&revoke; |
| 200 |
&rollback; |
| 201 |
&rollbackPrepared; |
| 202 |
&rollbackTo; |
| 203 |
&savepoint; |
| 204 |
&securityLabel; |
| 205 |
&select; |
| 206 |
&selectInto; |
| 207 |
&set; |
| 208 |
&setConstraints; |
| 209 |
&setRole; |
| 210 |
&setSessionAuth; |
| 211 |
&setTransaction; |
| 212 |
&show; |
| 213 |
&startTransaction; |
| 214 |
&truncate; |
| 215 |
&unlisten; |
| 216 |
&update; |
| 217 |
&vacuum; |
| 218 |
&values; |
| 219 |
|
| 220 |
</reference> |
| 221 |
|
| 222 |
<reference id="reference-client"> |
| 223 |
<title>PostgreSQL Client Applications</title> |
| 224 |
|
| 225 |
<partintro> |
| 226 |
<para> |
| 227 |
This part contains reference information for |
| 228 |
<productname>PostgreSQL</productname> client applications and |
| 229 |
utilities. Not all of these commands are of general utility; some |
| 230 |
might require special privileges. The common feature of these |
| 231 |
applications is that they can be run on any host, independent of |
| 232 |
where the database server resides. |
| 233 |
</para> |
| 234 |
|
| 235 |
<para> |
| 236 |
When specified on the command line, user and database names have |
| 237 |
their case preserved — the presence of spaces or special |
| 238 |
characters might require quoting. Table names and other identifiers |
| 239 |
do not have their case preserved, except where documented, and |
| 240 |
might require quoting. |
| 241 |
</para> |
| 242 |
</partintro> |
| 243 |
|
| 244 |
&clusterdb; |
| 245 |
&createdb; |
| 246 |
&createuser; |
| 247 |
&dropdb; |
| 248 |
&dropuser; |
| 249 |
&ecpgRef; |
| 250 |
&pgamcheck; |
| 251 |
&pgBasebackup; |
| 252 |
&pgbench; |
| 253 |
&pgCombinebackup; |
| 254 |
&pgConfig; |
| 255 |
&pgDump; |
| 256 |
&pgDumpall; |
| 257 |
&pgIsready; |
| 258 |
&pgReceivewal; |
| 259 |
&pgRecvlogical; |
| 260 |
&pgRestore; |
| 261 |
&pgVerifyBackup; |
| 262 |
&psqlRef; |
| 263 |
&reindexdb; |
| 264 |
&vacuumdb; |
| 265 |
|
| 266 |
</reference> |
| 267 |
|
| 268 |
<reference id="reference-server"> |
| 269 |
<title>PostgreSQL Server Applications</title> |
| 270 |
|
| 271 |
<partintro> |
| 272 |
<para> |
| 273 |
This part contains reference information for |
| 274 |
<productname>PostgreSQL</productname> server applications and |
| 275 |
support utilities. These commands can only be run usefully on the |
| 276 |
host where the database server resides. Other utility programs |
| 277 |
are listed in <xref linkend="reference-client"/>. |
| 278 |
</para> |
| 279 |
</partintro> |
| 280 |
|
| 281 |
&initdb; |
| 282 |
&pgarchivecleanup; |
| 283 |
&pgChecksums; |
| 284 |
&pgControldata; |
| 285 |
&pgCreateSubscriber; |
| 286 |
&pgCtl; |
| 287 |
&pgResetwal; |
| 288 |
&pgRewind; |
| 289 |
&pgtestfsync; |
| 290 |
&pgtesttiming; |
| 291 |
&pgupgrade; |
| 292 |
&pgwaldump; |
| 293 |
&pgwalsummary; |
| 294 |
&postgres; |
| 295 |
|
| 296 |
</reference> |
| 297 |
|
| 298 |
</part> |