1998-08-17 05:52:36 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
1999-02-14 00:22:53 +01:00
|
|
|
* libpq-int.h
|
1998-08-17 05:52:36 +02:00
|
|
|
* This file contains internal definitions meant to be used only by
|
|
|
|
* the frontend libpq library, not by applications that call it.
|
|
|
|
*
|
1998-09-03 04:10:56 +02:00
|
|
|
* An application can include this file if it wants to bypass the
|
|
|
|
* official API defined by libpq-fe.h, but code that does so is much
|
|
|
|
* more likely to break across PostgreSQL releases than code that uses
|
|
|
|
* only the official API.
|
|
|
|
*
|
1998-08-17 05:52:36 +02:00
|
|
|
* Copyright (c) 1994, Regents of the University of California
|
|
|
|
*
|
1999-05-25 18:15:34 +02:00
|
|
|
* $Id: libpq-int.h,v 1.8 1999/05/25 16:15:14 momjian Exp $
|
1998-08-17 05:52:36 +02:00
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef LIBPQ_INT_H
|
|
|
|
#define LIBPQ_INT_H
|
|
|
|
|
|
|
|
/* We assume libpq-fe.h has already been included. */
|
|
|
|
|
|
|
|
/* ----------------
|
|
|
|
* include stuff common to fe and be
|
|
|
|
* ----------------
|
|
|
|
*/
|
|
|
|
#include "libpq/pqcomm.h"
|
1998-09-03 04:10:56 +02:00
|
|
|
#include "lib/dllist.h"
|
1998-08-17 05:52:36 +02:00
|
|
|
|
|
|
|
/* libpq supports this version of the frontend/backend protocol.
|
|
|
|
*
|
|
|
|
* NB: we used to use PG_PROTOCOL_LATEST from the backend pqcomm.h file,
|
|
|
|
* but that's not really the right thing: just recompiling libpq
|
|
|
|
* against a more recent backend isn't going to magically update it
|
1998-09-01 06:40:42 +02:00
|
|
|
* for most sorts of protocol changes. So, when you change libpq
|
1998-08-17 05:52:36 +02:00
|
|
|
* to support a different protocol revision, you have to change this
|
|
|
|
* constant too. PG_PROTOCOL_EARLIEST and PG_PROTOCOL_LATEST in
|
|
|
|
* pqcomm.h describe what the backend knows, not what libpq knows.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define PG_PROTOCOL_LIBPQ PG_PROTOCOL(2,0)
|
|
|
|
|
1998-09-03 04:10:56 +02:00
|
|
|
/*
|
|
|
|
* POSTGRES backend dependent Constants.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* ERROR_MSG_LENGTH should really be the same as ELOG_MAXLEN in utils/elog.h*/
|
|
|
|
#define ERROR_MSG_LENGTH 4096
|
|
|
|
#define CMDSTATUS_LEN 40
|
|
|
|
|
1998-11-18 01:47:28 +01:00
|
|
|
/*
|
|
|
|
* PGresult and the subsidiary types PGresAttDesc, PGresAttValue
|
1998-09-03 04:10:56 +02:00
|
|
|
* represent the result of a query (or more precisely, of a single SQL
|
|
|
|
* command --- a query string given to PQexec can contain multiple commands).
|
|
|
|
* Note we assume that a single command can return at most one tuple group,
|
|
|
|
* hence there is no need for multiple descriptor sets.
|
|
|
|
*/
|
1998-11-18 01:47:28 +01:00
|
|
|
|
|
|
|
/* Subsidiary-storage management structure for PGresult.
|
|
|
|
* See space management routines in fe-exec.c for details.
|
|
|
|
* Note that space[k] refers to the k'th byte starting from the physical
|
|
|
|
* head of the block.
|
|
|
|
*/
|
1999-05-25 18:15:34 +02:00
|
|
|
typedef union pgresult_data PGresult_data;
|
1998-11-18 01:47:28 +01:00
|
|
|
|
1999-05-25 18:15:34 +02:00
|
|
|
union pgresult_data
|
|
|
|
{
|
|
|
|
PGresult_data *next; /* link to next block, or NULL */
|
|
|
|
char space[1]; /* dummy for accessing block as bytes */
|
|
|
|
};
|
1998-11-18 01:47:28 +01:00
|
|
|
|
|
|
|
/* Data about a single attribute (column) of a query result */
|
|
|
|
|
1999-05-25 18:15:34 +02:00
|
|
|
typedef struct pgresAttDesc
|
|
|
|
{
|
|
|
|
char *name; /* type name */
|
|
|
|
Oid typid; /* type id */
|
|
|
|
int typlen; /* type size */
|
|
|
|
int atttypmod; /* type-specific modifier info */
|
|
|
|
} PGresAttDesc;
|
1998-09-03 04:10:56 +02:00
|
|
|
|
1998-11-18 01:47:28 +01:00
|
|
|
/* Data for a single attribute of a single tuple */
|
|
|
|
|
|
|
|
/* We use char* for Attribute values.
|
|
|
|
The value pointer always points to a null-terminated area; we add a
|
|
|
|
null (zero) byte after whatever the backend sends us. This is only
|
|
|
|
particularly useful for ASCII tuples ... with a binary value, the
|
|
|
|
value might have embedded nulls, so the application can't use C string
|
|
|
|
operators on it. But we add a null anyway for consistency.
|
|
|
|
Note that the value itself does not contain a length word.
|
|
|
|
|
|
|
|
A NULL attribute is a special case in two ways: its len field is NULL_LEN
|
|
|
|
and its value field points to null_field in the owning PGresult. All the
|
|
|
|
NULL attributes in a query result point to the same place (there's no need
|
|
|
|
to store a null string separately for each one).
|
1998-09-03 04:10:56 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
#define NULL_LEN (-1) /* pg_result len for NULL value */
|
|
|
|
|
1999-05-25 18:15:34 +02:00
|
|
|
typedef struct pgresAttValue
|
|
|
|
{
|
|
|
|
int len; /* length in bytes of the value */
|
|
|
|
char *value; /* actual value, plus terminating zero
|
|
|
|
* byte */
|
|
|
|
} PGresAttValue;
|
|
|
|
|
|
|
|
struct pg_result
|
|
|
|
{
|
|
|
|
int ntups;
|
|
|
|
int numAttributes;
|
|
|
|
PGresAttDesc *attDescs;
|
|
|
|
PGresAttValue **tuples; /* each PGresTuple is an array of
|
1998-09-03 04:10:56 +02:00
|
|
|
* PGresAttValue's */
|
1999-05-25 18:15:34 +02:00
|
|
|
int tupArrSize; /* size of tuples array allocated */
|
|
|
|
ExecStatusType resultStatus;
|
|
|
|
char cmdStatus[CMDSTATUS_LEN]; /* cmd status from the
|
1998-09-03 04:10:56 +02:00
|
|
|
* last insert query */
|
1999-05-25 18:15:34 +02:00
|
|
|
int binary; /* binary tuple values if binary == 1,
|
1998-09-03 04:10:56 +02:00
|
|
|
* otherwise ASCII */
|
1999-05-25 18:15:34 +02:00
|
|
|
PGconn *conn; /* connection we did the query on, if any */
|
|
|
|
char *errMsg; /* error message, or NULL if no error */
|
|
|
|
|
|
|
|
/* All NULL attributes in the query result point to this null string */
|
|
|
|
char null_field[1];
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Space management information. Note that attDescs and errMsg, if
|
|
|
|
* not null, point into allocated blocks. But tuples points to a
|
|
|
|
* separately malloc'd block, so that we can realloc it.
|
|
|
|
*/
|
|
|
|
PGresult_data *curBlock; /* most recently allocated block */
|
|
|
|
int curOffset; /* start offset of free space in block */
|
|
|
|
int spaceLeft; /* number of free bytes remaining in block */
|
|
|
|
};
|
1998-09-03 04:10:56 +02:00
|
|
|
|
|
|
|
/* PGAsyncStatusType defines the state of the query-execution state machine */
|
1999-05-25 18:15:34 +02:00
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
PGASYNC_IDLE, /* nothing's happening, dude */
|
|
|
|
PGASYNC_BUSY, /* query in progress */
|
|
|
|
PGASYNC_READY, /* result ready for PQgetResult */
|
|
|
|
PGASYNC_COPY_IN, /* Copy In data transfer in progress */
|
|
|
|
PGASYNC_COPY_OUT /* Copy Out data transfer in progress */
|
|
|
|
} PGAsyncStatusType;
|
1998-09-03 04:10:56 +02:00
|
|
|
|
|
|
|
/* large-object-access data ... allocated only if large-object code is used. */
|
1999-05-25 18:15:34 +02:00
|
|
|
typedef struct pgLobjfuncs
|
|
|
|
{
|
|
|
|
Oid fn_lo_open; /* OID of backend function lo_open */
|
|
|
|
Oid fn_lo_close; /* OID of backend function lo_close */
|
|
|
|
Oid fn_lo_creat; /* OID of backend function lo_creat */
|
|
|
|
Oid fn_lo_unlink; /* OID of backend function lo_unlink */
|
|
|
|
Oid fn_lo_lseek; /* OID of backend function lo_lseek */
|
|
|
|
Oid fn_lo_tell; /* OID of backend function lo_tell */
|
|
|
|
Oid fn_lo_read; /* OID of backend function LOread */
|
|
|
|
Oid fn_lo_write; /* OID of backend function LOwrite */
|
|
|
|
} PGlobjfuncs;
|
1998-09-03 04:10:56 +02:00
|
|
|
|
|
|
|
/* PGconn stores all the state data associated with a single connection
|
|
|
|
* to a backend.
|
|
|
|
*/
|
1999-05-25 18:15:34 +02:00
|
|
|
struct pg_conn
|
|
|
|
{
|
|
|
|
/* Saved values of connection options */
|
|
|
|
char *pghost; /* the machine on which the server is
|
1998-09-03 04:10:56 +02:00
|
|
|
* running */
|
1999-05-25 18:15:34 +02:00
|
|
|
char *pgport; /* the server's communication port */
|
|
|
|
char *pgtty; /* tty on which the backend messages is
|
1998-09-03 04:10:56 +02:00
|
|
|
* displayed (NOT ACTUALLY USED???) */
|
1999-05-25 18:15:34 +02:00
|
|
|
char *pgoptions; /* options to start the backend with */
|
|
|
|
char *dbName; /* database name */
|
|
|
|
char *pguser; /* Postgres username and password, if any */
|
|
|
|
char *pgpass;
|
|
|
|
|
|
|
|
/* Optional file to write trace info to */
|
|
|
|
FILE *Pfdebug;
|
|
|
|
|
|
|
|
/* Callback procedure for notice/error message processing */
|
|
|
|
PQnoticeProcessor noticeHook;
|
|
|
|
void *noticeArg;
|
|
|
|
|
|
|
|
/* Status indicators */
|
|
|
|
ConnStatusType status;
|
|
|
|
PGAsyncStatusType asyncStatus;
|
|
|
|
Dllist *notifyList; /* Notify msgs not yet handed to
|
|
|
|
* application */
|
|
|
|
|
|
|
|
/* Connection data */
|
|
|
|
int sock; /* Unix FD for socket, -1 if not connected */
|
|
|
|
SockAddr laddr; /* Local address */
|
|
|
|
SockAddr raddr; /* Remote address */
|
|
|
|
int raddr_len; /* Length of remote address */
|
|
|
|
|
|
|
|
/* Miscellaneous stuff */
|
|
|
|
int be_pid; /* PID of backend --- needed for cancels */
|
|
|
|
int be_key; /* key of backend --- needed for cancels */
|
|
|
|
char salt[2]; /* password salt received from backend */
|
|
|
|
PGlobjfuncs *lobjfuncs; /* private state for large-object access
|
|
|
|
* fns */
|
|
|
|
|
|
|
|
/* Buffer for data received from backend and not yet processed */
|
|
|
|
char *inBuffer; /* currently allocated buffer */
|
|
|
|
int inBufSize; /* allocated size of buffer */
|
|
|
|
int inStart; /* offset to first unconsumed data in
|
|
|
|
* buffer */
|
|
|
|
int inCursor; /* next byte to tentatively consume */
|
|
|
|
int inEnd; /* offset to first position after avail
|
|
|
|
* data */
|
|
|
|
|
|
|
|
/* Buffer for data not yet sent to backend */
|
|
|
|
char *outBuffer; /* currently allocated buffer */
|
|
|
|
int outBufSize; /* allocated size of buffer */
|
|
|
|
int outCount; /* number of chars waiting in buffer */
|
|
|
|
|
|
|
|
/* Status for asynchronous result construction */
|
|
|
|
PGresult *result; /* result being constructed */
|
|
|
|
PGresAttValue *curTuple; /* tuple currently being read */
|
|
|
|
|
|
|
|
/* Message space. Placed last for code-size reasons. */
|
|
|
|
char errorMessage[ERROR_MSG_LENGTH];
|
|
|
|
};
|
1998-09-03 04:10:56 +02:00
|
|
|
|
1998-08-17 05:52:36 +02:00
|
|
|
/* ----------------
|
|
|
|
* Internal functions of libpq
|
|
|
|
* Functions declared here need to be visible across files of libpq,
|
|
|
|
* but are not intended to be called by applications. We use the
|
|
|
|
* convention "pqXXX" for internal functions, vs. the "PQxxx" names
|
|
|
|
* used for application-visible routines.
|
|
|
|
* ----------------
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* === in fe-connect.c === */
|
|
|
|
|
1998-09-01 06:40:42 +02:00
|
|
|
extern int pqPacketSend(PGconn *conn, const char *buf, size_t len);
|
1998-08-17 05:52:36 +02:00
|
|
|
|
|
|
|
/* === in fe-exec.c === */
|
|
|
|
|
1998-10-01 03:40:26 +02:00
|
|
|
extern void pqSetResultError(PGresult *res, const char *msg);
|
1999-05-25 18:15:34 +02:00
|
|
|
extern void *pqResultAlloc(PGresult *res, int nBytes, int isBinary);
|
|
|
|
extern char *pqResultStrdup(PGresult *res, const char *str);
|
1998-09-01 06:40:42 +02:00
|
|
|
extern void pqClearAsyncResult(PGconn *conn);
|
1998-08-17 05:52:36 +02:00
|
|
|
|
|
|
|
/* === in fe-misc.c === */
|
|
|
|
|
1998-09-01 06:40:42 +02:00
|
|
|
/*
|
|
|
|
* "Get" and "Put" routines return 0 if successful, EOF if not. Note that
|
|
|
|
* for Get, EOF merely means the buffer is exhausted, not that there is
|
|
|
|
* necessarily any error.
|
|
|
|
*/
|
|
|
|
extern int pqGetc(char *result, PGconn *conn);
|
|
|
|
extern int pqGets(char *s, int maxlen, PGconn *conn);
|
|
|
|
extern int pqPuts(const char *s, PGconn *conn);
|
|
|
|
extern int pqGetnchar(char *s, int len, PGconn *conn);
|
|
|
|
extern int pqPutnchar(const char *s, int len, PGconn *conn);
|
|
|
|
extern int pqGetInt(int *result, int bytes, PGconn *conn);
|
|
|
|
extern int pqPutInt(int value, int bytes, PGconn *conn);
|
|
|
|
extern int pqReadData(PGconn *conn);
|
|
|
|
extern int pqFlush(PGconn *conn);
|
|
|
|
extern int pqWait(int forRead, int forWrite, PGconn *conn);
|
1998-08-17 05:52:36 +02:00
|
|
|
|
|
|
|
/* max length of message to send */
|
1999-05-03 21:10:48 +02:00
|
|
|
#define MAX_MESSAGE_LEN MAX_QUERY_SIZE
|
1998-08-17 05:52:36 +02:00
|
|
|
|
|
|
|
/* maximum number of fields in a tuple */
|
|
|
|
#define MAX_FIELDS 512
|
|
|
|
|
|
|
|
/* bits in a byte */
|
|
|
|
#define BYTELEN 8
|
|
|
|
|
|
|
|
/* fall back options if they are not specified by arguments or defined
|
|
|
|
by environment variables */
|
|
|
|
#define DefaultHost "localhost"
|
|
|
|
#define DefaultTty ""
|
|
|
|
#define DefaultOption ""
|
|
|
|
#define DefaultAuthtype ""
|
|
|
|
#define DefaultPassword ""
|
|
|
|
|
|
|
|
/* supply an implementation of strerror() macro if system doesn't have it */
|
|
|
|
#ifndef strerror
|
|
|
|
#if defined(sun) && defined(sparc) && !defined(__SVR4)
|
|
|
|
extern char *sys_errlist[];
|
1998-09-01 06:40:42 +02:00
|
|
|
|
1998-08-17 05:52:36 +02:00
|
|
|
#define strerror(A) (sys_errlist[(A)])
|
1998-09-01 06:40:42 +02:00
|
|
|
#endif /* sunos4 */
|
|
|
|
#endif /* !strerror */
|
1998-08-17 05:52:36 +02:00
|
|
|
|
1998-09-01 06:40:42 +02:00
|
|
|
#endif /* LIBPQ_INT_H */
|