connect_utils.h File Reference

#include "libpq-fe.h"

Include dependency graph for connect_utils.h:

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

Go to the source code of this file.

Data Structures
struct	_connParams

Typedefs
typedef struct _connParams	ConnParams

Enumerations
enum	trivalue {   TRI_DEFAULT , TRI_NO , TRI_YES , TRI_DEFAULT ,   TRI_NO , TRI_YES , TRI_DEFAULT , TRI_NO ,   TRI_YES , TRI_DEFAULT , TRI_NO , TRI_YES }

Functions
PGconn *	connectDatabase (const ConnParams *cparams, const char *progname, bool echo, bool fail_ok, bool allow_password_reuse)
PGconn *	connectMaintenanceDatabase (ConnParams *cparams, const char *progname, bool echo)
void	disconnectDatabase (PGconn *conn)

Typedef Documentation

ConnParams

typedef struct _connParams ConnParams

Enumeration Type Documentation

trivalue

enum trivalue

Enumerator
TRI_DEFAULT
TRI_NO
TRI_YES
TRI_DEFAULT
TRI_NO
TRI_YES
TRI_DEFAULT
TRI_NO
TRI_YES
TRI_DEFAULT
TRI_NO
TRI_YES

Definition at line 17 of file connect_utils.h.

{
    TRI_DEFAULT,
    TRI_NO,
    TRI_YES
};

Function Documentation

connectDatabase()

PGconn * connectDatabase	(	const ConnParams *	cparams,
		const char *	progname,
		bool	echo,
		bool	fail_ok,
		bool	allow_password_reuse
	)

Definition at line 32 of file connect_utils.c.

{
    PGconn     *conn;
    bool        new_pass;
    static char *password = NULL;
 
    /* Callers must supply at least dbname; other params can be NULL */
    Assert(cparams->dbname);
 
    if (!allow_password_reuse && password)
    {
        free(password);
        password = NULL;
    }
 
    if (cparams->prompt_password == TRI_YES && password == NULL)
        password = simple_prompt("Password: ", false);
 
    /*
     * Start the connection.  Loop until we have a password if requested by
     * backend.
     */
    do
    {
        const char *keywords[8];
        const char *values[8];
        int         i = 0;
 
        /*
         * If dbname is a connstring, its entries can override the other
         * values obtained from cparams; but in turn, override_dbname can
         * override the dbname component of it.
         */
        keywords[i] = "host";
        values[i++] = cparams->pghost;
        keywords[i] = "port";
        values[i++] = cparams->pgport;
        keywords[i] = "user";
        values[i++] = cparams->pguser;
        keywords[i] = "password";
        values[i++] = password;
        keywords[i] = "dbname";
        values[i++] = cparams->dbname;
        if (cparams->override_dbname)
        {
            keywords[i] = "dbname";
            values[i++] = cparams->override_dbname;
        }
        keywords[i] = "fallback_application_name";
        values[i++] = progname;
        keywords[i] = NULL;
        values[i++] = NULL;
        Assert(i <= lengthof(keywords));
 
        new_pass = false;
        conn = PQconnectdbParams(keywords, values, true);
 
        if (!conn)
            pg_fatal("could not connect to database %s: out of memory",
                     cparams->dbname);
 
        /*
         * No luck?  Trying asking (again) for a password.
         */
        if (PQstatus(conn) == CONNECTION_BAD &&
            PQconnectionNeedsPassword(conn) &&
            cparams->prompt_password != TRI_NO)
        {
            PQfinish(conn);
            free(password);
            password = simple_prompt("Password: ", false);
            new_pass = true;
        }
    } while (new_pass);
 
    /* check to see that the backend connection was successfully made */
    if (PQstatus(conn) == CONNECTION_BAD)
    {
        if (fail_ok)
        {
            PQfinish(conn);
            return NULL;
        }
        pg_fatal("%s", PQerrorMessage(conn));
    }
 
    /* Start strict; callers may override this. */
    PQclear(executeQuery(conn, ALWAYS_SECURE_SEARCH_PATH_SQL, echo));
 
    return conn;
}

References ALWAYS_SECURE_SEARCH_PATH_SQL, Assert(), conn, CONNECTION_BAD, _connParams::dbname, executeQuery(), free, i, keywords, lengthof, _connParams::override_dbname, password, pg_fatal, _connParams::pghost, _connParams::pgport, _connParams::pguser, PQclear, PQconnectdbParams(), PQconnectionNeedsPassword(), PQerrorMessage(), PQfinish(), PQstatus(), progname, _connParams::prompt_password, simple_prompt(), TRI_NO, TRI_YES, and values.

Referenced by cluster_one_database(), connect_slot(), connectMaintenanceDatabase(), main(), reindex_one_database(), and vacuum_one_database().

connectMaintenanceDatabase()

PGconn * connectMaintenanceDatabase	(	ConnParams *	cparams,
		const char *	progname,
		bool	echo
	)

Definition at line 134 of file connect_utils.c.

{
    PGconn     *conn;
 
    /* If a maintenance database name was specified, just connect to it. */
    if (cparams->dbname)
        return connectDatabase(cparams, progname, echo, false, false);
 
    /* Otherwise, try postgres first and then template1. */
    cparams->dbname = "postgres";
    conn = connectDatabase(cparams, progname, echo, true, false);
    if (!conn)
    {
        cparams->dbname = "template1";
        conn = connectDatabase(cparams, progname, echo, false, false);
    }
    return conn;
}

References conn, connectDatabase(), _connParams::dbname, and progname.

Referenced by cluster_all_databases(), main(), reindex_all_databases(), and vacuum_all_databases().

disconnectDatabase()

void disconnectDatabase

(

PGconn *

conn

)

Definition at line 158 of file connect_utils.c.

{
    Assert(conn != NULL);
 
    if (PQtransactionStatus(conn) == PQTRANS_ACTIVE)
    {
        PGcancelConn *cancelConn = PQcancelCreate(conn);
 
        (void) PQcancelBlocking(cancelConn);
        PQcancelFinish(cancelConn);
    }
 
    PQfinish(conn);
}

References Assert(), cancelConn, conn, PQcancelBlocking(), PQcancelCreate(), PQcancelFinish(), PQfinish(), PQTRANS_ACTIVE, and PQtransactionStatus().

Referenced by compile_database_list(), compile_relation_list_one_db(), main(), ParallelSlotsAdoptConn(), ParallelSlotsGetIdle(), and ParallelSlotsTerminate().