File: libpq-fe.h

package info (click to toggle)
hydra 9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 4,008 kB
  • sloc: ansic: 21,638; sh: 2,166; makefile: 110
file content (410 lines) | stat: -rw-r--r-- 17,388 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410

/*-------------------------------------------------------------------------
 *
 * libpq-fe.h
 *	  This file contains definitions for structures and
 *	  externs for functions used by frontend postgres applications.
 *
 * Portions Copyright (c) 1996-2003, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * $Id: libpq-fe.h,v 1.100 2003/08/27 00:33:34 petere Exp $
 *
 *-------------------------------------------------------------------------
 */

#ifndef LIBPQ_FE_H
#define LIBPQ_FE_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdio.h>

/*
 * postgres_ext.h defines the backend's externally visible types,
 * such as Oid.
 */
#include "postgres_ext.h"

/* SSL type is needed here only to declare PQgetssl() */
#ifdef USE_SSL
#include <openssl/ssl.h>
#endif

/* Application-visible enum types */

  typedef enum {
    /*
     * Although it is okay to add to this list, values which become unused
     * should never be removed, nor should constants be redefined - that
     * would break compatibility with existing code.
     */
    CONNECTION_OK,
    CONNECTION_BAD,
    /* Non-blocking mode only below here */

    /*
     * The existence of these should never be relied upon - they should
     * only be used for user feedback or similar purposes.
     */
    CONNECTION_STARTED,         /* Waiting for connection to be made.  */
    CONNECTION_MADE,            /* Connection OK; waiting to send.         */
    CONNECTION_AWAITING_RESPONSE,       /* Waiting for a response from the
                                         * postmaster.            */
    CONNECTION_AUTH_OK,         /* Received authentication; waiting for
                                 * backend startup. */
    CONNECTION_SETENV,          /* Negotiating environment. */
    CONNECTION_SSL_STARTUP,     /* Negotiating SSL. */
    CONNECTION_NEEDED           /* Internal state: connect() needed */
  } ConnStatusType;

  typedef enum {
    PGRES_POLLING_FAILED = 0,
    PGRES_POLLING_READING,      /* These two indicate that one may        */
    PGRES_POLLING_WRITING,      /* use select before polling again.   */
    PGRES_POLLING_OK,
    PGRES_POLLING_ACTIVE        /* unused; keep for awhile for backwards
                                 * compatibility */
  } PostgresPollingStatusType;

  typedef enum {
    PGRES_EMPTY_QUERY = 0,      /* empty query string was executed */
    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 result tuples */
    PGRES_COPY_OUT,             /* Copy Out data transfer in progress */
    PGRES_COPY_IN,              /* Copy In data transfer in progress */
    PGRES_BAD_RESPONSE,         /* an unexpected response was recv'd from
                                 * the backend */
    PGRES_NONFATAL_ERROR,       /* notice or warning message */
    PGRES_FATAL_ERROR           /* query failed */
  } ExecStatusType;

  typedef enum {
    PQTRANS_IDLE,               /* connection idle */
    PQTRANS_ACTIVE,             /* command in progress */
    PQTRANS_INTRANS,            /* idle, within transaction block */
    PQTRANS_INERROR,            /* idle, within failed transaction */
    PQTRANS_UNKNOWN             /* cannot determine status */
  } PGTransactionStatusType;

  typedef enum {
    PQERRORS_TERSE,             /* single-line error messages */
    PQERRORS_DEFAULT,           /* recommended style */
    PQERRORS_VERBOSE            /* all the facts, ma'am */
  } PGVerbosity;

/* PGconn encapsulates a connection to the backend.
 * The contents of this struct are not supposed to be known to applications.
 */
  typedef struct pg_conn PGconn;

/* PGresult encapsulates the result of a query (or more precisely, of a single
 * SQL command --- a query string given to PQsendQuery can contain multiple
 * commands and thus return multiple PGresult objects).
 * The contents of this struct are not supposed to be known to applications.
 */
  typedef struct pg_result PGresult;

