select.sgml 62.2 KB
Newer Older
1
<!--
2
$PostgreSQL: pgsql/doc/src/sgml/ref/select.sgml,v 1.122 2009/05/03 20:45:43 tgl Exp $
3
PostgreSQL documentation
4 5
-->

6 7
<refentry id="SQL-SELECT">
 <refmeta>
8
  <refentrytitle id="sql-select-title">SELECT</refentrytitle>
9
  <manvolnum>7</manvolnum>
10 11
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>
12

13
 <refnamediv>
14
  <refname>SELECT</refname>
P
Peter Eisentraut 已提交
15
  <refname>TABLE</refname>
16
  <refname>WITH</refname>
17 18 19
  <refpurpose>retrieve rows from a table or view</refpurpose>
 </refnamediv>

P
Peter Eisentraut 已提交
20 21 22 23
 <indexterm zone="sql-select">
  <primary>SELECT</primary>
 </indexterm>

P
Peter Eisentraut 已提交
24 25 26 27
 <indexterm zone="sql-select">
  <primary>TABLE command</primary>
 </indexterm>

28 29 30 31 32
 <indexterm zone="sql-select">
  <primary>WITH</primary>
  <secondary>in SELECT</secondary>
 </indexterm>

33
 <refsynopsisdiv>
34
<synopsis>
35
[ WITH [ RECURSIVE ] <replaceable class="parameter">with_query</replaceable> [, ...] ]
36
SELECT [ ALL | DISTINCT [ ON ( <replaceable class="parameter">expression</replaceable> [, ...] ) ] ]
37
    * | <replaceable class="parameter">expression</replaceable> [ [ AS ] <replaceable class="parameter">output_name</replaceable> ] [, ...]
38 39 40 41
    [ FROM <replaceable class="parameter">from_item</replaceable> [, ...] ]
    [ WHERE <replaceable class="parameter">condition</replaceable> ]
    [ GROUP BY <replaceable class="parameter">expression</replaceable> [, ...] ]
    [ HAVING <replaceable class="parameter">condition</replaceable> [, ...] ]
T
Tom Lane 已提交
42
    [ WINDOW <replaceable class="parameter">window_name</replaceable> AS ( <replaceable class="parameter">window_definition</replaceable> ) [, ...] ]
43
    [ { UNION | INTERSECT | EXCEPT } [ ALL ] <replaceable class="parameter">select</replaceable> ]
44
    [ ORDER BY <replaceable class="parameter">expression</replaceable> [ ASC | DESC | USING <replaceable class="parameter">operator</replaceable> ] [ NULLS { FIRST | LAST } ] [, ...] ]
45
    [ LIMIT { <replaceable class="parameter">count</replaceable> | ALL } ]
46 47
    [ OFFSET <replaceable class="parameter">start</replaceable> [ ROW | ROWS ] ]
    [ FETCH { FIRST | NEXT } [ <replaceable class="parameter">count</replaceable> ] { ROW | ROWS } ONLY ]
48
    [ FOR { UPDATE | SHARE } [ OF <replaceable class="parameter">table_name</replaceable> [, ...] ] [ NOWAIT ] [...] ]
49 50 51 52 53

where <replaceable class="parameter">from_item</replaceable> can be one of:

    [ ONLY ] <replaceable class="parameter">table_name</replaceable> [ * ] [ [ AS ] <replaceable class="parameter">alias</replaceable> [ ( <replaceable class="parameter">column_alias</replaceable> [, ...] ) ] ]
    ( <replaceable class="parameter">select</replaceable> ) [ AS ] <replaceable class="parameter">alias</replaceable> [ ( <replaceable class="parameter">column_alias</replaceable> [, ...] ) ]
54
    <replaceable class="parameter">with_query_name</replaceable> [ [ AS ] <replaceable class="parameter">alias</replaceable> [ ( <replaceable class="parameter">column_alias</replaceable> [, ...] ) ] ]
55 56 57
    <replaceable class="parameter">function_name</replaceable> ( [ <replaceable class="parameter">argument</replaceable> [, ...] ] ) [ AS ] <replaceable class="parameter">alias</replaceable> [ ( <replaceable class="parameter">column_alias</replaceable> [, ...] | <replaceable class="parameter">column_definition</replaceable> [, ...] ) ]
    <replaceable class="parameter">function_name</replaceable> ( [ <replaceable class="parameter">argument</replaceable> [, ...] ] ) AS ( <replaceable class="parameter">column_definition</replaceable> [, ...] )
    <replaceable class="parameter">from_item</replaceable> [ NATURAL ] <replaceable class="parameter">join_type</replaceable> <replaceable class="parameter">from_item</replaceable> [ ON <replaceable class="parameter">join_condition</replaceable> | USING ( <replaceable class="parameter">join_column</replaceable> [, ...] ) ]
58 59 60 61

and <replaceable class="parameter">with_query</replaceable> is:

    <replaceable class="parameter">with_query_name</replaceable> [ ( <replaceable class="parameter">column_name</replaceable> [, ...] ) ] AS ( <replaceable class="parameter">select</replaceable> )
P
Peter Eisentraut 已提交
62

63
TABLE { [ ONLY ] <replaceable class="parameter">table_name</replaceable> [ * ] | <replaceable class="parameter">with_query_name</replaceable> }
64 65 66 67 68 69 70 71
</synopsis>

 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <para>
B
Bruce Momjian 已提交
72
   <command>SELECT</command> retrieves rows from zero or more tables.
73 74 75
   The general processing of <command>SELECT</command> is as follows:

   <orderedlist>
76 77 78 79 80 81 82 83 84 85 86
    <listitem>
     <para>
      All queries in the <literal>WITH</literal> list are computed.
      These effectively serve as temporary tables that can be referenced
      in the <literal>FROM</literal> list.  A <literal>WITH</literal> query
      that is referenced more than once in <literal>FROM</literal> is
      computed only once.
      (See <xref linkend="sql-with" endterm="sql-with-title"> below.)
     </para>
    </listitem>

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    <listitem>
     <para>
      All elements in the <literal>FROM</literal> list are computed.
      (Each element in the <literal>FROM</literal> list is a real or
      virtual table.)  If more than one element is specified in the
      <literal>FROM</literal> list, they are cross-joined together.
      (See <xref linkend="sql-from" endterm="sql-from-title"> below.)
     </para>
    </listitem>

    <listitem>
     <para>
      If the <literal>WHERE</literal> clause is specified, all rows
      that do not satisfy the condition are eliminated from the
      output.  (See <xref linkend="sql-where"
      endterm="sql-where-title"> below.)
     </para>
    </listitem>

    <listitem>
     <para>
      If the <literal>GROUP BY</literal> clause is specified, the
      output is divided into groups of rows that match on one or more
      values.  If the <literal>HAVING</literal> clause is present, it
      eliminates groups that do not satisfy the given condition.  (See
      <xref linkend="sql-groupby" endterm="sql-groupby-title"> and
      <xref linkend="sql-having" endterm="sql-having-title"> below.)
     </para>
    </listitem>

T
Tom Lane 已提交
117 118 119 120 121 122 123 124 125 126
    <listitem>
     <para>
      The actual output rows are computed using the
      <command>SELECT</command> output expressions for each selected
      row.  (See
      <xref linkend="sql-select-list" endterm="sql-select-list-title">
      below.)
     </para>
    </listitem>

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
    <listitem>
     <para>
      Using the operators <literal>UNION</literal>,
      <literal>INTERSECT</literal>, and <literal>EXCEPT</literal>, the
      output of more than one <command>SELECT</command> statement can
      be combined to form a single result set.  The
      <literal>UNION</literal> operator returns all rows that are in
      one or both of the result sets.  The
      <literal>INTERSECT</literal> operator returns all rows that are
      strictly in both result sets.  The <literal>EXCEPT</literal>
      operator returns the rows that are in the first result set but
      not in the second.  In all three cases, duplicate rows are
      eliminated unless <literal>ALL</literal> is specified. (See
      <xref linkend="sql-union" endterm="sql-union-title">, <xref
      linkend="sql-intersect" endterm="sql-intersect-title">, and
      <xref linkend="sql-except" endterm="sql-except-title"> below.)
     </para>
    </listitem>

    <listitem>
     <para>
      If the <literal>ORDER BY</literal> clause is specified, the
      returned rows are sorted in the specified order.  If
      <literal>ORDER BY</literal> is not given, the rows are returned
      in whatever order the system finds fastest to produce.  (See
      <xref linkend="sql-orderby" endterm="sql-orderby-title"> below.)
     </para>
    </listitem>

    <listitem>
     <para>
      <literal>DISTINCT</literal> eliminates duplicate rows from the
      result.  <literal>DISTINCT ON</literal> eliminates rows that
      match on all the specified expressions.  <literal>ALL</literal>
      (the default) will return all candidate rows, including
      duplicates.  (See <xref linkend="sql-distinct"
      endterm="sql-distinct-title"> below.)
     </para>
    </listitem>

