pg_dumpall.c File Reference

#include "postgres_fe.h"
#include <time.h>
#include <unistd.h>
#include "getopt_long.h"
#include "dumputils.h"
#include "pg_backup.h"
#include "common/file_utils.h"
#include "fe_utils/connect.h"
#include "fe_utils/string_utils.h"

Include dependency graph for pg_dumpall.c:

Go to the source code of this file.

Macros
#define	PGDUMP_VERSIONSTR   "pg_dump (PostgreSQL) " PG_VERSION "\n"
#define	PG_AUTHID   "pg_authid"
#define	PG_ROLES   "pg_roles "
#define	exit_nicely(code)   exit(code)

Functions
static void	help (void)
static void	dropRoles (PGconn *conn)
static void	dumpRoles (PGconn *conn)
static void	dumpRoleMembership (PGconn *conn)
static void	dumpGroups (PGconn *conn)
static void	dropTablespaces (PGconn *conn)
static void	dumpTablespaces (PGconn *conn)
static void	dropDBs (PGconn *conn)
static void	dumpUserConfig (PGconn *conn, const char *username)
static void	dumpDatabases (PGconn *conn)
static void	dumpTimestamp (const char *msg)
static int	runPgDump (const char *dbname, const char *create_opts)
static void	buildShSecLabels (PGconn *conn, const char *catalog_name, Oid objectId, const char *objtype, const char *objname, PQExpBuffer buffer)
static PGconn *	connectDatabase (const char *dbname, const char *connstr, const char *pghost, const char *pgport, const char *pguser, trivalue prompt_password, bool fail_on_error)
static char *	constructConnStr (const char **keywords, const char **values)
static PGresult *	executeQuery (PGconn *conn, const char *query)
static void	executeCommand (PGconn *conn, const char *query)
int	main (int argc, char *argv[])

Variables
static char	pg_dump_bin [MAXPGPATH]
static const char *	progname
static PQExpBuffer	pgdumpopts
static char *	connstr = ""
static bool	output_clean = false
static bool	skip_acls = false
static bool	verbose = false
static bool	dosync = true
static int	binary_upgrade = 0
static int	column_inserts = 0
static int	disable_dollar_quoting = 0
static int	disable_triggers = 0
static int	if_exists = 0
static int	inserts = 0
static int	no_tablespaces = 0
static int	use_setsessauth = 0
static int	no_comments = 0
static int	no_publications = 0
static int	no_security_labels = 0
static int	no_subscriptions = 0
static int	no_unlogged_table_data = 0
static int	no_role_passwords = 0
static int	server_version
static int	load_via_partition_root = 0
static char	role_catalog [10]
static FILE *	OPF
static char *	filename = NULL

Macro Definition Documentation

exit_nicely

#define exit_nicely

(

code

)

exit(code)

Definition at line 89 of file pg_dumpall.c.

Referenced by connectDatabase(), dumpDatabases(), dumpPolicy(), dumpRule(), dumpSequence(), dumpSequenceData(), dumpTableData_copy(), dumpTablespaces(), dumpTrigger(), executeCommand(), executeQuery(), findParentsByOid(), getTableAttrs(), init_parallel_dump_utils(), main(), parseOidArray(), and warn_or_exit_horribly().

PG_AUTHID

#define PG_AUTHID   "pg_authid"

Definition at line 83 of file pg_dumpall.c.

Referenced by main().

PG_ROLES

#define PG_ROLES   "pg_roles "

Definition at line 84 of file pg_dumpall.c.

Referenced by main().

PGDUMP_VERSIONSTR

#define PGDUMP_VERSIONSTR   "pg_dump (PostgreSQL) " PG_VERSION "\n"

Definition at line 30 of file pg_dumpall.c.

Referenced by main().

Function Documentation

buildShSecLabels()

static void buildShSecLabels ( PGconn *  conn, const char *  catalog_name, Oid  objectId, const char *  objtype, const char *  objname, PQExpBuffer  buffer  )

static

Definition at line 1496 of file pg_dumpall.c.

References buildShSecLabelQuery(), createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), emitShSecLabels(), executeQuery(), and PQclear().

Referenced by dumpRoles(), and dumpTablespaces().

{
    PQExpBuffer sql = createPQExpBuffer();
    PGresult   *res;

    buildShSecLabelQuery(conn, catalog_name, objectId, sql);
    res = executeQuery(conn, sql->data);
    emitShSecLabels(conn, res, buffer, objtype, objname);

    PQclear(res);
    destroyPQExpBuffer(sql);
}

connectDatabase()

static PGconn * connectDatabase ( const char *  dbname, const char *  connstr, const char *  pghost, const char *  pgport, const char *  pguser, trivalue  prompt_password, bool  fail_on_error  )

static

Definition at line 1522 of file pg_dumpall.c.

References _, ALWAYS_SECURE_SEARCH_PATH_SQL, conn, CONNECTION_BAD, connstr, constructConnStr(), dbname, executeQuery(), exit_nicely, free, have_password, i, _PQconninfoOption::keyword, password, pg_malloc0(), pghost, pgport, PQclear(), PQconnectdbParams(), PQconnectionNeedsPassword(), PQconninfoFree(), PQconninfoParse(), PQerrorMessage(), PQfinish(), PQparameterStatus(), PQserverVersion(), PQstatus(), progname, server_version, simple_prompt(), TRI_NO, TRI_YES, _PQconninfoOption::val, and values.

Referenced by cluster_one_database(), main(), reindex_one_database(), reindex_system_catalogs(), and vacuum_one_database().

{
    PGconn     *conn;
    bool        new_pass;
    const char *remoteversion_str;
    int         my_version;
    const char **keywords = NULL;
    const char **values = NULL;
    PQconninfoOption *conn_opts = NULL;
    static bool have_password = false;
    static char password[100];

    if (prompt_password == TRI_YES && !have_password)
    {
        simple_prompt("Password: ", password, sizeof(password), false);
        have_password = true;
    }

    /*
     * Start the connection.  Loop until we have a password if requested by
     * backend.
     */
    do
    {
        int         argcount = 6;
        PQconninfoOption *conn_opt;
        char       *err_msg = NULL;
        int         i = 0;

        if (keywords)
            free(keywords);
        if (values)
            free(values);
        if (conn_opts)
            PQconninfoFree(conn_opts);

        /*
         * Merge the connection info inputs given in form of connection string
         * and other options.  Explicitly discard any dbname value in the
         * connection string; otherwise, PQconnectdbParams() would interpret
         * that value as being itself a connection string.
         */
        if (connection_string)
        {
            conn_opts = PQconninfoParse(connection_string, &err_msg);
            if (conn_opts == NULL)
            {
                fprintf(stderr, "%s: %s", progname, err_msg);
                exit_nicely(1);
            }

            for (conn_opt = conn_opts; conn_opt->keyword != NULL; conn_opt++)
            {
                if (conn_opt->val != NULL && conn_opt->val[0] != '\0' &&
                    strcmp(conn_opt->keyword, "dbname") != 0)
                    argcount++;
            }

            keywords = pg_malloc0((argcount + 1) * sizeof(*keywords));
            values = pg_malloc0((argcount + 1) * sizeof(*values));

            for (conn_opt = conn_opts; conn_opt->keyword != NULL; conn_opt++)
            {
                if (conn_opt->val != NULL && conn_opt->val[0] != '\0' &&
                    strcmp(conn_opt->keyword, "dbname") != 0)
                {
                    keywords[i] = conn_opt->keyword;
                    values[i] = conn_opt->val;
                    i++;
                }
            }
        }
        else
        {
            keywords = pg_malloc0((argcount + 1) * sizeof(*keywords));
            values = pg_malloc0((argcount + 1) * sizeof(*values));
        }

        if (pghost)
        {
            keywords[i] = "host";
            values[i] = pghost;
            i++;
        }
        if (pgport)
        {
            keywords[i] = "port";
            values[i] = pgport;
            i++;
        }
        if (pguser)
        {
            keywords[i] = "user";
            values[i] = pguser;
            i++;
        }
        if (have_password)
        {
            keywords[i] = "password";
            values[i] = password;
            i++;
        }
        if (dbname)
        {
            keywords[i] = "dbname";
            values[i] = dbname;
            i++;
        }
        keywords[i] = "fallback_application_name";
        values[i] = progname;
        i++;

        new_pass = false;
        conn = PQconnectdbParams(keywords, values, true);

        if (!conn)
        {
            fprintf(stderr, _("%s: could not connect to database \"%s\"\n"),
                    progname, dbname);
            exit_nicely(1);
        }

        if (PQstatus(conn) == CONNECTION_BAD &&
            PQconnectionNeedsPassword(conn) &&
            !have_password &&
            prompt_password != TRI_NO)
        {
            PQfinish(conn);
            simple_prompt("Password: ", password, sizeof(password), false);
            have_password = true;
            new_pass = true;
        }
    } while (new_pass);

    /* check to see that the backend connection was successfully made */
    if (PQstatus(conn) == CONNECTION_BAD)
    {
        if (fail_on_error)
        {
            fprintf(stderr,
                    _("%s: could not connect to database \"%s\": %s\n"),
                    progname, dbname, PQerrorMessage(conn));
            exit_nicely(1);
        }
        else
        {
            PQfinish(conn);

            free(keywords);
            free(values);
            PQconninfoFree(conn_opts);

            return NULL;
        }
    }

    /*
     * Ok, connected successfully. Remember the options used, in the form of a
     * connection string.
     */
    connstr = constructConnStr(keywords, values);

    free(keywords);
    free(values);
    PQconninfoFree(conn_opts);

    /* Check version */
    remoteversion_str = PQparameterStatus(conn, "server_version");
    if (!remoteversion_str)
    {
        fprintf(stderr, _("%s: could not get server version\n"), progname);
        exit_nicely(1);
    }
    server_version = PQserverVersion(conn);
    if (server_version == 0)
    {
        fprintf(stderr, _("%s: could not parse server version \"%s\"\n"),
                progname, remoteversion_str);
        exit_nicely(1);
    }

    my_version = PG_VERSION_NUM;

    /*
     * We allow the server to be back to 8.0, and up to any minor release of
     * our own major version.  (See also version check in pg_dump.c.)
     */
    if (my_version != server_version
        && (server_version < 80000 ||
            (server_version / 100) > (my_version / 100)))
    {
        fprintf(stderr, _("server version: %s; %s version: %s\n"),
                remoteversion_str, progname, PG_VERSION);
        fprintf(stderr, _("aborting because of server version mismatch\n"));
        exit_nicely(1);
    }

    PQclear(executeQuery(conn, ALWAYS_SECURE_SEARCH_PATH_SQL));

    return conn;
}

