vacuuming.h File Reference

#include "common.h"
#include "fe_utils/connect_utils.h"
#include "fe_utils/simple_list.h"

Include dependency graph for vacuuming.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	vacuumingOptions

Macros
#define	ANALYZE_NO_STAGE   -1
#define	ANALYZE_NUM_STAGES   3
#define	OBJFILTER_ALL_DBS   0x01 /* --all */
#define	OBJFILTER_DATABASE   0x02 /* --dbname */
#define	OBJFILTER_TABLE   0x04 /* --table */
#define	OBJFILTER_SCHEMA   0x08 /* --schema */
#define	OBJFILTER_SCHEMA_EXCLUDE   0x10 /* --exclude-schema */

Typedefs
typedef struct vacuumingOptions	vacuumingOptions

Enumerations
enum	RunMode { MODE_VACUUM , MODE_ANALYZE , MODE_ANALYZE_IN_STAGES }

Functions
int	vacuuming_main (ConnParams *cparams, const char *dbname, const char *maintenance_db, vacuumingOptions *vacopts, SimpleStringList *objects, unsigned int tbl_count, int concurrentCons, const char *progname)
char *	escape_quotes (const char *src)

Macro Definition Documentation

ANALYZE_NO_STAGE

#define ANALYZE_NO_STAGE   -1

Definition at line 28 of file vacuuming.h.

ANALYZE_NUM_STAGES

#define ANALYZE_NUM_STAGES   3

Definition at line 29 of file vacuuming.h.

OBJFILTER_ALL_DBS

#define OBJFILTER_ALL_DBS   0x01 /* --all */

Definition at line 60 of file vacuuming.h.

OBJFILTER_DATABASE

#define OBJFILTER_DATABASE   0x02 /* --dbname */

Definition at line 61 of file vacuuming.h.

OBJFILTER_SCHEMA

#define OBJFILTER_SCHEMA   0x08 /* --schema */

Definition at line 63 of file vacuuming.h.

OBJFILTER_SCHEMA_EXCLUDE

#define OBJFILTER_SCHEMA_EXCLUDE   0x10 /* --exclude-schema */

Definition at line 64 of file vacuuming.h.

OBJFILTER_TABLE

#define OBJFILTER_TABLE   0x04 /* --table */

Definition at line 62 of file vacuuming.h.

Typedef Documentation

vacuumingOptions

typedef struct vacuumingOptions vacuumingOptions

Enumeration Type Documentation

RunMode

enum RunMode

Enumerator
MODE_VACUUM
MODE_ANALYZE
MODE_ANALYZE_IN_STAGES

Definition at line 20 of file vacuuming.h.

{
    MODE_VACUUM,
    MODE_ANALYZE,
    MODE_ANALYZE_IN_STAGES
} RunMode;

Function Documentation

escape_quotes()

char * escape_quotes

(

const char *

src

)

Definition at line 1043 of file vacuuming.c.

{
    char       *result = escape_single_quotes_ascii(src);
 
    if (!result)
        pg_fatal("out of memory");
    return result;
}

References escape_single_quotes_ascii(), and pg_fatal.

vacuuming_main()

int vacuuming_main	(	ConnParams *	cparams,
		const char *	dbname,
		const char *	maintenance_db,
		vacuumingOptions *	vacopts,
		SimpleStringList *	objects,
		unsigned int	tbl_count,
		int	concurrentCons,
		const char *	progname
	)

Definition at line 55 of file vacuuming.c.

{
    setup_cancel_handler(NULL);
 
    /* Avoid opening extra connections. */
    if (tbl_count > 0 && (concurrentCons > tbl_count))
        concurrentCons = tbl_count;
 
    if (vacopts->objfilter & OBJFILTER_ALL_DBS)
    {
        cparams->dbname = maintenance_db;
 
        return vacuum_all_databases(cparams, vacopts,
                                    objects,
                                    concurrentCons,
                                    progname);
    }
    else
    {
        if (dbname == NULL)
        {
            if (getenv("PGDATABASE"))
                dbname = getenv("PGDATABASE");
            else if (getenv("PGUSER"))
                dbname = getenv("PGUSER");
            else
                dbname = get_user_name_or_exit(progname);
        }
 
        cparams->dbname = dbname;
 
        if (vacopts->mode == MODE_ANALYZE_IN_STAGES)
        {
            SimpleStringList *found_objs = NULL;
 
            for (int stage = 0; stage < ANALYZE_NUM_STAGES; stage++)
            {
                int         ret;
 
                ret = vacuum_one_database(cparams, vacopts,
                                          stage,
                                          objects,
                                          vacopts->missing_stats_only ? &found_objs : NULL,
                                          concurrentCons,
                                          progname);
                if (ret != 0)
                {
                    free_retrieved_objects(found_objs);
                    return ret;
                }
            }
 
            free_retrieved_objects(found_objs);
            return EXIT_SUCCESS;
        }
        else
            return vacuum_one_database(cparams, vacopts,
                                       ANALYZE_NO_STAGE,
                                       objects, NULL,
                                       concurrentCons,
                                       progname);
    }
}

References ANALYZE_NO_STAGE, ANALYZE_NUM_STAGES, dbname, _connParams::dbname, EXIT_SUCCESS, free_retrieved_objects(), get_user_name_or_exit(), vacuumingOptions::missing_stats_only, vacuumingOptions::mode, MODE_ANALYZE_IN_STAGES, vacuumingOptions::objfilter, OBJFILTER_ALL_DBS, progname, setup_cancel_handler(), vacuum_all_databases(), and vacuum_one_database().

Referenced by main().