T
Tom Lane 已提交
167 168
    <listitem>
     <para>
169
      If the <literal>LIMIT</literal> (or <literal>FETCH FIRST</literal>) or <literal>OFFSET</literal>
T
Tom Lane 已提交
170 171 172 173 174 175
      clause is specified, the <command>SELECT</command> statement
      only returns a subset of the result rows. (See <xref
      linkend="sql-limit" endterm="sql-limit-title"> below.)
     </para>
    </listitem>

176 177
    <listitem>
     <para>
178 179
      If <literal>FOR UPDATE</literal> or <literal>FOR SHARE</literal>
      is specified, the
180 181 182
      <command>SELECT</command> statement locks the selected rows
      against concurrent updates.  (See <xref linkend="sql-for-update-share"
      endterm="sql-for-update-share-title"> below.)
183 184 185 186
     </para>
    </listitem>
   </orderedlist>
  </para>
187

188
  <para>
189 190 191 192 193
   You must have <literal>SELECT</literal> privilege on each column used
   in a <command>SELECT</> command.  The use of <literal>FOR UPDATE</literal>
   or <literal>FOR SHARE</literal> requires
   <literal>UPDATE</literal> privilege as well (for at least one column
   of each table so selected).
194 195 196 197 198 199
  </para>
 </refsect1>

 <refsect1>
  <title>Parameters</title>

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
  <refsect2 id="SQL-WITH">
   <title id="sql-with-title"><literal>WITH</literal> Clause</title>

   <para>
    The <literal>WITH</literal> clause allows you to specify one or more
    subqueries that can be referenced by name in the primary query.
    The subqueries effectively act as temporary tables or views
    for the duration of the primary query.
   </para>

   <para>
    A name (without schema qualification) must be specified for each
    <literal>WITH</literal> query.  Optionally, a list of column names
    can be specified; if this is omitted,
    the column names are inferred from the subquery.
   </para>

   <para>
    If <literal>RECURSIVE</literal> is specified, it allows a
    subquery to reference itself by name.  Such a subquery must have
    the form
<synopsis>
222
<replaceable class="parameter">non_recursive_term</replaceable> UNION [ ALL ] <replaceable class="parameter">recursive_term</replaceable>
223 224
</synopsis>
    where the recursive self-reference must appear on the right-hand
225
    side of the <literal>UNION</>.  Only one recursive self-reference
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
    is permitted per query.
   </para>

   <para>
    Another effect of <literal>RECURSIVE</literal> is that
    <literal>WITH</literal> queries need not be ordered: a query
    can reference another one that is later in the list.  (However,
    circular references, or mutual recursion, are not implemented.)
    Without <literal>RECURSIVE</literal>, <literal>WITH</literal> queries
    can only reference sibling <literal>WITH</literal> queries
    that are earlier in the <literal>WITH</literal> list.
   </para>

   <para>
    A useful property of <literal>WITH</literal> queries is that they
    are evaluated only once per execution of the primary query,
    even if the primary query refers to them more than once.
   </para>

   <para>
    See <xref linkend="queries-with"> for additional information.
   </para>
  </refsect2>

250 251
  <refsect2 id="SQL-FROM">
   <title id="sql-from-title"><literal>FROM</literal> Clause</title>
252

253
   <para>
254 255 256 257 258 259 260 261 262
    The <literal>FROM</literal> clause specifies one or more source
    tables for the <command>SELECT</command>.  If multiple sources are
    specified, the result is the Cartesian product (cross join) of all
    the sources.  But usually qualification conditions
    are added to restrict the returned rows to a small subset of the
    Cartesian product.
   </para>

   <para>
263 264
    The <literal>FROM</literal> clause can contain the following
    elements:
265

266 267
    <variablelist>
     <varlistentry>
268
      <term><replaceable class="parameter">table_name</replaceable></term>
269 270
      <listitem>
       <para>
271 272 273
        The name (optionally schema-qualified) of an existing table or
        view.  If <literal>ONLY</> is specified, only that table is
        scanned.  If <literal>ONLY</> is not specified, the table and
274
        any descendant tables are scanned.
275 276 277
       </para>
      </listitem>
     </varlistentry>
278

279
     <varlistentry>
280
      <term><replaceable class="parameter">alias</replaceable></term>
281 282
      <listitem>
       <para>
283 284 285 286 287 288 289 290 291 292
        A substitute name for the <literal>FROM</> item containing the
        alias.  An alias is used for brevity or to eliminate ambiguity
        for self-joins (where the same table is scanned multiple
        times).  When an alias is provided, it completely hides the
        actual name of the table or function; for example given
        <literal>FROM foo AS f</>, the remainder of the
        <command>SELECT</command> must refer to this <literal>FROM</>
        item as <literal>f</> not <literal>foo</>.  If an alias is
        written, a column alias list can also be written to provide
        substitute names for one or more columns of the table.
293 294 295
       </para>
      </listitem>
     </varlistentry>
296

297
     <varlistentry>
298
      <term><replaceable class="parameter">select</replaceable></term>
299 300
      <listitem>
       <para>
301 302 303 304 305 306
        A sub-<command>SELECT</command> can appear in the
        <literal>FROM</literal> clause.  This acts as though its
        output were created as a temporary table for the duration of
        this single <command>SELECT</command> command.  Note that the
        sub-<command>SELECT</command> must be surrounded by
        parentheses, and an alias <emphasis>must</emphasis> be
307 308 309
        provided for it.  A
        <xref linkend="sql-values" endterm="sql-values-title"> command
        can also be used here.
310 311 312
       </para>
      </listitem>
     </varlistentry>
313

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
     <varlistentry>
      <term><replaceable class="parameter">with_query_name</replaceable></term>
      <listitem>
       <para>
        A <literal>WITH</> query is referenced by writing its name,
        just as though the query's name were a table name.  (In fact,
        the <literal>WITH</> query hides any real table of the same name
        for the purposes of the primary query.  If necessary, you can
        refer to a real table of the same name by schema-qualifying
        the table's name.)
        An alias can be provided in the same way as for a table.
       </para>
      </listitem>
     </varlistentry>

329
     <varlistentry>
330
      <term><replaceable class="parameter">function_name</replaceable></term>
331 332
      <listitem>
       <para>
333 334 335 336 337
        Function calls can appear in the <literal>FROM</literal>
        clause.  (This is especially useful for functions that return
        result sets, but any function can be used.)  This acts as
        though its output were created as a temporary table for the
        duration of this single <command>SELECT</command> command. An
338
        alias can also be used. If an alias is written, a column alias
339 340 341 342 343 344 345 346 347 348
        list can also be written to provide substitute names for one
        or more attributes of the function's composite return type. If
        the function has been defined as returning the <type>record</>
        data type, then an alias or the key word <literal>AS</> must
        be present, followed by a column definition list in the form
        <literal>( <replaceable
        class="parameter">column_name</replaceable> <replaceable
        class="parameter">data_type</replaceable> <optional>, ... </>
        )</literal>.  The column definition list must match the actual
        number and types of columns returned by the function.
349 350 351
       </para>
      </listitem>
     </varlistentry>
352

353
     <varlistentry>
354
      <term><replaceable class="parameter">join_type</replaceable></term>
355 356
      <listitem>
       <para>
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
        One of
        <itemizedlist>
         <listitem>
          <para><literal>[ INNER ] JOIN</literal></para>
         </listitem>
         <listitem>
          <para><literal>LEFT [ OUTER ] JOIN</literal></para>
         </listitem>
         <listitem>
          <para><literal>RIGHT [ OUTER ] JOIN</literal></para>
         </listitem>
         <listitem>
          <para><literal>FULL [ OUTER ] JOIN</literal></para>
         </listitem>
         <listitem>
          <para><literal>CROSS JOIN</literal></para>
         </listitem>
        </itemizedlist>

        For the <literal>INNER</> and <literal>OUTER</> join types, a
        join condition must be specified, namely exactly one of
        <literal>NATURAL</>, <literal>ON <replaceable
        class="parameter">join_condition</replaceable></literal>, or
        <literal>USING (<replaceable
        class="parameter">join_column</replaceable> [, ...])</literal>.
        See below for the meaning.  For <literal>CROSS JOIN</literal>,