/* PGnotify represents the occurrence of a NOTIFY message.
 * Ideally this would be an opaque typedef, but it's so simple that it's
 * unlikely to change.
 * NOTE: in Postgres 6.4 and later, the be_pid is the notifying backend's,
 * whereas in earlier versions it was always your own backend's PID.
 */
  typedef struct pgNotify {
    char *relname;              /* notification condition name */
    int32_t be_pid;                 /* process ID of server process */
    char *extra;                /* notification parameter */
  } PGnotify;

/* Function types for notice-handling callbacks */
  typedef void (*PQnoticeReceiver) (void *arg, const PGresult * res);
  typedef void (*PQnoticeProcessor) (void *arg, const char *message);

/* Print options for PQprint() */
  typedef char pqbool;

  typedef 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 */
  } PQprintOpt;

/* ----------------
 * Structure for the conninfo parameter definitions returned by PQconndefaults
 *
 * All fields except "val" point at static strings which must not be altered.
 * "val" is either NULL or a malloc'd current-value string.  PQconninfoFree()
 * will release both the val strings and the PQconninfoOption array itself.
 * ----------------
 */
  typedef struct _PQconninfoOption {
    char *keyword;              /* The keyword of the option                    */
    char *envvar;               /* Fallback environment variable name   */
    char *compiled;             /* Fallback compiled in default value   */
    char *val;                  /* Option's current value, or NULL               */
    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
                                 * option - don't show by default */
    int32_t dispsize;               /* Field size in characters for dialog  */
  } PQconninfoOption;

/* ----------------
 * PQArgBlock -- structure for PQfn() arguments
 * ----------------
 */
  typedef struct {
    int32_t len;
    int32_t isint;
    union {
      int32_t *ptr;                 /* can't use void (dec compiler barfs)   */
      int32_t integer;
    } u;
  } PQArgBlock;

/* ----------------
 * Exported functions of libpq
 * ----------------
 */

/* ===	in fe-connect.c === */

/* make a new client connection to the backend */

/* Asynchronous (non-blocking) */
  extern PGconn *PQconnectStart(const char *conninfo);
  extern PostgresPollingStatusType PQconnectPoll(PGconn * conn);

/* Synchronous (blocking) */
  extern PGconn *PQconnectdb(const char *conninfo);
  extern PGconn *PQsetdbLogin(const char *pghost, const char *pgport, const char *pgoptions, const char *pgtty, const char *dbName, const char *login, const char *pwd);

#define PQsetdb(M_PGHOST,M_PGPORT,M_PGOPT,M_PGTTY,M_DBNAME)  \
	PQsetdbLogin(M_PGHOST, M_PGPORT, M_PGOPT, M_PGTTY, M_DBNAME, NULL, NULL)

/* close the current connection and free the PGconn data structure */
  extern void PQfinish(PGconn * conn);

/* get info about connection options known to PQconnectdb */
  extern PQconninfoOption *PQconndefaults(void);

/* free the data structure returned by PQconndefaults() */
  extern void PQconninfoFree(PQconninfoOption * connOptions);

/*
 * close the current connection and restablish a new one with the same
 * parameters
 */

/* Asynchronous (non-blocking) */
  extern int32_t PQresetStart(PGconn * conn);
  extern PostgresPollingStatusType PQresetPoll(PGconn * conn);

/* Synchronous (blocking) */
  extern void PQreset(PGconn * conn);

/* issue a cancel request */
  extern int32_t PQrequestCancel(PGconn * conn);

/* Accessor functions for PGconn objects */
  extern char *PQdb(const PGconn * conn);
  extern char *PQuser(const PGconn * conn);
  extern char *PQpass(const PGconn * conn);
  extern char *PQhost(const PGconn * conn);
  extern char *PQport(const PGconn * conn);
  extern char *PQtty(const PGconn * conn);
  extern char *PQoptions(const PGconn * conn);
  extern ConnStatusType PQstatus(const PGconn * conn);
  extern PGTransactionStatusType PQtransactionStatus(const PGconn * conn);
  extern const char *PQparameterStatus(const PGconn * conn, const char *paramName);
  extern int32_t PQprotocolVersion(const PGconn * conn);
  extern char *PQerrorMessage(const PGconn * conn);
  extern int32_t PQsocket(const PGconn * conn);
  extern int32_t PQbackendPID(const PGconn * conn);
  extern int32_t PQclientEncoding(const PGconn * conn);
  extern int32_t PQsetClientEncoding(PGconn * conn, const char *encoding);