constructConnStr()

static char * constructConnStr ( const char **  keywords, const char **  values  )

static

Definition at line 1737 of file pg_dumpall.c.

References appendConnStrVal(), appendPQExpBuffer(), appendPQExpBufferChar(), buf, connstr, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), i, and pg_strdup().

Referenced by connectDatabase().

{
    PQExpBuffer buf = createPQExpBuffer();
    char       *connstr;
    int         i;
    bool        firstkeyword = true;

    /* Construct a new connection string in key='value' format. */
    for (i = 0; keywords[i] != NULL; i++)
    {
        if (strcmp(keywords[i], "dbname") == 0 ||
            strcmp(keywords[i], "password") == 0 ||
            strcmp(keywords[i], "fallback_application_name") == 0)
            continue;

        if (!firstkeyword)
            appendPQExpBufferChar(buf, ' ');
        firstkeyword = false;
        appendPQExpBuffer(buf, "%s=", keywords[i]);
        appendConnStrVal(buf, values[i]);
    }

    connstr = pg_strdup(buf->data);
    destroyPQExpBuffer(buf);
    return connstr;
}

dropDBs()

static void dropDBs ( PGconn *  conn )

static

Definition at line 1259 of file pg_dumpall.c.

References dbname, executeQuery(), fmtId(), i, if_exists, OPF, PQclear(), PQgetvalue(), and PQntuples().

Referenced by main().

{
    PGresult   *res;
    int         i;

    /*
     * Skip databases marked not datallowconn, since we'd be unable to connect
     * to them anyway.  This must agree with dumpDatabases().
     */
    res = executeQuery(conn,
                       "SELECT datname "
                       "FROM pg_database d "
                       "WHERE datallowconn "
                       "ORDER BY datname");

    if (PQntuples(res) > 0)
        fprintf(OPF, "--\n-- Drop databases (except postgres and template1)\n--\n\n");

    for (i = 0; i < PQntuples(res); i++)
    {
        char       *dbname = PQgetvalue(res, i, 0);

        /*
         * Skip "postgres" and "template1"; dumpDatabases() will deal with
         * them specially.  Also, be sure to skip "template0", even if for
         * some reason it's not marked !datallowconn.
         */
        if (strcmp(dbname, "template1") != 0 &&
            strcmp(dbname, "template0") != 0 &&
            strcmp(dbname, "postgres") != 0)
        {
            fprintf(OPF, "DROP DATABASE %s%s;\n",
                    if_exists ? "IF EXISTS " : "",
                    fmtId(dbname));
        }
    }

    PQclear(res);

    fprintf(OPF, "\n\n");
}

dropRoles()

static void dropRoles ( PGconn *  conn )

static

Definition at line 649 of file pg_dumpall.c.

References buf, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), executeQuery(), fmtId(), i, if_exists, OPF, PQclear(), PQfnumber(), PQgetvalue(), PQntuples(), printfPQExpBuffer(), role_catalog, and server_version.

Referenced by main().

{
    PQExpBuffer buf = createPQExpBuffer();
    PGresult   *res;
    int         i_rolname;
    int         i;

    if (server_version >= 90600)
        printfPQExpBuffer(buf,
                          "SELECT rolname "
                          "FROM %s "
                          "WHERE rolname !~ '^pg_' "
                          "ORDER BY 1", role_catalog);
    else if (server_version >= 80100)
        printfPQExpBuffer(buf,
                          "SELECT rolname "
                          "FROM %s "
                          "ORDER BY 1", role_catalog);
    else
        printfPQExpBuffer(buf,
                          "SELECT usename as rolname "
                          "FROM pg_shadow "
                          "UNION "
                          "SELECT groname as rolname "
                          "FROM pg_group "
                          "ORDER BY 1");

    res = executeQuery(conn, buf->data);

    i_rolname = PQfnumber(res, "rolname");

    if (PQntuples(res) > 0)
        fprintf(OPF, "--\n-- Drop roles\n--\n\n");

    for (i = 0; i < PQntuples(res); i++)
    {
        const char *rolename;

        rolename = PQgetvalue(res, i, i_rolname);

        fprintf(OPF, "DROP ROLE %s%s;\n",
                if_exists ? "IF EXISTS " : "",
                fmtId(rolename));
    }

    PQclear(res);
    destroyPQExpBuffer(buf);

    fprintf(OPF, "\n\n");
}

dropTablespaces()

static void dropTablespaces ( PGconn *  conn )

static

Definition at line 1087 of file pg_dumpall.c.

References executeQuery(), fmtId(), i, if_exists, OPF, PQclear(), PQgetvalue(), and PQntuples().

Referenced by main().

{
    PGresult   *res;
    int         i;

    /*
     * Get all tablespaces except built-in ones (which we assume are named
     * pg_xxx)
     */
    res = executeQuery(conn, "SELECT spcname "
                       "FROM pg_catalog.pg_tablespace "
                       "WHERE spcname !~ '^pg_' "
                       "ORDER BY 1");

    if (PQntuples(res) > 0)
        fprintf(OPF, "--\n-- Drop tablespaces\n--\n\n");

    for (i = 0; i < PQntuples(res); i++)
    {
        char       *spcname = PQgetvalue(res, i, 0);

        fprintf(OPF, "DROP TABLESPACE %s%s;\n",
                if_exists ? "IF EXISTS " : "",
                fmtId(spcname));
    }

    PQclear(res);

    fprintf(OPF, "\n\n");
}

dumpDatabases()

static void dumpDatabases ( PGconn *  conn )

static

Definition at line 1354 of file pg_dumpall.c.

References _, dbname, executeQuery(), exit_nicely, filename, i, OPF, output_clean, PG_BINARY_A, PQclear(), PQgetvalue(), PQntuples(), progname, runPgDump(), strerror(), and verbose.

Referenced by main().

{
    PGresult   *res;
    int         i;

    /*
     * Skip databases marked not datallowconn, since we'd be unable to connect
     * to them anyway.  This must agree with dropDBs().
     *
     * We arrange for template1 to be processed first, then we process other
     * DBs in alphabetical order.  If we just did them all alphabetically, we
     * might find ourselves trying to drop the "postgres" database while still
     * connected to it.  This makes trying to run the restore script while
     * connected to "template1" a bad idea, but there's no fixed order that
     * doesn't have some failure mode with --clean.
     */
    res = executeQuery(conn,
                       "SELECT datname "
                       "FROM pg_database d "
                       "WHERE datallowconn "
                       "ORDER BY (datname <> 'template1'), datname");

    for (i = 0; i < PQntuples(res); i++)
    {
        char       *dbname = PQgetvalue(res, i, 0);
        const char *create_opts;
        int         ret;

        /* Skip template0, even if it's not marked !datallowconn. */
        if (strcmp(dbname, "template0") == 0)
            continue;

        if (verbose)
            fprintf(stderr, _("%s: dumping database \"%s\"...\n"), progname, dbname);

        /*
         * We assume that "template1" and "postgres" already exist in the
         * target installation.  dropDBs() won't have removed them, for fear
         * of removing the DB the restore script is initially connected to. If
         * --clean was specified, tell pg_dump to drop and recreate them;
         * otherwise we'll merely restore their contents.  Other databases
         * should simply be created.
         */
        if (strcmp(dbname, "template1") == 0 || strcmp(dbname, "postgres") == 0)
        {
            if (output_clean)
                create_opts = "--clean --create";
            else
            {
                create_opts = "";
                /* Since pg_dump won't emit a \connect command, we must */
                fprintf(OPF, "\\connect %s\n\n", dbname);
            }
        }
        else
            create_opts = "--create";

        if (filename)
            fclose(OPF);

        ret = runPgDump(dbname, create_opts);
        if (ret != 0)
        {
            fprintf(stderr, _("%s: pg_dump failed on database \"%s\", exiting\n"), progname, dbname);
            exit_nicely(1);
        }

        if (filename)
        {
            OPF = fopen(filename, PG_BINARY_A);
            if (!OPF)
            {
                fprintf(stderr, _("%s: could not re-open the output file \"%s\": %s\n"),
                        progname, filename, strerror(errno));
                exit_nicely(1);
            }
        }

    }

    PQclear(res);
}