383
        none of these clauses can appear.
384
       </para>
385

386
       <para>
T
Tom Lane 已提交
387 388 389
        A <literal>JOIN</literal> clause combines two
        <literal>FROM</> items.  Use parentheses if necessary to
        determine the order of nesting.  In the absence of parentheses,
390 391 392
        <literal>JOIN</literal>s nest left-to-right.  In any case
        <literal>JOIN</literal> binds more tightly than the commas
        separating <literal>FROM</> items.
393
       </para>
394

395
       <para>
396
        <literal>CROSS JOIN</> and <literal>INNER JOIN</literal>
T
Tom Lane 已提交
397 398
        produce a simple Cartesian product, the same result as you get from
        listing the two items at the top level of <literal>FROM</>,
399
        but restricted by the join condition (if any).
400
        <literal>CROSS JOIN</> is equivalent to <literal>INNER JOIN ON
T
Tom Lane 已提交
401
        (TRUE)</>, that is, no rows are removed by qualification.
402 403 404
        These join types are just a notational convenience, since they
        do nothing you couldn't do with plain <literal>FROM</> and
        <literal>WHERE</>.
405
       </para>
406

407
       <para>
408 409 410 411 412 413 414
        <literal>LEFT OUTER JOIN</> returns all rows in the qualified
        Cartesian product (i.e., all combined rows that pass its join
        condition), plus one copy of each row in the left-hand table
        for which there was no right-hand row that passed the join
        condition.  This left-hand row is extended to the full width
        of the joined table by inserting null values for the
        right-hand columns.  Note that only the <literal>JOIN</>
T
Tom Lane 已提交
415
        clause's own condition is considered while deciding which rows
416
        have matches.  Outer conditions are applied afterwards.
417
       </para>
418 419

       <para>
420 421 422 423 424
        Conversely, <literal>RIGHT OUTER JOIN</> returns all the
        joined rows, plus one row for each unmatched right-hand row
        (extended with nulls on the left).  This is just a notational
        convenience, since you could convert it to a <literal>LEFT
        OUTER JOIN</> by switching the left and right inputs.
425
       </para>
426

427
       <para>
428 429 430 431
        <literal>FULL OUTER JOIN</> returns all the joined rows, plus
        one row for each unmatched left-hand row (extended with nulls
        on the right), plus one row for each unmatched right-hand row
        (extended with nulls on the left).
432 433 434
       </para>
      </listitem>
     </varlistentry>
435

436
     <varlistentry>
437
      <term><literal>ON <replaceable class="parameter">join_condition</replaceable></literal></term>
438 439
      <listitem>
       <para>
440 441 442 443 444
        <replaceable class="parameter">join_condition</replaceable> is
        an expression resulting in a value of type
        <type>boolean</type> (similar to a <literal>WHERE</literal>
        clause) that specifies which rows in a join are considered to
        match.
445 446 447
       </para>
      </listitem>
     </varlistentry>
448

449
     <varlistentry>
450
      <term><literal>USING ( <replaceable class="parameter">join_column</replaceable> [, ...] )</literal></term>
451 452
      <listitem>
       <para>
453 454 455 456 457 458
        A clause of the form <literal>USING ( a, b, ... )</literal> is
        shorthand for <literal>ON left_table.a = right_table.a AND
        left_table.b = right_table.b ...</literal>.  Also,
        <literal>USING</> implies that only one of each pair of
        equivalent columns will be included in the join output, not
        both.
459 460 461 462
       </para>
      </listitem>
     </varlistentry>

463
     <varlistentry>
464
      <term><literal>NATURAL</literal></term>
465 466
      <listitem>
       <para>
467 468 469
        <literal>NATURAL</literal> is shorthand for a
        <literal>USING</> list that mentions all columns in the two
        tables that have the same names.
470 471 472 473
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
474
   </para>
475
  </refsect2>
476

477 478
  <refsect2 id="SQL-WHERE">
   <title id="sql-where-title"><literal>WHERE</literal> Clause</title>
479 480

   <para>
481 482 483 484 485 486 487 488 489 490
    The optional <literal>WHERE</literal> clause has the general form
<synopsis>
WHERE <replaceable class="parameter">condition</replaceable>
</synopsis>
    where <replaceable class="parameter">condition</replaceable> is
    any expression that evaluates to a result of type
    <type>boolean</type>.  Any row that does not satisfy this
    condition will be eliminated from the output.  A row satisfies the
    condition if it returns true when the actual row values are
    substituted for any variable references.
491
   </para>
492
  </refsect2>
493

494 495
  <refsect2 id="SQL-GROUPBY">
   <title id="sql-groupby-title"><literal>GROUP BY</literal> Clause</title>
496 497

   <para>
498 499 500 501
    The optional <literal>GROUP BY</literal> clause has the general form
<synopsis>
GROUP BY <replaceable class="parameter">expression</replaceable> [, ...]
</synopsis>
502 503 504
   </para>

   <para>
505 506 507 508 509
    <literal>GROUP BY</literal> will condense into a single row all
    selected rows that share the same values for the grouped
    expressions.  <replaceable
    class="parameter">expression</replaceable> can be an input column
    name, or the name or ordinal number of an output column
T
Tom Lane 已提交
510
    (<command>SELECT</command> list item), or an arbitrary
511 512 513
    expression formed from input-column values.  In case of ambiguity,
    a <literal>GROUP BY</literal> name will be interpreted as an
    input-column name rather than an output column name.
514 515
   </para>

516
   <para>
517 518 519 520 521 522 523 524 525
    Aggregate functions, if any are used, are computed across all rows
    making up each group, producing a separate value for each group
    (whereas without <literal>GROUP BY</literal>, an aggregate
    produces a single value computed across all the selected rows).
    When <literal>GROUP BY</literal> is present, it is not valid for
    the <command>SELECT</command> list expressions to refer to
    ungrouped columns except within aggregate functions, since there
    would be more than one possible value to return for an ungrouped
    column.
526
   </para>
527
  </refsect2>
528

529 530
  <refsect2 id="SQL-HAVING">
   <title id="sql-having-title"><literal>HAVING</literal> Clause</title>
531

532
   <para>
533 534 535 536 537 538
    The optional <literal>HAVING</literal> clause has the general form
<synopsis>
HAVING <replaceable class="parameter">condition</replaceable>
</synopsis>
    where <replaceable class="parameter">condition</replaceable> is
    the same as specified for the <literal>WHERE</literal> clause.
539
   </para>
540

541
   <para>
542 543 544 545 546 547 548 549 550
    <literal>HAVING</literal> eliminates group rows that do not
    satisfy the condition.  <literal>HAVING</literal> is different
    from <literal>WHERE</literal>: <literal>WHERE</literal> filters
    individual rows before the application of <literal>GROUP
    BY</literal>, while <literal>HAVING</literal> filters group rows
    created by <literal>GROUP BY</literal>.  Each column referenced in
    <replaceable class="parameter">condition</replaceable> must
    unambiguously reference a grouping column, unless the reference
    appears within an aggregate function.
551
   </para>
552

553 554 555 556 557 558 559 560 561 562
   <para>
    The presence of <literal>HAVING</literal> turns a query into a grouped
    query even if there is no <literal>GROUP BY</> clause.  This is the
    same as what happens when the query contains aggregate functions but
    no <literal>GROUP BY</> clause.  All the selected rows are considered to
    form a single group, and the <command>SELECT</command> list and
    <literal>HAVING</literal> clause can only reference table columns from
    within aggregate functions.  Such a query will emit a single row if the
    <literal>HAVING</literal> condition is true, zero rows if it is not true.
   </para>
563
  </refsect2>
T
Tom Lane 已提交
564

T
Tom Lane 已提交
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
  <refsect2 id="SQL-WINDOW">
   <title id="sql-window-title"><literal>WINDOW</literal> Clause</title>

   <para>
    The optional <literal>WINDOW</literal> clause has the general form
