From c0ad595386b6027449ada778162c599e4b09354a Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Tue, 27 Aug 2002 03:38:28 +0000 Subject: I attach a little patch to make CLUSTER set and reset the indisclustered bit on the indexes. I also attach clusterdb and clusterdb.sgml; both of them are blatant rips of vacuumdb and vacuumdb.sgml, but get the job done. Please review them, as I'm probably making a lot of mistakes with SGML and I can't compile it here. vacuumdb itself is not very comfortable to use when the databases have passwords, because it has to connect once for each table (I can probably make it connect only once for each database; should I?). Because of this I added a mention of PGPASSWORDFILE in the documentation, but I don't know if that is the correct place for that. Alvaro Herrera --- doc/src/sgml/ref/allfiles.sgml | 3 +- doc/src/sgml/ref/clusterdb.sgml | 280 ++++++++++++++++++++++++++++++++++++++++ doc/src/sgml/reference.sgml | 3 +- 3 files changed, 284 insertions(+), 2 deletions(-) create mode 100644 doc/src/sgml/ref/clusterdb.sgml (limited to 'doc/src') diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml index c81cded1178..79221044c21 100644 --- a/doc/src/sgml/ref/allfiles.sgml +++ b/doc/src/sgml/ref/allfiles.sgml @@ -1,5 +1,5 @@ @@ -120,6 +120,7 @@ Complete list of usable sgml source files in this directory. + diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml new file mode 100644 index 00000000000..b650ce24e45 --- /dev/null +++ b/doc/src/sgml/ref/clusterdb.sgml @@ -0,0 +1,280 @@ + + + + + clusterdb + 1 + Application + + + + clusterdb + cluster a PostgreSQL database + + + + + clusterdb + connection-options + --table | -t 'table + dbname + + clusterdb + connection-options + --all-a + + + + + + Description + + + clusterdb is a utility for clustering tables inside a + PostgreSQL database. + + + + clusterdb is a shell script wrapper around the + backend command + via + the PostgreSQL interactive terminal + . There is no effective + difference between clustering databases via this or other methods. + psql must be found by the script and + a database server must be running at the targeted host. Also, any default + settings and environment variables available to psql + and the libpq front-end library do apply. + + + + clusterdb will need to connect several times to the + PostgreSQL server, asking for the password each + time. It will probably be very convenient to have a PGPASSWORDFILE in that case. + + + + + + + Options + + + clusterdb accepts the following command line arguments: + + + + -d dbname + --dbname dbname + + + Specifies the name of the database to be clustered. + If this is not specified and (or + ) is not used, the database name is read + from the environment variable PGDATABASE. If + that is not set, the user name specified for the connection is + used. + + + + + + -a + --all + + + Cluster all databases. + + + + + + -t table + --table table + + + Clusters table only. + + + + + + + + + clusterdb also accepts + the following command line arguments for connection parameters: + + + + -h host + --host host + + + Specifies the host name of the machine on which the + server + is running. If host begins with a slash, it is used + as the directory for the Unix domain socket. + + + + + + -p port + --port port + + + Specifies the Internet TCP/IP port or local Unix domain socket file + extension on which the server + is listening for connections. + + + + + + -U username + --username username + + + User name to connect as + + + + + + -W + --password + + + Force password prompt. + + + + + + -e + --echo + + + Echo the commands that clusterdb generates + and sends to the server. + + + + + + -q + --quiet + + + Do not display a response. + + + + + + + + + + Diagnostics + + + + + CLUSTER + + + Everything went well. + + + + + + clusterdb: Cluster failed. + + + Something went wrong. clusterdb is only a wrapper + script. See + and for a detailed + discussion of error messages and potential problems. Note that this message + may appear once per table to be clustered. + + + + + + + + + + + Environment + + + + PGDATABASE + PGHOST + PGPORT + PGUSER + + + + Default connection parameters. + + + + + + + + + Examples + + + To cluster the database test: + +$ clusterdb test + + + + + To cluster a single table + foo in a database named + xyzzy: + +$ clusterdb --verbose --table foo xyzzy + + + + + + + See Also + + + + + + + + + diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml index 70af1fc6c9f..effe495f1da 100644 --- a/doc/src/sgml/reference.sgml +++ b/doc/src/sgml/reference.sgml @@ -1,5 +1,5 @@ @@ -165,6 +165,7 @@ Disable this chapter until we have more functions documented. + &clusterdb; &createdb; &createlang; &createuser; -- cgit v1.2.3