pg_backup_db.h File Reference

#include "pg_backup.h"

Include dependency graph for pg_backup_db.h:

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

Go to the source code of this file.

Functions
int	ExecuteSqlCommandBuf (Archive *AHX, const char *buf, size_t bufLen)
void	ExecuteSqlStatement (Archive *AHX, const char *query)
PGresult *	ExecuteSqlQuery (Archive *AHX, const char *query, ExecStatusType status)
PGresult *	ExecuteSqlQueryForSingleRow (Archive *fout, char *query)
void	EndDBCopyMode (Archive *AHX, const char *tocEntryTag)
void	StartTransaction (Archive *AHX)
void	CommitTransaction (Archive *AHX)

Function Documentation

void CommitTransaction

(

Archive *

AHX

)

Definition at line 655 of file pg_backup_db.c.

References ExecuteSqlCommand().

{
    ArchiveHandle *AH = (ArchiveHandle *) AHX;

    ExecuteSqlCommand(AH, "COMMIT", "could not commit database transaction");
}

void EndDBCopyMode	(	Archive *	AHX,
		const char *	tocEntryTag
	)

Definition at line 618 of file pg_backup_db.c.

References _archiveHandle::connection, exit_horribly(), modulename, NULL, _archiveHandle::pgCopyIn, PGRES_COMMAND_OK, PQclear(), PQerrorMessage(), PQgetResult(), PQputCopyEnd(), PQresultStatus(), warn_or_exit_horribly(), and write_msg().

Referenced by restore_toc_entry().

{
    ArchiveHandle *AH = (ArchiveHandle *) AHX;

    if (AH->pgCopyIn)
    {
        PGresult   *res;

        if (PQputCopyEnd(AH->connection, NULL) <= 0)
            exit_horribly(modulename, "error returned by PQputCopyEnd: %s",
                          PQerrorMessage(AH->connection));

        /* Check command status and return to normal libpq state */
        res = PQgetResult(AH->connection);
        if (PQresultStatus(res) != PGRES_COMMAND_OK)
            warn_or_exit_horribly(AH, modulename, "COPY failed for table \"%s\": %s",
                                  tocEntryTag, PQerrorMessage(AH->connection));
        PQclear(res);

        /* Do this to ensure we've pumped libpq back to idle state */
        if (PQgetResult(AH->connection) != NULL)
            write_msg(NULL, "WARNING: unexpected extra results during COPY of table \"%s\"\n",
                      tocEntryTag);

        AH->pgCopyIn = false;
    }
}

int ExecuteSqlCommandBuf	(	Archive *	AHX,
		const char *	buf,
		size_t	bufLen
	)

Definition at line 563 of file pg_backup_db.c.

References _archiveHandle::connection, ExecuteSimpleCommands(), ExecuteSqlCommand(), exit_horribly(), free, modulename, OUTPUT_COPYDATA, OUTPUT_OTHERDATA, _archiveHandle::outputKind, pg_malloc(), _archiveHandle::pgCopyIn, PQerrorMessage(), and PQputCopyData().

Referenced by ahwrite().

{
    ArchiveHandle *AH = (ArchiveHandle *) AHX;

    if (AH->outputKind == OUTPUT_COPYDATA)
    {
        /*
         * COPY data.
         *
         * We drop the data on the floor if libpq has failed to enter COPY
         * mode; this allows us to behave reasonably when trying to continue
         * after an error in a COPY command.
         */
        if (AH->pgCopyIn &&
            PQputCopyData(AH->connection, buf, bufLen) <= 0)
            exit_horribly(modulename, "error returned by PQputCopyData: %s",
                          PQerrorMessage(AH->connection));
    }
    else if (AH->outputKind == OUTPUT_OTHERDATA)
    {
        /*
         * Table data expressed as INSERT commands; or, in old dump files,
         * BLOB COMMENTS data (which is expressed as COMMENT ON commands).
         */
        ExecuteSimpleCommands(AH, buf, bufLen);
    }
    else
    {
        /*
         * General SQL commands; we assume that commands will not be split
         * across calls.
         *
         * In most cases the data passed to us will be a null-terminated
         * string, but if it's not, we have to add a trailing null.
         */
        if (buf[bufLen] == '\0')
            ExecuteSqlCommand(AH, buf, "could not execute query");
        else
        {
            char       *str = (char *) pg_malloc(bufLen + 1);

            memcpy(str, buf, bufLen);
            str[bufLen] = '\0';
            ExecuteSqlCommand(AH, str, "could not execute query");
            free(str);
        }
    }

    return bufLen;
}