<synopsis>
WINDOW <replaceable class="parameter">window_name</replaceable> AS ( <replaceable class="parameter">window_definition</replaceable> ) [, ...]
</synopsis>
    where <replaceable class="parameter">window_name</replaceable> is
    a name that can be referenced from subsequent window definitions or
    <literal>OVER</> clauses, and
    <replaceable class="parameter">window_definition</replaceable> is
<synopsis>
[ <replaceable class="parameter">existing_window_name</replaceable> ]
[ PARTITION BY <replaceable class="parameter">expression</replaceable> [, ...] ]
[ ORDER BY <replaceable class="parameter">expression</replaceable> [ ASC | DESC | USING <replaceable class="parameter">operator</replaceable> ] [ NULLS { FIRST | LAST } ] [, ...] ]
581
[ <replaceable class="parameter">frame_clause</replaceable> ]
T
Tom Lane 已提交
582
</synopsis>
583 584 585 586 587 588 589 590 591
   </para>

   <para>
    If an <replaceable class="parameter">existing_window_name</replaceable>
    is specified it must refer to an earlier entry in the <literal>WINDOW</>
    list; the new window copies its partitioning clause from that entry,
    as well as its ordering clause if any.  In this case the new window cannot
    specify its own <literal>PARTITION BY</> clause, and it can specify
    <literal>ORDER BY</> only if the copied window does not have one.
592 593
    The new window always uses its own frame clause; the copied window
    must not specify a frame clause.
594 595 596
   </para>

   <para>
T
Tom Lane 已提交
597 598 599 600 601 602 603 604 605 606 607 608 609
    The elements of the <literal>PARTITION BY</> list are interpreted in
    the same fashion as elements of a
    <xref linkend="sql-groupby" endterm="sql-groupby-title">, and
    the elements of the <literal>ORDER BY</> list are interpreted in the
    same fashion as elements of an
    <xref linkend="sql-orderby" endterm="sql-orderby-title">.
    The only difference is that these expressions can contain aggregate
    function calls, which are not allowed in a regular <literal>GROUP BY</>
    clause.  They are allowed here because windowing occurs after grouping
    and aggregation.
   </para>

   <para>
610
    The optional <replaceable class="parameter">frame_clause</> defines
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
    the <firstterm>window frame</> for window functions that depend on the
    frame (not all do).  It can be one of
<synopsis>
RANGE UNBOUNDED PRECEDING
RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW
RANGE BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING
ROWS UNBOUNDED PRECEDING
ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW
ROWS BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING
</synopsis>
    The first two are equivalent and are also the default: they set the
    frame to be all rows from the partition start up through the current row's
    last peer in the <literal>ORDER BY</> ordering (which means all rows if
    there is no <literal>ORDER BY</>).  The options
    <literal>RANGE BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING</> and
    <literal>ROWS BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING</>
    are also equivalent: they always select all rows in the partition.
    Lastly, <literal>ROWS UNBOUNDED PRECEDING</> or its verbose equivalent
    <literal>ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW</> select
    all rows up through the current row (regardless of duplicates).
    Beware that this option can produce implementation-dependent results
    if the <literal>ORDER BY</> ordering does not order the rows uniquely.
T
Tom Lane 已提交
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
   </para>

   <para>
    The purpose of a <literal>WINDOW</literal> clause is to specify the
    behavior of <firstterm>window functions</> appearing in the query's
    <xref linkend="sql-select-list" endterm="sql-select-list-title"> or
    <xref linkend="sql-orderby" endterm="sql-orderby-title">.  These functions
    can reference the <literal>WINDOW</literal> clause entries by name
    in their <literal>OVER</> clauses.  A <literal>WINDOW</literal> clause
    entry does not have to be referenced anywhere, however; if it is not
    used in the query it is simply ignored.  It is possible to use window
    functions without any <literal>WINDOW</literal> clause at all, since
    a window function call can specify its window definition directly in
    its <literal>OVER</> clause.  However, the <literal>WINDOW</literal>
    clause saves typing when the same window definition is needed for more
    than one window function.
   </para>

   <para>
    Window functions are described in detail in
653 654 655
    <xref linkend="tutorial-window">,
    <xref linkend="syntax-window-functions">, and
    <xref linkend="queries-window">.
T
Tom Lane 已提交
656 657 658
   </para>
  </refsect2>

T
Tom Lane 已提交
659 660 661 662 663 664 665 666
  <refsect2 id="sql-select-list">
   <title id="sql-select-list-title"><command>SELECT</command> List</title>

   <para>
    The <command>SELECT</command> list (between the key words
    <literal>SELECT</> and <literal>FROM</>) specifies expressions
    that form the output rows of the <command>SELECT</command>
    statement.  The expressions can (and usually do) refer to columns
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
    computed in the <literal>FROM</> clause.
   </para>

   <para>
    Just as in a table, every output column of a <command>SELECT</command>
    has a name.  In a simple <command>SELECT</command> this name is just
    used to label the column for display, but when the <command>SELECT</>
    is a sub-query of a larger query, the name is seen by the larger query
    as the column name of the virtual table produced by the sub-query.
    To specify the name to use for an output column, write
    <literal>AS</> <replaceable class="parameter">output_name</replaceable>
    after the column's expression.  (You can omit <literal>AS</literal>,
    but only if the desired output name does not match any
    <productname>PostgreSQL</productname> keyword (see <xref
    linkend="sql-keywords-appendix">).  For protection against possible
    future keyword additions, it is recommended that you always either
    write <literal>AS</literal> or double-quote the output name.)
    If you do not specify a column name, a name is chosen automatically
    by <productname>PostgreSQL</productname>.  If the column's expression
    is a simple column reference then the chosen name is the same as that
    column's name; in more complex cases a generated name looking like
    <literal>?column<replaceable>N</>?</literal> is usually chosen.
   </para>

   <para>
    An output column's name can be used to refer to the column's value in
    <literal>ORDER BY</> and <literal>GROUP BY</> clauses, but not in the
    <literal>WHERE</> or <literal>HAVING</> clauses; there you must write
    out the expression instead.
T
Tom Lane 已提交
696 697 698 699 700
   </para>

   <para>
    Instead of an expression, <literal>*</literal> can be written in
    the output list as a shorthand for all the columns of the selected
701
    rows.  Also, you can write <literal><replaceable
T
Tom Lane 已提交
702
    class="parameter">table_name</replaceable>.*</literal> as a
703 704 705
    shorthand for the columns coming from just that table.  In these
    cases it is not possible to specify new names with <literal>AS</>;
    the output column names will be the same as the table columns' names.
T
Tom Lane 已提交
706 707
   </para>
  </refsect2>
708

709 710
  <refsect2 id="SQL-UNION">
   <title id="sql-union-title"><literal>UNION</literal> Clause</title>
711 712

   <para>
713 714 715 716 717 718
    The <literal>UNION</literal> clause has this general form:
<synopsis>
<replaceable class="parameter">select_statement</replaceable> UNION [ ALL ] <replaceable class="parameter">select_statement</replaceable>
</synopsis>
    <replaceable class="parameter">select_statement</replaceable> is
    any <command>SELECT</command> statement without an <literal>ORDER
719
    BY</>, <literal>LIMIT</>, <literal>FOR UPDATE</literal>, or
720
    <literal>FOR SHARE</literal> clause.
721 722 723 724 725
    (<literal>ORDER BY</> and <literal>LIMIT</> can be attached to a
    subexpression if it is enclosed in parentheses.  Without
    parentheses, these clauses will be taken to apply to the result of
    the <literal>UNION</literal>, not to its right-hand input
    expression.)
726
   </para>
727

728
   <para>
729 730 731 732 733 734 735 736
    The <literal>UNION</literal> operator computes the set union of
    the rows returned by the involved <command>SELECT</command>
    statements.  A row is in the set union of two result sets if it
    appears in at least one of the result sets.  The two
    <command>SELECT</command> statements that represent the direct
    operands of the <literal>UNION</literal> must produce the same
    number of columns, and corresponding columns must be of compatible
    data types.
737
   </para>
738

739
   <para>
740 741
    The result of <literal>UNION</> does not contain any duplicate
    rows unless the <literal>ALL</> option is specified.
T
Tom Lane 已提交
742 743 744
    <literal>ALL</> prevents elimination of duplicates.  (Therefore,
    <literal>UNION ALL</> is usually significantly quicker than
    <literal>UNION</>; use <literal>ALL</> when you can.)
745
   </para>
746

747
   <para>