#ifdef USE_SSL

/* Get the SSL structure associated with a connection */
  extern SSL *PQgetssl(PGconn * conn);
#endif

/* Set verbosity for PQerrorMessage and PQresultErrorMessage */
  extern PGVerbosity PQsetErrorVerbosity(PGconn * conn, PGVerbosity verbosity);

/* Enable/disable tracing */
  extern void PQtrace(PGconn * conn, FILE * debug_port);
  extern void PQuntrace(PGconn * conn);

/* Override default notice handling routines */
  extern PQnoticeReceiver PQsetNoticeReceiver(PGconn * conn, PQnoticeReceiver proc, void *arg);
  extern PQnoticeProcessor PQsetNoticeProcessor(PGconn * conn, PQnoticeProcessor proc, void *arg);

/* === in fe-exec.c === */

/* Simple synchronous query */
  extern PGresult *PQexec(PGconn * conn, const char *query);
  extern PGresult *PQexecParams(PGconn * conn,
                                const char *command,
                                int32_t nParams, const Oid * paramTypes, const char *const *paramValues, const int32_t *paramLengths, const int32_t *paramFormats, int32_t resultFormat);
  extern PGresult *PQexecPrepared(PGconn * conn,
                                  const char *stmtName, int32_t nParams, const char *const *paramValues, const int32_t *paramLengths, const int32_t *paramFormats, int32_t resultFormat);

/* Interface for multiple-result or asynchronous queries */
  extern int32_t PQsendQuery(PGconn * conn, const char *query);
  extern int32_t PQsendQueryParams(PGconn * conn,
                               const char *command,
                               int32_t nParams, const Oid * paramTypes, const char *const *paramValues, const int32_t *paramLengths, const int32_t *paramFormats, int32_t resultFormat);
  extern int32_t PQsendQueryPrepared(PGconn * conn,
                                 const char *stmtName, int32_t nParams, const char *const *paramValues, const int32_t *paramLengths, const int32_t *paramFormats, int32_t resultFormat);
  extern PGresult *PQgetResult(PGconn * conn);

/* Routines for managing an asynchronous query */
  extern int32_t PQisBusy(PGconn * conn);
  extern int32_t PQconsumeInput(PGconn * conn);

/* LISTEN/NOTIFY support */
  extern PGnotify *PQnotifies(PGconn * conn);

/* Routines for copy in/out */
  extern int32_t PQputCopyData(PGconn * conn, const char *buffer, int32_t nbytes);
  extern int32_t PQputCopyEnd(PGconn * conn, const char *errormsg);
  extern int32_t PQgetCopyData(PGconn * conn, char **buffer, int32_t async);

/* Deprecated routines for copy in/out */
  extern int32_t PQgetline(PGconn * conn, char *string, int32_t length);
  extern int32_t PQputline(PGconn * conn, const char *string);
  extern int32_t PQgetlineAsync(PGconn * conn, char *buffer, int32_t bufsize);
  extern int32_t PQputnbytes(PGconn * conn, const char *buffer, int32_t nbytes);
  extern int32_t PQendcopy(PGconn * conn);

/* Set blocking/nonblocking connection to the backend */
  extern int32_t PQsetnonblocking(PGconn * conn, int32_t arg);
  extern int32_t PQisnonblocking(const PGconn * conn);

/* Force the write buffer to be written (or at least try) */
  extern int32_t PQflush(PGconn * conn);

/*
 * "Fast path" interface --- not really recommended for application
 * use
 */
  extern PGresult *PQfn(PGconn * conn, int32_t fnid, int32_t *result_buf, int32_t *result_len, int32_t result_is_int, const PQArgBlock * args, int32_t nargs);

