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