From a4ac2f458e8cb76177254f4bd7bbd885991379af Mon Sep 17 00:00:00 2001 From: "Thomas G. Lockhart" Date: Tue, 6 Jul 1999 17:16:42 +0000 Subject: Fix markup for docbook2man man page generation. No big deal; fixed lots of other markup at the same time. Bigest change: make sure there is no whitespace in front of contents. This will probably help the other output types too. --- doc/src/sgml/ref/create_index.sgml | 415 ++++++++++++++++++------------------- 1 file changed, 201 insertions(+), 214 deletions(-) (limited to 'doc/src/sgml/ref/create_index.sgml') diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml index 1629a600547..860a793c6c2 100644 --- a/doc/src/sgml/ref/create_index.sgml +++ b/doc/src/sgml/ref/create_index.sgml @@ -1,133 +1,124 @@ - - - + + + CREATE INDEX - - SQL - Language Statements - - - + + SQL - Language Statements + + + CREATE INDEX - - + + Constructs a secondary index - + - - - 1998-09-09 - - + + + 1998-09-09 + + CREATE [ UNIQUE ] INDEX index_name ON table [ USING acc_name ] ( column [ ops_name] [, ...] ) CREATE [ UNIQUE ] INDEX index_name ON table [ USING acc_name ] - ( func_name( column [, ... ]) ops_name ) - - - - - 1998-09-09 - - + ( <replaceable class="parameter">func_name</replaceable>( <replaceable class="parameter">r">col</replaceable>le> [, ... ]) <replaceable class="parameter">ops_name</replaceable> ) + </synopsis> + + <refsect2 id="R2-SQL-CREATEINDEX-1"> + <refsect2info> + <date>1998-09-09</date> + </refsect2info> + <title> Inputs - - - - - - UNIQUE - - - - 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 non-duplicate data will generate an - error. - - - - - - index_name - - - - The name of the index to be created. - - - - - - table - - - - The name of the table to be indexed. - - - - - - acc_name - - - - 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: - - - BTREE - - - an implementation of the Lehman-Yao - high-concurrency btrees. - - - - - RTREE - - implements standard rtrees using Guttman's - quadratic split algorithm. - - - - - HASH - - - an implementation of Litwin's linear hashing. - - - - - - - - - - column - - - - The name of a column of the table. - - - - - - ops_name - - - - An associated operator class. - The following select list returns all ops_names: - - + + + + + + UNIQUE + + + 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 non-duplicate data will generate an + error. + + + + + index_name + + + The name of the index to be created. + + + + + table + + + The name of the table to be indexed. + + + + + acc_name + + + 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: + + + BTREE + + + an implementation of the Lehman-Yao + high-concurrency btrees. + + + + + RTREE + + implements standard rtrees using Guttman's + quadratic split algorithm. + + + + + HASH + + + an implementation of Litwin's linear hashing. + + + + + + + + + + + column + + + The name of a column of the table. + + + + + ops_name + + + An associated operator class. + The following select list returns all ops_names: + + SELECT am.amname AS acc_name, opc.opcname AS ops_name, opr.oprname AS ops_comp @@ -137,75 +128,72 @@ SELECT am.amname AS acc_name, amop.amopclaid = opc.oid AND amop.amopopr = opr.oid ORDER BY acc_name, ops_name, ops_comp - - - - - - - - func_name - - - + + + + + + func_name + + A user-defined function, which returns a value that can be indexed. - - - + + + - - - - - 1998-09-09 - - + </refsect2> + + <refsect2 id="R2-SQL-CREATEINDEX-2"> + <refsect2info> + <date>1998-09-09</date> + </refsect2info> + <title> Outputs - - + + - - - - CREATE - - - - The message returned if the index is successfully created. - - - + + + +CREATE + + + + The message returned if the index is successfully created. + + + - - - ERROR: Cannot create index: 'index_name' already exists. - - - + + +ERROR: Cannot create index: 'index_name' already exists. + + + This error occurs if it is impossible to create the index. - - - - - - 1998-09-09 - - + </refsect2> + </refsynopsisdiv> + + <refsect1 id="R1-SQL-CREATEINDEX-1"> + <refsect1info> + <date>1998-09-09</date> + </refsect1info> + <title> Description - - + + CREATE INDEX constructs an index index_name. on the specified table. - + Indexes are primarily used to enhance database performance. @@ -225,45 +213,45 @@ SELECT am.amname AS acc_name, operator class is the appropriate operator class for that field type. - - In the second syntax, an index is defined - on the result of a user-defined function - func_name applied - to one or more attributes of a single class. These functional - indexes 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. - - - - - 1998-09-09 - - + <para> + In the second syntax, 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 functional + indexes 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> + + <refsect2 id="R2-SQL-CREATEINDEX-3"> + <refsect2info> + <date>1998-09-09</date> + </refsect2info> + <title> Notes - - + + Currently, only the BTREE access method supports multi-column indexes. Up to 7 keys may be specified. - + Use DROP INDEX to remove an index. - + - - + <refsect1 id="R1-SQL-CREATEINDEX-2"> + <title> Usage - - To create a btree index on the field title + + To create a btree index on the field title in the table films: - - + + CREATE UNIQUE INDEX title_idx ON films (title); - + - + - - + <refsect1 id="R1-SQL-CREATEINDEX-3"> + <title> Compatibility - - - + + + - - - 1998-09-09 - - + <refsect2 id="R2-SQL-CREATEINDEX-4"> + <refsect2info> + <date>1998-09-09</date> + </refsect2info> + <title> SQL92 - - + + CREATE INDEX is a Postgres language extension. - + There is no CREATE INDEX command in SQL92. - - +