748 749 750
    Multiple <literal>UNION</> operators in the same
    <command>SELECT</command> statement are evaluated left to right,
    unless otherwise indicated by parentheses.
751
   </para>
752

753
   <para>
754
    Currently, <literal>FOR UPDATE</> and <literal>FOR SHARE</> cannot be
755 756
    specified either for a <literal>UNION</> result or for any input of a
    <literal>UNION</>.
757
   </para>
758
  </refsect2>
759

760 761
  <refsect2 id="SQL-INTERSECT">
   <title id="sql-intersect-title"><literal>INTERSECT</literal> Clause</title>
762 763

   <para>
764 765 766 767 768 769
    The <literal>INTERSECT</literal> clause has this general form:
<synopsis>
<replaceable class="parameter">select_statement</replaceable> INTERSECT [ ALL ] <replaceable class="parameter">select_statement</replaceable>
</synopsis>
    <replaceable class="parameter">select_statement</replaceable> is
    any <command>SELECT</command> statement without an <literal>ORDER
770 771
    BY</>, <literal>LIMIT</>, <literal>FOR UPDATE</literal>, or
    <literal>FOR SHARE</literal> clause.
772
   </para>
773

774
   <para>
775 776 777 778
    The <literal>INTERSECT</literal> operator computes the set
    intersection of the rows returned by the involved
    <command>SELECT</command> statements.  A row is in the
    intersection of two result sets if it appears in both result sets.
779
   </para>
780

781
   <para>
782 783
    The result of <literal>INTERSECT</literal> does not contain any
    duplicate rows unless the <literal>ALL</> option is specified.
T
Tom Lane 已提交
784 785 786
    With <literal>ALL</>, a row that has <replaceable>m</> duplicates in the
    left table and <replaceable>n</> duplicates in the right table will appear
    min(<replaceable>m</>,<replaceable>n</>) times in the result set.
787
   </para>
788

789
   <para>
790 791 792 793 794 795 796
    Multiple <literal>INTERSECT</literal> operators in the same
    <command>SELECT</command> statement are evaluated left to right,
    unless parentheses dictate otherwise.
    <literal>INTERSECT</literal> binds more tightly than
    <literal>UNION</literal>.  That is, <literal>A UNION B INTERSECT
    C</literal> will be read as <literal>A UNION (B INTERSECT
    C)</literal>.
797
   </para>
798

T
Tom Lane 已提交
799
   <para>
800
    Currently, <literal>FOR UPDATE</> and <literal>FOR SHARE</> cannot be
801 802
    specified either for an <literal>INTERSECT</> result or for any input of
    an <literal>INTERSECT</>.
T
Tom Lane 已提交
803
   </para>
804
  </refsect2>
805 806 807 808

  <refsect2 id="SQL-EXCEPT">
   <title id="sql-except-title"><literal>EXCEPT</literal> Clause</title>

809
   <para>
810 811 812 813 814 815
    The <literal>EXCEPT</literal> clause has this general form:
<synopsis>
<replaceable class="parameter">select_statement</replaceable> EXCEPT [ ALL ] <replaceable class="parameter">select_statement</replaceable>
</synopsis>
    <replaceable class="parameter">select_statement</replaceable> is
    any <command>SELECT</command> statement without an <literal>ORDER
816 817
    BY</>, <literal>LIMIT</>, <literal>FOR UPDATE</literal>, or
    <literal>FOR SHARE</literal> clause.
818
   </para>
819

820
   <para>
821 822 823 824
    The <literal>EXCEPT</literal> operator computes the set of rows
    that are in the result of the left <command>SELECT</command>
    statement but not in the result of the right one.
   </para>
825

826
   <para>
827 828
    The result of <literal>EXCEPT</literal> does not contain any
    duplicate rows unless the <literal>ALL</> option is specified.
T
Tom Lane 已提交
829 830 831
    With <literal>ALL</>, a row that has <replaceable>m</> duplicates in the
    left table and <replaceable>n</> duplicates in the right table will appear
    max(<replaceable>m</>-<replaceable>n</>,0) times in the result set.
832
   </para>
833

834
   <para>
835 836 837 838
    Multiple <literal>EXCEPT</literal> operators in the same
    <command>SELECT</command> statement are evaluated left to right,
    unless parentheses dictate otherwise.  <literal>EXCEPT</> binds at
    the same level as <literal>UNION</>.
839
   </para>
840

841
   <para>
842
    Currently, <literal>FOR UPDATE</> and <literal>FOR SHARE</> cannot be
843 844
    specified either for an <literal>EXCEPT</> result or for any input of
    an <literal>EXCEPT</>.
845
   </para>
846 847 848 849
  </refsect2>

  <refsect2 id="SQL-ORDERBY">
   <title id="sql-orderby-title"><literal>ORDER BY</literal> Clause</title>
850

851
   <para>
852 853
    The optional <literal>ORDER BY</literal> clause has this general form:
<synopsis>
854
ORDER BY <replaceable class="parameter">expression</replaceable> [ ASC | DESC | USING <replaceable class="parameter">operator</replaceable> ] [ NULLS { FIRST | LAST } ] [, ...]
855 856
</synopsis>
    The <literal>ORDER BY</literal> clause causes the result rows to
857 858
    be sorted according to the specified expression(s).  If two rows are
    equal according to the leftmost expression, they are compared
859 860
    according to the next expression and so on.  If they are equal
    according to all specified expressions, they are returned in
T
Tom Lane 已提交
861
    an implementation-dependent order.
862
   </para>
863

864 865 866 867 868 869 870
   <para>
    Each <replaceable class="parameter">expression</replaceable> can be the
    name or ordinal number of an output column
    (<command>SELECT</command> list item), or it can be an arbitrary
    expression formed from input-column values.
   </para>

871
   <para>
872
    The ordinal number refers to the ordinal (left-to-right) position
873
    of the output column. This feature makes it possible to define an
874 875
    ordering on the basis of a column that does not have a unique
    name.  This is never absolutely necessary because it is always
876
    possible to assign a name to an output column using the
877
    <literal>AS</> clause.
878
   </para>
879

880
   <para>
881 882
    It is also possible to use arbitrary expressions in the
    <literal>ORDER BY</literal> clause, including columns that do not
883
    appear in the <command>SELECT</command> output list.  Thus the
884 885 886 887 888 889
    following statement is valid:
<programlisting>
SELECT name FROM distributors ORDER BY code;
</programlisting>
    A limitation of this feature is that an <literal>ORDER BY</>
    clause applying to the result of a <literal>UNION</>,
890
    <literal>INTERSECT</>, or <literal>EXCEPT</> clause can only
891
    specify an output column name or number, not an expression.
892
   </para>
893

894
   <para>
895
    If an <literal>ORDER BY</> expression is a simple name that
896 897
    matches both an output column name and an input column name,
    <literal>ORDER BY</> will interpret it as the output column name.
898 899 900
    This is the opposite of the choice that <literal>GROUP BY</> will
    make in the same situation.  This inconsistency is made to be
    compatible with the SQL standard.
901
   </para>
902

903
   <para>
904
    Optionally one can add the key word <literal>ASC</> (ascending) or
T
Tom Lane 已提交
905
    <literal>DESC</> (descending) after any expression in the
906 907
    <literal>ORDER BY</> clause.  If not specified, <literal>ASC</> is
    assumed by default.  Alternatively, a specific ordering operator
908
    name can be specified in the <literal>USING</> clause.
909
    An ordering operator must be a less-than or greater-than
P
Peter Eisentraut 已提交
910
    member of some B-tree operator family.
911 912
    <literal>ASC</> is usually equivalent to <literal>USING &lt;</> and
    <literal>DESC</> is usually equivalent to <literal>USING &gt;</>.
913
    (But the creator of a user-defined data type can define exactly what the
914 915
    default sort ordering is, and it might correspond to operators with other
    names.)
916 917
   </para>

918
   <para>
919 920 921 922 923 924 925 926
    If <literal>NULLS LAST</> is specified, null values sort after all
    non-null values; if <literal>NULLS FIRST</> is specified, null values
    sort before all non-null values.  If neither is specified, the default
    behavior is <literal>NULLS LAST</> when <literal>ASC</> is specified
    or implied, and <literal>NULLS FIRST</> when <literal>DESC</> is specified
    (thus, the default is to act as though nulls are larger than non-nulls).
    When <literal>USING</> is specified, the default nulls ordering depends
    on whether the operator is a less-than or greater-than operator.
