| <?xml version="1.0" encoding="UTF-8" standalone="no"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>clusterdb</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="reference-client.html" title="PostgreSQL Client Applications" /><link rel="next" href="app-createdb.html" title="createdb" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center"><span class="application">clusterdb</span></th></tr><tr><td width="10%" align="left"><a accesskey="p" href="reference-client.html" title="PostgreSQL Client Applications">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="reference-client.html" title="PostgreSQL Client Applications">Up</a></td><th width="60%" align="center">PostgreSQL Client Applications</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="app-createdb.html" title="createdb">Next</a></td></tr></table><hr /></div><div class="refentry" id="APP-CLUSTERDB"><div class="titlepage"></div><a id="id-1.9.4.3.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle"><span class="application">clusterdb</span></span></h2><p>clusterdb — cluster a <span class="productname">PostgreSQL</span> database</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p id="id-1.9.4.3.4.1"><code class="command">clusterdb</code> [<em class="replaceable"><code>connection-option</code></em>...] [ <code class="option">--verbose</code> | <code class="option">-v</code> ] |
| [ |
| <code class="option">--table</code> | <code class="option">-t</code> |
| <em class="replaceable"><code>table</code></em> |
| ] |
| ... [<em class="replaceable"><code>dbname</code></em>]</p></div><div class="cmdsynopsis"><p id="id-1.9.4.3.4.2"><code class="command">clusterdb</code> [<em class="replaceable"><code>connection-option</code></em>...] [ <code class="option">--verbose</code> | <code class="option">-v</code> ] <code class="option">--all</code> | <code class="option">-a</code> </p></div></div><div class="refsect1" id="id-1.9.4.3.5"><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 class="xref" href="sql-cluster.html" title="CLUSTER"><span class="refentrytitle">CLUSTER</span></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" id="id-1.9.4.3.6"><h2>Options</h2><p> |
| <span class="application">clusterdb</span> accepts the following command-line arguments: |
|
|
| </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-a</code><br /></span><span class="term"><code class="option">--all</code></span></dt><dd><p> |
| Cluster all databases. |
| </p></dd><dt><span class="term"><code class="option">[<span class="optional">-d</span>] <em class="replaceable"><code>dbname</code></em></code><br /></span><span class="term"><code class="option">[<span class="optional">--dbname=</span>]<em class="replaceable"><code>dbname</code></em></code></span></dt><dd><p> |
| Specifies the name of the database to be clustered, |
| when <code class="option">-a</code>/<code class="option">--all</code> is not used. |
| If this is not specified, the database name is read |
| from the environment variable <code class="envar">PGDATABASE</code>. If |
| that is not set, the user name specified for the connection is |
| used. The <em class="replaceable"><code>dbname</code></em> can be a <a class="link" href="libpq-connect.html#LIBPQ-CONNSTRING" title="34.1.1. Connection Strings">connection string</a>. If so, |
| connection string parameters will override any conflicting command |
| line options. |
| </p></dd><dt><span class="term"><code class="option">-e</code><br /></span><span class="term"><code class="option">--echo</code></span></dt><dd><p> |
| Echo the commands that <span class="application">clusterdb</span> generates |
| and sends to the server. |
| </p></dd><dt><span class="term"><code class="option">-q</code><br /></span><span class="term"><code class="option">--quiet</code></span></dt><dd><p> |
| Do not display progress messages. |
| </p></dd><dt><span class="term"><code class="option">-t <em class="replaceable"><code>table</code></em></code><br /></span><span class="term"><code class="option">--table=<em class="replaceable"><code>table</code></em></code></span></dt><dd><p> |
| Cluster <em class="replaceable"><code>table</code></em> only. |
| Multiple tables can be clustered by writing multiple |
| <code class="option">-t</code> switches. |
| </p></dd><dt><span class="term"><code class="option">-v</code><br /></span><span class="term"><code class="option">--verbose</code></span></dt><dd><p> |
| Print detailed information during processing. |
| </p></dd><dt><span class="term"><code class="option">-V</code><br /></span><span class="term"><code class="option">--version</code></span></dt><dd><p> |
| Print the <span class="application">clusterdb</span> version and exit. |
| </p></dd><dt><span class="term"><code class="option">-?</code><br /></span><span class="term"><code class="option">--help</code></span></dt><dd><p> |
| Show help about <span class="application">clusterdb</span> command line |
| arguments, and exit. |
| </p></dd></dl></div><p> |
| </p><p> |
| <span class="application">clusterdb</span> also accepts |
| the following command-line arguments for connection parameters: |
|
|
| </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-h <em class="replaceable"><code>host</code></em></code><br /></span><span class="term"><code class="option">--host=<em class="replaceable"><code>host</code></em></code></span></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><span class="term"><code class="option">-p <em class="replaceable"><code>port</code></em></code><br /></span><span class="term"><code class="option">--port=<em class="replaceable"><code>port</code></em></code></span></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><span class="term"><code class="option">-U <em class="replaceable"><code>username</code></em></code><br /></span><span class="term"><code class="option">--username=<em class="replaceable"><code>username</code></em></code></span></dt><dd><p> |
| User name to connect as. |
| </p></dd><dt><span class="term"><code class="option">-w</code><br /></span><span class="term"><code class="option">--no-password</code></span></dt><dd><p> |
| Never issue a password prompt. If the server requires |
| password authentication and a password is not available by |
| other means such as a <code class="filename">.pgpass</code> file, the |
| connection attempt will fail. This option can be useful in |
| batch jobs and scripts where no user is present to enter a |
| password. |
| </p></dd><dt><span class="term"><code class="option">-W</code><br /></span><span class="term"><code class="option">--password</code></span></dt><dd><p> |
| Force <span class="application">clusterdb</span> to prompt for a |
| password before connecting to a database. |
| </p><p> |
| This option is never essential, since |
| <span class="application">clusterdb</span> will automatically prompt |
| for a password if the server demands password authentication. |
| However, <span class="application">clusterdb</span> will waste a |
| connection attempt finding out that the server wants a password. |
| In some cases it is worth typing <code class="option">-W</code> to avoid the extra |
| connection attempt. |
| </p></dd><dt><span class="term"><code class="option">--maintenance-db=<em class="replaceable"><code>dbname</code></em></code></span></dt><dd><p> |
| Specifies the name of the database to connect to to discover which |
| databases should be clustered, |
| when <code class="option">-a</code>/<code class="option">--all</code> is used. |
| If not specified, the <code class="literal">postgres</code> database will be used, |
| or if that does not exist, <code class="literal">template1</code> will be used. |
| This can be a <a class="link" href="libpq-connect.html#LIBPQ-CONNSTRING" title="34.1.1. Connection Strings">connection |
| string</a>. If so, connection string parameters will override any |
| conflicting command line options. Also, connection string parameters |
| other than the database name itself will be re-used when connecting |
| to other databases. |
| </p></dd></dl></div><p> |
| </p></div><div class="refsect1" id="id-1.9.4.3.7"><h2>Environment</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="envar">PGDATABASE</code><br /></span><span class="term"><code class="envar">PGHOST</code><br /></span><span class="term"><code class="envar">PGPORT</code><br /></span><span class="term"><code class="envar">PGUSER</code></span></dt><dd><p> |
| Default connection parameters |
| </p></dd><dt><span class="term"><code class="envar">PG_COLOR</code></span></dt><dd><p> |
| Specifies whether to use color in diagnostic messages. Possible values |
| are <code class="literal">always</code>, <code class="literal">auto</code> and |
| <code class="literal">never</code>. |
| </p></dd></dl></div><p> |
| This utility, like most other <span class="productname">PostgreSQL</span> utilities, |
| also uses the environment variables supported by <span class="application">libpq</span> |
| (see <a class="xref" href="libpq-envars.html" title="34.15. Environment Variables">Section 34.15</a>). |
| </p></div><div class="refsect1" id="id-1.9.4.3.8"><h2>Diagnostics</h2><p> |
| In case of difficulty, see <a class="xref" href="sql-cluster.html" title="CLUSTER"><span class="refentrytitle">CLUSTER</span></a> |
| and <a class="xref" href="app-psql.html" title="psql"><span class="refentrytitle"><span class="application">psql</span></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" id="id-1.9.4.3.9"><h2>Examples</h2><p> |
| To cluster the database <code class="literal">test</code>: |
| </p><pre class="screen"> |
| <code class="prompt">$ </code><strong class="userinput"><code>clusterdb test</code></strong> |
| </pre><p> |
| </p><p> |
| To cluster a single table |
| <code class="literal">foo</code> in a database named |
| <code class="literal">xyzzy</code>: |
| </p><pre class="screen"> |
| <code class="prompt">$ </code><strong class="userinput"><code>clusterdb --table=foo xyzzy</code></strong> |
| </pre></div><div class="refsect1" id="id-1.9.4.3.10"><h2>See Also</h2><span class="simplelist"><a class="xref" href="sql-cluster.html" title="CLUSTER"><span class="refentrytitle">CLUSTER</span></a></span></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="reference-client.html" title="PostgreSQL Client Applications">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="reference-client.html" title="PostgreSQL Client Applications">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="app-createdb.html" title="createdb">Next</a></td></tr><tr><td width="40%" align="left" valign="top">PostgreSQL Client Applications </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="40%" align="right" valign="top"> <span class="application">createdb</span></td></tr></table></div></body></html> |
