Age Owner Branch data TLA Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * clusterdb
4 : : *
5 : : * Portions Copyright (c) 2002-2024, PostgreSQL Global Development Group
6 : : *
7 : : * src/bin/scripts/clusterdb.c
8 : : *
9 : : *-------------------------------------------------------------------------
10 : : */
11 : :
12 : : #include "postgres_fe.h"
13 : : #include "common.h"
14 : : #include "common/logging.h"
15 : : #include "fe_utils/cancel.h"
16 : : #include "fe_utils/option_utils.h"
17 : : #include "fe_utils/query_utils.h"
18 : : #include "fe_utils/simple_list.h"
19 : : #include "fe_utils/string_utils.h"
20 : :
21 : :
22 : : static void cluster_one_database(const ConnParams *cparams, const char *table,
23 : : const char *progname, bool verbose, bool echo);
24 : : static void cluster_all_databases(ConnParams *cparams, SimpleStringList *tables,
25 : : const char *progname, bool verbose, bool echo,
26 : : bool quiet);
27 : : static void help(const char *progname);
28 : :
29 : :
30 : : int
7606 peter_e@gmx.net 31 :CBC 12 : main(int argc, char *argv[])
32 : : {
33 : : static struct option long_options[] = {
34 : : {"host", required_argument, NULL, 'h'},
35 : : {"port", required_argument, NULL, 'p'},
36 : : {"username", required_argument, NULL, 'U'},
37 : : {"no-password", no_argument, NULL, 'w'},
38 : : {"password", no_argument, NULL, 'W'},
39 : : {"echo", no_argument, NULL, 'e'},
40 : : {"quiet", no_argument, NULL, 'q'},
41 : : {"dbname", required_argument, NULL, 'd'},
42 : : {"all", no_argument, NULL, 'a'},
43 : : {"table", required_argument, NULL, 't'},
44 : : {"verbose", no_argument, NULL, 'v'},
45 : : {"maintenance-db", required_argument, NULL, 2},
46 : : {NULL, 0, NULL, 0}
47 : : };
48 : :
49 : : const char *progname;
50 : : int optindex;
51 : : int c;
52 : :
53 : 12 : const char *dbname = NULL;
4513 rhaas@postgresql.org 54 : 12 : const char *maintenance_db = NULL;
7606 peter_e@gmx.net 55 : 12 : char *host = NULL;
56 : 12 : char *port = NULL;
57 : 12 : char *username = NULL;
5526 58 : 12 : enum trivalue prompt_password = TRI_DEFAULT;
59 : : ConnParams cparams;
7606 60 : 12 : bool echo = false;
61 : 12 : bool quiet = false;
62 : 12 : bool alldb = false;
5620 63 : 12 : bool verbose = false;
4105 magnus@hagander.net 64 : 12 : SimpleStringList tables = {NULL, NULL};
65 : :
1840 peter@eisentraut.org 66 : 12 : pg_logging_init(argv[0]);
7606 peter_e@gmx.net 67 : 12 : progname = get_progname(argv[0]);
5603 68 : 12 : set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pgscripts"));
69 : :
7606 70 : 12 : handle_help_version_opts(argc, argv, "clusterdb", help);
71 : :
489 peter@eisentraut.org 72 [ + + ]: 22 : while ((c = getopt_long(argc, argv, "ad:eh:p:qt:U:vwW", long_options, &optindex)) != -1)
73 : : {
7606 peter_e@gmx.net 74 [ + + + - : 13 : switch (c)
- - + - +
- - - + ]
75 : : {
489 peter@eisentraut.org 76 : 4 : case 'a':
77 : 4 : alldb = true;
78 : 4 : break;
79 : 1 : case 'd':
80 : 1 : dbname = pg_strdup(optarg);
81 : 1 : break;
82 : 2 : case 'e':
83 : 2 : echo = true;
84 : 2 : break;
7606 peter_e@gmx.net 85 :UBC 0 : case 'h':
4202 bruce@momjian.us 86 : 0 : host = pg_strdup(optarg);
7606 peter_e@gmx.net 87 : 0 : break;
88 : 0 : case 'p':
4202 bruce@momjian.us 89 : 0 : port = pg_strdup(optarg);
7606 peter_e@gmx.net 90 : 0 : break;
91 : 0 : case 'q':
92 : 0 : quiet = true;
93 : 0 : break;
7606 peter_e@gmx.net 94 :CBC 3 : case 't':
4105 magnus@hagander.net 95 : 3 : simple_string_list_append(&tables, optarg);
7606 peter_e@gmx.net 96 : 3 : break;
489 peter@eisentraut.org 97 :UBC 0 : case 'U':
98 : 0 : username = pg_strdup(optarg);
99 : 0 : break;
5620 peter_e@gmx.net 100 :CBC 2 : case 'v':
101 : 2 : verbose = true;
102 : 2 : break;
489 peter@eisentraut.org 103 :UBC 0 : case 'w':
104 : 0 : prompt_password = TRI_NO;
105 : 0 : break;
106 : 0 : case 'W':
107 : 0 : prompt_password = TRI_YES;
108 : 0 : break;
4513 rhaas@postgresql.org 109 : 0 : case 2:
4202 bruce@momjian.us 110 : 0 : maintenance_db = pg_strdup(optarg);
4513 rhaas@postgresql.org 111 : 0 : break;
7606 peter_e@gmx.net 112 :CBC 1 : default:
113 : : /* getopt_long already emitted a complaint */
737 tgl@sss.pgh.pa.us 114 : 1 : pg_log_error_hint("Try \"%s --help\" for more information.", progname);
7606 peter_e@gmx.net 115 : 1 : exit(1);
116 : : }
117 : : }
118 : :
119 : : /*
120 : : * Non-option argument specifies database name as long as it wasn't
121 : : * already specified with -d / --dbname
122 : : */
4380 andrew@dunslane.net 123 [ + + + - ]: 9 : if (optind < argc && dbname == NULL)
124 : : {
125 : 1 : dbname = argv[optind];
126 : 1 : optind++;
127 : : }
128 : :
129 [ - + ]: 9 : if (optind < argc)
130 : : {
1840 peter@eisentraut.org 131 :UBC 0 : pg_log_error("too many command-line arguments (first is \"%s\")",
132 : : argv[optind]);
737 tgl@sss.pgh.pa.us 133 : 0 : pg_log_error_hint("Try \"%s --help\" for more information.", progname);
4380 andrew@dunslane.net 134 : 0 : exit(1);
135 : : }
136 : :
137 : : /* fill cparams except for dbname, which is set below */
1273 tgl@sss.pgh.pa.us 138 :CBC 9 : cparams.pghost = host;
139 : 9 : cparams.pgport = port;
140 : 9 : cparams.pguser = username;
141 : 9 : cparams.prompt_password = prompt_password;
142 : 9 : cparams.override_dbname = NULL;
143 : :
1595 michael@paquier.xyz 144 : 9 : setup_cancel_handler(NULL);
145 : :
7606 peter_e@gmx.net 146 [ + + ]: 9 : if (alldb)
147 : : {
148 [ - + ]: 4 : if (dbname)
737 tgl@sss.pgh.pa.us 149 :UBC 0 : pg_fatal("cannot cluster all databases and a specific one at the same time");
150 : :
1273 tgl@sss.pgh.pa.us 151 :CBC 4 : cparams.dbname = maintenance_db;
152 : :
34 nathan@postgresql.or 153 :GNC 4 : cluster_all_databases(&cparams, &tables,
154 : : progname, verbose, echo, quiet);
155 : : }
156 : : else
157 : : {
7606 peter_e@gmx.net 158 [ + + ]:CBC 5 : if (dbname == NULL)
159 : : {
160 [ + - ]: 3 : if (getenv("PGDATABASE"))
161 : 3 : dbname = getenv("PGDATABASE");
7606 peter_e@gmx.net 162 [ # # ]:UBC 0 : else if (getenv("PGUSER"))
163 : 0 : dbname = getenv("PGUSER");
164 : : else
3770 bruce@momjian.us 165 : 0 : dbname = get_user_name_or_exit(progname);
166 : : }
167 : :
1273 tgl@sss.pgh.pa.us 168 :CBC 5 : cparams.dbname = dbname;
169 : :
4105 magnus@hagander.net 170 [ + + ]: 5 : if (tables.head != NULL)
171 : : {
172 : : SimpleStringListCell *cell;
173 : :
174 [ + + ]: 3 : for (cell = tables.head; cell; cell = cell->next)
175 : : {
1273 tgl@sss.pgh.pa.us 176 : 2 : cluster_one_database(&cparams, cell->val,
177 : : progname, verbose, echo);
178 : : }
179 : : }
180 : : else
181 : 3 : cluster_one_database(&cparams, NULL,
182 : : progname, verbose, echo);
183 : : }
184 : :
7606 peter_e@gmx.net 185 : 7 : exit(0);
186 : : }
187 : :
188 : :
189 : : static void
1273 tgl@sss.pgh.pa.us 190 : 18 : cluster_one_database(const ConnParams *cparams, const char *table,
191 : : const char *progname, bool verbose, bool echo)
192 : : {
193 : : PQExpBufferData sql;
194 : :
195 : : PGconn *conn;
196 : :
261 nathan@postgresql.or 197 :GNC 18 : conn = connectDatabase(cparams, progname, echo, false, true);
198 : :
7606 peter_e@gmx.net 199 :CBC 17 : initPQExpBuffer(&sql);
200 : :
3800 heikki.linnakangas@i 201 : 17 : appendPQExpBufferStr(&sql, "CLUSTER");
5620 peter_e@gmx.net 202 [ + + ]: 17 : if (verbose)
3800 heikki.linnakangas@i 203 : 8 : appendPQExpBufferStr(&sql, " VERBOSE");
7606 peter_e@gmx.net 204 [ + + ]: 17 : if (table)
205 : : {
2239 noah@leadboat.com 206 : 4 : appendPQExpBufferChar(&sql, ' ');
1731 michael@paquier.xyz 207 : 4 : appendQualifiedRelation(&sql, table, conn, echo);
208 : : }
3209 heikki.linnakangas@i 209 : 16 : appendPQExpBufferChar(&sql, ';');
210 : :
6215 magnus@hagander.net 211 [ - + ]: 16 : if (!executeMaintenanceCommand(conn, sql.data, echo))
212 : : {
7606 peter_e@gmx.net 213 [ # # ]:UBC 0 : if (table)
1840 peter@eisentraut.org 214 : 0 : pg_log_error("clustering of table \"%s\" in database \"%s\" failed: %s",
215 : : table, PQdb(conn), PQerrorMessage(conn));
216 : : else
217 : 0 : pg_log_error("clustering of database \"%s\" failed: %s",
218 : : PQdb(conn), PQerrorMessage(conn));
7606 peter_e@gmx.net 219 : 0 : PQfinish(conn);
220 : 0 : exit(1);
221 : : }
7606 peter_e@gmx.net 222 :CBC 16 : PQfinish(conn);
223 : 16 : termPQExpBuffer(&sql);
224 : 16 : }
225 : :
226 : :
227 : : static void
34 nathan@postgresql.or 228 :GNC 4 : cluster_all_databases(ConnParams *cparams, SimpleStringList *tables,
229 : : const char *progname, bool verbose, bool echo,
230 : : bool quiet)
231 : : {
232 : : PGconn *conn;
233 : : PGresult *result;
234 : : int i;
235 : :
1273 tgl@sss.pgh.pa.us 236 :CBC 4 : conn = connectMaintenanceDatabase(cparams, progname, echo);
276 andres@anarazel.de 237 : 4 : result = executeQuery(conn,
238 : : "SELECT datname FROM pg_database WHERE datallowconn AND datconnlimit <> -2 ORDER BY 1;",
239 : : echo);
7606 peter_e@gmx.net 240 : 4 : PQfinish(conn);
241 : :
242 [ + + ]: 17 : for (i = 0; i < PQntuples(result); i++)
243 : : {
244 : 13 : char *dbname = PQgetvalue(result, i, 0);
245 : :
246 [ + - ]: 13 : if (!quiet)
247 : : {
6159 248 : 13 : printf(_("%s: clustering database \"%s\"\n"), progname, dbname);
249 : 13 : fflush(stdout);
250 : : }
251 : :
1273 tgl@sss.pgh.pa.us 252 : 13 : cparams->override_dbname = dbname;
253 : :
34 nathan@postgresql.or 254 [ + + ]:GNC 13 : if (tables->head != NULL)
255 : : {
256 : : SimpleStringListCell *cell;
257 : :
258 [ + + ]: 4 : for (cell = tables->head; cell; cell = cell->next)
259 : 2 : cluster_one_database(cparams, cell->val,
260 : : progname, verbose, echo);
261 : : }
262 : : else
263 : 11 : cluster_one_database(cparams, NULL,
264 : : progname, verbose, echo);
265 : : }
266 : :
7606 peter_e@gmx.net 267 :CBC 4 : PQclear(result);
268 : 4 : }
269 : :
270 : :
271 : : static void
272 : 1 : help(const char *progname)
273 : : {
7571 274 : 1 : printf(_("%s clusters all previously clustered tables in a database.\n\n"), progname);
7606 275 : 1 : printf(_("Usage:\n"));
276 : 1 : printf(_(" %s [OPTION]... [DBNAME]\n"), progname);
277 : 1 : printf(_("\nOptions:\n"));
278 : 1 : printf(_(" -a, --all cluster all databases\n"));
279 : 1 : printf(_(" -d, --dbname=DBNAME database to cluster\n"));
280 : 1 : printf(_(" -e, --echo show the commands being sent to the server\n"));
281 : 1 : printf(_(" -q, --quiet don't write any messages\n"));
4105 magnus@hagander.net 282 : 1 : printf(_(" -t, --table=TABLE cluster specific table(s) only\n"));
5620 peter_e@gmx.net 283 : 1 : printf(_(" -v, --verbose write a lot of output\n"));
4318 284 : 1 : printf(_(" -V, --version output version information, then exit\n"));
285 : 1 : printf(_(" -?, --help show this help, then exit\n"));
7606 286 : 1 : printf(_("\nConnection options:\n"));
287 : 1 : printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
288 : 1 : printf(_(" -p, --port=PORT database server port\n"));
289 : 1 : printf(_(" -U, --username=USERNAME user name to connect as\n"));
5526 290 : 1 : printf(_(" -w, --no-password never prompt for password\n"));
5969 tgl@sss.pgh.pa.us 291 : 1 : printf(_(" -W, --password force password prompt\n"));
4513 rhaas@postgresql.org 292 : 1 : printf(_(" --maintenance-db=DBNAME alternate maintenance database\n"));
7606 peter_e@gmx.net 293 : 1 : printf(_("\nRead the description of the SQL command CLUSTER for details.\n"));
1507 peter@eisentraut.org 294 : 1 : printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
295 : 1 : printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
7606 peter_e@gmx.net 296 : 1 : }
|
