<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.11 2000/04/11 05:39:15 thomas Exp $ Postgres documentation --> <refentry id="SQL-CREATEINDEX"> <refmeta> <refentrytitle id="sql-createindex-title"> CREATE INDEX </refentrytitle> <refmiscinfo>SQL - Language Statements</refmiscinfo> </refmeta> <refnamediv> <refname> CREATE INDEX </refname> <refpurpose> Constructs a secondary index </refpurpose> </refnamediv> <refsynopsisdiv> <refsynopsisdivinfo> <date>1999-07-20</date> </refsynopsisdivinfo> <synopsis> CREATE [ UNIQUE ] INDEX <replaceable class="parameter">index_name</replaceable> ON <replaceable class="parameter">table</replaceable> [ USING <replaceable class="parameter">acc_name</replaceable> ] ( <replaceable class="parameter">column</replaceable> [ <replaceable class="parameter">ops_name</replaceable>] [, ...] ) CREATE [ UNIQUE ] INDEX <replaceable class="parameter">index_name</replaceable> ON <replaceable class="parameter">table</replaceable> [ USING <replaceable class="parameter">acc_name</replaceable> ] ( <replaceable class="parameter">func_name</replaceable>( <replaceable class="parameter">col</replaceable> [, ... ]) <replaceable class="parameter">ops_name</replaceable> ) </synopsis> <refsect2 id="R2-SQL-CREATEINDEX-1"> <refsect2info> <date>1998-09-09</date> </refsect2info> <title> Inputs </title> <para> <variablelist> <varlistentry> <term>UNIQUE</term> <listitem> <para> Causes the system to check for duplicate values in the table when the index is created (if data already exist) and each time data is added. Attempts to insert or update data which would result in duplicate entries will generate an error. </para> </listitem> </varlistentry> <varlistentry> <term><replaceable class="parameter">index_name</replaceable></term> <listitem> <para> The name of the index to be created. </para> </listitem> </varlistentry> <varlistentry> <term><replaceable class="parameter">table</replaceable></term> <listitem> <para> The name of the table to be indexed. </para> </listitem> </varlistentry> <varlistentry> <term><replaceable class="parameter">acc_name</replaceable></term> <listitem> <para> the name of the access method which is to be used for the index. The default access method is BTREE. Postgres provides three access methods for secondary indexes: <variablelist> <varlistentry> <term>BTREE</term> <listitem> <para> an implementation of the Lehman-Yao high-concurrency btrees. </para> </listitem> </varlistentry> <varlistentry> <term>RTREE</term> <listitem> <para>implements standard rtrees using Guttman's quadratic split algorithm. </para> </listitem> </varlistentry> <varlistentry> <term>HASH</term> <listitem> <para> an implementation of Litwin's linear hashing. </para> </listitem> </varlistentry> </variablelist> </para> </listitem> </varlistentry> <varlistentry> <term><replaceable class="parameter">column</replaceable></term> <listitem> <para> The name of a column of the table. </para> </listitem> </varlistentry> <varlistentry> <term><replaceable class="parameter">ops_name</replaceable></term> <listitem> <para> An associated operator class. See below for details. </para> </listitem> </varlistentry> <varlistentry> <term><replaceable class="parameter">func_name</replaceable></term> <listitem> <para> A user-defined function, which returns a value that can be indexed. </para> </listitem> </varlistentry> </variablelist> </para> </refsect2> <refsect2 id="R2-SQL-CREATEINDEX-2"> <refsect2info> <date>1998-09-09</date> </refsect2info> <title> Outputs </title> <para> <variablelist> <varlistentry> <term><computeroutput> CREATE </computeroutput></term> <listitem> <para> The message returned if the index is successfully created. </para> </listitem> </varlistentry> <varlistentry> <term><computeroutput> ERROR: Cannot create index: 'index_name' already exists. </computeroutput></term> <listitem> <para> This error occurs if it is impossible to create the index. </para> </listitem> </varlistentry> </variablelist> </para> </refsect2> </refsynopsisdiv> <refsect1 id="R1-SQL-CREATEINDEX-1"> <refsect1info> <date>1998-09-09</date> </refsect1info> <title> Description </title> <para> <command>CREATE INDEX</command> constructs an index <replaceable class="parameter">index_name</replaceable> on the specified <replaceable class="parameter">table</replaceable>. <tip> <para> Indexes are primarily used to enhance database performance. But inappropriate use will result in slower performance. </para> </tip> </para> <para> In the first syntax shown above, the key fields for the index are specified as column names; a column may also have an associated operator class. An operator class is used to specify the operators to be used for a particular index. For example, a btree index on four-byte integers would use the <literal>int4_ops</literal> class; this operator class includes comparison functions for four-byte integers. The default operator class is the appropriate operator class for that field type. </para> <para> In the second syntax shown above, an index is defined on the result of a user-defined function <replaceable class="parameter">func_name</replaceable> applied to one or more attributes of a single class. These <firstterm>functional indices</firstterm> can be used to obtain fast access to data based on operators that would normally require some transformation to apply them to the base data. </para> <para> Postgres provides btree, rtree and hash access methods for secondary indices. The btree access method is an implementation of the Lehman-Yao high-concurrency btrees. The rtree access method implements standard rtrees using Guttman's quadratic split algorithm. The hash access method is an implementation of Litwin's linear hashing. We mention the algorithms used solely to indicate that all of these access methods are fully dynamic and do not have to be optimized periodically (as is the case with, for example, static hash access methods). </para> <refsect2 id="R2-SQL-CREATEINDEX-3"> <refsect2info> <date>1998-09-09</date> </refsect2info> <title> Notes </title> <para> The Postgres query optimizer will consider using btree indices in a scan whenever an indexed attribute is involved in a comparison using one of: <simplelist type="inline"> <member><</member> <member><=</member> <member>=</member> <member>>=</member> <member>></member> </simplelist> </para> <para> Both box classes support indices on the <literal>box</literal> data type in <productname>Postgres</productname>. The difference between them is that <literal>bigbox_ops</literal> scales box coordinates down, to avoid floating point exceptions from doing multiplication, addition, and subtraction on very large floating-point coordinates. If the field on which your rectangles lie is about 20,000 units square or larger, you should use <literal>bigbox_ops</literal>. The <literal>poly_ops</literal> operator class supports rtree indices on <literal>polygon</literal> data. </para> <para> The <productname>Postgres</productname> query optimizer will consider using an rtree index whenever an indexed attribute is involved in a comparison using one of: <simplelist type="inline"> <member><<</member> <member>&<</member> <member>&></member> <member>>></member> <member>@</member> <member>~=</member> <member>&&</member> </simplelist> </para> <para> The <productname>Postgres</productname> query optimizer will consider using a hash index whenever an indexed attribute is involved in a comparison using the <literal>=</literal> operator. </para> <para> Currently, only the BTREE access method supports multi-column indexes. Up to 7 keys may be specified. </para> <para> Use <xref linkend="sql-dropindex-title" endterm="sql-dropindex-title"> to remove an index. </para> <para> The <literal>int24_ops</literal> operator class is useful for constructing indices on int2 data, and doing comparisons against int4 data in query qualifications. Similarly, <literal>int42_ops</literal> support indices on int4 data that is to be compared against int2 data in queries. </para> <para> The following select list returns all ops_names: <programlisting> SELECT am.amname AS acc_name, opc.opcname AS ops_name, opr.oprname AS ops_comp FROM pg_am am, pg_amop amop, pg_opclass opc, pg_operator opr WHERE amop.amopid = am.oid AND amop.amopclaid = opc.oid AND amop.amopopr = opr.oid ORDER BY acc_name, ops_name, ops_comp </programlisting> </para> </refsect2> </refsect1> <refsect1 id="R1-SQL-CREATEINDEX-2"> <title> Usage </title> <para>To create a btree index on the field <literal>title</literal> in the table <literal>films</literal>: </para> <programlisting> CREATE UNIQUE INDEX title_idx ON films (title); </programlisting> <!-- <comment> Is this example correct? </comment> <para> To create a rtree index on a point attribute so that we can efficiently use box operators on the result of the conversion function: </para> <programlisting> CREATE INDEX pointloc ON points USING RTREE (point2box(location) box_ops); SELECT * FROM points WHERE point2box(points.pointloc) = boxes.box; </programlisting> --> </refsect1> <refsect1 id="R1-SQL-CREATEINDEX-3"> <title> Compatibility </title> <refsect2 id="R2-SQL-CREATEINDEX-4"> <refsect2info> <date>1998-09-09</date> </refsect2info> <title> SQL92 </title> <para> CREATE INDEX is a <productname>Postgres</productname> language extension. </para> <para> There is no <command>CREATE INDEX</command> command in SQL92. </para> </refsect2> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:nil sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../reference.ced" sgml-exposed-tags:nil sgml-local-catalogs:"/usr/lib/sgml/catalog" sgml-local-ecat-files:nil End: -->