927 928
   </para>

929 930 931 932 933 934
   <para>
    Note that ordering options apply only to the expression they follow;
    for example <literal>ORDER BY x, y DESC</> does not mean
    the same thing as <literal>ORDER BY x DESC, y DESC</>.
   </para>

935
   <para>
936
    Character-string data is sorted according to the locale-specific
937
    collation order that was established when the database was created.
938
   </para>
939
  </refsect2>
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959

  <refsect2 id="sql-distinct">
   <title id="sql-distinct-title"><literal>DISTINCT</literal> Clause</title>

   <para>
    If <literal>DISTINCT</> is specified, all duplicate rows are
    removed from the result set (one row is kept from each group of
    duplicates).  <literal>ALL</> specifies the opposite: all rows are
    kept; that is the default.
   </para>

   <para>
    <literal>DISTINCT ON ( <replaceable
    class="parameter">expression</replaceable> [, ...] )</literal>
    keeps only the first row of each set of rows where the given
    expressions evaluate to equal.  The <literal>DISTINCT ON</literal>
    expressions are interpreted using the same rules as for
    <literal>ORDER BY</> (see above).  Note that the <quote>first
    row</quote> of each set is unpredictable unless <literal>ORDER
    BY</> is used to ensure that the desired row appears first.  For
960
    example:
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
<programlisting>
SELECT DISTINCT ON (location) location, time, report
    FROM weather_reports
    ORDER BY location, time DESC;
</programlisting>
    retrieves the most recent weather report for each location.  But
    if we had not used <literal>ORDER BY</> to force descending order
    of time values for each location, we'd have gotten a report from
    an unpredictable time for each location.
   </para>

   <para>
    The <literal>DISTINCT ON</> expression(s) must match the leftmost
    <literal>ORDER BY</> expression(s).  The <literal>ORDER BY</> clause
    will normally contain additional expression(s) that determine the
    desired precedence of rows within each <literal>DISTINCT ON</> group.
   </para>
  </refsect2>
979

980 981
  <refsect2 id="SQL-LIMIT">
   <title id="sql-limit-title"><literal>LIMIT</literal> Clause</title>
982 983

   <para>
984
    The <literal>LIMIT</literal> clause consists of two independent
T
Tom Lane 已提交
985
    sub-clauses:
986 987 988 989 990
<synopsis>
LIMIT { <replaceable class="parameter">count</replaceable> | ALL }
OFFSET <replaceable class="parameter">start</replaceable>
</synopsis>
    <replaceable class="parameter">count</replaceable> specifies the
T
Tom Lane 已提交
991
    maximum number of rows to return, while <replaceable
992
    class="parameter">start</replaceable> specifies the number of rows
T
Tom Lane 已提交
993 994 995 996
    to skip before starting to return rows.  When both are specified,
    <replaceable class="parameter">start</replaceable> rows are skipped
    before starting to count the <replaceable
    class="parameter">count</replaceable> rows to be returned.
997 998
   </para>

999 1000 1001 1002 1003 1004 1005
   <para>
    If the <replaceable class="parameter">count</replaceable> expression
    evaluates to NULL, it is treated as <literal>LIMIT ALL</>, i.e., no
    limit.  If <replaceable class="parameter">start</replaceable> evaluates
    to NULL, it is treated the same as <literal>OFFSET 0</>.
   </para>

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
   <para>
    SQL:2008 introduced a different syntax to achieve the same thing,
    which PostgreSQL also supports.  It is:
<synopsis>
OFFSET <replaceable class="parameter">start</replaceable> { ROW | ROWS }
FETCH { FIRST | NEXT } [ <replaceable class="parameter">count</replaceable> ] { ROW | ROWS } ONLY
</synopsis>
    Both clauses are optional, but if present
    the <literal>OFFSET</literal> clause must come before
    the <literal>FETCH</literal> clause.  <literal>ROW</literal>
    and <literal>ROWS</literal> as well as <literal>FIRST</literal>
    and <literal>NEXT</literal> are noise words that don't influence
1018 1019 1020 1021 1022
    the effects of these clauses.  In this syntax, when using expressions
    other than simple constants for <replaceable class="parameter">start</>
    or <replaceable class="parameter">count</replaceable>, parentheses will be
    necessary in most cases.  If <replaceable class="parameter">count</> is
    omitted in <literal>FETCH</>, it defaults to 1.
T
Tom Lane 已提交
1023
   </para>
1024

1025
   <para>
1026 1027 1028
    When using <literal>LIMIT</>, it is a good idea to use an
    <literal>ORDER BY</> clause that constrains the result rows into a
    unique order.  Otherwise you will get an unpredictable subset of
1029
    the query's rows &mdash; you might be asking for the tenth through
1030 1031
    twentieth rows, but tenth through twentieth in what ordering?  You
    don't know what ordering unless you specify <literal>ORDER BY</>.
1032 1033 1034
   </para>

   <para>
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
    The query planner takes <literal>LIMIT</> into account when
    generating a query plan, so you are very likely to get different
    plans (yielding different row orders) depending on what you use
    for <literal>LIMIT</> and <literal>OFFSET</>.  Thus, using
    different <literal>LIMIT</>/<literal>OFFSET</> values to select
    different subsets of a query result <emphasis>will give
    inconsistent results</emphasis> unless you enforce a predictable
    result ordering with <literal>ORDER BY</>.  This is not a bug; it
    is an inherent consequence of the fact that SQL does not promise
    to deliver the results of a query in any particular order unless
    <literal>ORDER BY</> is used to constrain the order.
1046
   </para>
1047 1048 1049 1050 1051 1052 1053 1054

   <para>
    It is even possible for repeated executions of the same <literal>LIMIT</>
    query to return different subsets of the rows of a table, if there
    is not an <literal>ORDER BY</> to enforce selection of a deterministic
    subset.  Again, this is not a bug; determinism of the results is
    simply not guaranteed in such a case.
   </para>
1055
  </refsect2>
1056

1057 1058
  <refsect2 id="SQL-FOR-UPDATE-SHARE">
   <title id="sql-for-update-share-title"><literal>FOR UPDATE</literal>/<literal>FOR SHARE</literal> Clause</title>
1059

1060
   <para>
1061 1062
    The <literal>FOR UPDATE</literal> clause has this form:
<synopsis>
1063
FOR UPDATE [ OF <replaceable class="parameter">table_name</replaceable> [, ...] ] [ NOWAIT ]
1064
</synopsis>
1065 1066
   </para>

1067 1068 1069
   <para>
    The closely related <literal>FOR SHARE</literal> clause has this form:
<synopsis>
1070
FOR SHARE [ OF <replaceable class="parameter">table_name</replaceable> [, ...] ] [ NOWAIT ]
1071 1072 1073
</synopsis>
   </para>

1074
   <para>
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
    <literal>FOR UPDATE</literal> causes the rows retrieved by the
    <command>SELECT</command> statement to be locked as though for
    update.  This prevents them from being modified or deleted by
    other transactions until the current transaction ends.  That is,
    other transactions that attempt <command>UPDATE</command>,
    <command>DELETE</command>, or <command>SELECT FOR UPDATE</command>
    of these rows will be blocked until the current transaction ends.
    Also, if an <command>UPDATE</command>, <command>DELETE</command>,
    or <command>SELECT FOR UPDATE</command> from another transaction
    has already locked a selected row or rows, <command>SELECT FOR
1085 1086
    UPDATE</command> will wait for the other transaction to complete,
    and will then lock and return the updated row (or no row, if the
1087 1088
    row was deleted).  For further discussion see <xref
    linkend="mvcc">.
1089 1090
   </para>

1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
   <para>
    To prevent the operation from waiting for other transactions to commit,
    use the <literal>NOWAIT</> option.  <command>SELECT FOR UPDATE
    NOWAIT</command> reports an error, rather than waiting, if a selected row
    cannot be locked immediately.  Note that <literal>NOWAIT</> applies only
    to the row-level lock(s) &mdash; the required <literal>ROW SHARE</literal>
    table-level lock is still taken in the ordinary way (see
    <xref linkend="mvcc">).  You can use the <literal>NOWAIT</> option of
    <xref linkend="sql-lock" endterm="sql-lock-title">
    if you need to acquire the table-level lock without waiting.
   </para>