dumpGroups()

static void dumpGroups ( PGconn *  conn )

static

Definition at line 1022 of file pg_dumpall.c.

References buf, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), executeQuery(), fmtId(), free, i, OPF, pg_strdup(), PQclear(), PQgetvalue(), PQntuples(), and printfPQExpBuffer().

Referenced by main().

{
    PQExpBuffer buf = createPQExpBuffer();
    PGresult   *res;
    int         i;

    res = executeQuery(conn,
                       "SELECT groname, grolist FROM pg_group ORDER BY 1");

    if (PQntuples(res) > 0)
        fprintf(OPF, "--\n-- Role memberships\n--\n\n");

    for (i = 0; i < PQntuples(res); i++)
    {
        char       *groname = PQgetvalue(res, i, 0);
        char       *grolist = PQgetvalue(res, i, 1);
        PGresult   *res2;
        int         j;

        /*
         * Array representation is {1,2,3} ... convert to (1,2,3)
         */
        if (strlen(grolist) < 3)
            continue;

        grolist = pg_strdup(grolist);
        grolist[0] = '(';
        grolist[strlen(grolist) - 1] = ')';
        printfPQExpBuffer(buf,
                          "SELECT usename FROM pg_shadow "
                          "WHERE usesysid IN %s ORDER BY 1",
                          grolist);
        free(grolist);

        res2 = executeQuery(conn, buf->data);

        for (j = 0; j < PQntuples(res2); j++)
        {
            char       *usename = PQgetvalue(res2, j, 0);

            /*
             * Don't try to grant a role to itself; can happen if old
             * installation has identically named user and group.
             */
            if (strcmp(groname, usename) == 0)
                continue;

            fprintf(OPF, "GRANT %s", fmtId(groname));
            fprintf(OPF, " TO %s;\n", fmtId(usename));
        }

        PQclear(res2);
    }

    PQclear(res);
    destroyPQExpBuffer(buf);

    fprintf(OPF, "\n\n");
}

dumpRoleMembership()

static void dumpRoleMembership ( PGconn *  conn )

static

Definition at line 962 of file pg_dumpall.c.

References buf, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), executeQuery(), fmtId(), grantor, i, member, OPF, PQclear(), PQgetisnull(), PQgetvalue(), PQntuples(), printfPQExpBuffer(), and role_catalog.

Referenced by main().

{
    PQExpBuffer buf = createPQExpBuffer();
    PGresult   *res;
    int         i;

    printfPQExpBuffer(buf, "SELECT ur.rolname AS roleid, "
                      "um.rolname AS member, "
                      "a.admin_option, "
                      "ug.rolname AS grantor "
                      "FROM pg_auth_members a "
                      "LEFT JOIN %s ur on ur.oid = a.roleid "
                      "LEFT JOIN %s um on um.oid = a.member "
                      "LEFT JOIN %s ug on ug.oid = a.grantor "
                      "WHERE NOT (ur.rolname ~ '^pg_' AND um.rolname ~ '^pg_')"
                      "ORDER BY 1,2,3", role_catalog, role_catalog, role_catalog);
    res = executeQuery(conn, buf->data);

    if (PQntuples(res) > 0)
        fprintf(OPF, "--\n-- Role memberships\n--\n\n");

    for (i = 0; i < PQntuples(res); i++)
    {
        char       *roleid = PQgetvalue(res, i, 0);
        char       *member = PQgetvalue(res, i, 1);
        char       *option = PQgetvalue(res, i, 2);

        fprintf(OPF, "GRANT %s", fmtId(roleid));
        fprintf(OPF, " TO %s", fmtId(member));
        if (*option == 't')
            fprintf(OPF, " WITH ADMIN OPTION");

        /*
         * We don't track the grantor very carefully in the backend, so cope
         * with the possibility that it has been dropped.
         */
        if (!PQgetisnull(res, i, 3))
        {
            char       *grantor = PQgetvalue(res, i, 3);

            fprintf(OPF, " GRANTED BY %s", fmtId(grantor));
        }
        fprintf(OPF, ";\n");
    }

    PQclear(res);
    destroyPQExpBuffer(buf);

    fprintf(OPF, "\n\n");
}

dumpRoles()

static void dumpRoles ( PGconn *  conn )

static

Definition at line 704 of file pg_dumpall.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), appendStringLiteralConn(), atooid, binary_upgrade, buf, buildShSecLabels(), createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), dumpUserConfig(), executeQuery(), fmtId(), i, no_comments, no_role_passwords, no_security_labels, OPF, PQclear(), PQfnumber(), PQgetisnull(), PQgetvalue(), PQntuples(), printfPQExpBuffer(), progname, resetPQExpBuffer(), role_catalog, and server_version.

Referenced by main().

