libpq-be-fe.h File Reference

#include "libpq-fe.h"

Include dependency graph for libpq-be-fe.h:

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

Go to the source code of this file.

Data Structures
struct	libpqsrv_PGresult

Macros
#define	PGresult   libpqsrv_PGresult
#define	PQclear   libpqsrv_PQclear
#define	PQgetResult   libpqsrv_PQgetResult
#define	PQresultStatus   libpqsrv_PQresultStatus
#define	PQresultErrorMessage   libpqsrv_PQresultErrorMessage
#define	PQresultErrorField   libpqsrv_PQresultErrorField
#define	PQcmdStatus   libpqsrv_PQcmdStatus
#define	PQntuples   libpqsrv_PQntuples
#define	PQnfields   libpqsrv_PQnfields
#define	PQgetvalue   libpqsrv_PQgetvalue
#define	PQgetlength   libpqsrv_PQgetlength
#define	PQgetisnull   libpqsrv_PQgetisnull
#define	PQfname   libpqsrv_PQfname
#define	PQcmdTuples   libpqsrv_PQcmdTuples

Typedefs
typedef struct libpqsrv_PGresult	libpqsrv_PGresult

Functions
static libpqsrv_PGresult *	libpqsrv_PQwrap (PGresult *res)
static void	libpqsrv_PQclear (libpqsrv_PGresult *bres)
static libpqsrv_PGresult *	libpqsrv_PGresultSetParent (libpqsrv_PGresult *bres, MemoryContext ctx)
static libpqsrv_PGresult *	libpqsrv_PQgetResult (PGconn *conn)
static ExecStatusType	libpqsrv_PQresultStatus (const libpqsrv_PGresult *res)
static const char *	libpqsrv_PQresultErrorMessage (const libpqsrv_PGresult *res)
static char *	libpqsrv_PQresultErrorField (const libpqsrv_PGresult *res, int fieldcode)
static char *	libpqsrv_PQcmdStatus (const libpqsrv_PGresult *res)
static int	libpqsrv_PQntuples (const libpqsrv_PGresult *res)
static int	libpqsrv_PQnfields (const libpqsrv_PGresult *res)
static char *	libpqsrv_PQgetvalue (const libpqsrv_PGresult *res, int tup_num, int field_num)
static int	libpqsrv_PQgetlength (const libpqsrv_PGresult *res, int tup_num, int field_num)
static int	libpqsrv_PQgetisnull (const libpqsrv_PGresult *res, int tup_num, int field_num)
static char *	libpqsrv_PQfname (const libpqsrv_PGresult *res, int field_num)
static const char *	libpqsrv_PQcmdTuples (const libpqsrv_PGresult *res)

Macro Definition Documentation

PGresult

#define PGresult   libpqsrv_PGresult

Definition at line 244 of file libpq-be-fe.h.

PQclear

#define PQclear   libpqsrv_PQclear

Definition at line 245 of file libpq-be-fe.h.

PQcmdStatus

#define PQcmdStatus   libpqsrv_PQcmdStatus

Definition at line 250 of file libpq-be-fe.h.

PQcmdTuples

#define PQcmdTuples   libpqsrv_PQcmdTuples

Definition at line 257 of file libpq-be-fe.h.

PQfname

#define PQfname   libpqsrv_PQfname

Definition at line 256 of file libpq-be-fe.h.

PQgetisnull

#define PQgetisnull   libpqsrv_PQgetisnull

Definition at line 255 of file libpq-be-fe.h.

PQgetlength

#define PQgetlength   libpqsrv_PQgetlength

Definition at line 254 of file libpq-be-fe.h.

PQgetResult

#define PQgetResult   libpqsrv_PQgetResult

Definition at line 246 of file libpq-be-fe.h.

PQgetvalue

#define PQgetvalue   libpqsrv_PQgetvalue

Definition at line 253 of file libpq-be-fe.h.

PQnfields

#define PQnfields   libpqsrv_PQnfields

Definition at line 252 of file libpq-be-fe.h.

PQntuples

#define PQntuples   libpqsrv_PQntuples

Definition at line 251 of file libpq-be-fe.h.

PQresultErrorField

#define PQresultErrorField   libpqsrv_PQresultErrorField

