<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >clusterdb</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REV="MADE" HREF="mailto:pgsql-docs@postgresql.org"><LINK REL="HOME" TITLE="PostgreSQL 7.4.1 Documentation" HREF="index.html"><LINK REL="UP" TITLE="PostgreSQL Client Applications" HREF="reference-client.html"><LINK REL="PREVIOUS" TITLE="PostgreSQL Client Applications" HREF="reference-client.html"><LINK REL="NEXT" TITLE="createdb" HREF="app-createdb.html"><LINK REL="STYLESHEET" TYPE="text/css" HREF="stylesheet.css"><META NAME="creation" CONTENT="2003-12-22T03:48:47"></HEAD ><BODY CLASS="REFENTRY" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="5" ALIGN="center" VALIGN="bottom" >PostgreSQL 7.4.1 Documentation</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="top" ><A HREF="reference-client.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="10%" ALIGN="left" VALIGN="top" ><A HREF="reference-client.html#AEN43043" >Fast Backward</A ></TD ><TD WIDTH="60%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="top" ><A HREF="app-createdb.html" >Fast Forward</A ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="top" ><A HREF="app-createdb.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="APP-CLUSTERDB" ></A ><SPAN CLASS="APPLICATION" >clusterdb</SPAN ></H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN43052" ></A ><H2 >Name</H2 >clusterdb -- cluster a <SPAN CLASS="PRODUCTNAME" >PostgreSQL</SPAN > database</DIV ><A NAME="AEN43056" ></A ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN43058" ></A ><H2 >Synopsis</H2 ><P ><TT CLASS="COMMAND" >clusterdb</TT > [<VAR CLASS="REPLACEABLE" >connection-option</VAR >...] [--table | -t <VAR CLASS="REPLACEABLE" >table</VAR > ] [<VAR CLASS="REPLACEABLE" >dbname</VAR >]<BR><TT CLASS="COMMAND" >clusterdb</TT > [<VAR CLASS="REPLACEABLE" >connection-option</VAR >...] [--all | -a]</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN43074" ></A ><H2 >Description</H2 ><P > <SPAN CLASS="APPLICATION" >clusterdb</SPAN > is a utility for reclustering tables in a <SPAN CLASS="PRODUCTNAME" >PostgreSQL</SPAN > database. It finds tables that have previously been clustered, and clusters them again on the same index that was last used. Tables that have never been clustered are not affected. </P ><P > <SPAN CLASS="APPLICATION" >clusterdb</SPAN > is a wrapper around the SQL command <A HREF="sql-cluster.html" ><I >CLUSTER</I ></A >. There is no effective difference between clustering databases via this utility and via other methods for accessing the server. </P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN43082" ></A ><H2 >Options</H2 ><P > <SPAN CLASS="APPLICATION" >clusterdb</SPAN > accepts the following command-line arguments: <P ></P ></P><DIV CLASS="VARIABLELIST" ><DL ><DT ><VAR CLASS="OPTION" >-a</VAR ><BR><VAR CLASS="OPTION" >--all</VAR ></DT ><DD ><P > Cluster all databases. </P ></DD ><DT ><VAR CLASS="OPTION" >[<SPAN CLASS="OPTIONAL" >-d</SPAN >] <VAR CLASS="REPLACEABLE" >dbname</VAR ></VAR ><BR><VAR CLASS="OPTION" >[<SPAN CLASS="OPTIONAL" >--dbname</SPAN >] <VAR CLASS="REPLACEABLE" >dbname</VAR ></VAR ></DT ><DD ><P > Specifies the name of the database to be clustered. If this is not specified and <VAR CLASS="OPTION" >-a</VAR > (or <VAR CLASS="OPTION" >--all</VAR >) is not used, the database name is read from the environment variable <TT CLASS="ENVAR" >PGDATABASE</TT >. If that is not set, the user name specified for the connection is used. </P ></DD ><DT ><VAR CLASS="OPTION" >-e</VAR ><BR><VAR CLASS="OPTION" >--echo</VAR ></DT ><DD ><P > Echo the commands that <SPAN CLASS="APPLICATION" >clusterdb</SPAN > generates and sends to the server. </P ></DD ><DT ><VAR CLASS="OPTION" >-q</VAR ><BR><VAR CLASS="OPTION" >--quiet</VAR ></DT ><DD ><P > Do not display a response. </P ></DD ><DT ><VAR CLASS="OPTION" >-t <VAR CLASS="REPLACEABLE" >table</VAR ></VAR ><BR><VAR CLASS="OPTION" >--table <VAR CLASS="REPLACEABLE" >table</VAR ></VAR ></DT ><DD ><P > Cluster <VAR CLASS="REPLACEABLE" >table</VAR > only. </P ></DD ></DL ></DIV ><P> </P ><P > <SPAN CLASS="APPLICATION" >clusterdb</SPAN > also accepts the following command-line arguments for connection parameters: <P ></P ></P><DIV CLASS="VARIABLELIST" ><DL ><DT ><VAR CLASS="OPTION" >-h <VAR CLASS="REPLACEABLE" >host</VAR ></VAR ><BR><VAR CLASS="OPTION" >--host <VAR CLASS="REPLACEABLE" >host</VAR ></VAR ></DT ><DD ><P > Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the Unix domain socket. </P ></DD ><DT ><VAR CLASS="OPTION" >-p <VAR CLASS="REPLACEABLE" >port</VAR ></VAR ><BR><VAR CLASS="OPTION" >--port <VAR CLASS="REPLACEABLE" >port</VAR ></VAR ></DT ><DD ><P > Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. </P ></DD ><DT ><VAR CLASS="OPTION" >-U <VAR CLASS="REPLACEABLE" >username</VAR ></VAR ><BR><VAR CLASS="OPTION" >--username <VAR CLASS="REPLACEABLE" >username</VAR ></VAR ></DT ><DD ><P > User name to connect as. </P ></DD ><DT ><VAR CLASS="OPTION" >-W</VAR ><BR><VAR CLASS="OPTION" >--password</VAR ></DT ><DD ><P > Force password prompt. </P ></DD ></DL ></DIV ><P> </P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN43170" ></A ><H2 >Environment</H2 ><P ></P ><DIV CLASS="VARIABLELIST" ><DL ><DT ><TT CLASS="ENVAR" >PGDATABASE</TT ><BR><TT CLASS="ENVAR" >PGHOST</TT ><BR><TT CLASS="ENVAR" >PGPORT</TT ><BR><TT CLASS="ENVAR" >PGUSER</TT ></DT ><DD ><P > Default connection parameters </P ></DD ></DL ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN43184" ></A ><H2 >Diagnostics</H2 ><P > In case of difficulty, see <A HREF="sql-cluster.html" ><I >CLUSTER</I ></A > and <A HREF="app-psql.html" ><SPAN CLASS="APPLICATION" >psql</SPAN ></A > for discussions of potential problems and error messages. The database server must be running at the targeted host. Also, any default connection settings and environment variables used by the <SPAN CLASS="APPLICATION" >libpq</SPAN > front-end library will apply. </P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN43190" ></A ><H2 >Examples</H2 ><P > To cluster the database <TT CLASS="LITERAL" >test</TT >: </P><PRE CLASS="SCREEN" ><SAMP CLASS="PROMPT" >$ </SAMP ><KBD CLASS="USERINPUT" >clusterdb test</KBD ></PRE ><P> </P ><P > To cluster a single table <TT CLASS="LITERAL" >foo</TT > in a database named <TT CLASS="LITERAL" >xyzzy</TT >: </P><PRE CLASS="SCREEN" ><SAMP CLASS="PROMPT" >$ </SAMP ><KBD CLASS="USERINPUT" >clusterdb --table foo xyzzy</KBD ></PRE ><P> </P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN43203" ></A ><H2 >See Also</H2 ><A HREF="sql-cluster.html" ><I >CLUSTER</I ></A ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="reference-client.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="app-createdb.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >PostgreSQL Client Applications</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="reference-client.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><SPAN CLASS="APPLICATION" >createdb</SPAN ></TD ></TR ></TABLE ></DIV ></BODY ></HTML >