{
    PQExpBuffer buf = createPQExpBuffer();
    PGresult   *res;
    int         i_oid,
                i_rolname,
                i_rolsuper,
                i_rolinherit,
                i_rolcreaterole,
                i_rolcreatedb,
                i_rolcanlogin,
                i_rolconnlimit,
                i_rolpassword,
                i_rolvaliduntil,
                i_rolreplication,
                i_rolbypassrls,
                i_rolcomment,
                i_is_current_user;
    int         i;

    /* note: rolconfig is dumped later */
    if (server_version >= 90600)
        printfPQExpBuffer(buf,
                          "SELECT oid, rolname, rolsuper, rolinherit, "
                          "rolcreaterole, rolcreatedb, "
                          "rolcanlogin, rolconnlimit, rolpassword, "
                          "rolvaliduntil, rolreplication, rolbypassrls, "
                          "pg_catalog.shobj_description(oid, '%s') as rolcomment, "
                          "rolname = current_user AS is_current_user "
                          "FROM %s "
                          "WHERE rolname !~ '^pg_' "
                          "ORDER BY 2", role_catalog, role_catalog);
    else if (server_version >= 90500)
        printfPQExpBuffer(buf,
                          "SELECT oid, rolname, rolsuper, rolinherit, "
                          "rolcreaterole, rolcreatedb, "
                          "rolcanlogin, rolconnlimit, rolpassword, "
                          "rolvaliduntil, rolreplication, rolbypassrls, "
                          "pg_catalog.shobj_description(oid, '%s') as rolcomment, "
                          "rolname = current_user AS is_current_user "
                          "FROM %s "
                          "ORDER BY 2", role_catalog, role_catalog);
    else if (server_version >= 90100)
        printfPQExpBuffer(buf,
                          "SELECT oid, rolname, rolsuper, rolinherit, "
                          "rolcreaterole, rolcreatedb, "
                          "rolcanlogin, rolconnlimit, rolpassword, "
                          "rolvaliduntil, rolreplication, "
                          "false as rolbypassrls, "
                          "pg_catalog.shobj_description(oid, '%s') as rolcomment, "
                          "rolname = current_user AS is_current_user "
                          "FROM %s "
                          "ORDER BY 2", role_catalog, role_catalog);
    else if (server_version >= 80200)
        printfPQExpBuffer(buf,
                          "SELECT oid, rolname, rolsuper, rolinherit, "
                          "rolcreaterole, rolcreatedb, "
                          "rolcanlogin, rolconnlimit, rolpassword, "
                          "rolvaliduntil, false as rolreplication, "
                          "false as rolbypassrls, "
                          "pg_catalog.shobj_description(oid, '%s') as rolcomment, "
                          "rolname = current_user AS is_current_user "
                          "FROM %s "
                          "ORDER BY 2", role_catalog, role_catalog);
    else if (server_version >= 80100)
        printfPQExpBuffer(buf,
                          "SELECT oid, rolname, rolsuper, rolinherit, "
                          "rolcreaterole, rolcreatedb, "
                          "rolcanlogin, rolconnlimit, rolpassword, "
                          "rolvaliduntil, false as rolreplication, "
                          "false as rolbypassrls, "
                          "null as rolcomment, "
                          "rolname = current_user AS is_current_user "
                          "FROM %s "
                          "ORDER BY 2", role_catalog);
    else
        printfPQExpBuffer(buf,
                          "SELECT 0 as oid, usename as rolname, "
                          "usesuper as rolsuper, "
                          "true as rolinherit, "
                          "usesuper as rolcreaterole, "
                          "usecreatedb as rolcreatedb, "
                          "true as rolcanlogin, "
                          "-1 as rolconnlimit, "
                          "passwd as rolpassword, "
                          "valuntil as rolvaliduntil, "
                          "false as rolreplication, "
                          "false as rolbypassrls, "
                          "null as rolcomment, "
                          "usename = current_user AS is_current_user "
                          "FROM pg_shadow "
                          "UNION ALL "
                          "SELECT 0 as oid, groname as rolname, "
                          "false as rolsuper, "
                          "true as rolinherit, "
                          "false as rolcreaterole, "
                          "false as rolcreatedb, "
                          "false as rolcanlogin, "
                          "-1 as rolconnlimit, "
                          "null::text as rolpassword, "
                          "null::abstime as rolvaliduntil, "
                          "false as rolreplication, "
                          "false as rolbypassrls, "
                          "null as rolcomment, "
                          "false AS is_current_user "
                          "FROM pg_group "
                          "WHERE NOT EXISTS (SELECT 1 FROM pg_shadow "
                          " WHERE usename = groname) "
                          "ORDER BY 2");

    res = executeQuery(conn, buf->data);

    i_oid = PQfnumber(res, "oid");
    i_rolname = PQfnumber(res, "rolname");
    i_rolsuper = PQfnumber(res, "rolsuper");
    i_rolinherit = PQfnumber(res, "rolinherit");
    i_rolcreaterole = PQfnumber(res, "rolcreaterole");
    i_rolcreatedb = PQfnumber(res, "rolcreatedb");
    i_rolcanlogin = PQfnumber(res, "rolcanlogin");
    i_rolconnlimit = PQfnumber(res, "rolconnlimit");
    i_rolpassword = PQfnumber(res, "rolpassword");
    i_rolvaliduntil = PQfnumber(res, "rolvaliduntil");
    i_rolreplication = PQfnumber(res, "rolreplication");
    i_rolbypassrls = PQfnumber(res, "rolbypassrls");
    i_rolcomment = PQfnumber(res, "rolcomment");
    i_is_current_user = PQfnumber(res, "is_current_user");

    if (PQntuples(res) > 0)
        fprintf(OPF, "--\n-- Roles\n--\n\n");

    for (i = 0; i < PQntuples(res); i++)
    {
        const char *rolename;
        Oid         auth_oid;

        auth_oid = atooid(PQgetvalue(res, i, i_oid));
        rolename = PQgetvalue(res, i, i_rolname);

        if (strncmp(rolename, "pg_", 3) == 0)
        {
            fprintf(stderr, _("%s: role name starting with \"pg_\" skipped (%s)\n"),
                    progname, rolename);
            continue;
        }

        resetPQExpBuffer(buf);

        if (binary_upgrade)
        {
            appendPQExpBufferStr(buf, "\n-- For binary upgrade, must preserve pg_authid.oid\n");
            appendPQExpBuffer(buf,
                              "SELECT pg_catalog.binary_upgrade_set_next_pg_authid_oid('%u'::pg_catalog.oid);\n\n",
                              auth_oid);
        }

        /*
         * We dump CREATE ROLE followed by ALTER ROLE to ensure that the role
         * will acquire the right properties even if it already exists (ie, it
         * won't hurt for the CREATE to fail).  This is particularly important
         * for the role we are connected as, since even with --clean we will
         * have failed to drop it.  binary_upgrade cannot generate any errors,
         * so we assume the current role is already created.
         */
        if (!binary_upgrade ||
            strcmp(PQgetvalue(res, i, i_is_current_user), "f") == 0)
            appendPQExpBuffer(buf, "CREATE ROLE %s;\n", fmtId(rolename));
        appendPQExpBuffer(buf, "ALTER ROLE %s WITH", fmtId(rolename));

        if (strcmp(PQgetvalue(res, i, i_rolsuper), "t") == 0)
            appendPQExpBufferStr(buf, " SUPERUSER");
        else
            appendPQExpBufferStr(buf, " NOSUPERUSER");

        if (strcmp(PQgetvalue(res, i, i_rolinherit), "t") == 0)
            appendPQExpBufferStr(buf, " INHERIT");
        else
            appendPQExpBufferStr(buf, " NOINHERIT");

        if (strcmp(PQgetvalue(res, i, i_rolcreaterole), "t") == 0)
            appendPQExpBufferStr(buf, " CREATEROLE");
        else
            appendPQExpBufferStr(buf, " NOCREATEROLE");

        if (strcmp(PQgetvalue(res, i, i_rolcreatedb), "t") == 0)
            appendPQExpBufferStr(buf, " CREATEDB");
        else
            appendPQExpBufferStr(buf, " NOCREATEDB");

        if (strcmp(PQgetvalue(res, i, i_rolcanlogin), "t") == 0)
            appendPQExpBufferStr(buf, " LOGIN");
        else
            appendPQExpBufferStr(buf, " NOLOGIN");

        if (strcmp(PQgetvalue(res, i, i_rolreplication), "t") == 0)
            appendPQExpBufferStr(buf, " REPLICATION");
        else
            appendPQExpBufferStr(buf, " NOREPLICATION");

        if (strcmp(PQgetvalue(res, i, i_rolbypassrls), "t") == 0)
            appendPQExpBufferStr(buf, " BYPASSRLS");
        else
            appendPQExpBufferStr(buf, " NOBYPASSRLS");

        if (strcmp(PQgetvalue(res, i, i_rolconnlimit), "-1") != 0)
            appendPQExpBuffer(buf, " CONNECTION LIMIT %s",
                              PQgetvalue(res, i, i_rolconnlimit));


        if (!PQgetisnull(res, i, i_rolpassword) && !no_role_passwords)
        {
            appendPQExpBufferStr(buf, " PASSWORD ");
            appendStringLiteralConn(buf, PQgetvalue(res, i, i_rolpassword), conn);
        }

        if (!PQgetisnull(res, i, i_rolvaliduntil))
            appendPQExpBuffer(buf, " VALID UNTIL '%s'",
                              PQgetvalue(res, i, i_rolvaliduntil));

        appendPQExpBufferStr(buf, ";\n");

        if (!no_comments && !PQgetisnull(res, i, i_rolcomment))
        {
            appendPQExpBuffer(buf, "COMMENT ON ROLE %s IS ", fmtId(rolename));
            appendStringLiteralConn(buf, PQgetvalue(res, i, i_rolcomment), conn);
            appendPQExpBufferStr(buf, ";\n");
        }

        if (!no_security_labels && server_version >= 90200)
            buildShSecLabels(conn, "pg_authid", auth_oid,
                             "ROLE", rolename,
                             buf);

        fprintf(OPF, "%s", buf->data);
    }

    /*
     * Dump configuration settings for roles after all roles have been dumped.
     * We do it this way because config settings for roles could mention the
     * names of other roles.
     */
    for (i = 0; i < PQntuples(res); i++)
        dumpUserConfig(conn, PQgetvalue(res, i, i_rolname));

    PQclear(res);

    fprintf(OPF, "\n\n");

    destroyPQExpBuffer(buf);
}

dumpTablespaces()

static void dumpTablespaces ( PGconn *  conn )

static

Definition at line 1122 of file pg_dumpall.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), appendStringLiteralConn(), atooid, buf, buildACLCommands(), buildShSecLabels(), createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), executeQuery(), exit_nicely, fmtId(), free, i, no_comments, no_security_labels, OPF, pg_strdup(), PQclear(), PQfinish(), PQgetvalue(), PQntuples(), progname, server_version, and skip_acls.

Referenced by main().