Definition at line 249 of file libpq-be-fe.h.

PQresultErrorMessage

#define PQresultErrorMessage   libpqsrv_PQresultErrorMessage

Definition at line 248 of file libpq-be-fe.h.

PQresultStatus

#define PQresultStatus   libpqsrv_PQresultStatus

Definition at line 247 of file libpq-be-fe.h.

Typedef Documentation

libpqsrv_PGresult

typedef struct libpqsrv_PGresult libpqsrv_PGresult

Function Documentation

libpqsrv_PGresultSetParent()

static libpqsrv_PGresult * libpqsrv_PGresultSetParent ( libpqsrv_PGresult *  bres, MemoryContext  ctx  )

inlinestatic

Definition at line 109 of file libpq-be-fe.h.

{
    libpqsrv_PGresult *newres;
 
    /* We pass through a NULL result as-is */
    if (bres == NULL)
        return NULL;
    /* Make a new wrapper in the target context, raising error on OOM */
    newres = (libpqsrv_PGresult *)
        MemoryContextAlloc(ctx, sizeof(libpqsrv_PGresult));
    /* Okay, set up the new wrapper */
    newres->res = bres->res;
    newres->ctx = ctx;
    newres->cb.func = (MemoryContextCallbackFunction) PQclear;
    newres->cb.arg = bres->res;
    MemoryContextRegisterResetCallback(ctx, &newres->cb);
    /* Disarm and delete the old wrapper */
    MemoryContextUnregisterResetCallback(bres->ctx, &bres->cb);
    pfree(bres);
    return newres;
}

References fb(), MemoryContextAlloc(), MemoryContextRegisterResetCallback(), MemoryContextUnregisterResetCallback(), pfree(), PQclear, and libpqsrv_PGresult::res.

Referenced by execute_dml_stmt().

libpqsrv_PQclear()

static void libpqsrv_PQclear ( libpqsrv_PGresult *  bres )

inlinestatic

Definition at line 95 of file libpq-be-fe.h.

{
    if (bres)
    {
        MemoryContextUnregisterResetCallback(bres->ctx, &bres->cb);
        PQclear(bres->res);
        pfree(bres);
    }
}

References fb(), MemoryContextUnregisterResetCallback(), pfree(), and PQclear.

libpqsrv_PQcmdStatus()

static char * libpqsrv_PQcmdStatus ( const libpqsrv_PGresult *  res )

inlinestatic

Definition at line 175 of file libpq-be-fe.h.

{
    if (!res)
        return NULL;
    return PQcmdStatus(res->res);
}

References fb(), PQcmdStatus, and libpqsrv_PGresult::res.

libpqsrv_PQcmdTuples()

static const char * libpqsrv_PQcmdTuples ( const libpqsrv_PGresult *  res )

inlinestatic

Definition at line 231 of file libpq-be-fe.h.

{
    if (!res)
        return "";
    return PQcmdTuples(res->res);
}

References PQcmdTuples, and libpqsrv_PGresult::res.

libpqsrv_PQfname()

static char * libpqsrv_PQfname ( const libpqsrv_PGresult *  res, int  field_num  )

inlinestatic

Definition at line 223 of file libpq-be-fe.h.

{
    if (!res)
        return NULL;
    return PQfname(res->res, field_num);
}

References fb(), PQfname, and libpqsrv_PGresult::res.

libpqsrv_PQgetisnull()

static int libpqsrv_PQgetisnull ( const libpqsrv_PGresult *  res, int  tup_num, int  field_num  )

inlinestatic

Definition at line 215 of file libpq-be-fe.h.

{
    if (!res)
        return 1;               /* pretend it is null */
    return PQgetisnull(res->res, tup_num, field_num);
}

References fb(), PQgetisnull, and libpqsrv_PGresult::res.

libpqsrv_PQgetlength()

static int libpqsrv_PQgetlength ( const libpqsrv_PGresult *  res, int  tup_num, int  field_num  )

inlinestatic

Definition at line 207 of file libpq-be-fe.h.

{
    if (!res)
        return 0;
    return PQgetlength(res->res, tup_num, field_num);
}

References fb(), PQgetlength, and libpqsrv_PGresult::res.

