granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/create_index.sgml

   1 <!--
   2 $PostgreSQL: pgsql/doc/src/sgml/ref/create_index.sgml,v 1.50 2004/11/05 19:15:51 tgl Exp $
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-CREATEINDEX">
   7  <refmeta>
   8   <refentrytitle id="sql-createindex-title">CREATE INDEX</refentrytitle>
   9   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  10  </refmeta>
  11
  12  <refnamediv>
  13   <refname>CREATE INDEX</refname>
  14   <refpurpose>define a new index</refpurpose>
  15  </refnamediv>
  16
  17  <indexterm zone="sql-createindex">
  18   <primary>CREATE INDEX</primary>
  19  </indexterm>
  20
  21  <refsynopsisdiv>
  22 <synopsis>
  23 CREATE [ UNIQUE ] INDEX <replaceable class="parameter">name</replaceable> ON <replaceable class="parameter">table</replaceable> [ USING <replaceable class="parameter">method</replaceable> ]
  24     ( { <replaceable class="parameter">column</replaceable> | ( <replaceable class="parameter">expression</replaceable> ) } [ <replaceable class="parameter">opclass</replaceable> ] [, ...] )
  25     [ TABLESPACE <replaceable class="parameter">tablespace</replaceable> ]
  26     [ WHERE <replaceable class="parameter">predicate</replaceable> ]
  27 </synopsis>
  28  </refsynopsisdiv>
  29
  30  <refsect1>
  31   <title>Description</title>
  32
  33   <para>
  34    <command>CREATE INDEX</command> constructs an index <replaceable
  35    class="parameter">index_name</replaceable> on the specified table.
  36    Indexes are primarily used to enhance database performance (though
  37    inappropriate use will result in slower performance).
  38   </para>
  39
  40   <para>
  41    The key field(s) for the index are specified as column names,
  42    or alternatively as expressions written in parentheses.
  43    Multiple fields can be specified if the index method supports
  44    multicolumn indexes.
  45   </para>
  46
  47   <para>
  48    An index field can be an expression computed from the values of
  49    one or more columns of the table row.  This feature can be used
  50    to obtain fast access to data based on some transformation of
  51    the basic data. For example, an index computed on
  52    <literal>upper(col)</> would allow the clause
  53    <literal>WHERE upper(col) = 'JIM'</> to use an index.
  54   </para>
  55
  56   <para>
  57    <productname>PostgreSQL</productname> provides the index methods
  58    B-tree, R-tree, hash, and GiST. The B-tree index method is an
  59    implementation of Lehman-Yao high-concurrency B-trees. The R-tree
  60    index method implements standard R-trees using Guttman's quadratic
  61    split algorithm. The hash index method is an implementation of
  62    Litwin's linear hashing.  Users can also define their own index
  63    methods, but that is fairly complicated.
  64   </para>
  65
  66   <para>
  67     When the <literal>WHERE</literal> clause is present, a
  68     <firstterm>partial index</firstterm> is created.
  69     A partial index is an index that contains entries for only a portion of
  70     a table, usually a portion that is more useful for indexing than the
  71     rest of the table. For example, if you have a table that contains both
  72     billed and unbilled orders where the unbilled orders take up a small
  73     fraction of the total table and yet that is an often used section, you
  74     can improve performance by creating an index on just that portion.
  75     Another possible application is to use <literal>WHERE</literal> with
  76     <literal>UNIQUE</literal> to enforce uniqueness over a subset of a
  77     table.
  78   </para>
  79
  80   <para>
  81    Indexes are not used for <literal>IS NULL</> clauses by default.
  82    The best way to use indexes in such cases is to create a partial index
  83    using an <literal>IS NULL</> comparison.
  84   </para>
  85
  86   <para>
  87     The expression used in the <literal>WHERE</literal> clause may refer
  88     only to columns of the underlying table, but it can use all columns,
  89     not just the ones being indexed.  Presently, subqueries and
  90     aggregate expressions are also forbidden in <literal>WHERE</literal>.
  91     The same restrictions apply to index fields that are expressions.
  92   </para>
  93
  94   <para>
  95    All functions and operators used in an index definition must be
  96    <quote>immutable</>, that is, their results must depend only on
  97    their arguments and never on any outside influence (such as
  98    the contents of another table or the current time).  This restriction
  99    ensures that the behavior of the index is well-defined.  To use a
 100    user-defined function in an index expression or <literal>WHERE</literal>
 101    clause, remember to mark the function immutable when you create it.
 102   </para>
 103  </refsect1>
 104
 105  <refsect1>
 106   <title>Parameters</title>
 107
 108     <variablelist>
 109      <varlistentry>
 110       <term><literal>UNIQUE</literal></term>
 111       <listitem>
 112        <para>
 113         Causes the system to check for
 114         duplicate values in the table when the index is created (if data
 115         already exist) and each time data is added. Attempts to
 116         insert or update data which would result in duplicate entries
 117         will generate an error.
 118        </para>
 119       </listitem>
 120      </varlistentry>
 121
 122      <varlistentry>
 123       <term><replaceable class="parameter">name</replaceable></term>
 124       <listitem>
 125        <para>
 126         The name of the index to be created.  No schema name can be included
 127         here; the index is always created in the same schema as its parent
 128         table.
 129        </para>
 130       </listitem>
 131      </varlistentry>
 132
 133      <varlistentry>
 134       <term><replaceable class="parameter">table</replaceable></term>
 135       <listitem>
 136        <para>
 137         The name (possibly schema-qualified) of the table to be indexed.
 138        </para>
 139       </listitem>
 140      </varlistentry>
 141
 142      <varlistentry>
 143       <term><replaceable class="parameter">method</replaceable></term>
 144       <listitem>
 145        <para>
 146         The name of the method to be used for the index.  Choices are
 147         <literal>btree</literal>, <literal>hash</literal>,
 148         <literal>rtree</literal>, and <literal>gist</literal>.  The
 149         default method is <literal>btree</literal>.
 150        </para>
 151       </listitem>
 152      </varlistentry>
 153
 154      <varlistentry>
 155       <term><replaceable class="parameter">column</replaceable></term>
 156       <listitem>
 157        <para>
 158         The name of a column of the table.
 159        </para>
 160       </listitem>
 161      </varlistentry>
 162
 163      <varlistentry>
 164       <term><replaceable class="parameter">expression</replaceable></term>
 165       <listitem>
 166        <para>
 167         An expression based on one or more columns of the table.  The
 168         expression usually must be written with surrounding parentheses,
 169         as shown in the syntax.  However, the parentheses may be omitted
 170         if the expression has the form of a function call.
 171        </para>
 172       </listitem>
 173      </varlistentry>
 174
 175      <varlistentry>
 176       <term><replaceable class="parameter">opclass</replaceable></term>
 177       <listitem>
 178        <para>
 179         The name of an operator class. See below for details.
 180        </para>
 181       </listitem>
 182      </varlistentry>
 183
 184      <varlistentry>
 185       <term><replaceable class="parameter">tablespace</replaceable></term>
 186       <listitem>
 187        <para>
 188         The tablespace in which to create the index.  If not specified,
 189         <xref linkend="guc-default-tablespace"> is used, or the database's
 190         default tablespace if <varname>default_tablespace</> is an empty
 191         string.
 192        </para>
 193       </listitem>
 194      </varlistentry>
 195
 196      <varlistentry>
 197       <term><replaceable class="parameter">predicate</replaceable></term>
 198       <listitem>
 199        <para>
 200         The constraint expression for a partial index.
 201        </para>
 202       </listitem>
 203      </varlistentry>
 204
 205     </variablelist>
 206  </refsect1>
 207
 208  <refsect1>
 209   <title>Notes</title>
 210
 211   <para>
 212    See <xref linkend="indexes"> for information about when indexes can
 213    be used, when they are not used, and in which particular situations
 214    can be useful.
 215   </para>
 216
 217   <para>
 218    Currently, only the B-tree and GiST index methods support
 219    multicolumn indexes. Up to 32 fields may be specified by default.
 220    (This limit can be altered when building
 221    <productname>PostgreSQL</productname>.)  Only B-tree currently
 222    supports unique indexes.
 223   </para>
 224
 225   <para>
 226    An <firstterm>operator class</firstterm> can be specified for each
 227    column of an index. The operator class identifies the operators to be
 228    used by the index for that column. For example, a B-tree index on
 229    four-byte integers would use the <literal>int4_ops</literal> class;
 230    this operator class includes comparison functions for four-byte
 231    integers. In practice the default operator class for the column's data
 232    type is usually sufficient. The main point of having operator classes
 233    is that for some data types, there could be more than one meaningful
 234    ordering. For example, we might want to sort a complex-number data
 235    type either by absolute value or by real part. We could do this by
 236    defining two operator classes for the data type and then selecting
 237    the proper class when making an index.  More information about
 238    operator classes is in <xref linkend="indexes-opclass"> and in <xref
 239    linkend="xindex">.
 240   </para>
 241
 242   <para>
 243    Use <xref linkend="sql-dropindex" endterm="sql-dropindex-title">
 244    to remove an index.
 245   </para>
 246  </refsect1>
 247
 248  <refsect1>
 249   <title>Examples</title>
 250
 251   <para>
 252    To create a B-tree index on the column <literal>title</literal> in
 253    the table <literal>films</literal>:
 254 <programlisting>
 255 CREATE UNIQUE INDEX title_idx ON films (title);
 256 </programlisting>
 257   </para>
 258
 259   <para>
 260    To create an index on the column <literal>code</> in the table
 261    <literal>films</> and have the index reside in the tablespace
 262    <literal>indexspace</>:
 263 <programlisting>
 264 CREATE INDEX code_idx ON films(code) TABLESPACE indexspace;
 265 </programlisting>
 266   </para>
 267
 268 <!--
 269 <comment>
 270 Is this example correct?
 271 </comment>
 272   <para>
 273    To create a R-tree index on a point attribute so that we
 274    can efficiently use box operators on the result of the
 275    conversion function:
 276   </para>
 277   <programlisting>
 278 CREATE INDEX pointloc
 279     ON points USING RTREE (point2box(location) box_ops);
 280 SELECT * FROM points
 281     WHERE point2box(points.pointloc) = boxes.box;
 282   </programlisting>
 283 -->
 284
 285  </refsect1>
 286
 287  <refsect1>
 288   <title>Compatibility</title>
 289
 290   <para>
 291    <command>CREATE INDEX</command> is a
 292    <productname>PostgreSQL</productname> language extension.  There
 293    are no provisions for indexes in the SQL standard.
 294   </para>
 295  </refsect1>
 296 </refentry>
 297
 298 <!-- Keep this comment at the end of the file
 299 Local variables:
 300 mode: sgml
 301 sgml-omittag:nil
 302 sgml-shorttag:t
 303 sgml-minimize-attributes:nil
 304 sgml-always-quote-attributes:t
 305 sgml-indent-step:1
 306 sgml-indent-data:t
 307 sgml-parent-document:nil
 308 sgml-default-dtd-file:"../reference.ced"
 309 sgml-exposed-tags:nil
 310 sgml-local-catalogs:"/usr/lib/sgml/catalog"
 311 sgml-local-ecat-files:nil
 312 End:
 313 -->