/* Accessor functions for PGresult objects */
  extern ExecStatusType PQresultStatus(const PGresult * res);
  extern char *PQresStatus(ExecStatusType status);
  extern char *PQresultErrorMessage(const PGresult * res);
  extern char *PQresultErrorField(const PGresult * res, int32_t fieldcode);
  extern int32_t PQntuples(const PGresult * res);
  extern int32_t PQnfields(const PGresult * res);
  extern int32_t PQbinaryTuples(const PGresult * res);
  extern char *PQfname(const PGresult * res, int32_t field_num);
  extern int32_t PQfnumber(const PGresult * res, const char *field_name);
  extern Oid PQftable(const PGresult * res, int32_t field_num);
  extern int32_t PQftablecol(const PGresult * res, int32_t field_num);
  extern int32_t PQfformat(const PGresult * res, int32_t field_num);
  extern Oid PQftype(const PGresult * res, int32_t field_num);
  extern int32_t PQfsize(const PGresult * res, int32_t field_num);
  extern int32_t PQfmod(const PGresult * res, int32_t field_num);
  extern char *PQcmdStatus(PGresult * res);
  extern char *PQoidStatus(const PGresult * res);       /* old and ugly */
  extern Oid PQoidValue(const PGresult * res);  /* new and improved */
  extern char *PQcmdTuples(PGresult * res);
  extern char *PQgetvalue(const PGresult * res, int32_t tup_num, int32_t field_num);
  extern int32_t PQgetlength(const PGresult * res, int32_t tup_num, int32_t field_num);
  extern int32_t PQgetisnull(const PGresult * res, int32_t tup_num, int32_t field_num);

/* Delete a PGresult */
  extern void PQclear(PGresult * res);

/* For freeing other alloc'd results, such as PGnotify structs */
  extern void PQfreemem(void *ptr);

/* Exists for backward compatibility.  bjm 2003-03-24 */
#define PQfreeNotify(ptr) PQfreemem(ptr)

/*
 * Make an empty PGresult with given status (some apps find this
 * useful). If conn is not NULL and status indicates an error, the
 * conn's errorMessage is copied.
 */
  extern PGresult *PQmakeEmptyPGresult(PGconn * conn, ExecStatusType status);


/* Quoting strings before inclusion in queries. */
  extern size_t PQescapeString(char *to, const char *from, size_t length);
  extern unsigned char *PQescapeBytea(const unsigned char *bintext, size_t binlen, size_t * bytealen);
  extern unsigned char *PQunescapeBytea(const unsigned char *strtext, size_t * retbuflen);



/* === in fe-print.c === */

  extern void
    PQprint(FILE * fout,        /* output stream */
            const PGresult * res, const PQprintOpt * ps);       /* option structure */

/*
 * really old printing routines
 */
  extern void
    PQdisplayTuples(const PGresult * res, FILE * fp,    /* where to send the output */
                    int32_t fillAlign,      /* pad the fields with spaces */
                    const char *fieldSep,       /* field separator */
                    int32_t printHeader,    /* display headers? */
                    int32_t quiet);

  extern void
    PQprintTuples(const PGresult * res, FILE * fout,    /* output stream */
                  int32_t printAttName,     /* print attribute names */
                  int32_t terseOutput,      /* delimiter bars */
                  int32_t width);   /* width of column, if 0, use variable
                                 * width */


/* === in fe-lobj.c === */

/* Large-object access routines */
  extern int32_t lo_open(PGconn * conn, Oid lobjId, int32_t mode);
  extern int32_t lo_close(PGconn * conn, int32_t fd);
  extern int32_t lo_read(PGconn * conn, int32_t fd, char *buf, size_t len);
  extern int32_t lo_write(PGconn * conn, int32_t fd, char *buf, size_t len);
  extern int32_t lo_lseek(PGconn * conn, int32_t fd, int32_t offset, int32_t whence);
  extern Oid lo_creat(PGconn * conn, int32_t mode);
  extern int32_t lo_tell(PGconn * conn, int32_t fd);
  extern int32_t lo_unlink(PGconn * conn, Oid lobjId);
  extern Oid lo_import(PGconn * conn, const char *filename);
  extern int32_t lo_export(PGconn * conn, Oid lobjId, const char *filename);

/* === in fe-misc.c === */

/* Determine length of multibyte encoded char at *s */
  extern int32_t PQmblen(const unsigned char *s, int32_t encoding);

/* Get encoding id from environment variable PGCLIENTENCODING */
  extern int32_t PQenv2encoding(void);

#ifdef __cplusplus
}
#endif
#endif                          /* LIBPQ_FE_H */