libpqsrv_PQgetResult()

static libpqsrv_PGresult * libpqsrv_PQgetResult ( PGconn *  conn )

inlinestatic

Definition at line 138 of file libpq-be-fe.h.

{
    return libpqsrv_PQwrap(PQgetResult(conn));
}

References conn, libpqsrv_PQwrap(), and PQgetResult.

libpqsrv_PQgetvalue()

static char * libpqsrv_PQgetvalue ( const libpqsrv_PGresult *  res, int  tup_num, int  field_num  )

inlinestatic

Definition at line 199 of file libpq-be-fe.h.

{
    if (!res)
        return NULL;
    return PQgetvalue(res->res, tup_num, field_num);
}

References fb(), PQgetvalue, and libpqsrv_PGresult::res.

libpqsrv_PQnfields()

static int libpqsrv_PQnfields ( const libpqsrv_PGresult *  res )

inlinestatic

Definition at line 191 of file libpq-be-fe.h.

{
    if (!res)
        return 0;
    return PQnfields(res->res);
}

References PQnfields, and libpqsrv_PGresult::res.

libpqsrv_PQntuples()

static int libpqsrv_PQntuples ( const libpqsrv_PGresult *  res )

inlinestatic

Definition at line 183 of file libpq-be-fe.h.

{
    if (!res)
        return 0;
    return PQntuples(res->res);
}

References PQntuples, and libpqsrv_PGresult::res.

libpqsrv_PQresultErrorField()

static char * libpqsrv_PQresultErrorField ( const libpqsrv_PGresult *  res, int  fieldcode  )

inlinestatic

Definition at line 167 of file libpq-be-fe.h.

{
    if (!res)
        return NULL;
    return PQresultErrorField(res->res, fieldcode);
}

References fb(), PQresultErrorField, and libpqsrv_PGresult::res.

libpqsrv_PQresultErrorMessage()

static const char * libpqsrv_PQresultErrorMessage ( const libpqsrv_PGresult *  res )

inlinestatic

Definition at line 159 of file libpq-be-fe.h.

{
    if (!res)
        return "";
    return PQresultErrorMessage(res->res);
}

References PQresultErrorMessage, and libpqsrv_PGresult::res.

libpqsrv_PQresultStatus()

static ExecStatusType libpqsrv_PQresultStatus ( const libpqsrv_PGresult *  res )

inlinestatic

Definition at line 151 of file libpq-be-fe.h.

{
    if (!res)
        return PGRES_FATAL_ERROR;
    return PQresultStatus(res->res);
}

References PGRES_FATAL_ERROR, PQresultStatus, and libpqsrv_PGresult::res.

libpqsrv_PQwrap()

static libpqsrv_PGresult * libpqsrv_PQwrap ( PGresult *  res )

inlinestatic

Definition at line 60 of file libpq-be-fe.h.

{
    libpqsrv_PGresult *bres;
    MemoryContext ctx = CurrentMemoryContext;
 
    /* We pass through a NULL result as-is, since there's nothing to free */
    if (res == NULL)
        return NULL;
    /* Attempt to allocate the wrapper ... this had better not throw error */
    bres = (libpqsrv_PGresult *)
        MemoryContextAllocExtended(ctx,
                                   sizeof(libpqsrv_PGresult),
                                   MCXT_ALLOC_NO_OOM);
    /* If we failed to allocate a wrapper, free the PGresult before failing */
    if (bres == NULL)
    {
        PQclear(res);
        ereport(ERROR,
                (errcode(ERRCODE_OUT_OF_MEMORY),
                 errmsg("out of memory")));
    }
    /* Okay, set up the wrapper */
    bres->res = res;
    bres->ctx = ctx;
    bres->cb.func = (MemoryContextCallbackFunction) PQclear;
    bres->cb.arg = res;
    MemoryContextRegisterResetCallback(ctx, &bres->cb);
    return bres;
}

References CurrentMemoryContext, ereport, errcode(), errmsg(), ERROR, fb(), MCXT_ALLOC_NO_OOM, MemoryContextAllocExtended(), MemoryContextRegisterResetCallback(), and PQclear.

Referenced by libpqsrv_PQgetResult().