{
    PGresult   *res;
    int         i;

    /*
     * Get all tablespaces except built-in ones (which we assume are named
     * pg_xxx)
     *
     * For the tablespace ACLs, as of 9.6, we extract both the positive (as
     * spcacl) and negative (as rspcacl) ACLs, relative to the default ACL for
     * tablespaces, which are then passed to buildACLCommands() below.
     *
     * See buildACLQueries() and buildACLCommands().
     *
     * Note that we do not support initial privileges (pg_init_privs) on
     * tablespaces.
     */
    if (server_version >= 90600)
        res = executeQuery(conn, "SELECT oid, spcname, "
                           "pg_catalog.pg_get_userbyid(spcowner) AS spcowner, "
                           "pg_catalog.pg_tablespace_location(oid), "
                           "(SELECT pg_catalog.array_agg(acl) FROM (SELECT pg_catalog.unnest(coalesce(spcacl,pg_catalog.acldefault('t',spcowner))) AS acl "
                           "EXCEPT SELECT pg_catalog.unnest(pg_catalog.acldefault('t',spcowner))) as foo)"
                           "AS spcacl,"
                           "(SELECT pg_catalog.array_agg(acl) FROM (SELECT pg_catalog.unnest(pg_catalog.acldefault('t',spcowner)) AS acl "
                           "EXCEPT SELECT pg_catalog.unnest(coalesce(spcacl,pg_catalog.acldefault('t',spcowner)))) as foo)"
                           "AS rspcacl,"
                           "array_to_string(spcoptions, ', '),"
                           "pg_catalog.shobj_description(oid, 'pg_tablespace') "
                           "FROM pg_catalog.pg_tablespace "
                           "WHERE spcname !~ '^pg_' "
                           "ORDER BY 1");
    else if (server_version >= 90200)
        res = executeQuery(conn, "SELECT oid, spcname, "
                           "pg_catalog.pg_get_userbyid(spcowner) AS spcowner, "
                           "pg_catalog.pg_tablespace_location(oid), "
                           "spcacl, '' as rspcacl, "
                           "array_to_string(spcoptions, ', '),"
                           "pg_catalog.shobj_description(oid, 'pg_tablespace') "
                           "FROM pg_catalog.pg_tablespace "
                           "WHERE spcname !~ '^pg_' "
                           "ORDER BY 1");
    else if (server_version >= 90000)
        res = executeQuery(conn, "SELECT oid, spcname, "
                           "pg_catalog.pg_get_userbyid(spcowner) AS spcowner, "
                           "spclocation, spcacl, '' as rspcacl, "
                           "array_to_string(spcoptions, ', '),"
                           "pg_catalog.shobj_description(oid, 'pg_tablespace') "
                           "FROM pg_catalog.pg_tablespace "
                           "WHERE spcname !~ '^pg_' "
                           "ORDER BY 1");
    else if (server_version >= 80200)
        res = executeQuery(conn, "SELECT oid, spcname, "
                           "pg_catalog.pg_get_userbyid(spcowner) AS spcowner, "
                           "spclocation, spcacl, '' as rspcacl, null, "
                           "pg_catalog.shobj_description(oid, 'pg_tablespace') "
                           "FROM pg_catalog.pg_tablespace "
                           "WHERE spcname !~ '^pg_' "
                           "ORDER BY 1");
    else
        res = executeQuery(conn, "SELECT oid, spcname, "
                           "pg_catalog.pg_get_userbyid(spcowner) AS spcowner, "
                           "spclocation, spcacl, '' as rspcacl, "
                           "null, null "
                           "FROM pg_catalog.pg_tablespace "
                           "WHERE spcname !~ '^pg_' "
                           "ORDER BY 1");

    if (PQntuples(res) > 0)
        fprintf(OPF, "--\n-- Tablespaces\n--\n\n");

    for (i = 0; i < PQntuples(res); i++)
    {
        PQExpBuffer buf = createPQExpBuffer();
        Oid         spcoid = atooid(PQgetvalue(res, i, 0));
        char       *spcname = PQgetvalue(res, i, 1);
        char       *spcowner = PQgetvalue(res, i, 2);
        char       *spclocation = PQgetvalue(res, i, 3);
        char       *spcacl = PQgetvalue(res, i, 4);
        char       *rspcacl = PQgetvalue(res, i, 5);
        char       *spcoptions = PQgetvalue(res, i, 6);
        char       *spccomment = PQgetvalue(res, i, 7);
        char       *fspcname;

        /* needed for buildACLCommands() */
        fspcname = pg_strdup(fmtId(spcname));

        appendPQExpBuffer(buf, "CREATE TABLESPACE %s", fspcname);
        appendPQExpBuffer(buf, " OWNER %s", fmtId(spcowner));

        appendPQExpBufferStr(buf, " LOCATION ");
        appendStringLiteralConn(buf, spclocation, conn);
        appendPQExpBufferStr(buf, ";\n");

        if (spcoptions && spcoptions[0] != '\0')
            appendPQExpBuffer(buf, "ALTER TABLESPACE %s SET (%s);\n",
                              fspcname, spcoptions);

        if (!skip_acls &&
            !buildACLCommands(fspcname, NULL, NULL, "TABLESPACE",
                              spcacl, rspcacl,
                              spcowner, "", server_version, buf))
        {
            fprintf(stderr, _("%s: could not parse ACL list (%s) for tablespace \"%s\"\n"),
                    progname, spcacl, spcname);
            PQfinish(conn);
            exit_nicely(1);
        }

        if (!no_comments && spccomment && spccomment[0] != '\0')
        {
            appendPQExpBuffer(buf, "COMMENT ON TABLESPACE %s IS ", fspcname);
            appendStringLiteralConn(buf, spccomment, conn);
            appendPQExpBufferStr(buf, ";\n");
        }

        if (!no_security_labels && server_version >= 90200)
            buildShSecLabels(conn, "pg_tablespace", spcoid,
                             "TABLESPACE", spcname,
                             buf);

        fprintf(OPF, "%s", buf->data);

        free(fspcname);
        destroyPQExpBuffer(buf);
    }

    PQclear(res);
    fprintf(OPF, "\n\n");
}

dumpTimestamp()

static void dumpTimestamp ( const char *  msg )

static

Definition at line 1821 of file pg_dumpall.c.

References buf, now(), OPF, and PGDUMP_STRFTIME_FMT.

Referenced by main().

{
    char        buf[64];
    time_t      now = time(NULL);

    if (strftime(buf, sizeof(buf), PGDUMP_STRFTIME_FMT, localtime(&now)) != 0)
        fprintf(OPF, "-- %s %s\n\n", msg, buf);
}

dumpUserConfig()

static void dumpUserConfig ( PGconn *  conn, const char *  username  )

static

Definition at line 1306 of file pg_dumpall.c.

References appendPQExpBufferChar(), appendStringLiteralConn(), buf, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), executeQuery(), makeAlterConfigCommand(), OPF, PQclear(), PQgetisnull(), PQgetvalue(), PQntuples(), printfPQExpBuffer(), resetPQExpBuffer(), role_catalog, and server_version.

Referenced by dumpRoles().

{
    PQExpBuffer buf = createPQExpBuffer();
    int         count = 1;

    for (;;)
    {
        PGresult   *res;

        if (server_version >= 90000)
            printfPQExpBuffer(buf, "SELECT setconfig[%d] FROM pg_db_role_setting WHERE "
                              "setdatabase = 0 AND setrole = "
                              "(SELECT oid FROM %s WHERE rolname = ", count, role_catalog);
        else if (server_version >= 80100)
            printfPQExpBuffer(buf, "SELECT rolconfig[%d] FROM %s WHERE rolname = ", count, role_catalog);
        else
            printfPQExpBuffer(buf, "SELECT useconfig[%d] FROM pg_shadow WHERE usename = ", count);
        appendStringLiteralConn(buf, username, conn);
        if (server_version >= 90000)
            appendPQExpBufferChar(buf, ')');

        res = executeQuery(conn, buf->data);
        if (PQntuples(res) == 1 &&
            !PQgetisnull(res, 0, 0))
        {
            resetPQExpBuffer(buf);
            makeAlterConfigCommand(conn, PQgetvalue(res, 0, 0),
                                   "ROLE", username, NULL, NULL,
                                   buf);
            fprintf(OPF, "%s", buf->data);
            PQclear(res);
            count++;
        }
        else
        {
            PQclear(res);
            break;
        }
    }

    destroyPQExpBuffer(buf);
}

executeCommand()

static void executeCommand ( PGconn *  conn, const char *  query  )

static

Definition at line 1794 of file pg_dumpall.c.

References _, exit_nicely, PGRES_COMMAND_OK, PQclear(), PQerrorMessage(), PQexec(), PQfinish(), PQresultStatus(), progname, and verbose.

Referenced by main(), and vacuum_one_database().

{
    PGresult   *res;

    if (verbose)
        fprintf(stderr, _("%s: executing %s\n"), progname, query);

    res = PQexec(conn, query);
    if (!res ||
        PQresultStatus(res) != PGRES_COMMAND_OK)
    {
        fprintf(stderr, _("%s: query failed: %s"),
                progname, PQerrorMessage(conn));
        fprintf(stderr, _("%s: query was: %s\n"),
                progname, query);
        PQfinish(conn);
        exit_nicely(1);
    }

    PQclear(res);
}

executeQuery()

static PGresult * executeQuery ( PGconn *  conn, const char *  query  )

static

Definition at line 1768 of file pg_dumpall.c.

References _, exit_nicely, PGRES_TUPLES_OK, PQerrorMessage(), PQexec(), PQfinish(), PQresultStatus(), progname, and verbose.

Referenced by buildShSecLabels(), cluster_all_databases(), connectDatabase(), dropDBs(), dropRoles(), dropTablespaces(), dumpDatabases(), dumpGroups(), dumpRoleMembership(), dumpRoles(), dumpTablespaces(), dumpUserConfig(), reindex_all_databases(), vacuum_all_databases(), and vacuum_one_database().

{
    PGresult   *res;

    if (verbose)
        fprintf(stderr, _("%s: executing %s\n"), progname, query);

    res = PQexec(conn, query);
    if (!res ||
        PQresultStatus(res) != PGRES_TUPLES_OK)
    {
        fprintf(stderr, _("%s: query failed: %s"),
                progname, PQerrorMessage(conn));
        fprintf(stderr, _("%s: query was: %s\n"),
                progname, query);
        PQfinish(conn);
        exit_nicely(1);
    }

    return res;
}

help()

static void help ( void  )

static

Definition at line 585 of file pg_dumpall.c.

References _, and progname.

Referenced by main().

