PostgreSQL Source Code  git master
vacuumdb.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * vacuumdb
4  *
5  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
6  * Portions Copyright (c) 1994, Regents of the University of California
7  *
8  * src/bin/scripts/vacuumdb.c
9  *
10  *-------------------------------------------------------------------------
11  */
12 
13 #include "postgres_fe.h"
14 
15 #include <limits.h>
16 
17 #include "catalog/pg_class_d.h"
18 #include "common.h"
19 #include "common/connect.h"
20 #include "common/logging.h"
21 #include "fe_utils/cancel.h"
22 #include "fe_utils/option_utils.h"
23 #include "fe_utils/parallel_slot.h"
24 #include "fe_utils/query_utils.h"
25 #include "fe_utils/simple_list.h"
26 #include "fe_utils/string_utils.h"
27 
28 
29 /* vacuum options controlled by user flags */
30 typedef struct vacuumingOptions
31 {
33  bool verbose;
35  bool full;
36  bool freeze;
41  int parallel_workers; /* >= 0 indicates user specified the
42  * parallel degree, otherwise -1 */
51 
52 /* object filter options */
53 typedef enum
54 {
55  OBJFILTER_NONE = 0, /* no filter used */
56  OBJFILTER_ALL_DBS = (1 << 0), /* -a | --all */
57  OBJFILTER_DATABASE = (1 << 1), /* -d | --dbname */
58  OBJFILTER_TABLE = (1 << 2), /* -t | --table */
59  OBJFILTER_SCHEMA = (1 << 3), /* -n | --schema */
60  OBJFILTER_SCHEMA_EXCLUDE = (1 << 4), /* -N | --exclude-schema */
61 } VacObjFilter;
62 
64 
65 static void vacuum_one_database(ConnParams *cparams,
66  vacuumingOptions *vacopts,
67  int stage,
68  SimpleStringList *objects,
69  int concurrentCons,
70  const char *progname, bool echo, bool quiet);
71 
72 static void vacuum_all_databases(ConnParams *cparams,
73  vacuumingOptions *vacopts,
74  bool analyze_in_stages,
75  SimpleStringList *objects,
76  int concurrentCons,
77  const char *progname, bool echo, bool quiet);
78 
79 static void prepare_vacuum_command(PQExpBuffer sql, int serverVersion,
80  vacuumingOptions *vacopts, const char *table);
81 
82 static void run_vacuum_command(PGconn *conn, const char *sql, bool echo,
83  const char *table);
84 
85 static void help(const char *progname);
86 
87 void check_objfilter(void);
88 
89 static char *escape_quotes(const char *src);
90 
91 /* For analyze-in-stages mode */
92 #define ANALYZE_NO_STAGE -1
93 #define ANALYZE_NUM_STAGES 3
94 
95 
96 int
97 main(int argc, char *argv[])
98 {
99  static struct option long_options[] = {
100  {"host", required_argument, NULL, 'h'},
101  {"port", required_argument, NULL, 'p'},
102  {"username", required_argument, NULL, 'U'},
103  {"no-password", no_argument, NULL, 'w'},
104  {"password", no_argument, NULL, 'W'},
105  {"echo", no_argument, NULL, 'e'},
106  {"quiet", no_argument, NULL, 'q'},
107  {"dbname", required_argument, NULL, 'd'},
108  {"analyze", no_argument, NULL, 'z'},
109  {"analyze-only", no_argument, NULL, 'Z'},
110  {"freeze", no_argument, NULL, 'F'},
111  {"all", no_argument, NULL, 'a'},
112  {"table", required_argument, NULL, 't'},
113  {"full", no_argument, NULL, 'f'},
114  {"verbose", no_argument, NULL, 'v'},
115  {"jobs", required_argument, NULL, 'j'},
116  {"parallel", required_argument, NULL, 'P'},
117  {"schema", required_argument, NULL, 'n'},
118  {"exclude-schema", required_argument, NULL, 'N'},
119  {"maintenance-db", required_argument, NULL, 2},
120  {"analyze-in-stages", no_argument, NULL, 3},
121  {"disable-page-skipping", no_argument, NULL, 4},
122  {"skip-locked", no_argument, NULL, 5},
123  {"min-xid-age", required_argument, NULL, 6},
124  {"min-mxid-age", required_argument, NULL, 7},
125  {"no-index-cleanup", no_argument, NULL, 8},
126  {"force-index-cleanup", no_argument, NULL, 9},
127  {"no-truncate", no_argument, NULL, 10},
128  {"no-process-toast", no_argument, NULL, 11},
129  {"no-process-main", no_argument, NULL, 12},
130  {"buffer-usage-limit", required_argument, NULL, 13},
131  {NULL, 0, NULL, 0}
132  };
133 
134  const char *progname;
135  int optindex;
136  int c;
137  const char *dbname = NULL;
138  const char *maintenance_db = NULL;
139  char *host = NULL;
140  char *port = NULL;
141  char *username = NULL;
142  enum trivalue prompt_password = TRI_DEFAULT;
143  ConnParams cparams;
144  bool echo = false;
145  bool quiet = false;
146  vacuumingOptions vacopts;
147  bool analyze_in_stages = false;
148  SimpleStringList objects = {NULL, NULL};
149  int concurrentCons = 1;
150  int tbl_count = 0;
151 
152  /* initialize options */
153  memset(&vacopts, 0, sizeof(vacopts));
154  vacopts.parallel_workers = -1;
155  vacopts.buffer_usage_limit = NULL;
156  vacopts.no_index_cleanup = false;
157  vacopts.force_index_cleanup = false;
158  vacopts.do_truncate = true;
159  vacopts.process_main = true;
160  vacopts.process_toast = true;
161 
162  pg_logging_init(argv[0]);
163  progname = get_progname(argv[0]);
164  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pgscripts"));
165 
166  handle_help_version_opts(argc, argv, "vacuumdb", help);
167 
168  while ((c = getopt_long(argc, argv, "ad:efFh:j:n:N:p:P:qt:U:vwWzZ", long_options, &optindex)) != -1)
169  {
170  switch (c)
171  {
172  case 'a':
174  break;
175  case 'd':
178  break;
179  case 'e':
180  echo = true;
181  break;
182  case 'f':
183  vacopts.full = true;
184  break;
185  case 'F':
186  vacopts.freeze = true;
187  break;
188  case 'h':
189  host = pg_strdup(optarg);
190  break;
191  case 'j':
192  if (!option_parse_int(optarg, "-j/--jobs", 1, INT_MAX,
193  &concurrentCons))
194  exit(1);
195  break;
196  case 'n':
199  break;
200  case 'N':
203  break;
204  case 'p':
205  port = pg_strdup(optarg);
206  break;
207  case 'P':
208  if (!option_parse_int(optarg, "-P/--parallel", 0, INT_MAX,
209  &vacopts.parallel_workers))
210  exit(1);
211  break;
212  case 'q':
213  quiet = true;
214  break;
215  case 't':
218  tbl_count++;
219  break;
220  case 'U':
222  break;
223  case 'v':
224  vacopts.verbose = true;
225  break;
226  case 'w':
227  prompt_password = TRI_NO;
228  break;
229  case 'W':
230  prompt_password = TRI_YES;
231  break;
232  case 'z':
233  vacopts.and_analyze = true;
234  break;
235  case 'Z':
236  vacopts.analyze_only = true;
237  break;
238  case 2:
239  maintenance_db = pg_strdup(optarg);
240  break;
241  case 3:
242  analyze_in_stages = vacopts.analyze_only = true;
243  break;
244  case 4:
245  vacopts.disable_page_skipping = true;
246  break;
247  case 5:
248  vacopts.skip_locked = true;
249  break;
250  case 6:
251  if (!option_parse_int(optarg, "--min-xid-age", 1, INT_MAX,
252  &vacopts.min_xid_age))
253  exit(1);
254  break;
255  case 7:
256  if (!option_parse_int(optarg, "--min-mxid-age", 1, INT_MAX,
257  &vacopts.min_mxid_age))
258  exit(1);
259  break;
260  case 8:
261  vacopts.no_index_cleanup = true;
262  break;
263  case 9:
264  vacopts.force_index_cleanup = true;
265  break;
266  case 10:
267  vacopts.do_truncate = false;
268  break;
269  case 11:
270  vacopts.process_toast = false;
271  break;
272  case 12:
273  vacopts.process_main = false;
274  break;
275  case 13:
277  break;
278  default:
279  /* getopt_long already emitted a complaint */
280  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
281  exit(1);
282  }
283  }
284 
285  /*
286  * Non-option argument specifies database name as long as it wasn't
287  * already specified with -d / --dbname
288  */
289  if (optind < argc && dbname == NULL)
290  {
292  dbname = argv[optind];
293  optind++;
294  }
295 
296  if (optind < argc)
297  {
298  pg_log_error("too many command-line arguments (first is \"%s\")",
299  argv[optind]);
300  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
301  exit(1);
302  }
303 
304  /*
305  * Validate the combination of filters specified in the command-line
306  * options.
307  */
308  check_objfilter();
309 
310  if (vacopts.analyze_only)
311  {
312  if (vacopts.full)
313  pg_fatal("cannot use the \"%s\" option when performing only analyze",
314  "full");
315  if (vacopts.freeze)
316  pg_fatal("cannot use the \"%s\" option when performing only analyze",
317  "freeze");
318  if (vacopts.disable_page_skipping)
319  pg_fatal("cannot use the \"%s\" option when performing only analyze",
320  "disable-page-skipping");
321  if (vacopts.no_index_cleanup)
322  pg_fatal("cannot use the \"%s\" option when performing only analyze",
323  "no-index-cleanup");
324  if (vacopts.force_index_cleanup)
325  pg_fatal("cannot use the \"%s\" option when performing only analyze",
326  "force-index-cleanup");
327  if (!vacopts.do_truncate)
328  pg_fatal("cannot use the \"%s\" option when performing only analyze",
329  "no-truncate");
330  if (!vacopts.process_main)
331  pg_fatal("cannot use the \"%s\" option when performing only analyze",
332  "no-process-main");
333  if (!vacopts.process_toast)
334  pg_fatal("cannot use the \"%s\" option when performing only analyze",
335  "no-process-toast");
336  /* allow 'and_analyze' with 'analyze_only' */
337  }
338 
339  /* Prohibit full and analyze_only options with parallel option */
340  if (vacopts.parallel_workers >= 0)
341  {
342  if (vacopts.analyze_only)
343  pg_fatal("cannot use the \"%s\" option when performing only analyze",
344  "parallel");
345  if (vacopts.full)
346  pg_fatal("cannot use the \"%s\" option when performing full vacuum",
347  "parallel");
348  }
349 
350  /* Prohibit --no-index-cleanup and --force-index-cleanup together */
351  if (vacopts.no_index_cleanup && vacopts.force_index_cleanup)
352  pg_fatal("cannot use the \"%s\" option with the \"%s\" option",
353  "no-index-cleanup", "force-index-cleanup");
354 
355  /*
356  * buffer-usage-limit is not allowed with VACUUM FULL unless ANALYZE is
357  * included too.
358  */
359  if (vacopts.buffer_usage_limit && vacopts.full && !vacopts.and_analyze)
360  pg_fatal("cannot use the \"%s\" option with the \"%s\" option",
361  "buffer-usage-limit", "full");
362 
363  /* fill cparams except for dbname, which is set below */
364  cparams.pghost = host;
365  cparams.pgport = port;
366  cparams.pguser = username;
367  cparams.prompt_password = prompt_password;
368  cparams.override_dbname = NULL;
369 
370  setup_cancel_handler(NULL);
371 
372  /* Avoid opening extra connections. */
373  if (tbl_count && (concurrentCons > tbl_count))
374  concurrentCons = tbl_count;
375 
377  {
378  cparams.dbname = maintenance_db;
379 
380  vacuum_all_databases(&cparams, &vacopts,
381  analyze_in_stages,
382  &objects,
383  concurrentCons,
384  progname, echo, quiet);
385  }
386  else
387  {
388  if (dbname == NULL)
389  {
390  if (getenv("PGDATABASE"))
391  dbname = getenv("PGDATABASE");
392  else if (getenv("PGUSER"))
393  dbname = getenv("PGUSER");
394  else
396  }
397 
398  cparams.dbname = dbname;
399 
400  if (analyze_in_stages)
401  {
402  int stage;
403 
404  for (stage = 0; stage < ANALYZE_NUM_STAGES; stage++)
405  {
406  vacuum_one_database(&cparams, &vacopts,
407  stage,
408  &objects,
409  concurrentCons,
410  progname, echo, quiet);
411  }
412  }
413  else
414  vacuum_one_database(&cparams, &vacopts,
416  &objects,
417  concurrentCons,
418  progname, echo, quiet);
419  }
420 
421  exit(0);
422 }
423 
424 /*
425  * Verify that the filters used at command line are compatible.
426  */
427 void
429 {
430  if ((objfilter & OBJFILTER_ALL_DBS) &&
432  pg_fatal("cannot vacuum all databases and a specific one at the same time");
433 
434  if ((objfilter & OBJFILTER_TABLE) &&
436  pg_fatal("cannot vacuum all tables in schema(s) and specific table(s) at the same time");
437 
438  if ((objfilter & OBJFILTER_TABLE) &&
440  pg_fatal("cannot vacuum specific table(s) and exclude schema(s) at the same time");
441 
442  if ((objfilter & OBJFILTER_SCHEMA) &&
444  pg_fatal("cannot vacuum all tables in schema(s) and exclude schema(s) at the same time");
445 }
446 
447 /*
448  * Returns a newly malloc'd version of 'src' with escaped single quotes and
449  * backslashes.
450  */
451 static char *
452 escape_quotes(const char *src)
453 {
454  char *result = escape_single_quotes_ascii(src);
455 
456  if (!result)
457  pg_fatal("out of memory");
458  return result;
459 }
460 
461 /*
462  * vacuum_one_database
463  *
464  * Process tables in the given database. If the 'tables' list is empty,
465  * process all tables in the database.
466  *
467  * Note that this function is only concerned with running exactly one stage
468  * when in analyze-in-stages mode; caller must iterate on us if necessary.
469  *
470  * If concurrentCons is > 1, multiple connections are used to vacuum tables
471  * in parallel. In this case and if the table list is empty, we first obtain
472  * a list of tables from the database.
473  */
474 static void
476  vacuumingOptions *vacopts,
477  int stage,
478  SimpleStringList *objects,
479  int concurrentCons,
480  const char *progname, bool echo, bool quiet)
481 {
482  PQExpBufferData sql;
484  PQExpBufferData catalog_query;
485  PGresult *res;
486  PGconn *conn;
487  SimpleStringListCell *cell;
489  SimpleStringList dbtables = {NULL, NULL};
490  int i;
491  int ntups;
492  bool failed = false;
493  bool objects_listed = false;
494  bool has_where = false;
495  const char *initcmd;
496  const char *stage_commands[] = {
497  "SET default_statistics_target=1; SET vacuum_cost_delay=0;",
498  "SET default_statistics_target=10; RESET vacuum_cost_delay;",
499  "RESET default_statistics_target;"
500  };
501  const char *stage_messages[] = {
502  gettext_noop("Generating minimal optimizer statistics (1 target)"),
503  gettext_noop("Generating medium optimizer statistics (10 targets)"),
504  gettext_noop("Generating default (full) optimizer statistics")
505  };
506 
507  Assert(stage == ANALYZE_NO_STAGE ||
508  (stage >= 0 && stage < ANALYZE_NUM_STAGES));
509 
510  conn = connectDatabase(cparams, progname, echo, false, true);
511 
512  if (vacopts->disable_page_skipping && PQserverVersion(conn) < 90600)
513  {
514  PQfinish(conn);
515  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
516  "disable-page-skipping", "9.6");
517  }
518 
519  if (vacopts->no_index_cleanup && PQserverVersion(conn) < 120000)
520  {
521  PQfinish(conn);
522  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
523  "no-index-cleanup", "12");
524  }
525 
526  if (vacopts->force_index_cleanup && PQserverVersion(conn) < 120000)
527  {
528  PQfinish(conn);
529  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
530  "force-index-cleanup", "12");
531  }
532 
533  if (!vacopts->do_truncate && PQserverVersion(conn) < 120000)
534  {
535  PQfinish(conn);
536  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
537  "no-truncate", "12");
538  }
539 
540  if (!vacopts->process_main && PQserverVersion(conn) < 160000)
541  {
542  PQfinish(conn);
543  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
544  "no-process-main", "16");
545  }
546 
547  if (!vacopts->process_toast && PQserverVersion(conn) < 140000)
548  {
549  PQfinish(conn);
550  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
551  "no-process-toast", "14");
552  }
553 
554  if (vacopts->skip_locked && PQserverVersion(conn) < 120000)
555  {
556  PQfinish(conn);
557  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
558  "skip-locked", "12");
559  }
560 
561  if (vacopts->min_xid_age != 0 && PQserverVersion(conn) < 90600)
562  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
563  "--min-xid-age", "9.6");
564 
565  if (vacopts->min_mxid_age != 0 && PQserverVersion(conn) < 90600)
566  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
567  "--min-mxid-age", "9.6");
568 
569  if (vacopts->parallel_workers >= 0 && PQserverVersion(conn) < 130000)
570  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
571  "--parallel", "13");
572 
573  if (vacopts->buffer_usage_limit && PQserverVersion(conn) < 160000)
574  pg_fatal("cannot use the \"%s\" option on server versions older than PostgreSQL %s",
575  "--buffer-usage-limit", "16");
576 
577  /* skip_database_stats is used automatically if server supports it */
578  vacopts->skip_database_stats = (PQserverVersion(conn) >= 160000);
579 
580  if (!quiet)
581  {
582  if (stage != ANALYZE_NO_STAGE)
583  printf(_("%s: processing database \"%s\": %s\n"),
584  progname, PQdb(conn), _(stage_messages[stage]));
585  else
586  printf(_("%s: vacuuming database \"%s\"\n"),
587  progname, PQdb(conn));
588  fflush(stdout);
589  }
590 
591  /*
592  * Prepare the list of tables to process by querying the catalogs.
593  *
594  * Since we execute the constructed query with the default search_path
595  * (which could be unsafe), everything in this query MUST be fully
596  * qualified.
597  *
598  * First, build a WITH clause for the catalog query if any tables were
599  * specified, with a set of values made of relation names and their
600  * optional set of columns. This is used to match any provided column
601  * lists with the generated qualified identifiers and to filter for the
602  * tables provided via --table. If a listed table does not exist, the
603  * catalog query will fail.
604  */
605  initPQExpBuffer(&catalog_query);
606  for (cell = objects ? objects->head : NULL; cell; cell = cell->next)
607  {
608  char *just_table = NULL;
609  const char *just_columns = NULL;
610 
611  if (!objects_listed)
612  {
613  appendPQExpBufferStr(&catalog_query,
614  "WITH listed_objects (object_oid, column_list) "
615  "AS (\n VALUES (");
616  objects_listed = true;
617  }
618  else
619  appendPQExpBufferStr(&catalog_query, ",\n (");
620 
622  {
623  appendStringLiteralConn(&catalog_query, cell->val, conn);
624  appendPQExpBufferStr(&catalog_query, "::pg_catalog.regnamespace, ");
625  }
626 
628  {
629  /*
630  * Split relation and column names given by the user, this is used
631  * to feed the CTE with values on which are performed pre-run
632  * validity checks as well. For now these happen only on the
633  * relation name.
634  */
636  &just_table, &just_columns);
637 
638  appendStringLiteralConn(&catalog_query, just_table, conn);
639  appendPQExpBufferStr(&catalog_query, "::pg_catalog.regclass, ");
640  }
641 
642  if (just_columns && just_columns[0] != '\0')
643  appendStringLiteralConn(&catalog_query, just_columns, conn);
644  else
645  appendPQExpBufferStr(&catalog_query, "NULL");
646 
647  appendPQExpBufferStr(&catalog_query, "::pg_catalog.text)");
648 
649  pg_free(just_table);
650  }
651 
652  /* Finish formatting the CTE */
653  if (objects_listed)
654  appendPQExpBufferStr(&catalog_query, "\n)\n");
655 
656  appendPQExpBufferStr(&catalog_query, "SELECT c.relname, ns.nspname");
657 
658  if (objects_listed)
659  appendPQExpBufferStr(&catalog_query, ", listed_objects.column_list");
660 
661  appendPQExpBufferStr(&catalog_query,
662  " FROM pg_catalog.pg_class c\n"
663  " JOIN pg_catalog.pg_namespace ns"
664  " ON c.relnamespace OPERATOR(pg_catalog.=) ns.oid\n"
665  " LEFT JOIN pg_catalog.pg_class t"
666  " ON c.reltoastrelid OPERATOR(pg_catalog.=) t.oid\n");
667 
668  /* Used to match the tables or schemas listed by the user */
669  if (objects_listed)
670  {
671  appendPQExpBufferStr(&catalog_query, " LEFT JOIN listed_objects"
672  " ON listed_objects.object_oid"
673  " OPERATOR(pg_catalog.=) ");
674 
676  appendPQExpBufferStr(&catalog_query, "c.oid\n");
677  else
678  appendPQExpBufferStr(&catalog_query, "ns.oid\n");
679 
681  appendPQExpBuffer(&catalog_query,
682  " WHERE listed_objects.object_oid IS NULL\n");
683  else
684  appendPQExpBuffer(&catalog_query,
685  " WHERE listed_objects.object_oid IS NOT NULL\n");
686  has_where = true;
687  }
688 
689  /*
690  * If no tables were listed, filter for the relevant relation types. If
691  * tables were given via --table, don't bother filtering by relation type.
692  * Instead, let the server decide whether a given relation can be
693  * processed in which case the user will know about it.
694  */
695  if ((objfilter & OBJFILTER_TABLE) == 0)
696  {
697  appendPQExpBuffer(&catalog_query,
698  " %s c.relkind OPERATOR(pg_catalog.=) ANY (array["
699  CppAsString2(RELKIND_RELATION) ", "
700  CppAsString2(RELKIND_MATVIEW) "])\n",
701  has_where ? "AND" : "WHERE");
702  has_where = true;
703  }
704 
705  /*
706  * For --min-xid-age and --min-mxid-age, the age of the relation is the
707  * greatest of the ages of the main relation and its associated TOAST
708  * table. The commands generated by vacuumdb will also process the TOAST
709  * table for the relation if necessary, so it does not need to be
710  * considered separately.
711  */
712  if (vacopts->min_xid_age != 0)
713  {
714  appendPQExpBuffer(&catalog_query,
715  " %s GREATEST(pg_catalog.age(c.relfrozenxid),"
716  " pg_catalog.age(t.relfrozenxid)) "
717  " OPERATOR(pg_catalog.>=) '%d'::pg_catalog.int4\n"
718  " AND c.relfrozenxid OPERATOR(pg_catalog.!=)"
719  " '0'::pg_catalog.xid\n",
720  has_where ? "AND" : "WHERE", vacopts->min_xid_age);
721  has_where = true;
722  }
723 
724  if (vacopts->min_mxid_age != 0)
725  {
726  appendPQExpBuffer(&catalog_query,
727  " %s GREATEST(pg_catalog.mxid_age(c.relminmxid),"
728  " pg_catalog.mxid_age(t.relminmxid)) OPERATOR(pg_catalog.>=)"
729  " '%d'::pg_catalog.int4\n"
730  " AND c.relminmxid OPERATOR(pg_catalog.!=)"
731  " '0'::pg_catalog.xid\n",
732  has_where ? "AND" : "WHERE", vacopts->min_mxid_age);
733  has_where = true;
734  }
735 
736  /*
737  * Execute the catalog query. We use the default search_path for this
738  * query for consistency with table lookups done elsewhere by the user.
739  */
740  appendPQExpBufferStr(&catalog_query, " ORDER BY c.relpages DESC;");
741  executeCommand(conn, "RESET search_path;", echo);
742  res = executeQuery(conn, catalog_query.data, echo);
743  termPQExpBuffer(&catalog_query);
745 
746  /*
747  * If no rows are returned, there are no matching tables, so we are done.
748  */
749  ntups = PQntuples(res);
750  if (ntups == 0)
751  {
752  PQclear(res);
753  PQfinish(conn);
754  return;
755  }
756 
757  /*
758  * Build qualified identifiers for each table, including the column list
759  * if given.
760  */
762  for (i = 0; i < ntups; i++)
763  {
766  PQgetvalue(res, i, 0)));
767 
768  if (objects_listed && !PQgetisnull(res, i, 2))
770 
771  simple_string_list_append(&dbtables, buf.data);
773  }
775  PQclear(res);
776 
777  /*
778  * Ensure concurrentCons is sane. If there are more connections than
779  * vacuumable relations, we don't need to use them all.
780  */
781  if (concurrentCons > ntups)
782  concurrentCons = ntups;
783  if (concurrentCons <= 0)
784  concurrentCons = 1;
785 
786  /*
787  * All slots need to be prepared to run the appropriate analyze stage, if
788  * caller requested that mode. We have to prepare the initial connection
789  * ourselves before setting up the slots.
790  */
791  if (stage == ANALYZE_NO_STAGE)
792  initcmd = NULL;
793  else
794  {
795  initcmd = stage_commands[stage];
796  executeCommand(conn, initcmd, echo);
797  }
798 
799  /*
800  * Setup the database connections. We reuse the connection we already have
801  * for the first slot. If not in parallel mode, the first slot in the
802  * array contains the connection.
803  */
804  sa = ParallelSlotsSetup(concurrentCons, cparams, progname, echo, initcmd);
806 
807  initPQExpBuffer(&sql);
808 
809  cell = dbtables.head;
810  do
811  {
812  const char *tabname = cell->val;
813  ParallelSlot *free_slot;
814 
815  if (CancelRequested)
816  {
817  failed = true;
818  goto finish;
819  }
820 
821  free_slot = ParallelSlotsGetIdle(sa, NULL);
822  if (!free_slot)
823  {
824  failed = true;
825  goto finish;
826  }
827 
829  vacopts, tabname);
830 
831  /*
832  * Execute the vacuum. All errors are handled in processQueryResult
833  * through ParallelSlotsGetIdle.
834  */
836  run_vacuum_command(free_slot->connection, sql.data,
837  echo, tabname);
838 
839  cell = cell->next;
840  } while (cell != NULL);
841 
843  {
844  failed = true;
845  goto finish;
846  }
847 
848  /* If we used SKIP_DATABASE_STATS, mop up with ONLY_DATABASE_STATS */
849  if (vacopts->skip_database_stats && stage == ANALYZE_NO_STAGE)
850  {
851  const char *cmd = "VACUUM (ONLY_DATABASE_STATS);";
852  ParallelSlot *free_slot = ParallelSlotsGetIdle(sa, NULL);
853 
854  if (!free_slot)
855  {
856  failed = true;
857  goto finish;
858  }
859 
861  run_vacuum_command(free_slot->connection, cmd, echo, NULL);
862 
864  failed = true;
865  }
866 
867 finish:
869  pg_free(sa);
870 
871  termPQExpBuffer(&sql);
872 
873  if (failed)
874  exit(1);
875 }
876 
877 /*
878  * Vacuum/analyze all connectable databases.
879  *
880  * In analyze-in-stages mode, we process all databases in one stage before
881  * moving on to the next stage. That ensure minimal stats are available
882  * quickly everywhere before generating more detailed ones.
883  */
884 static void
886  vacuumingOptions *vacopts,
887  bool analyze_in_stages,
888  SimpleStringList *objects,
889  int concurrentCons,
890  const char *progname, bool echo, bool quiet)
891 {
892  PGconn *conn;
893  PGresult *result;
894  int stage;
895  int i;
896 
897  conn = connectMaintenanceDatabase(cparams, progname, echo);
898  result = executeQuery(conn,
899  "SELECT datname FROM pg_database WHERE datallowconn AND datconnlimit <> -2 ORDER BY 1;",
900  echo);
901  PQfinish(conn);
902 
903  if (analyze_in_stages)
904  {
905  /*
906  * When analyzing all databases in stages, we analyze them all in the
907  * fastest stage first, so that initial statistics become available
908  * for all of them as soon as possible.
909  *
910  * This means we establish several times as many connections, but
911  * that's a secondary consideration.
912  */
913  for (stage = 0; stage < ANALYZE_NUM_STAGES; stage++)
914  {
915  for (i = 0; i < PQntuples(result); i++)
916  {
917  cparams->override_dbname = PQgetvalue(result, i, 0);
918 
919  vacuum_one_database(cparams, vacopts,
920  stage,
921  objects,
922  concurrentCons,
923  progname, echo, quiet);
924  }
925  }
926  }
927  else
928  {
929  for (i = 0; i < PQntuples(result); i++)
930  {
931  cparams->override_dbname = PQgetvalue(result, i, 0);
932 
933  vacuum_one_database(cparams, vacopts,
935  objects,
936  concurrentCons,
937  progname, echo, quiet);
938  }
939  }
940 
941  PQclear(result);
942 }
943 
944 /*
945  * Construct a vacuum/analyze command to run based on the given options, in the
946  * given string buffer, which may contain previous garbage.
947  *
948  * The table name used must be already properly quoted. The command generated
949  * depends on the server version involved and it is semicolon-terminated.
950  */
951 static void
952 prepare_vacuum_command(PQExpBuffer sql, int serverVersion,
953  vacuumingOptions *vacopts, const char *table)
954 {
955  const char *paren = " (";
956  const char *comma = ", ";
957  const char *sep = paren;
958 
959  resetPQExpBuffer(sql);
960 
961  if (vacopts->analyze_only)
962  {
963  appendPQExpBufferStr(sql, "ANALYZE");
964 
965  /* parenthesized grammar of ANALYZE is supported since v11 */
966  if (serverVersion >= 110000)
967  {
968  if (vacopts->skip_locked)
969  {
970  /* SKIP_LOCKED is supported since v12 */
971  Assert(serverVersion >= 120000);
972  appendPQExpBuffer(sql, "%sSKIP_LOCKED", sep);
973  sep = comma;
974  }
975  if (vacopts->verbose)
976  {
977  appendPQExpBuffer(sql, "%sVERBOSE", sep);
978  sep = comma;
979  }
980  if (vacopts->buffer_usage_limit)
981  {
982  Assert(serverVersion >= 160000);
983  appendPQExpBuffer(sql, "%sBUFFER_USAGE_LIMIT '%s'", sep,
984  vacopts->buffer_usage_limit);
985  sep = comma;
986  }
987  if (sep != paren)
988  appendPQExpBufferChar(sql, ')');
989  }
990  else
991  {
992  if (vacopts->verbose)
993  appendPQExpBufferStr(sql, " VERBOSE");
994  }
995  }
996  else
997  {
998  appendPQExpBufferStr(sql, "VACUUM");
999 
1000  /* parenthesized grammar of VACUUM is supported since v9.0 */
1001  if (serverVersion >= 90000)
1002  {
1003  if (vacopts->disable_page_skipping)
1004  {
1005  /* DISABLE_PAGE_SKIPPING is supported since v9.6 */
1006  Assert(serverVersion >= 90600);
1007  appendPQExpBuffer(sql, "%sDISABLE_PAGE_SKIPPING", sep);
1008  sep = comma;
1009  }
1010  if (vacopts->no_index_cleanup)
1011  {
1012  /* "INDEX_CLEANUP FALSE" has been supported since v12 */
1013  Assert(serverVersion >= 120000);
1014  Assert(!vacopts->force_index_cleanup);
1015  appendPQExpBuffer(sql, "%sINDEX_CLEANUP FALSE", sep);
1016  sep = comma;
1017  }
1018  if (vacopts->force_index_cleanup)
1019  {
1020  /* "INDEX_CLEANUP TRUE" has been supported since v12 */
1021  Assert(serverVersion >= 120000);
1022  Assert(!vacopts->no_index_cleanup);
1023  appendPQExpBuffer(sql, "%sINDEX_CLEANUP TRUE", sep);
1024  sep = comma;
1025  }
1026  if (!vacopts->do_truncate)
1027  {
1028  /* TRUNCATE is supported since v12 */
1029  Assert(serverVersion >= 120000);
1030  appendPQExpBuffer(sql, "%sTRUNCATE FALSE", sep);
1031  sep = comma;
1032  }
1033  if (!vacopts->process_main)
1034  {
1035  /* PROCESS_MAIN is supported since v16 */
1036  Assert(serverVersion >= 160000);
1037  appendPQExpBuffer(sql, "%sPROCESS_MAIN FALSE", sep);
1038  sep = comma;
1039  }
1040  if (!vacopts->process_toast)
1041  {
1042  /* PROCESS_TOAST is supported since v14 */
1043  Assert(serverVersion >= 140000);
1044  appendPQExpBuffer(sql, "%sPROCESS_TOAST FALSE", sep);
1045  sep = comma;
1046  }
1047  if (vacopts->skip_database_stats)
1048  {
1049  /* SKIP_DATABASE_STATS is supported since v16 */
1050  Assert(serverVersion >= 160000);
1051  appendPQExpBuffer(sql, "%sSKIP_DATABASE_STATS", sep);
1052  sep = comma;
1053  }
1054  if (vacopts->skip_locked)
1055  {
1056  /* SKIP_LOCKED is supported since v12 */
1057  Assert(serverVersion >= 120000);
1058  appendPQExpBuffer(sql, "%sSKIP_LOCKED", sep);
1059  sep = comma;
1060  }
1061  if (vacopts->full)
1062  {
1063  appendPQExpBuffer(sql, "%sFULL", sep);
1064  sep = comma;
1065  }
1066  if (vacopts->freeze)
1067  {
1068  appendPQExpBuffer(sql, "%sFREEZE", sep);
1069  sep = comma;
1070  }
1071  if (vacopts->verbose)
1072  {
1073  appendPQExpBuffer(sql, "%sVERBOSE", sep);
1074  sep = comma;
1075  }
1076  if (vacopts->and_analyze)
1077  {
1078  appendPQExpBuffer(sql, "%sANALYZE", sep);
1079  sep = comma;
1080  }
1081  if (vacopts->parallel_workers >= 0)
1082  {
1083  /* PARALLEL is supported since v13 */
1084  Assert(serverVersion >= 130000);
1085  appendPQExpBuffer(sql, "%sPARALLEL %d", sep,
1086  vacopts->parallel_workers);
1087  sep = comma;
1088  }
1089  if (vacopts->buffer_usage_limit)
1090  {
1091  Assert(serverVersion >= 160000);
1092  appendPQExpBuffer(sql, "%sBUFFER_USAGE_LIMIT '%s'", sep,
1093  vacopts->buffer_usage_limit);
1094  sep = comma;
1095  }
1096  if (sep != paren)
1097  appendPQExpBufferChar(sql, ')');
1098  }
1099  else
1100  {
1101  if (vacopts->full)
1102  appendPQExpBufferStr(sql, " FULL");
1103  if (vacopts->freeze)
1104  appendPQExpBufferStr(sql, " FREEZE");
1105  if (vacopts->verbose)
1106  appendPQExpBufferStr(sql, " VERBOSE");
1107  if (vacopts->and_analyze)
1108  appendPQExpBufferStr(sql, " ANALYZE");
1109  }
1110  }
1111 
1112  appendPQExpBuffer(sql, " %s;", table);
1113 }
1114 
1115 /*
1116  * Send a vacuum/analyze command to the server, returning after sending the
1117  * command.
1118  *
1119  * Any errors during command execution are reported to stderr.
1120  */
1121 static void
1122 run_vacuum_command(PGconn *conn, const char *sql, bool echo,
1123  const char *table)
1124 {
1125  bool status;
1126 
1127  if (echo)
1128  printf("%s\n", sql);
1129 
1130  status = PQsendQuery(conn, sql) == 1;
1131 
1132  if (!status)
1133  {
1134  if (table)
1135  pg_log_error("vacuuming of table \"%s\" in database \"%s\" failed: %s",
1136  table, PQdb(conn), PQerrorMessage(conn));
1137  else
1138  pg_log_error("vacuuming of database \"%s\" failed: %s",
1140  }
1141 }
1142 
1143 static void
1144 help(const char *progname)
1145 {
1146  printf(_("%s cleans and analyzes a PostgreSQL database.\n\n"), progname);
1147  printf(_("Usage:\n"));
1148  printf(_(" %s [OPTION]... [DBNAME]\n"), progname);
1149  printf(_("\nOptions:\n"));
1150  printf(_(" -a, --all vacuum all databases\n"));
1151  printf(_(" --buffer-usage-limit=SIZE size of ring buffer used for vacuum\n"));
1152  printf(_(" -d, --dbname=DBNAME database to vacuum\n"));
1153  printf(_(" --disable-page-skipping disable all page-skipping behavior\n"));
1154  printf(_(" -e, --echo show the commands being sent to the server\n"));
1155  printf(_(" -f, --full do full vacuuming\n"));
1156  printf(_(" -F, --freeze freeze row transaction information\n"));
1157  printf(_(" --force-index-cleanup always remove index entries that point to dead tuples\n"));
1158  printf(_(" -j, --jobs=NUM use this many concurrent connections to vacuum\n"));
1159  printf(_(" --min-mxid-age=MXID_AGE minimum multixact ID age of tables to vacuum\n"));
1160  printf(_(" --min-xid-age=XID_AGE minimum transaction ID age of tables to vacuum\n"));
1161  printf(_(" --no-index-cleanup don't remove index entries that point to dead tuples\n"));
1162  printf(_(" --no-process-main skip the main relation\n"));
1163  printf(_(" --no-process-toast skip the TOAST table associated with the table to vacuum\n"));
1164  printf(_(" --no-truncate don't truncate empty pages at the end of the table\n"));
1165  printf(_(" -n, --schema=SCHEMA vacuum tables in the specified schema(s) only\n"));
1166  printf(_(" -N, --exclude-schema=SCHEMA do not vacuum tables in the specified schema(s)\n"));
1167  printf(_(" -P, --parallel=PARALLEL_WORKERS use this many background workers for vacuum, if available\n"));
1168  printf(_(" -q, --quiet don't write any messages\n"));
1169  printf(_(" --skip-locked skip relations that cannot be immediately locked\n"));
1170  printf(_(" -t, --table='TABLE[(COLUMNS)]' vacuum specific table(s) only\n"));
1171  printf(_(" -v, --verbose write a lot of output\n"));
1172  printf(_(" -V, --version output version information, then exit\n"));
1173  printf(_(" -z, --analyze update optimizer statistics\n"));
1174  printf(_(" -Z, --analyze-only only update optimizer statistics; no vacuum\n"));
1175  printf(_(" --analyze-in-stages only update optimizer statistics, in multiple\n"
1176  " stages for faster results; no vacuum\n"));
1177  printf(_(" -?, --help show this help, then exit\n"));
1178  printf(_("\nConnection options:\n"));
1179  printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
1180  printf(_(" -p, --port=PORT database server port\n"));
1181  printf(_(" -U, --username=USERNAME user name to connect as\n"));
1182  printf(_(" -w, --no-password never prompt for password\n"));
1183  printf(_(" -W, --password force password prompt\n"));
1184  printf(_(" --maintenance-db=DBNAME alternate maintenance database\n"));
1185  printf(_("\nRead the description of the SQL command VACUUM for details.\n"));
1186  printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
1187  printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
1188 }
void splitTableColumnsSpec(const char *spec, int encoding, char **table, const char **columns)
Definition: common.c:34
#define gettext_noop(x)
Definition: c.h:1196
#define Assert(condition)
Definition: c.h:858
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1214
#define CppAsString2(x)
Definition: c.h:327
volatile sig_atomic_t CancelRequested
Definition: cancel.c:59
void setup_cancel_handler(void(*query_cancel_callback)(void))
Definition: cancel.c:183
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:448
#define ALWAYS_SECURE_SEARCH_PATH_SQL
Definition: connect.h:25
PGconn * connectMaintenanceDatabase(ConnParams *cparams, const char *progname, bool echo)
#define _(x)
Definition: elog.c:90
int PQserverVersion(const PGconn *conn)
Definition: fe-connect.c:7157
char * PQdb(const PGconn *conn)
Definition: fe-connect.c:7013
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:7167
int PQclientEncoding(const PGconn *conn)
Definition: fe-connect.c:7255
void PQfinish(PGconn *conn)
Definition: fe-connect.c:4888
int PQntuples(const PGresult *res)
Definition: fe-exec.c:3481
char * PQgetvalue(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3876
int PQgetisnull(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3901
int PQsendQuery(PGconn *conn, const char *query)
Definition: fe-exec.c:1416
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
void pg_free(void *ptr)
Definition: fe_memutils.c:105
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:60
#define no_argument
Definition: getopt_long.h:24
#define required_argument
Definition: getopt_long.h:25
#define comma
Definition: indent_codes.h:48
int i
Definition: isn.c:73
static void const char fflush(stdout)
exit(1)
void pg_logging_init(const char *argv0)
Definition: logging.c:83
#define pg_log_error(...)
Definition: logging.h:106
#define pg_log_error_hint(...)
Definition: logging.h:112
const char * progname
Definition: main.c:44
bool option_parse_int(const char *optarg, const char *optname, int min_range, int max_range, int *result)
Definition: option_utils.c:50
void handle_help_version_opts(int argc, char *argv[], const char *fixed_progname, help_handler hlp)
Definition: option_utils.c:24
ParallelSlot * ParallelSlotsGetIdle(ParallelSlotArray *sa, const char *dbname)
bool ParallelSlotsWaitCompletion(ParallelSlotArray *sa)
ParallelSlotArray * ParallelSlotsSetup(int numslots, ConnParams *cparams, const char *progname, bool echo, const char *initcmd)
bool TableCommandResultHandler(PGresult *res, PGconn *conn, void *context)
void ParallelSlotsTerminate(ParallelSlotArray *sa)
void ParallelSlotsAdoptConn(ParallelSlotArray *sa, PGconn *conn)
static void ParallelSlotSetHandler(ParallelSlot *slot, ParallelSlotResultHandler handler, void *context)
Definition: parallel_slot.h:47
#define pg_fatal(...)
static PGconn * connectDatabase(const char *dbname, const char *connection_string, const char *pghost, const char *pgport, const char *pguser, trivalue prompt_password, bool fail_on_error)
Definition: pg_dumpall.c:1663
static void executeCommand(PGconn *conn, const char *query)
Definition: pg_dumpall.c:1906
static PGresult * executeQuery(PGconn *conn, const char *query)
Definition: pg_dumpall.c:1883
PGDLLIMPORT int optind
Definition: getopt.c:50
PGDLLIMPORT char * optarg
Definition: getopt.c:52
static int port
Definition: pg_regress.c:116
static char * buf
Definition: pg_test_fsync.c:73
const char * username
Definition: pgbench.c:296
const char * get_progname(const char *argv0)
Definition: path.c:574
#define printf(...)
Definition: port.h:244
char * escape_single_quotes_ascii(const char *src)
Definition: quotes.c:33
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:90
void resetPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:146
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:265
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:378
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:367
void termPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:129
char * c
void simple_string_list_append(SimpleStringList *list, const char *val)
Definition: simple_list.c:63
char * dbname
Definition: streamutil.c:52
PGconn * conn
Definition: streamutil.c:55
void appendStringLiteralConn(PQExpBuffer buf, const char *str, PGconn *conn)
Definition: string_utils.c:293
const char * fmtQualifiedId(const char *schema, const char *id)
Definition: string_utils.c:145
PGconn * connection
Definition: parallel_slot.h:23
char val[FLEXIBLE_ARRAY_MEMBER]
Definition: simple_list.h:37
struct SimpleStringListCell * next
Definition: simple_list.h:34
SimpleStringListCell * head
Definition: simple_list.h:42
const char * pguser
Definition: connect_utils.h:31
char * override_dbname
Definition: pg_backup.h:91
char * pgport
Definition: pg_backup.h:85
char * pghost
Definition: pg_backup.h:86
char * dbname
Definition: pg_backup.h:84
enum trivalue prompt_password
Definition: connect_utils.h:32
bool force_index_cleanup
Definition: vacuumdb.c:44
bool no_index_cleanup
Definition: vacuumdb.c:43
int parallel_workers
Definition: vacuumdb.c:41
bool disable_page_skipping
Definition: vacuumdb.c:37
bool skip_locked
Definition: vacuumdb.c:38
bool process_toast
Definition: vacuumdb.c:47
char * buffer_usage_limit
Definition: vacuumdb.c:49
bool do_truncate
Definition: vacuumdb.c:45
bool process_main
Definition: vacuumdb.c:46
bool skip_database_stats
Definition: vacuumdb.c:48
bool and_analyze
Definition: vacuumdb.c:34
bool analyze_only
Definition: vacuumdb.c:32
const char * get_user_name_or_exit(const char *progname)
Definition: username.c:74
int main(int argc, char *argv[])
Definition: vacuumdb.c:97
void check_objfilter(void)
Definition: vacuumdb.c:428
static void vacuum_all_databases(ConnParams *cparams, vacuumingOptions *vacopts, bool analyze_in_stages, SimpleStringList *objects, int concurrentCons, const char *progname, bool echo, bool quiet)
Definition: vacuumdb.c:885
static void help(const char *progname)
Definition: vacuumdb.c:1144
struct vacuumingOptions vacuumingOptions
static void run_vacuum_command(PGconn *conn, const char *sql, bool echo, const char *table)
Definition: vacuumdb.c:1122
#define ANALYZE_NUM_STAGES
Definition: vacuumdb.c:93
VacObjFilter
Definition: vacuumdb.c:54
@ OBJFILTER_DATABASE
Definition: vacuumdb.c:57
@ OBJFILTER_ALL_DBS
Definition: vacuumdb.c:56
@ OBJFILTER_SCHEMA
Definition: vacuumdb.c:59
@ OBJFILTER_SCHEMA_EXCLUDE
Definition: vacuumdb.c:60
@ OBJFILTER_TABLE
Definition: vacuumdb.c:58
@ OBJFILTER_NONE
Definition: vacuumdb.c:55
static void prepare_vacuum_command(PQExpBuffer sql, int serverVersion, vacuumingOptions *vacopts, const char *table)
Definition: vacuumdb.c:952
#define ANALYZE_NO_STAGE
Definition: vacuumdb.c:92
static char * escape_quotes(const char *src)
Definition: vacuumdb.c:452
static void vacuum_one_database(ConnParams *cparams, vacuumingOptions *vacopts, int stage, SimpleStringList *objects, int concurrentCons, const char *progname, bool echo, bool quiet)
Definition: vacuumdb.c:475
VacObjFilter objfilter
Definition: vacuumdb.c:63
trivalue
Definition: vacuumlo.c:35
@ TRI_YES
Definition: vacuumlo.c:38
@ TRI_DEFAULT
Definition: vacuumlo.c:36
@ TRI_NO
Definition: vacuumlo.c:37