1103
   <para>
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
    <literal>FOR SHARE</literal> behaves similarly, except that it
    acquires a shared rather than exclusive lock on each retrieved
    row.  A shared lock blocks other transactions from performing
    <command>UPDATE</command>, <command>DELETE</command>, or <command>SELECT
    FOR UPDATE</command> on these rows, but it does not prevent them
    from performing <command>SELECT FOR SHARE</command>.
   </para>

   <para>
    If specific tables are named in <literal>FOR UPDATE</literal>
    or <literal>FOR SHARE</literal>,
1115 1116
    then only rows coming from those tables are locked; any other
    tables used in the <command>SELECT</command> are simply read as
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
    usual.  A <literal>FOR UPDATE</literal> or <literal>FOR SHARE</literal>
    clause without a table list affects all tables used in the command.
    If <literal>FOR UPDATE</literal> or <literal>FOR SHARE</literal> is
    applied to a view or sub-query, it affects all tables used in
    the view or sub-query.
   </para>

   <para>
    Multiple <literal>FOR UPDATE</literal> and <literal>FOR SHARE</literal>
    clauses can be written if it is necessary to specify different locking
    behavior for different tables.  If the same table is mentioned (or
    implicitly affected) by both <literal>FOR UPDATE</literal> and
    <literal>FOR SHARE</literal> clauses, then it is processed as
    <literal>FOR UPDATE</literal>.  Similarly, a table is processed
    as <literal>NOWAIT</> if that is specified in any of the clauses
    affecting it.
1133 1134 1135
   </para>

   <para>
1136
    <literal>FOR UPDATE</literal> and <literal>FOR SHARE</literal> cannot be
1137 1138
    used in contexts where returned rows cannot be clearly identified with
    individual table rows; for example they cannot be used with aggregation.
T
Tom Lane 已提交
1139 1140
   </para>

1141 1142 1143 1144
  <caution>
   <para>
    Avoid locking a row and then modifying it within a later savepoint or
    <application>PL/pgSQL</application> exception block.  A subsequent
1145
    rollback would cause the lock to be lost.  For example:
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
<programlisting>
BEGIN;
SELECT * FROM mytable WHERE key = 1 FOR UPDATE;
SAVEPOINT s;
UPDATE mytable SET ... WHERE key = 1;
ROLLBACK TO s;
</programlisting>
    After the <command>ROLLBACK</>, the row is effectively unlocked, rather
    than returned to its pre-savepoint state of being locked but not modified.
    This hazard occurs if a row locked in the current transaction is updated
    or deleted, or if a shared lock is upgraded to exclusive: in all these
    cases, the former lock state is forgotten.  If the transaction is then
    rolled back to a state between the original locking command and the
    subsequent change, the row will appear not to be locked at all.  This is
    an implementation deficiency which will be addressed in a future release
    of <productname>PostgreSQL</productname>.
   </para>
  </caution>

  <caution>
T
Tom Lane 已提交
1166
   <para>
1167
    It is possible for a <command>SELECT</> command using both
1168
    <literal>LIMIT</literal> and <literal>FOR UPDATE/SHARE</literal>
1169
    clauses to return fewer rows than specified by <literal>LIMIT</literal>.
1170 1171
    This is because <literal>LIMIT</> is applied first.  The command
    selects the specified number of rows,
1172
    but might then block trying to obtain a lock on one or more of them.
1173 1174 1175
    Once the <literal>SELECT</> unblocks, the row might have been deleted
    or updated so that it does not meet the query <literal>WHERE</> condition
    anymore, in which case it will not be returned.
1176
   </para>
1177
  </caution>
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192

  <caution>
   <para>
    Similarly, it is possible for a <command>SELECT</> command
    using <literal>ORDER BY</literal> and <literal>FOR
    UPDATE/SHARE</literal> to return rows out of order.  This is
    because <literal>ORDER BY</> is applied first.  The command
    orders the result, but might then block trying to obtain a lock
    on one or more of the rows.  Once the <literal>SELECT</>
    unblocks, one of the ordered columns might have been modified
    and be returned out of order.  A workaround is to perform
    <command>SELECT ... FOR UPDATE/SHARE</> and then <command>SELECT
    ... ORDER BY</>.
   </para>
  </caution>
1193
  </refsect2>
P
Peter Eisentraut 已提交
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210

  <refsect2 id="SQL-TABLE">
   <title><literal>TABLE</literal> Command</title>

   <para>
    The command
<programlisting>
TABLE <replaceable class="parameter">name</replaceable>
</programlisting>
    is completely equivalent to
<programlisting>
SELECT * FROM <replaceable class="parameter">name</replaceable>
</programlisting>
    It can be used as a top-level command or as a space-saving syntax
    variant in parts of complex queries.
   </para>
  </refsect2>
1211
 </refsect1>
1212

1213 1214
 <refsect1>
  <title>Examples</title>
1215

1216 1217 1218
  <para>
   To join the table <literal>films</literal> with the table
   <literal>distributors</literal>:
1219

1220
<programlisting>
1221 1222 1223
SELECT f.title, f.did, d.name, f.date_prod, f.kind
    FROM distributors d, films f
    WHERE f.did = d.did
1224

1225 1226 1227 1228 1229
       title       | did |     name     | date_prod  |   kind
-------------------+-----+--------------+------------+----------
 The Third Man     | 101 | British Lion | 1949-12-23 | Drama
 The African Queen | 101 | British Lion | 1951-08-11 | Romantic
 ...
1230
</programlisting>
1231 1232
  </para>

1233 1234
  <para>
   To sum the column <literal>len</literal> of all films and group
1235
   the results by <literal>kind</literal>:
1236

1237
<programlisting>
1238
SELECT kind, sum(len) AS total FROM films GROUP BY kind;
1239

1240 1241 1242 1243 1244 1245 1246 1247
   kind   | total
----------+-------
 Action   | 07:34
 Comedy   | 02:58
 Drama    | 14:28
 Musical  | 06:42
 Romantic | 04:38
</programlisting>
1248
  </para>
1249 1250 1251

  <para>
   To sum the column <literal>len</literal> of all films, group
1252
   the results by <literal>kind</literal> and show those group totals
1253
   that are less than 5 hours:
1254

1255
<programlisting>
1256
SELECT kind, sum(len) AS total
1257 1258
    FROM films
    GROUP BY kind
1259
    HAVING sum(len) &lt; interval '5 hours';
1260

1261
   kind   | total
1262 1263 1264 1265
----------+-------
 Comedy   | 02:58
 Romantic | 04:38
</programlisting>
1266 1267
  </para>

1268
  <para>
1269
   The following two examples are identical ways of sorting the individual
1270 1271
   results according to the contents of the second column
   (<literal>name</literal>):
1272

1273
<programlisting>
1274 1275
SELECT * FROM distributors ORDER BY name;
SELECT * FROM distributors ORDER BY 2;
1276

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
 did |       name
-----+------------------
 109 | 20th Century Fox
 110 | Bavaria Atelier
 101 | British Lion
 107 | Columbia
 102 | Jean Luc Godard
 113 | Luso films
 104 | Mosfilm
 103 | Paramount
 106 | Toho
 105 | United Artists
 111 | Walt Disney
 112 | Warner Bros.
 108 | Westward
</programlisting>
1293
  </para>
1294 1295

  <para>
T
Tom Lane 已提交
1296
   The next example shows how to obtain the union of the tables
1297 1298
   <literal>distributors</literal> and
   <literal>actors</literal>, restricting the results to those that begin
T
Tom Lane 已提交
1299
   with the letter W in each table.  Only distinct rows are wanted, so the
1300
   key word <literal>ALL</literal> is omitted.
1301

1302 1303 1304 1305 1306 1307 1308 1309
<programlisting>
distributors:               actors:
 did |     name              id |     name
-----+--------------        ----+----------------
 108 | Westward               1 | Woody Allen
 111 | Walt Disney            2 | Warren Beatty
 112 | Warner Bros.           3 | Walter Matthau
 ...                         ...
1310

1311
SELECT distributors.name
1312 1313
    FROM distributors
    WHERE distributors.name LIKE 'W%'
1314 1315
UNION
SELECT actors.name
1316 1317
    FROM actors
    WHERE actors.name LIKE 'W%';
1318

1319 1320 1321 1322 1323 1324 1325 1326
      name
----------------
 Walt Disney
 Walter Matthau
 Warner Bros.
 Warren Beatty
 Westward
 Woody Allen
1327 1328 1329 1330
</programlisting>
  </para>

  <para>
1331
   This example shows how to use a function in the <literal>FROM</>