{
    printf(_("%s extracts a PostgreSQL database cluster into an SQL script file.\n\n"), progname);
    printf(_("Usage:\n"));
    printf(_("  %s [OPTION]...\n"), progname);

    printf(_("\nGeneral options:\n"));
    printf(_("  -f, --file=FILENAME          output file name\n"));
    printf(_("  -v, --verbose                verbose mode\n"));
    printf(_("  -V, --version                output version information, then exit\n"));
    printf(_("  --lock-wait-timeout=TIMEOUT  fail after waiting TIMEOUT for a table lock\n"));
    printf(_("  -?, --help                   show this help, then exit\n"));
    printf(_("\nOptions controlling the output content:\n"));
    printf(_("  -a, --data-only              dump only the data, not the schema\n"));
    printf(_("  -c, --clean                  clean (drop) databases before recreating\n"));
    printf(_("  -E, --encoding=ENCODING      dump the data in encoding ENCODING\n"));
    printf(_("  -g, --globals-only           dump only global objects, no databases\n"));
    printf(_("  -o, --oids                   include OIDs in dump\n"));
    printf(_("  -O, --no-owner               skip restoration of object ownership\n"));
    printf(_("  -r, --roles-only             dump only roles, no databases or tablespaces\n"));
    printf(_("  -s, --schema-only            dump only the schema, no data\n"));
    printf(_("  -S, --superuser=NAME         superuser user name to use in the dump\n"));
    printf(_("  -t, --tablespaces-only       dump only tablespaces, no databases or roles\n"));
    printf(_("  -x, --no-privileges          do not dump privileges (grant/revoke)\n"));
    printf(_("  --binary-upgrade             for use by upgrade utilities only\n"));
    printf(_("  --column-inserts             dump data as INSERT commands with column names\n"));
    printf(_("  --disable-dollar-quoting     disable dollar quoting, use SQL standard quoting\n"));
    printf(_("  --disable-triggers           disable triggers during data-only restore\n"));
    printf(_("  --if-exists                  use IF EXISTS when dropping objects\n"));
    printf(_("  --inserts                    dump data as INSERT commands, rather than COPY\n"));
    printf(_("  --no-comments                do not dump comments\n"));
    printf(_("  --no-publications            do not dump publications\n"));
    printf(_("  --no-role-passwords          do not dump passwords for roles\n"));
    printf(_("  --no-security-labels         do not dump security label assignments\n"));
    printf(_("  --no-subscriptions           do not dump subscriptions\n"));
    printf(_("  --no-sync                    do not wait for changes to be written safely to disk\n"));
    printf(_("  --no-tablespaces             do not dump tablespace assignments\n"));
    printf(_("  --no-unlogged-table-data     do not dump unlogged table data\n"));
    printf(_("  --quote-all-identifiers      quote all identifiers, even if not key words\n"));
    printf(_("  --load-via-partition-root    load partitions via the root table\n"));
    printf(_("  --use-set-session-authorization\n"
             "                               use SET SESSION AUTHORIZATION commands instead of\n"
             "                               ALTER OWNER commands to set ownership\n"));

    printf(_("\nConnection options:\n"));
    printf(_("  -d, --dbname=CONNSTR     connect using connection string\n"));
    printf(_("  -h, --host=HOSTNAME      database server host or socket directory\n"));
    printf(_("  -l, --database=DBNAME    alternative default database\n"));
    printf(_("  -p, --port=PORT          database server port number\n"));
    printf(_("  -U, --username=NAME      connect as specified database user\n"));
    printf(_("  -w, --no-password        never prompt for password\n"));
    printf(_("  -W, --password           force password prompt (should happen automatically)\n"));
    printf(_("  --role=ROLENAME          do SET ROLE before dump\n"));

    printf(_("\nIf -f/--file is not used, then the SQL script will be written to the standard\n"
             "output.\n\n"));
    printf(_("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
}

main()

int main	(	int	argc,
		char *	argv[]
	)

Definition at line 92 of file pg_dumpall.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), appendShellString(), binary_upgrade, column_inserts, conn, connectDatabase(), connstr, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), disable_dollar_quoting, disable_triggers, dosync, dropDBs(), dropRoles(), dropTablespaces(), dumpDatabases(), dumpGroups(), dumpRoleMembership(), dumpRoles(), dumpTablespaces(), dumpTimestamp(), encoding, executeCommand(), exit_nicely, filename, find_my_exec(), find_other_exec(), fmtId(), fsync_fname(), get_progname(), getopt_long(), help(), if_exists, inserts, load_via_partition_root, MAXPGPATH, no_argument, no_comments, no_publications, no_role_passwords, no_security_labels, no_subscriptions, no_tablespaces, no_unlogged_table_data, OPF, optarg, optind, output_clean, PG_AUTHID, PG_BINARY_W, pg_dump_bin, pg_encoding_to_char(), PG_ROLES, pg_strdup(), PG_TEXTDOMAIN, PGDUMP_VERSIONSTR, pghost, pgport, PQclientEncoding(), PQfinish(), PQparameterStatus(), PQsetClientEncoding(), progname, quote_all_identifiers, required_argument, role_catalog, server_version, set_pglocale_pgservice(), skip_acls, strerror(), strlcpy(), TRI_DEFAULT, TRI_NO, TRI_YES, use_setsessauth, and verbose.

