<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/cluster.sgml,v 1.40 2007/02/01 00:28:18 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/cluster.sgml,v 1.41 2007/04/08 00:26:33 momjian Exp $
PostgreSQL documentation
-->
<refsynopsisdiv>
<synopsis>
-CLUSTER <replaceable class="PARAMETER">indexname</replaceable> ON <replaceable class="PARAMETER">tablename</replaceable>
-CLUSTER <replaceable class="PARAMETER">tablename</replaceable>
+CLUSTER <replaceable class="PARAMETER">tablename</replaceable> [ USING <replaceable class="PARAMETER">indexname</replaceable> ]
CLUSTER
</synopsis>
</refsynopsisdiv>
<variablelist>
<varlistentry>
- <term><replaceable class="PARAMETER">indexname</replaceable></term>
+ <term><replaceable class="PARAMETER">tablename</replaceable></term>
<listitem>
<para>
- The name of an index.
+ The name (possibly schema-qualified) of a table.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><replaceable class="PARAMETER">tablename</replaceable></term>
+ <term><replaceable class="PARAMETER">indexname</replaceable></term>
<listitem>
<para>
- The name (possibly schema-qualified) of a table.
+ The name of an index.
</para>
</listitem>
</varlistentry>
<para>
Cluster the table <literal>employees</literal> on the basis of
- its index <literal>emp_ind</literal>:
+ its index <literal>employees_ind</literal>:
<programlisting>
-CLUSTER emp_ind ON emp;
+CLUSTER employees USING employees_ind;
</programlisting>
</para>
Cluster the <literal>employees</literal> table using the same
index that was used before:
<programlisting>
-CLUSTER emp;
+CLUSTER employees;
</programlisting>
</para>
<title>Compatibility</title>
<para>
- There is no <command>CLUSTER</command> statement in the SQL standard.
+ The syntax:
+<synopsis>
+CLUSTER <replaceable class="PARAMETER">indexname</replaceable> ON <replaceable class="PARAMETER">tablename</replaceable>
+</synopsis>
+ is also supported for compatibility with pre-8.3 <productname>PostgreSQL</> installations.
+ There is no <command>CLUSTER</command> statement in the SQL standard.
</para>
</refsect1>
*
*
* IDENTIFICATION
- * $PostgreSQL: pgsql/src/backend/parser/gram.y,v 2.586 2007/04/02 22:20:53 momjian Exp $
+ * $PostgreSQL: pgsql/src/backend/parser/gram.y,v 2.587 2007/04/08 00:26:34 momjian Exp $
*
* HISTORY
* AUTHOR DATE MAJOR EVENT
%type <str> relation_name copy_file_name
database_name access_method_clause access_method attr_name
- index_name name file_name
+ index_name name file_name cluster_index_specification
%type <list> func_name handler_name qual_Op qual_all_Op subquery_Op
opt_class opt_validator
/*****************************************************************************
*
* QUERY:
- * load "filename"
+ * LOAD "filename"
*
*****************************************************************************/
/*****************************************************************************
*
* QUERY:
- * cluster <index_name> on <qualified_name>
- * cluster <qualified_name>
- * cluster
+ * CLUSTER <qualified_name> [ USING <index_name> ]
+ * CLUSTER
+ * CLUSTER <index_name> ON <qualified_name> (for pre-8.3)
*
*****************************************************************************/
ClusterStmt:
- CLUSTER index_name ON qualified_name
- {
- ClusterStmt *n = makeNode(ClusterStmt);
- n->relation = $4;
- n->indexname = $2;
- $$ = (Node*)n;
- }
- | CLUSTER qualified_name
+ CLUSTER qualified_name cluster_index_specification
{
ClusterStmt *n = makeNode(ClusterStmt);
n->relation = $2;
- n->indexname = NULL;
+ n->indexname = $3;
$$ = (Node*)n;
}
| CLUSTER
n->indexname = NULL;
$$ = (Node*)n;
}
+ /* kept for pre-8.3 compatibility */
+ | CLUSTER index_name ON qualified_name
+ {
+ ClusterStmt *n = makeNode(ClusterStmt);
+ n->relation = $4;
+ n->indexname = $2;
+ $$ = (Node*)n;
+ }
+ ;
+
+cluster_index_specification:
+ USING index_name { $$ = $2; }
+ | /*EMPTY*/ { $$ = NULL; }
;
+
/*****************************************************************************
*
* QUERY:
- * vacuum
- * analyze
+ * VACUUM
+ * ANALYZE
*
*****************************************************************************/
*
* Copyright (c) 2000-2007, PostgreSQL Global Development Group
*
- * $PostgreSQL: pgsql/src/bin/psql/tab-complete.c,v 1.160 2007/03/26 16:58:40 tgl Exp $
+ * $PostgreSQL: pgsql/src/bin/psql/tab-complete.c,v 1.161 2007/04/08 00:26:34 momjian Exp $
*/
/*----------------------------------------------------------------------
COMPLETE_WITH_LIST(list_COLUMNALTER);
}
- else if (pg_strcasecmp(prev3_wd, "TABLE") == 0 &&
- pg_strcasecmp(prev_wd, "CLUSTER") == 0)
+ else if (pg_strcasecmp(prev3_wd, "TABLE") == 0)
COMPLETE_WITH_CONST("ON");
else if (pg_strcasecmp(prev4_wd, "TABLE") == 0 &&
- pg_strcasecmp(prev2_wd, "CLUSTER") == 0 &&
pg_strcasecmp(prev_wd, "ON") == 0)
{
completion_info_charp = prev3_wd;
/*
* If the previous word is CLUSTER and not without produce list of
- * indexes.
+ * tables
*/
else if (pg_strcasecmp(prev_wd, "CLUSTER") == 0 &&
pg_strcasecmp(prev2_wd, "WITHOUT") != 0)
- COMPLETE_WITH_SCHEMA_QUERY(Query_for_list_of_indexes, NULL);
- /* If we have CLUSTER <sth>, then add "ON" */
+ COMPLETE_WITH_SCHEMA_QUERY(Query_for_list_of_tables, NULL);
+ /* If we have CLUSTER <sth>, then add "USING" */
else if (pg_strcasecmp(prev2_wd, "CLUSTER") == 0 &&
- pg_strcasecmp(prev_wd, "ON") != 0)
- COMPLETE_WITH_CONST("ON");
+ pg_strcasecmp(prev_wd, "ON") != 0) {
+ COMPLETE_WITH_CONST("USING");
+ }
/*
- * If we have CLUSTER <sth> ON, then add the correct tablename as well.
+ * If we have CLUSTER <sth> ORDER BY, then add the index as well.
*/
else if (pg_strcasecmp(prev3_wd, "CLUSTER") == 0 &&
- pg_strcasecmp(prev_wd, "ON") == 0)
+ pg_strcasecmp(prev_wd, "USING") == 0)
{
completion_info_charp = prev2_wd;
- COMPLETE_WITH_QUERY(Query_for_table_owning_index);
+ COMPLETE_WITH_QUERY(Query_for_index_of_table);
}
/* COMMENT */
CLUSTER clstr_2;
ERROR: there is no previously clustered index for table "clstr_2"
CLUSTER clstr_1_pkey ON clstr_1;
-CLUSTER clstr_2_pkey ON clstr_2;
+CLUSTER clstr_2 USING clstr_2_pkey;
SELECT * FROM clstr_1 UNION ALL
SELECT * FROM clstr_2 UNION ALL
SELECT * FROM clstr_3;
CLUSTER clstr_2;
CLUSTER clstr_1_pkey ON clstr_1;
-CLUSTER clstr_2_pkey ON clstr_2;
+CLUSTER clstr_2 USING clstr_2_pkey;
SELECT * FROM clstr_1 UNION ALL
SELECT * FROM clstr_2 UNION ALL
SELECT * FROM clstr_3;