PGresult* ExecuteSqlQuery	(	Archive *	AHX,
		const char *	query,
		ExecStatusType	status
	)

Definition at line 407 of file pg_backup_db.c.

References _archiveHandle::connection, die_on_query_failure(), modulename, PQexec(), and PQresultStatus().

Referenced by buildMatViewRefreshDependencies(), collectComments(), collectSecLabels(), createViewAsClause(), dumpBlobs(), dumpCompositeType(), dumpCompositeTypeColComments(), dumpDatabase(), dumpEnumType(), dumpOpclass(), dumpOpfamily(), dumpRule(), dumpSequence(), dumpSequenceData(), dumpTable(), dumpTableData_copy(), dumpTableData_insert(), dumpTSConfig(), dumpUserMappings(), ExecuteSqlQueryForSingleRow(), expand_schema_name_patterns(), expand_table_name_patterns(), getAccessMethods(), getAggregates(), getBlobs(), getCasts(), getCollations(), getConstraints(), getConversions(), getDefaultACLs(), getDependencies(), getDomainConstraints(), getEventTriggers(), getExtendedStatistics(), getExtensionMembership(), getExtensions(), getForeignDataWrappers(), getForeignServers(), getFuncs(), getIndexes(), getInherits(), getNamespaces(), getOpclasses(), getOperators(), getOpfamilies(), getPolicies(), getProcLangs(), getPublications(), getPublicationTables(), getRules(), getSubscriptions(), getTableAttrs(), getTables(), getTransforms(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTSParsers(), getTSTemplates(), getTypes(), and processExtensionTables().

{
    ArchiveHandle *AH = (ArchiveHandle *) AHX;
    PGresult   *res;

    res = PQexec(AH->connection, query);
    if (PQresultStatus(res) != status)
        die_on_query_failure(AH, modulename, query);
    return res;
}

PGresult* ExecuteSqlQueryForSingleRow	(	Archive *	fout,
		char *	query
	)

Definition at line 422 of file pg_backup_db.c.

References ExecuteSqlQuery(), exit_horribly(), ngettext, NULL, PGRES_TUPLES_OK, and PQntuples().

Referenced by _check_database_version(), binary_upgrade_set_pg_class_oids(), binary_upgrade_set_type_oids_by_rel_oid(), binary_upgrade_set_type_oids_by_type_oid(), convertTSFunction(), dumpAgg(), dumpBaseType(), dumpCollation(), dumpConversion(), dumpDatabase(), dumpDomain(), dumpForeignServer(), dumpFunc(), dumpOpclass(), dumpOpfamily(), dumpOpr(), dumpRangeType(), dumpTableSchema(), dumpTSConfig(), dumpTSDictionary(), findLastBuiltinOid_V71(), get_language_name(), get_synchronized_snapshot(), and getFormattedTypeName().

{
    PGresult   *res;
    int         ntups;

    res = ExecuteSqlQuery(fout, query, PGRES_TUPLES_OK);

    /* Expecting a single result only */
    ntups = PQntuples(res);
    if (ntups != 1)
        exit_horribly(NULL,
                      ngettext("query returned %d row instead of one: %s\n",
                               "query returned %d rows instead of one: %s\n",
                               ntups),
                      ntups, query);

    return res;
}

void ExecuteSqlStatement	(	Archive *	AHX,
		const char *	query
	)

Definition at line 395 of file pg_backup_db.c.

References _archiveHandle::connection, die_on_query_failure(), modulename, PGRES_COMMAND_OK, PQclear(), PQexec(), and PQresultStatus().

Referenced by dumpBlobs(), dumpTableData_insert(), getTables(), selectSourceSchema(), and setup_connection().

{
    ArchiveHandle *AH = (ArchiveHandle *) AHX;
    PGresult   *res;

    res = PQexec(AH->connection, query);
    if (PQresultStatus(res) != PGRES_COMMAND_OK)
        die_on_query_failure(AH, modulename, query);
    PQclear(res);
}

void StartTransaction

(

Archive *

AHX

)

Definition at line 647 of file pg_backup_db.c.

References ExecuteSqlCommand().

{
    ArchiveHandle *AH = (ArchiveHandle *) AHX;

    ExecuteSqlCommand(AH, "BEGIN", "could not start database transaction");
}