{
    static struct option long_options[] = {
        {"data-only", no_argument, NULL, 'a'},
        {"clean", no_argument, NULL, 'c'},
        {"encoding", required_argument, NULL, 'E'},
        {"file", required_argument, NULL, 'f'},
        {"globals-only", no_argument, NULL, 'g'},
        {"host", required_argument, NULL, 'h'},
        {"dbname", required_argument, NULL, 'd'},
        {"database", required_argument, NULL, 'l'},
        {"oids", no_argument, NULL, 'o'},
        {"no-owner", no_argument, NULL, 'O'},
        {"port", required_argument, NULL, 'p'},
        {"roles-only", no_argument, NULL, 'r'},
        {"schema-only", no_argument, NULL, 's'},
        {"superuser", required_argument, NULL, 'S'},
        {"tablespaces-only", no_argument, NULL, 't'},
        {"username", required_argument, NULL, 'U'},
        {"verbose", no_argument, NULL, 'v'},
        {"no-password", no_argument, NULL, 'w'},
        {"password", no_argument, NULL, 'W'},
        {"no-privileges", no_argument, NULL, 'x'},
        {"no-acl", no_argument, NULL, 'x'},

        /*
         * the following options don't have an equivalent short option letter
         */
        {"attribute-inserts", no_argument, &column_inserts, 1},
        {"binary-upgrade", no_argument, &binary_upgrade, 1},
        {"column-inserts", no_argument, &column_inserts, 1},
        {"disable-dollar-quoting", no_argument, &disable_dollar_quoting, 1},
        {"disable-triggers", no_argument, &disable_triggers, 1},
        {"if-exists", no_argument, &if_exists, 1},
        {"inserts", no_argument, &inserts, 1},
        {"lock-wait-timeout", required_argument, NULL, 2},
        {"no-tablespaces", no_argument, &no_tablespaces, 1},
        {"quote-all-identifiers", no_argument, &quote_all_identifiers, 1},
        {"load-via-partition-root", no_argument, &load_via_partition_root, 1},
        {"role", required_argument, NULL, 3},
        {"use-set-session-authorization", no_argument, &use_setsessauth, 1},
        {"no-comments", no_argument, &no_comments, 1},
        {"no-publications", no_argument, &no_publications, 1},
        {"no-role-passwords", no_argument, &no_role_passwords, 1},
        {"no-security-labels", no_argument, &no_security_labels, 1},
        {"no-subscriptions", no_argument, &no_subscriptions, 1},
        {"no-sync", no_argument, NULL, 4},
        {"no-unlogged-table-data", no_argument, &no_unlogged_table_data, 1},

        {NULL, 0, NULL, 0}
    };

    char       *pghost = NULL;
    char       *pgport = NULL;
    char       *pguser = NULL;
    char       *pgdb = NULL;
    char       *use_role = NULL;
    const char *dumpencoding = NULL;
    trivalue    prompt_password = TRI_DEFAULT;
    bool        data_only = false;
    bool        globals_only = false;
    bool        roles_only = false;
    bool        tablespaces_only = false;
    PGconn     *conn;
    int         encoding;
    const char *std_strings;
    int         c,
                ret;
    int         optindex;

    set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_dump"));

    progname = get_progname(argv[0]);

    if (argc > 1)
    {
        if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
        {
            help();
            exit_nicely(0);
        }
        if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
        {
            puts("pg_dumpall (PostgreSQL) " PG_VERSION);
            exit_nicely(0);
        }
    }

    if ((ret = find_other_exec(argv[0], "pg_dump", PGDUMP_VERSIONSTR,
                               pg_dump_bin)) < 0)
    {
        char        full_path[MAXPGPATH];

        if (find_my_exec(argv[0], full_path) < 0)
            strlcpy(full_path, progname, sizeof(full_path));

        if (ret == -1)
            fprintf(stderr,
                    _("The program \"pg_dump\" is needed by %s "
                      "but was not found in the\n"
                      "same directory as \"%s\".\n"
                      "Check your installation.\n"),
                    progname, full_path);
        else
            fprintf(stderr,
                    _("The program \"pg_dump\" was found by \"%s\"\n"
                      "but was not the same version as %s.\n"
                      "Check your installation.\n"),
                    full_path, progname);
        exit_nicely(1);
    }

    pgdumpopts = createPQExpBuffer();

    while ((c = getopt_long(argc, argv, "acd:E:f:gh:l:oOp:rsS:tU:vwWx", long_options, &optindex)) != -1)
    {
        switch (c)
        {
            case 'a':
                data_only = true;
                appendPQExpBufferStr(pgdumpopts, " -a");
                break;

            case 'c':
                output_clean = true;
                break;

            case 'd':
                connstr = pg_strdup(optarg);
                break;

            case 'E':
                dumpencoding = pg_strdup(optarg);
                appendPQExpBufferStr(pgdumpopts, " -E ");
                appendShellString(pgdumpopts, optarg);
                break;

            case 'f':
                filename = pg_strdup(optarg);
                appendPQExpBufferStr(pgdumpopts, " -f ");
                appendShellString(pgdumpopts, filename);
                break;

            case 'g':
                globals_only = true;
                break;

            case 'h':
                pghost = pg_strdup(optarg);
                break;

            case 'l':
                pgdb = pg_strdup(optarg);
                break;

            case 'o':
                appendPQExpBufferStr(pgdumpopts, " -o");
                break;

            case 'O':
                appendPQExpBufferStr(pgdumpopts, " -O");
                break;

            case 'p':
                pgport = pg_strdup(optarg);
                break;

            case 'r':
                roles_only = true;
                break;

            case 's':
                appendPQExpBufferStr(pgdumpopts, " -s");
                break;

            case 'S':
                appendPQExpBufferStr(pgdumpopts, " -S ");
                appendShellString(pgdumpopts, optarg);
                break;

            case 't':
                tablespaces_only = true;
                break;

            case 'U':
                pguser = pg_strdup(optarg);
                break;

            case 'v':
                verbose = true;
                appendPQExpBufferStr(pgdumpopts, " -v");
                break;

            case 'w':
                prompt_password = TRI_NO;
                appendPQExpBufferStr(pgdumpopts, " -w");
                break;

            case 'W':
                prompt_password = TRI_YES;
                appendPQExpBufferStr(pgdumpopts, " -W");
                break;

            case 'x':
                skip_acls = true;
                appendPQExpBufferStr(pgdumpopts, " -x");
                break;

            case 0:
                break;

            case 2:
                appendPQExpBufferStr(pgdumpopts, " --lock-wait-timeout ");
                appendShellString(pgdumpopts, optarg);
                break;

            case 3:
                use_role = pg_strdup(optarg);
                appendPQExpBufferStr(pgdumpopts, " --role ");
                appendShellString(pgdumpopts, use_role);
                break;

            case 4:
                dosync = false;
                appendPQExpBufferStr(pgdumpopts, " --no-sync");
                break;

            default:
                fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
                exit_nicely(1);
        }
    }

    /* Complain if any arguments remain */
    if (optind < argc)
    {
        fprintf(stderr, _("%s: too many command-line arguments (first is \"%s\")\n"),
                progname, argv[optind]);
        fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
                progname);
        exit_nicely(1);
    }

    /* Make sure the user hasn't specified a mix of globals-only options */
    if (globals_only && roles_only)
    {
        fprintf(stderr, _("%s: options -g/--globals-only and -r/--roles-only cannot be used together\n"),
                progname);
        fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
                progname);
        exit_nicely(1);
    }

    if (globals_only && tablespaces_only)
    {
        fprintf(stderr, _("%s: options -g/--globals-only and -t/--tablespaces-only cannot be used together\n"),
                progname);
        fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
                progname);
        exit_nicely(1);
    }

    if (if_exists && !output_clean)
    {
        fprintf(stderr, _("%s: option --if-exists requires option -c/--clean\n"),
                progname);
        exit_nicely(1);
    }

    if (roles_only && tablespaces_only)
    {
        fprintf(stderr, _("%s: options -r/--roles-only and -t/--tablespaces-only cannot be used together\n"),
                progname);
        fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
                progname);
        exit_nicely(1);
    }

    /*
     * If password values are not required in the dump, switch to using
     * pg_roles which is equally useful, just more likely to have unrestricted
     * access than pg_authid.
     */
    if (no_role_passwords)
        sprintf(role_catalog, "%s", PG_ROLES);
    else
        sprintf(role_catalog, "%s", PG_AUTHID);

    /* Add long options to the pg_dump argument list */
    if (binary_upgrade)
        appendPQExpBufferStr(pgdumpopts, " --binary-upgrade");
    if (column_inserts)
        appendPQExpBufferStr(pgdumpopts, " --column-inserts");
    if (disable_dollar_quoting)
        appendPQExpBufferStr(pgdumpopts, " --disable-dollar-quoting");
    if (disable_triggers)
        appendPQExpBufferStr(pgdumpopts, " --disable-triggers");
    if (inserts)
        appendPQExpBufferStr(pgdumpopts, " --inserts");
    if (no_tablespaces)
        appendPQExpBufferStr(pgdumpopts, " --no-tablespaces");
    if (quote_all_identifiers)
        appendPQExpBufferStr(pgdumpopts, " --quote-all-identifiers");
    if (load_via_partition_root)
        appendPQExpBufferStr(pgdumpopts, " --load-via-partition-root");
    if (use_setsessauth)
        appendPQExpBufferStr(pgdumpopts, " --use-set-session-authorization");
    if (no_comments)
        appendPQExpBufferStr(pgdumpopts, " --no-comments");
    if (no_publications)
        appendPQExpBufferStr(pgdumpopts, " --no-publications");
    if (no_security_labels)
        appendPQExpBufferStr(pgdumpopts, " --no-security-labels");
    if (no_subscriptions)
        appendPQExpBufferStr(pgdumpopts, " --no-subscriptions");
    if (no_unlogged_table_data)
        appendPQExpBufferStr(pgdumpopts, " --no-unlogged-table-data");

    /*
     * If there was a database specified on the command line, use that,
     * otherwise try to connect to database "postgres", and failing that
     * "template1".  "postgres" is the preferred choice for 8.1 and later
     * servers, but it usually will not exist on older ones.
     */
    if (pgdb)
    {
        conn = connectDatabase(pgdb, connstr, pghost, pgport, pguser,
                               prompt_password, false);

        if (!conn)
        {
            fprintf(stderr, _("%s: could not connect to database \"%s\"\n"),
                    progname, pgdb);
            exit_nicely(1);
        }
    }
    else
    {
        conn = connectDatabase("postgres", connstr, pghost, pgport, pguser,
                               prompt_password, false);
        if (!conn)
            conn = connectDatabase("template1", connstr, pghost, pgport, pguser,
                                   prompt_password, true);

        if (!conn)
        {
            fprintf(stderr, _("%s: could not connect to databases \"postgres\" or \"template1\"\n"
                              "Please specify an alternative database.\n"),
                    progname);
            fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
                    progname);
            exit_nicely(1);
        }
    }

    /*
     * Open the output file if required, otherwise use stdout
     */
    if (filename)
    {
        OPF = fopen(filename, PG_BINARY_W);
        if (!OPF)
        {
            fprintf(stderr, _("%s: could not open the output file \"%s\": %s\n"),
                    progname, filename, strerror(errno));
            exit_nicely(1);
        }
    }
    else
        OPF = stdout;

    /*
     * Set the client encoding if requested.
     */
    if (dumpencoding)
    {
        if (PQsetClientEncoding(conn, dumpencoding) < 0)
        {
            fprintf(stderr, _("%s: invalid client encoding \"%s\" specified\n"),
                    progname, dumpencoding);
            exit_nicely(1);
        }
    }

    /*
     * Get the active encoding and the standard_conforming_strings setting, so
     * we know how to escape strings.
     */
    encoding = PQclientEncoding(conn);
    std_strings = PQparameterStatus(conn, "standard_conforming_strings");
    if (!std_strings)
        std_strings = "off";

    /* Set the role if requested */
    if (use_role && server_version >= 80100)
    {
        PQExpBuffer query = createPQExpBuffer();

        appendPQExpBuffer(query, "SET ROLE %s", fmtId(use_role));
        executeCommand(conn, query->data);
        destroyPQExpBuffer(query);
    }

    /* Force quoting of all identifiers if requested. */
    if (quote_all_identifiers && server_version >= 90100)
        executeCommand(conn, "SET quote_all_identifiers = true");

    fprintf(OPF, "--\n-- PostgreSQL database cluster dump\n--\n\n");
    if (verbose)
        dumpTimestamp("Started on");

    /*
     * We used to emit \connect postgres here, but that served no purpose
     * other than to break things for installations without a postgres
     * database.  Everything we're restoring here is a global, so whichever
     * database we're connected to at the moment is fine.
     */

    /* Restore will need to write to the target cluster */
    fprintf(OPF, "SET default_transaction_read_only = off;\n\n");

    /* Replicate encoding and std_strings in output */
    fprintf(OPF, "SET client_encoding = '%s';\n",
            pg_encoding_to_char(encoding));
    fprintf(OPF, "SET standard_conforming_strings = %s;\n", std_strings);
    if (strcmp(std_strings, "off") == 0)
        fprintf(OPF, "SET escape_string_warning = off;\n");
    fprintf(OPF, "\n");

    if (!data_only)
    {
        /*
         * If asked to --clean, do that first.  We can avoid detailed
         * dependency analysis because databases never depend on each other,
         * and tablespaces never depend on each other.  Roles could have
         * grants to each other, but DROP ROLE will clean those up silently.
         */
        if (output_clean)
        {
            if (!globals_only && !roles_only && !tablespaces_only)
                dropDBs(conn);

            if (!roles_only && !no_tablespaces)
                dropTablespaces(conn);

            if (!tablespaces_only)
                dropRoles(conn);
        }

        /*
         * Now create objects as requested.  Be careful that option logic here
         * is the same as for drops above.
         */
        if (!tablespaces_only)
        {
            /* Dump roles (users) */
            dumpRoles(conn);

            /* Dump role memberships --- need different method for pre-8.1 */
            if (server_version >= 80100)
                dumpRoleMembership(conn);
            else
                dumpGroups(conn);
        }

        /* Dump tablespaces */
        if (!roles_only && !no_tablespaces)
            dumpTablespaces(conn);
    }

    if (!globals_only && !roles_only && !tablespaces_only)
        dumpDatabases(conn);

    PQfinish(conn);

    if (verbose)
        dumpTimestamp("Completed on");
    fprintf(OPF, "--\n-- PostgreSQL database cluster dump complete\n--\n\n");

    if (filename)
    {
        fclose(OPF);

        /* sync the resulting file, errors are not fatal */
        if (dosync)
            (void) fsync_fname(filename, false, progname);
    }

    exit_nicely(0);
}