T
Tom Lane 已提交
1332
   clause, both with and without a column definition list:
1333 1334

<programlisting>
1335
CREATE FUNCTION distributors(int) RETURNS SETOF distributors AS $$
1336
    SELECT * FROM distributors WHERE did = $1;
1337
$$ LANGUAGE SQL;
1338 1339 1340 1341 1342 1343

SELECT * FROM distributors(111);
 did |    name
-----+-------------
 111 | Walt Disney

1344
CREATE FUNCTION distributors_2(int) RETURNS SETOF record AS $$
1345
    SELECT * FROM distributors WHERE did = $1;
1346
$$ LANGUAGE SQL;
1347 1348 1349 1350 1351

SELECT * FROM distributors_2(111) AS (f1 int, f2 text);
 f1  |     f2
-----+-------------
 111 | Walt Disney
1352
</programlisting>
1353
  </para>
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399

  <para>
   This example shows how to use a simple <literal>WITH</> clause:

<programlisting>
WITH t AS (
    SELECT random() as x FROM generate_series(1, 3)
  )
SELECT * FROM t
UNION ALL
SELECT * FROM t

         x          
--------------------
  0.534150459803641
  0.520092216785997
 0.0735620250925422
  0.534150459803641
  0.520092216785997
 0.0735620250925422
</programlisting>

   Notice that the <literal>WITH</> query was evaluated only once,
   so that we got two sets of the same three random values.
  </para>

  <para>
   This example uses <literal>WITH RECURSIVE</literal> to find all
   subordinates (direct or indirect) of the employee Mary, and their
   level of indirectness, from a table that shows only direct
   subordinates:

<programlisting>
WITH RECURSIVE employee_recursive(distance, employee_name, manager_name) AS (
    SELECT 1, employee_name, manager_name
    FROM employee
    WHERE manager_name = 'Mary'
  UNION ALL
    SELECT er.distance + 1, e.employee_name, e.manager_name
    FROM employee_recursive er, employee e
    WHERE er.employee_name = e.manager_name
  )
SELECT distance, employee_name FROM employee_recursive;
</programlisting>

   Notice the typical form of recursive queries:
1400
   an initial condition, followed by <literal>UNION</literal>,
1401 1402 1403 1404 1405
   followed by the recursive part of the query. Be sure that the
   recursive part of the query will eventually return no tuples, or
   else the query will loop indefinitely.  (See <xref linkend="queries-with">
   for more examples.)
  </para>
1406
 </refsect1>
1407

1408 1409 1410 1411 1412 1413 1414 1415
 <refsect1>
  <title>Compatibility</title>

  <para>
   Of course, the <command>SELECT</command> statement is compatible
   with the SQL standard.  But there are some extensions and some
   missing features.
  </para>
1416

1417 1418
  <refsect2>
   <title>Omitted <literal>FROM</literal> Clauses</title>
1419 1420

   <para>
1421 1422 1423 1424
    <productname>PostgreSQL</productname> allows one to omit the
    <literal>FROM</literal> clause.  It has a straightforward use to
    compute the results of simple expressions:
<programlisting>
1425 1426 1427 1428 1429
SELECT 2+2;

 ?column?
----------
        4
1430 1431 1432 1433 1434
</programlisting>
    Some other <acronym>SQL</acronym> databases cannot do this except
    by introducing a dummy one-row table from which to do the
    <command>SELECT</command>.
   </para>
1435

1436
   <para>
1437 1438 1439
    Note that if a <literal>FROM</literal> clause is not specified,
    the query cannot reference any database tables. For example, the
    following query is invalid:
1440
<programlisting>
1441
SELECT distributors.* WHERE distributors.name = 'Westward';
1442
</programlisting>
1443 1444 1445 1446 1447 1448 1449 1450 1451
    <productname>PostgreSQL</productname> releases prior to
    8.1 would accept queries of this form, and add an implicit entry
    to the query's <literal>FROM</literal> clause for each table
    referenced by the query. This is no longer the default behavior,
    because it does not comply with the SQL standard, and is
    considered by many to be error-prone. For compatibility with
    applications that rely on this behavior the <xref
    linkend="guc-add-missing-from"> configuration variable can be
    enabled.
1452 1453 1454 1455
   </para>
  </refsect2>

  <refsect2>
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
   <title>Omitting the <literal>AS</literal> Key Word</title>

   <para>
    In the SQL standard, the optional key word <literal>AS</> can be
    omitted before an output column name whenever the new column name
    is a valid column name (that is, not the same as any reserved
    keyword).  <productname>PostgreSQL</productname> is slightly more
    restrictive: <literal>AS</> is required if the new column name
    matches any keyword at all, reserved or not.  Recommended practice is
    to use <literal>AS</> or double-quote output column names, to prevent
    any possible conflict against future keyword additions.
   </para>
1468

1469
   <para>
1470 1471 1472 1473 1474
    In <literal>FROM</literal> items, both the standard and
    <productname>PostgreSQL</productname> allow <literal>AS</> to
    be omitted before an alias that is an unreserved keyword.  But
    this is impractical for output column names, because of syntactic
    ambiguities.
1475
   </para>
1476 1477
  </refsect2>

1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
  <refsect2>
   <title><literal>ONLY</literal> and Parentheses</title>

   <para>
    The SQL standard requires parentheses around the table name
    after <literal>ONLY</literal>, as in <literal>SELECT * FROM ONLY
    (tab1), ONLY (tab2) WHERE ...</literal>.  PostgreSQL supports that
    as well, but the parentheses are optional.  (This point applies
    equally to all SQL commands supporting the <literal>ONLY</literal>
    option.)
   </para>
  </refsect2>

1491 1492
  <refsect2>
   <title>Namespace Available to <literal>GROUP BY</literal> and <literal>ORDER BY</literal></title>
1493 1494

   <para>
1495
    In the SQL-92 standard, an <literal>ORDER BY</literal> clause can
1496
    only use output column names or numbers, while a <literal>GROUP
1497
    BY</literal> clause can only use expressions based on input column
1498 1499 1500 1501 1502 1503
    names.  <productname>PostgreSQL</productname> extends each of
    these clauses to allow the other choice as well (but it uses the
    standard's interpretation if there is ambiguity).
    <productname>PostgreSQL</productname> also allows both clauses to
    specify arbitrary expressions.  Note that names appearing in an
    expression will always be taken as input-column names, not as
1504
    output-column names.
1505
   </para>
1506 1507

   <para>
1508
    SQL:1999 and later use a slightly different definition which is not
1509
    entirely upward compatible with SQL-92.
1510
    In most cases, however, <productname>PostgreSQL</productname>
1511
    will interpret an <literal>ORDER BY</literal> or <literal>GROUP
1512
    BY</literal> expression the same way SQL:1999 does.
1513
   </para>
1514
  </refsect2>
1515

T
Tom Lane 已提交
1516 1517 1518 1519
  <refsect2>
   <title><literal>WINDOW</literal> Clause Restrictions</title>

   <para>
1520
    The SQL standard provides additional options for the window
1521
    <replaceable class="parameter">frame_clause</>.
1522 1523
    <productname>PostgreSQL</productname> currently supports only the
    options listed above.
T
Tom Lane 已提交
1524 1525 1526
   </para>
  </refsect2>

1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544
  <refsect2>
   <title><literal>LIMIT</literal> and <literal>OFFSET</literal></title>

   <para>
    The clauses <literal>LIMIT</literal> and <literal>OFFSET</literal>
    are <productname>PostgreSQL</productname>-specific syntax, also
    used by <productname>MySQL</productname>.  The SQL:2008 standard
    has introduced the clauses <literal>OFFSET ... FETCH {FIRST|NEXT}
    ...</literal> for the same functionality, as shown above
    in <xref linkend="sql-limit" endterm="sql-limit-title">, and this
    syntax is also used by <productname>IBM DB2</productname>.
    (Applications written for <productname>Oracle</productname>
    frequently use a workaround involving the automatically
    generated <literal>rownum</literal> column, not available in
    PostgreSQL, to implement the effects of these clauses.)
   </para>
  </refsect2>

1545 1546 1547
  <refsect2>
   <title>Nonstandard Clauses</title>

1548
   <para>
1549 1550
    The clause <literal>DISTINCT ON</literal> is not defined in the
    SQL standard.
1551 1552 1553 1554
   </para>
  </refsect2>
 </refsect1>
</refentry>