1996-07-09 08:22:35 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
|
|
|
* libpq-fe.h--
|
1997-09-07 07:04:48 +02:00
|
|
|
* This file contains definitions for structures and
|
|
|
|
* externs for functions used by frontend postgres applications.
|
1996-07-09 08:22:35 +02:00
|
|
|
*
|
|
|
|
* Copyright (c) 1994, Regents of the University of California
|
|
|
|
*
|
1997-09-07 07:04:48 +02:00
|
|
|
* $Id: libpq-fe.h,v 1.21 1997/09/07 05:03:36 momjian Exp $
|
1996-07-09 08:22:35 +02:00
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef LIBPQ_FE_H
|
|
|
|
#define LIBPQ_FE_H
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
1997-09-07 07:04:48 +02:00
|
|
|
extern "C"
|
|
|
|
{
|
1996-07-09 08:22:35 +02:00
|
|
|
#endif
|
|
|
|
|
1996-11-22 05:39:53 +01:00
|
|
|
#include <stdio.h>
|
1996-07-09 08:22:35 +02:00
|
|
|
/* ----------------
|
1997-09-07 07:04:48 +02:00
|
|
|
* include stuff common to fe and be
|
1996-07-09 08:22:35 +02:00
|
|
|
* ----------------
|
|
|
|
*/
|
1996-12-10 08:05:12 +01:00
|
|
|
#include "postgres_ext.h"
|
1996-07-09 08:22:35 +02:00
|
|
|
#include "libpq/pqcomm.h"
|
|
|
|
#include "lib/dllist.h"
|
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
CONNECTION_OK,
|
|
|
|
CONNECTION_BAD
|
|
|
|
} ConnStatusType;
|
|
|
|
|
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
PGRES_EMPTY_QUERY = 0,
|
|
|
|
PGRES_COMMAND_OK, /* a query command that doesn't return */
|
|
|
|
/* anything was executed properly by the backend */
|
|
|
|
PGRES_TUPLES_OK, /* a query command that returns tuples */
|
|
|
|
/* was executed properly by the backend, PGresult */
|
|
|
|
/* contains the resulttuples */
|
|
|
|
PGRES_COPY_OUT,
|
|
|
|
PGRES_COPY_IN,
|
|
|
|
PGRES_BAD_RESPONSE, /* an unexpected response was recv'd from
|
|
|
|
* the backend */
|
|
|
|
PGRES_NONFATAL_ERROR,
|
|
|
|
PGRES_FATAL_ERROR
|
|
|
|
|
|
|
|
} ExecStatusType;
|
1996-07-09 08:22:35 +02:00
|
|
|
|
|
|
|
/* string descriptions of the ExecStatusTypes */
|
1997-09-07 07:04:48 +02:00
|
|
|
extern const char *pgresStatus[];
|
1996-07-09 08:22:35 +02:00
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
/*
|
|
|
|
* POSTGRES backend dependent Constants.
|
1996-07-09 08:22:35 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
/* ERROR_MSG_LENGTH should really be the same as ELOG_MAXLEN in utils/elog.h*/
|
|
|
|
#define ERROR_MSG_LENGTH 4096
|
|
|
|
#define COMMAND_LENGTH 20
|
|
|
|
#define REMARK_LENGTH 80
|
|
|
|
#define PORTAL_NAME_LENGTH 16
|
|
|
|
|
|
|
|
/* ----------------
|
|
|
|
* PQArgBlock --
|
1997-09-07 07:04:48 +02:00
|
|
|
* Information (pointer to array of this structure) required
|
|
|
|
* for the PQfn() call.
|
1996-07-09 08:22:35 +02:00
|
|
|
* ----------------
|
|
|
|
*/
|
1997-09-07 07:04:48 +02:00
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
int len;
|
|
|
|
int isint;
|
|
|
|
union
|
|
|
|
{
|
|
|
|
int *ptr;/* can't use void (dec compiler barfs) */
|
|
|
|
int integer;
|
|
|
|
} u;
|
|
|
|
} PQArgBlock;
|
|
|
|
|
|
|
|
typedef struct pgresAttDesc
|
|
|
|
{
|
|
|
|
char *name; /* type name */
|
|
|
|
Oid adtid; /* type id */
|
|
|
|
short adtsize;/* type size */
|
|
|
|
} PGresAttDesc;
|
1996-07-09 08:22:35 +02:00
|
|
|
|
|
|
|
/* use char* for Attribute values,
|
|
|
|
ASCII tuples are guaranteed to be null-terminated
|
|
|
|
For binary tuples, the first four bytes of the value is the size,
|
1997-09-07 07:04:48 +02:00
|
|
|
and the bytes afterwards are the value. The binary value is
|
1996-07-09 08:22:35 +02:00
|
|
|
not guaranteed to be null-terminated. In fact, it can have embedded nulls*/
|
1996-08-13 03:34:29 +02:00
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
#define NULL_LEN (-1) /* pg_result len for NULL value */
|
|
|
|
|
|
|
|
typedef struct pgresAttValue
|
|
|
|
{
|
|
|
|
int len; /* length in bytes of the value */
|
|
|
|
char *value; /* actual value */
|
|
|
|
} PGresAttValue;
|
|
|
|
|
|
|
|
typedef struct pgNotify
|
|
|
|
{
|
|
|
|
char relname[NAMEDATALEN]; /* name of relation
|
|
|
|
* containing data */
|
|
|
|
int be_pid; /* process id of backend */
|
|
|
|
} PGnotify;
|
|
|
|
|
|
|
|
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;
|
1996-11-11 13:16:57 +01:00
|
|
|
|
1996-07-09 08:22:35 +02:00
|
|
|
/* PGconn encapsulates a connection to the backend */
|
1997-09-07 07:04:48 +02:00
|
|
|
typedef struct pg_conn
|
|
|
|
{
|
|
|
|
char *pghost; /* the machine on which the server is
|
|
|
|
* running */
|
|
|
|
char *pgtty; /* tty on which the backend messages is
|
|
|
|
* displayed */
|
|
|
|
char *pgport; /* the communication port with the backend */
|
|
|
|
char *pgoptions; /* options to start the backend
|
|
|
|
* with */
|
|
|
|
char *dbName; /* database name */
|
|
|
|
ConnStatusType status;
|
|
|
|
char errorMessage[ERROR_MSG_LENGTH];
|
|
|
|
/* pipes for be/fe communication */
|
|
|
|
FILE *Pfin;
|
|
|
|
FILE *Pfout;
|
|
|
|
FILE *Pfdebug;
|
|
|
|
void *port; /* really a Port* */
|
|
|
|
int asyncNotifyWaiting;
|
|
|
|
Dllist *notifyList;
|
|
|
|
char *pguser; /* Postgres username of user who is
|
|
|
|
* connected */
|
|
|
|
char *pgpass;
|
|
|
|
char *pgauth;
|
|
|
|
PGlobjfuncs *lobjfuncs; /* Backend function OID's for
|
|
|
|
* large object access */
|
|
|
|
} PGconn;
|
1996-07-09 08:22:35 +02:00
|
|
|
|
|
|
|
#define CMDSTATUS_LEN 40
|
|
|
|
|
|
|
|
/* PGresult encapsulates the result of a query */
|
|
|
|
/* unlike the old libpq, we assume that queries only return in one group */
|
1997-09-07 07:04:48 +02:00
|
|
|
typedef struct pg_result
|
|
|
|
{
|
|
|
|
int ntups;
|
|
|
|
int numAttributes;
|
|
|
|
PGresAttDesc *attDescs;
|
|
|
|
PGresAttValue **tuples;/* each PGresTuple is an array of
|
|
|
|
* PGresAttValue's */
|
|
|
|
int tupArrSize; /* size of tuples array allocated */
|
|
|
|
ExecStatusType resultStatus;
|
|
|
|
char cmdStatus[CMDSTATUS_LEN]; /* cmd status from the
|
|
|
|
* last insert query */
|
|
|
|
int binary; /* binary tuple values if binary == 1,
|
|
|
|
* otherwise ASCII */
|
|
|
|
PGconn *conn;
|
|
|
|
} PGresult;
|
|
|
|
|
|
|
|
typedef char pqbool;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* We can't use the conventional "bool", because we are designed to be
|
|
|
|
* included in a user's program, and user may already have that type
|
|
|
|
* defined. Pqbool, on the other hand, is unlikely to be used.
|
|
|
|
*/
|
|
|
|
|
|
|
|
struct _PQprintOpt
|
|
|
|
{
|
|
|
|
pqbool header; /* print output field headings and row
|
|
|
|
* count */
|
|
|
|
pqbool align; /* fill align the fields */
|
|
|
|
pqbool standard; /* old brain dead format */
|
|
|
|
pqbool html3; /* output html tables */
|
|
|
|
pqbool expanded; /* expand tables */
|
|
|
|
pqbool pager; /* use pager for output if needed */
|
|
|
|
char *fieldSep; /* field separator */
|
|
|
|
char *tableOpt; /* insert to HTML <table ...> */
|
|
|
|
char *caption;/* HTML <caption> */
|
|
|
|
char **fieldName; /* null terminated array of
|
|
|
|
* repalcement field names */
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef struct _PQprintOpt PQprintOpt;
|
1996-07-09 08:22:35 +02:00
|
|
|
|
1996-11-09 11:39:54 +01:00
|
|
|
/* ----------------
|
|
|
|
* Structure for the conninfo parameter definitions of PQconnectdb()
|
|
|
|
* ----------------
|
|
|
|
*/
|
1997-09-07 07:04:48 +02:00
|
|
|
struct _PQconninfoOption
|
|
|
|
{
|
|
|
|
char *keyword;/* The keyword of the option */
|
|
|
|
char *environ;/* Fallback environment variable name */
|
|
|
|
char *compiled; /* Fallback compiled in default
|
|
|
|
* value */
|
|
|
|
char *val; /* Options value */
|
|
|
|
char *label; /* Label for field in connect dialog */
|
|
|
|
char *dispchar; /* Character to display for this
|
|
|
|
* field */
|
|
|
|
/* in a connect dialog. Values are: */
|
|
|
|
/* "" Display entered value as is */
|
|
|
|
/* "*" Password field - hide value */
|
|
|
|
/* "D" Debug options - don't */
|
|
|
|
/* create a field by default */
|
|
|
|
int dispsize; /* Field size in characters for
|
|
|
|
* dialog */
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef struct _PQconninfoOption PQconninfoOption;
|
|
|
|
|
|
|
|
/* === in fe-connect.c === */
|
|
|
|
/* make a new client connection to the backend */
|
|
|
|
extern PGconn *PQconnectdb(const char *conninfo);
|
|
|
|
extern PQconninfoOption *PQconndefaults(void);
|
|
|
|
extern PGconn *PQsetdb(const char *pghost, const char *pgport, const char *pgoptions,
|
|
|
|
const char *pgtty, const char *dbName);
|
|
|
|
/* close the current connection and free the PGconn data structure */
|
|
|
|
extern void PQfinish(PGconn * conn);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* close the current connection and restablish a new one with the same
|
|
|
|
* parameters
|
|
|
|
*/
|
|
|
|
extern void PQreset(PGconn * conn);
|
|
|
|
|
|
|
|
extern char *PQdb(PGconn * conn);
|
|
|
|
extern char *PQuser(PGconn * conn);
|
|
|
|
extern char *PQhost(PGconn * conn);
|
|
|
|
extern char *PQoptions(PGconn * conn);
|
|
|
|
extern char *PQport(PGconn * conn);
|
|
|
|
extern char *PQtty(PGconn * conn);
|
|
|
|
extern ConnStatusType PQstatus(PGconn * conn);
|
|
|
|
extern char *PQerrorMessage(PGconn * conn);
|
|
|
|
extern void PQtrace(PGconn * conn, FILE * debug_port);
|
|
|
|
extern void PQuntrace(PGconn * conn);
|
1996-07-09 08:22:35 +02:00
|
|
|
|
|
|
|
/* === in fe-exec.c === */
|
1997-09-07 07:04:48 +02:00
|
|
|
extern PGresult *PQexec(PGconn * conn, const char *query);
|
|
|
|
extern int PQgetline(PGconn * conn, char *string, int length);
|
|
|
|
extern int PQendcopy(PGconn * conn);
|
|
|
|
extern void PQputline(PGconn * conn, const char *string);
|
|
|
|
extern ExecStatusType PQresultStatus(PGresult * res);
|
|
|
|
extern int PQntuples(PGresult * res);
|
|
|
|
extern int PQnfields(PGresult * res);
|
|
|
|
extern char *PQfname(PGresult * res, int field_num);
|
|
|
|
extern int PQfnumber(PGresult * res, const char *field_name);
|
|
|
|
extern Oid PQftype(PGresult * res, int field_num);
|
|
|
|
extern short PQfsize(PGresult * res, int field_num);
|
|
|
|
extern char *PQcmdStatus(PGresult * res);
|
|
|
|
extern const char *PQoidStatus(PGresult * res);
|
|
|
|
extern const char *PQcmdTuples(PGresult * res);
|
|
|
|
extern char *PQgetvalue(PGresult * res, int tup_num, int field_num);
|
|
|
|
extern int PQgetlength(PGresult * res, int tup_num, int field_num);
|
|
|
|
extern int PQgetisnull(PGresult * res, int tup_num, int field_num);
|
|
|
|
extern void PQclear(PGresult * res);
|
1996-07-23 05:35:14 +02:00
|
|
|
/* PQdisplayTuples() is a better version of PQprintTuples() */
|
1997-09-07 07:04:48 +02:00
|
|
|
extern void PQdisplayTuples(PGresult * res,
|
|
|
|
FILE * fp, /* where to send the
|
|
|
|
* output */
|
|
|
|
int fillAlign, /* pad the fields with
|
|
|
|
* spaces */
|
|
|
|
const char *fieldSep, /* field separator */
|
|
|
|
int printHeader, /* display headers? */
|
|
|
|
int quiet);
|
|
|
|
extern void PQprintTuples(PGresult * res,
|
|
|
|
FILE * fout, /* output stream */
|
|
|
|
int printAttName, /* print attribute names
|
|
|
|
* or not */
|
|
|
|
int terseOutput, /* delimiter bars or
|
|
|
|
* not? */
|
|
|
|
int width /* width of column, if
|
|
|
|
* 0, use variable width */
|
|
|
|
);
|
|
|
|
extern void PQprint(FILE * fout, /* output stream */
|
|
|
|
PGresult * res,
|
|
|
|
PQprintOpt * ps /* option structure */
|
|
|
|
);
|
|
|
|
extern PGnotify *PQnotifies(PGconn * conn);
|
|
|
|
extern PGresult *PQfn(PGconn * conn,
|
|
|
|
int fnid,
|
|
|
|
int *result_buf,
|
|
|
|
int *result_len,
|
|
|
|
int result_is_int,
|
|
|
|
PQArgBlock * args,
|
|
|
|
int nargs);
|
1996-07-09 08:22:35 +02:00
|
|
|
/* === in fe-auth.c === */
|
1997-09-07 07:04:48 +02:00
|
|
|
extern MsgType fe_getauthsvc(char *PQerrormsg);
|
|
|
|
extern void fe_setauthsvc(const char *name, char *PQerrormsg);
|
|
|
|
extern char *fe_getauthname(char *PQerrormsg);
|
1996-07-09 08:22:35 +02:00
|
|
|
|
|
|
|
/* === in fe-misc.c === */
|
|
|
|
/* pqGets and pqPuts gets and sends strings to the file stream
|
1997-09-07 07:04:48 +02:00
|
|
|
returns 0 if successful
|
|
|
|
if debug is non-null, debugging output is sent to that stream
|
1996-07-09 08:22:35 +02:00
|
|
|
*/
|
1997-09-07 07:04:48 +02:00
|
|
|
extern int pqGets(char *s, int maxlen, FILE * stream, FILE * debug);
|
|
|
|
extern int pqGetnchar(char *s, int maxlen, FILE * stream, FILE * debug);
|
|
|
|
extern int pqPutnchar(const char *s, int maxlen, FILE * stream, FILE * debug);
|
|
|
|
extern int pqPuts(const char *s, FILE * stream, FILE * debug);
|
|
|
|
extern int pqGetc(FILE * stream, FILE * debug);
|
1996-07-09 08:22:35 +02:00
|
|
|
/* get a n-byte integer from the stream into result */
|
|
|
|
/* returns 0 if successful */
|
1997-09-07 07:04:48 +02:00
|
|
|
extern int pqGetInt(int *result, int bytes, FILE * stream, FILE * debug);
|
1996-07-09 08:22:35 +02:00
|
|
|
/* put a n-byte integer into the stream */
|
|
|
|
/* returns 0 if successful */
|
1997-09-07 07:04:48 +02:00
|
|
|
extern int pqPutInt(const int n, int bytes, FILE * stream, FILE * debug);
|
|
|
|
extern void pqFlush(FILE * stream, FILE * debug);
|
1996-07-09 08:22:35 +02:00
|
|
|
|
|
|
|
/* === in fe-lobj.c === */
|
1997-09-07 07:04:48 +02:00
|
|
|
int lo_open(PGconn * conn, Oid lobjId, int mode);
|
|
|
|
int lo_close(PGconn * conn, int fd);
|
|
|
|
int lo_read(PGconn * conn, int fd, char *buf, int len);
|
|
|
|
int lo_write(PGconn * conn, int fd, char *buf, int len);
|
|
|
|
int lo_lseek(PGconn * conn, int fd, int offset, int whence);
|
|
|
|
Oid lo_creat(PGconn * conn, int mode);
|
|
|
|
int lo_tell(PGconn * conn, int fd);
|
|
|
|
int lo_unlink(PGconn * conn, Oid lobjId);
|
|
|
|
Oid lo_import(PGconn * conn, char *filename);
|
|
|
|
int lo_export(PGconn * conn, Oid lobjId, char *filename);
|
1996-07-09 08:22:35 +02:00
|
|
|
/* max length of message to send */
|
|
|
|
#define MAX_MESSAGE_LEN 8193
|
|
|
|
|
|
|
|
/* maximum number of fields in a tuple */
|
|
|
|
#define BYTELEN 8
|
|
|
|
#define MAX_FIELDS 512
|
|
|
|
|
|
|
|
/* fall back options if they are not specified by arguments or defined
|
|
|
|
by environment variables */
|
1997-09-07 07:04:48 +02:00
|
|
|
#define DefaultHost "localhost"
|
|
|
|
#define DefaultTty ""
|
1996-07-09 08:22:35 +02:00
|
|
|
#define DefaultOption ""
|
1997-09-07 07:04:48 +02:00
|
|
|
#define DefaultAuthtype ""
|
|
|
|
#define DefaultPassword ""
|
1997-05-09 05:28:54 +02:00
|
|
|
|
1996-07-09 08:22:35 +02:00
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
typedef void *TUPLE;
|
1996-07-09 08:22:35 +02:00
|
|
|
#define palloc malloc
|
|
|
|
#define pfree free
|
|
|
|
|
1996-12-04 04:06:33 +01:00
|
|
|
#if defined(sunos4)
|
1997-09-07 07:04:48 +02:00
|
|
|
extern char *sys_errlist[];
|
1996-07-09 08:22:35 +02:00
|
|
|
#define strerror(A) (sys_errlist[(A)])
|
1997-09-07 07:04:48 +02:00
|
|
|
#endif /* sunos4 */
|
1996-07-09 08:22:35 +02:00
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
};
|
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
#endif
|
1996-07-09 08:22:35 +02:00
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
#endif /* LIBPQ_FE_H */
|