runPgDump()

static int runPgDump ( const char *  dbname, const char *  create_opts  )

static

Definition at line 1443 of file pg_dumpall.c.

References _, appendConnStrVal(), appendPQExpBuffer(), appendPQExpBufferStr(), appendShellString(), connstr, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), filename, pg_dump_bin, progname, and verbose.

Referenced by dumpDatabases().

{
    PQExpBuffer connstrbuf = createPQExpBuffer();
    PQExpBuffer cmd = createPQExpBuffer();
    int         ret;

    appendPQExpBuffer(cmd, "\"%s\" %s %s", pg_dump_bin,
                      pgdumpopts->data, create_opts);

    /*
     * If we have a filename, use the undocumented plain-append pg_dump
     * format.
     */
    if (filename)
        appendPQExpBufferStr(cmd, " -Fa ");
    else
        appendPQExpBufferStr(cmd, " -Fp ");

    /*
     * Append the database name to the already-constructed stem of connection
     * string.
     */
    appendPQExpBuffer(connstrbuf, "%s dbname=", connstr);
    appendConnStrVal(connstrbuf, dbname);

    appendShellString(cmd, connstrbuf->data);

    if (verbose)
        fprintf(stderr, _("%s: running \"%s\"\n"), progname, cmd->data);

    fflush(stdout);
    fflush(stderr);

    ret = system(cmd->data);

    destroyPQExpBuffer(cmd);
    destroyPQExpBuffer(connstrbuf);

    return ret;
}

Variable Documentation

binary_upgrade

int binary_upgrade = 0

static

Definition at line 65 of file pg_dumpall.c.

Referenced by dumpRoles(), and main().

column_inserts

int column_inserts = 0

static

Definition at line 66 of file pg_dumpall.c.

Referenced by main().

connstr

char* connstr = ""

static

Definition at line 59 of file pg_dumpall.c.

Referenced by _connectDB(), appendPsqlMetaConnect(), CloneArchive(), cluster_all_databases(), connectDatabase(), constructConnStr(), dblink_connect(), dblink_get_conn(), do_connect(), generate_old_dump(), main(), reindex_all_databases(), restore_toc_entry(), runPgDump(), and vacuum_all_databases().

disable_dollar_quoting

int disable_dollar_quoting = 0

static

Definition at line 67 of file pg_dumpall.c.

Referenced by main().

disable_triggers

int disable_triggers = 0

static

Definition at line 68 of file pg_dumpall.c.

Referenced by main().

dosync

bool dosync = true

static

Definition at line 63 of file pg_dumpall.c.

Referenced by main().

filename

char* filename = NULL

static

Definition at line 87 of file pg_dumpall.c.

Referenced by _copyCopyStmt(), _copyLoadStmt(), _equalCopyStmt(), _equalLoadStmt(), adjust_data_dir(), be_lo_export(), be_lo_import(), be_lo_import_with_oid(), check_file_excluded(), CheckXLogRemoved(), cleanup(), convert_and_check_filename(), CreateExtensionInternal(), db_dir_size(), dsynonym_init(), dumpDatabases(), dxsyn_init(), elog_start(), errstart(), execute_extension_script(), expand_tilde(), file_acquire_sample_rows(), file_fdw_validator(), fileAnalyzeForeignTable(), fileBeginForeignScan(), fileExplainForeignScan(), get_cfp_error(), get_sock_dir(), libpqGetFile(), llvm_compile_module(), load_libraries(), logfile_getname(), logfile_rotate(), LogicalTapeSetCreate(), ltsConcatWorkerTapes(), main(), open_csvlogfile(), parse_extension_control_file(), parseCommandLine(), pg_file_unlink(), pg_file_unlink_v1_1(), pg_file_write_internal(), pg_read_binary_file(), pg_read_file(), pg_read_file_v2(), pg_stat_file(), PLy_traceback(), process_file(), readstoplist(), ReceiveAndUnpackTarFile(), receiveFileChunks(), ReceiveTarFile(), rmtree(), runPgDump(), sendFile(), splitTzLine(), SysLogger_Start(), tsearch_readline_begin(), and WriteRecoveryConf().

if_exists

int if_exists = 0

static

Definition at line 69 of file pg_dumpall.c.

Referenced by dropDBs(), dropRoles(), dropTablespaces(), and main().

inserts

int inserts = 0

static

Definition at line 70 of file pg_dumpall.c.

Referenced by main().

load_via_partition_root

int load_via_partition_root = 0

static

Definition at line 80 of file pg_dumpall.c.

Referenced by main().

no_comments

int no_comments = 0

static

Definition at line 73 of file pg_dumpall.c.

Referenced by dumpRoles(), dumpTablespaces(), and main().

no_publications

int no_publications = 0

static

Definition at line 74 of file pg_dumpall.c.

Referenced by main().

no_role_passwords

int no_role_passwords = 0

static

Definition at line 78 of file pg_dumpall.c.

Referenced by dumpRoles(), and main().

no_security_labels

int no_security_labels = 0

static

Definition at line 75 of file pg_dumpall.c.

Referenced by dumpRoles(), dumpTablespaces(), and main().

no_subscriptions

int no_subscriptions = 0

static

Definition at line 76 of file pg_dumpall.c.

Referenced by main().

no_tablespaces

int no_tablespaces = 0

static

Definition at line 71 of file pg_dumpall.c.

Referenced by main().

no_unlogged_table_data

int no_unlogged_table_data = 0

static

Definition at line 77 of file pg_dumpall.c.

Referenced by main().

OPF

FILE* OPF

static

Definition at line 86 of file pg_dumpall.c.

Referenced by dropDBs(), dropRoles(), dropTablespaces(), dumpDatabases(), dumpGroups(), dumpRoleMembership(), dumpRoles(), dumpTablespaces(), dumpTimestamp(), dumpUserConfig(), and main().

output_clean

bool output_clean = false

static

Definition at line 60 of file pg_dumpall.c.

Referenced by dumpDatabases(), and main().

pg_dump_bin

char pg_dump_bin[MAXPGPATH]

static

Definition at line 56 of file pg_dumpall.c.

Referenced by main(), and runPgDump().

pgdumpopts

PQExpBuffer pgdumpopts

static

Definition at line 58 of file pg_dumpall.c.

progname

const char* progname

static

Definition at line 57 of file pg_dumpall.c.

Referenced by connectDatabase(), dumpDatabases(), dumpRoles(), dumpTablespaces(), executeCommand(), executeQuery(), help(), main(), and runPgDump().

role_catalog

char role_catalog[10]

static

Definition at line 82 of file pg_dumpall.c.

Referenced by dropRoles(), dumpRoleMembership(), dumpRoles(), dumpUserConfig(), and main().

server_version

int server_version

static

Definition at line 79 of file pg_dumpall.c.

Referenced by ApplyWorkerMain(), connectDatabase(), connection_warnings(), dropRoles(), dumpRoles(), dumpTablespaces(), dumpUserConfig(), main(), SyncVariables(), and WalReceiverMain().

skip_acls

bool skip_acls = false

static

Definition at line 61 of file pg_dumpall.c.

Referenced by dumpTablespaces(), and main().

use_setsessauth

int use_setsessauth = 0

static

Definition at line 72 of file pg_dumpall.c.

Referenced by main().

verbose

bool verbose = false

static

Definition at line 62 of file pg_dumpall.c.

Referenced by dumpDatabases(), executeCommand(), executeQuery(), main(), and runPgDump().