granicus.if.org Git - postgresql/blob - src/interfaces/libpq/libpq-fe.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * libpq-fe.h
   4  *        This file contains definitions for structures and
   5  *        externs for functions used by frontend postgres applications.
   6  *
   7  * Portions Copyright (c) 1996-2012, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * src/interfaces/libpq/libpq-fe.h
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14
  15 #ifndef LIBPQ_FE_H
  16 #define LIBPQ_FE_H
  17
  18 #ifdef __cplusplus
  19 extern          "C"
  20 {
  21 #endif
  22
  23 #include <stdio.h>
  24
  25 /*
  26  * postgres_ext.h defines the backend's externally visible types,
  27  * such as Oid.
  28  */
  29 #include "postgres_ext.h"
  30
  31 /*
  32  * Option flags for PQcopyResult
  33  */
  34 #define PG_COPYRES_ATTRS                  0x01
  35 #define PG_COPYRES_TUPLES                 0x02  /* Implies PG_COPYRES_ATTRS */
  36 #define PG_COPYRES_EVENTS                 0x04
  37 #define PG_COPYRES_NOTICEHOOKS    0x08
  38
  39 /* Application-visible enum types */
  40
  41 /*
  42  * Although it is okay to add to these lists, values which become unused
  43  * should never be removed, nor should constants be redefined - that would
  44  * break compatibility with existing code.
  45  */
  46
  47 typedef enum
  48 {
  49         CONNECTION_OK,
  50         CONNECTION_BAD,
  51         /* Non-blocking mode only below here */
  52
  53         /*
  54          * The existence of these should never be relied upon - they should only
  55          * be used for user feedback or similar purposes.
  56          */
  57         CONNECTION_STARTED,                     /* Waiting for connection to be made.  */
  58         CONNECTION_MADE,                        /* Connection OK; waiting to send.         */
  59         CONNECTION_AWAITING_RESPONSE,           /* Waiting for a response from the
  60                                                                                  * postmaster.            */
  61         CONNECTION_AUTH_OK,                     /* Received authentication; waiting for
  62                                                                  * backend startup. */
  63         CONNECTION_SETENV,                      /* Negotiating environment. */
  64         CONNECTION_SSL_STARTUP,         /* Negotiating SSL. */
  65         CONNECTION_NEEDED                       /* Internal state: connect() needed */
  66 } ConnStatusType;
  67
  68 typedef enum
  69 {
  70         PGRES_POLLING_FAILED = 0,
  71         PGRES_POLLING_READING,          /* These two indicate that one may        */
  72         PGRES_POLLING_WRITING,          /* use select before polling again.   */
  73         PGRES_POLLING_OK,
  74         PGRES_POLLING_ACTIVE            /* unused; keep for awhile for backwards
  75                                                                  * compatibility */
  76 } PostgresPollingStatusType;
  77
  78 typedef enum
  79 {
  80         PGRES_EMPTY_QUERY = 0,          /* empty query string was executed */
  81         PGRES_COMMAND_OK,                       /* a query command that doesn't return
  82                                                                  * anything was executed properly by the
  83                                                                  * backend */
  84         PGRES_TUPLES_OK,                        /* a query command that returns tuples was
  85                                                                  * executed properly by the backend, PGresult
  86                                                                  * contains the result tuples */
  87         PGRES_COPY_OUT,                         /* Copy Out data transfer in progress */
  88         PGRES_COPY_IN,                          /* Copy In data transfer in progress */
  89         PGRES_BAD_RESPONSE,                     /* an unexpected response was recv'd from the
  90                                                                  * backend */
  91         PGRES_NONFATAL_ERROR,           /* notice or warning message */
  92         PGRES_FATAL_ERROR,                      /* query failed */
  93         PGRES_COPY_BOTH,                        /* Copy In/Out data transfer in progress */
  94         PGRES_SINGLE_TUPLE                      /* single tuple from larger resultset */
  95 } ExecStatusType;
  96
  97 typedef enum
  98 {
  99         PQTRANS_IDLE,                           /* connection idle */
 100         PQTRANS_ACTIVE,                         /* command in progress */
 101         PQTRANS_INTRANS,                        /* idle, within transaction block */
 102         PQTRANS_INERROR,                        /* idle, within failed transaction */
 103         PQTRANS_UNKNOWN                         /* cannot determine status */
 104 } PGTransactionStatusType;
 105
 106 typedef enum
 107 {
 108         PQERRORS_TERSE,                         /* single-line error messages */
 109         PQERRORS_DEFAULT,                       /* recommended style */
 110         PQERRORS_VERBOSE                        /* all the facts, ma'am */
 111 } PGVerbosity;
 112
 113 typedef enum
 114 {
 115         PQPING_OK,                                      /* server is accepting connections */
 116         PQPING_REJECT,                          /* server is alive but rejecting connections */
 117         PQPING_NO_RESPONSE,                     /* could not establish connection */
 118         PQPING_NO_ATTEMPT                       /* connection not attempted (bad params) */
 119 } PGPing;
 120
 121 /* PGconn encapsulates a connection to the backend.
 122  * The contents of this struct are not supposed to be known to applications.
 123  */
 124 typedef struct pg_conn PGconn;
 125
 126 /* PGresult encapsulates the result of a query (or more precisely, of a single
 127  * SQL command --- a query string given to PQsendQuery can contain multiple
 128  * commands and thus return multiple PGresult objects).
 129  * The contents of this struct are not supposed to be known to applications.
 130  */
 131 typedef struct pg_result PGresult;
 132
 133 /* PGcancel encapsulates the information needed to cancel a running
 134  * query on an existing connection.
 135  * The contents of this struct are not supposed to be known to applications.
 136  */
 137 typedef struct pg_cancel PGcancel;
 138
 139 /* PGnotify represents the occurrence of a NOTIFY message.
 140  * Ideally this would be an opaque typedef, but it's so simple that it's
 141  * unlikely to change.
 142  * NOTE: in Postgres 6.4 and later, the be_pid is the notifying backend's,
 143  * whereas in earlier versions it was always your own backend's PID.
 144  */
 145 typedef struct pgNotify
 146 {
 147         char       *relname;            /* notification condition name */
 148         int                     be_pid;                 /* process ID of notifying server process */
 149         char       *extra;                      /* notification parameter */
 150         /* Fields below here are private to libpq; apps should not use 'em */
 151         struct pgNotify *next;          /* list link */
 152 } PGnotify;
 153
 154 /* Function types for notice-handling callbacks */
 155 typedef void (*PQnoticeReceiver) (void *arg, const PGresult *res);
 156 typedef void (*PQnoticeProcessor) (void *arg, const char *message);
 157
 158 /* Print options for PQprint() */
 159 typedef char pqbool;
 160
 161 typedef struct _PQprintOpt
 162 {
 163         pqbool          header;                 /* print output field headings and row count */
 164         pqbool          align;                  /* fill align the fields */
 165         pqbool          standard;               /* old brain dead format */
 166         pqbool          html3;                  /* output html tables */
 167         pqbool          expanded;               /* expand tables */
 168         pqbool          pager;                  /* use pager for output if needed */
 169         char       *fieldSep;           /* field separator */
 170         char       *tableOpt;           /* insert to HTML <table ...> */
 171         char       *caption;            /* HTML <caption> */
 172         char      **fieldName;          /* null terminated array of replacement field
 173                                                                  * names */
 174 } PQprintOpt;
 175
 176 /* ----------------
 177  * Structure for the conninfo parameter definitions returned by PQconndefaults
 178  * or PQconninfoParse.
 179  *
 180  * All fields except "val" point at static strings which must not be altered.
 181  * "val" is either NULL or a malloc'd current-value string.  PQconninfoFree()
 182  * will release both the val strings and the PQconninfoOption array itself.
 183  * ----------------
 184  */
 185 typedef struct _PQconninfoOption
 186 {
 187         char       *keyword;            /* The keyword of the option                    */
 188         char       *envvar;                     /* Fallback environment variable name   */
 189         char       *compiled;           /* Fallback compiled in default value   */
 190         char       *val;                        /* Option's current value, or NULL               */
 191         char       *label;                      /* Label for field in connect dialog    */
 192         char       *dispchar;           /* Indicates how to display this field in a
 193                                                                  * connect dialog. Values are: "" Display
 194                                                                  * entered value as is "*" Password field -
 195                                                                  * hide value "D"  Debug option - don't show
 196                                                                  * by default */
 197         int                     dispsize;               /* Field size in characters for dialog  */
 198 } PQconninfoOption;
 199
 200 /* ----------------
 201  * PQArgBlock -- structure for PQfn() arguments
 202  * ----------------
 203  */
 204 typedef struct
 205 {
 206         int                     len;
 207         int                     isint;
 208         union
 209         {
 210                 int                *ptr;                /* can't use void (dec compiler barfs)   */
 211                 int                     integer;
 212         }                       u;
 213 } PQArgBlock;
 214
 215 /* ----------------
 216  * PGresAttDesc -- Data about a single attribute (column) of a query result
 217  * ----------------
 218  */
 219 typedef struct pgresAttDesc
 220 {
 221         char       *name;                       /* column name */
 222         Oid                     tableid;                /* source table, if known */
 223         int                     columnid;               /* source column, if known */
 224         int                     format;                 /* format code for value (text/binary) */
 225         Oid                     typid;                  /* type id */
 226         int                     typlen;                 /* type size */
 227         int                     atttypmod;              /* type-specific modifier info */
 228 } PGresAttDesc;
 229
 230 /* ----------------
 231  * Exported functions of libpq
 232  * ----------------
 233  */
 234
 235 /* ===  in fe-connect.c === */
 236
 237 /* make a new client connection to the backend */
 238 /* Asynchronous (non-blocking) */
 239 extern PGconn *PQconnectStart(const char *conninfo);
 240 extern PGconn *PQconnectStartParams(const char *const * keywords,
 241                                          const char *const * values, int expand_dbname);
 242 extern PostgresPollingStatusType PQconnectPoll(PGconn *conn);
 243
 244 /* Synchronous (blocking) */
 245 extern PGconn *PQconnectdb(const char *conninfo);
 246 extern PGconn *PQconnectdbParams(const char *const * keywords,
 247                                   const char *const * values, int expand_dbname);
 248 extern PGconn *PQsetdbLogin(const char *pghost, const char *pgport,
 249                          const char *pgoptions, const char *pgtty,
 250                          const char *dbName,
 251                          const char *login, const char *pwd);
 252
 253 #define PQsetdb(M_PGHOST,M_PGPORT,M_PGOPT,M_PGTTY,M_DBNAME)  \
 254         PQsetdbLogin(M_PGHOST, M_PGPORT, M_PGOPT, M_PGTTY, M_DBNAME, NULL, NULL)
 255
 256 /* close the current connection and free the PGconn data structure */
 257 extern void PQfinish(PGconn *conn);
 258
 259 /* get info about connection options known to PQconnectdb */
 260 extern PQconninfoOption *PQconndefaults(void);
 261
 262 /* parse connection options in same way as PQconnectdb */
 263 extern PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg);
 264
 265 /* free the data structure returned by PQconndefaults() or PQconninfoParse() */
 266 extern void PQconninfoFree(PQconninfoOption *connOptions);
 267
 268 /*
 269  * close the current connection and restablish a new one with the same
 270  * parameters
 271  */
 272 /* Asynchronous (non-blocking) */
 273 extern int      PQresetStart(PGconn *conn);
 274 extern PostgresPollingStatusType PQresetPoll(PGconn *conn);
 275
 276 /* Synchronous (blocking) */
 277 extern void PQreset(PGconn *conn);
 278
 279 /* request a cancel structure */
 280 extern PGcancel *PQgetCancel(PGconn *conn);
 281
 282 /* free a cancel structure */
 283 extern void PQfreeCancel(PGcancel *cancel);
 284
 285 /* issue a cancel request */
 286 extern int      PQcancel(PGcancel *cancel, char *errbuf, int errbufsize);
 287
 288 /* backwards compatible version of PQcancel; not thread-safe */
 289 extern int      PQrequestCancel(PGconn *conn);
 290
 291 /* Accessor functions for PGconn objects */
 292 extern char *PQdb(const PGconn *conn);
 293 extern char *PQuser(const PGconn *conn);
 294 extern char *PQpass(const PGconn *conn);
 295 extern char *PQhost(const PGconn *conn);
 296 extern char *PQport(const PGconn *conn);
 297 extern char *PQtty(const PGconn *conn);
 298 extern char *PQoptions(const PGconn *conn);
 299 extern ConnStatusType PQstatus(const PGconn *conn);
 300 extern PGTransactionStatusType PQtransactionStatus(const PGconn *conn);
 301 extern const char *PQparameterStatus(const PGconn *conn,
 302                                   const char *paramName);
 303 extern int      PQprotocolVersion(const PGconn *conn);
 304 extern int      PQserverVersion(const PGconn *conn);
 305 extern char *PQerrorMessage(const PGconn *conn);
 306 extern int      PQsocket(const PGconn *conn);
 307 extern int      PQbackendPID(const PGconn *conn);
 308 extern int      PQconnectionNeedsPassword(const PGconn *conn);
 309 extern int      PQconnectionUsedPassword(const PGconn *conn);
 310 extern int      PQclientEncoding(const PGconn *conn);
 311 extern int      PQsetClientEncoding(PGconn *conn, const char *encoding);
 312
 313 /* Get the OpenSSL structure associated with a connection. Returns NULL for
 314  * unencrypted connections or if any other TLS library is in use. */
 315 extern void *PQgetssl(PGconn *conn);
 316
 317 /* Tell libpq whether it needs to initialize OpenSSL */
 318 extern void PQinitSSL(int do_init);
 319
 320 /* More detailed way to tell libpq whether it needs to initialize OpenSSL */
 321 extern void PQinitOpenSSL(int do_ssl, int do_crypto);
 322
 323 /* Set verbosity for PQerrorMessage and PQresultErrorMessage */
 324 extern PGVerbosity PQsetErrorVerbosity(PGconn *conn, PGVerbosity verbosity);
 325
 326 /* Enable/disable tracing */
 327 extern void PQtrace(PGconn *conn, FILE *debug_port);
 328 extern void PQuntrace(PGconn *conn);
 329
 330 /* Override default notice handling routines */
 331 extern PQnoticeReceiver PQsetNoticeReceiver(PGconn *conn,
 332                                         PQnoticeReceiver proc,
 333                                         void *arg);
 334 extern PQnoticeProcessor PQsetNoticeProcessor(PGconn *conn,
 335                                          PQnoticeProcessor proc,
 336                                          void *arg);
 337
 338 /*
 339  *         Used to set callback that prevents concurrent access to
 340  *         non-thread safe functions that libpq needs.
 341  *         The default implementation uses a libpq internal mutex.
 342  *         Only required for multithreaded apps that use kerberos
 343  *         both within their app and for postgresql connections.
 344  */
 345 typedef void (*pgthreadlock_t) (int acquire);
 346
 347 extern pgthreadlock_t PQregisterThreadLock(pgthreadlock_t newhandler);
 348
 349 /* === in fe-exec.c === */
 350
 351 /* Simple synchronous query */
 352 extern PGresult *PQexec(PGconn *conn, const char *query);
 353 extern PGresult *PQexecParams(PGconn *conn,
 354                          const char *command,
 355                          int nParams,
 356                          const Oid *paramTypes,
 357                          const char *const * paramValues,
 358                          const int *paramLengths,
 359                          const int *paramFormats,
 360                          int resultFormat);
 361 extern PGresult *PQprepare(PGconn *conn, const char *stmtName,
 362                   const char *query, int nParams,
 363                   const Oid *paramTypes);
 364 extern PGresult *PQexecPrepared(PGconn *conn,
 365                            const char *stmtName,
 366                            int nParams,
 367                            const char *const * paramValues,
 368                            const int *paramLengths,
 369                            const int *paramFormats,
 370                            int resultFormat);
 371
 372 /* Interface for multiple-result or asynchronous queries */
 373 extern int      PQsendQuery(PGconn *conn, const char *query);
 374 extern int PQsendQueryParams(PGconn *conn,
 375                                   const char *command,
 376                                   int nParams,
 377                                   const Oid *paramTypes,
 378                                   const char *const * paramValues,
 379                                   const int *paramLengths,
 380                                   const int *paramFormats,
 381                                   int resultFormat);
 382 extern int PQsendPrepare(PGconn *conn, const char *stmtName,
 383                           const char *query, int nParams,
 384                           const Oid *paramTypes);
 385 extern int PQsendQueryPrepared(PGconn *conn,
 386                                         const char *stmtName,
 387                                         int nParams,
 388                                         const char *const * paramValues,
 389                                         const int *paramLengths,
 390                                         const int *paramFormats,
 391                                         int resultFormat);
 392 extern int      PQsetSingleRowMode(PGconn *conn);
 393 extern PGresult *PQgetResult(PGconn *conn);
 394
 395 /* Routines for managing an asynchronous query */
 396 extern int      PQisBusy(PGconn *conn);
 397 extern int      PQconsumeInput(PGconn *conn);
 398
 399 /* LISTEN/NOTIFY support */
 400 extern PGnotify *PQnotifies(PGconn *conn);
 401
 402 /* Routines for copy in/out */
 403 extern int      PQputCopyData(PGconn *conn, const char *buffer, int nbytes);
 404 extern int      PQputCopyEnd(PGconn *conn, const char *errormsg);
 405 extern int      PQgetCopyData(PGconn *conn, char **buffer, int async);
 406
 407 /* Deprecated routines for copy in/out */
 408 extern int      PQgetline(PGconn *conn, char *string, int length);
 409 extern int      PQputline(PGconn *conn, const char *string);
 410 extern int      PQgetlineAsync(PGconn *conn, char *buffer, int bufsize);
 411 extern int      PQputnbytes(PGconn *conn, const char *buffer, int nbytes);
 412 extern int      PQendcopy(PGconn *conn);
 413
 414 /* Set blocking/nonblocking connection to the backend */
 415 extern int      PQsetnonblocking(PGconn *conn, int arg);
 416 extern int      PQisnonblocking(const PGconn *conn);
 417 extern int      PQisthreadsafe(void);
 418 extern PGPing PQping(const char *conninfo);
 419 extern PGPing PQpingParams(const char *const * keywords,
 420                          const char *const * values, int expand_dbname);
 421
 422 /* Force the write buffer to be written (or at least try) */
 423 extern int      PQflush(PGconn *conn);
 424
 425 /*
 426  * "Fast path" interface --- not really recommended for application
 427  * use
 428  */
 429 extern PGresult *PQfn(PGconn *conn,
 430          int fnid,
 431          int *result_buf,
 432          int *result_len,
 433          int result_is_int,
 434          const PQArgBlock *args,
 435          int nargs);
 436
 437 /* Accessor functions for PGresult objects */
 438 extern ExecStatusType PQresultStatus(const PGresult *res);
 439 extern char *PQresStatus(ExecStatusType status);
 440 extern char *PQresultErrorMessage(const PGresult *res);
 441 extern char *PQresultErrorField(const PGresult *res, int fieldcode);
 442 extern int      PQntuples(const PGresult *res);
 443 extern int      PQnfields(const PGresult *res);
 444 extern int      PQbinaryTuples(const PGresult *res);
 445 extern char *PQfname(const PGresult *res, int field_num);
 446 extern int      PQfnumber(const PGresult *res, const char *field_name);
 447 extern Oid      PQftable(const PGresult *res, int field_num);
 448 extern int      PQftablecol(const PGresult *res, int field_num);
 449 extern int      PQfformat(const PGresult *res, int field_num);
 450 extern Oid      PQftype(const PGresult *res, int field_num);
 451 extern int      PQfsize(const PGresult *res, int field_num);
 452 extern int      PQfmod(const PGresult *res, int field_num);
 453 extern char *PQcmdStatus(PGresult *res);
 454 extern char *PQoidStatus(const PGresult *res);  /* old and ugly */
 455 extern Oid      PQoidValue(const PGresult *res);        /* new and improved */
 456 extern char *PQcmdTuples(PGresult *res);
 457 extern char *PQgetvalue(const PGresult *res, int tup_num, int field_num);
 458 extern int      PQgetlength(const PGresult *res, int tup_num, int field_num);
 459 extern int      PQgetisnull(const PGresult *res, int tup_num, int field_num);
 460 extern int      PQnparams(const PGresult *res);
 461 extern Oid      PQparamtype(const PGresult *res, int param_num);
 462
 463 /* Describe prepared statements and portals */
 464 extern PGresult *PQdescribePrepared(PGconn *conn, const char *stmt);
 465 extern PGresult *PQdescribePortal(PGconn *conn, const char *portal);
 466 extern int      PQsendDescribePrepared(PGconn *conn, const char *stmt);
 467 extern int      PQsendDescribePortal(PGconn *conn, const char *portal);
 468
 469 /* Delete a PGresult */
 470 extern void PQclear(PGresult *res);
 471
 472 /* For freeing other alloc'd results, such as PGnotify structs */
 473 extern void PQfreemem(void *ptr);
 474
 475 /* Exists for backward compatibility.  bjm 2003-03-24 */
 476 #define PQfreeNotify(ptr) PQfreemem(ptr)
 477
 478 /* Error when no password was given. */
 479 /* Note: depending on this is deprecated; use PQconnectionNeedsPassword(). */
 480 #define PQnoPasswordSupplied    "fe_sendauth: no password supplied\n"
 481
 482 /* Create and manipulate PGresults */
 483 extern PGresult *PQmakeEmptyPGresult(PGconn *conn, ExecStatusType status);
 484 extern PGresult *PQcopyResult(const PGresult *src, int flags);
 485 extern int      PQsetResultAttrs(PGresult *res, int numAttributes, PGresAttDesc *attDescs);
 486 extern void *PQresultAlloc(PGresult *res, size_t nBytes);
 487 extern int      PQsetvalue(PGresult *res, int tup_num, int field_num, char *value, int len);
 488
 489 /* Quoting strings before inclusion in queries. */
 490 extern size_t PQescapeStringConn(PGconn *conn,
 491                                    char *to, const char *from, size_t length,
 492                                    int *error);
 493 extern char *PQescapeLiteral(PGconn *conn, const char *str, size_t len);
 494 extern char *PQescapeIdentifier(PGconn *conn, const char *str, size_t len);
 495 extern unsigned char *PQescapeByteaConn(PGconn *conn,
 496                                   const unsigned char *from, size_t from_length,
 497                                   size_t *to_length);
 498 extern unsigned char *PQunescapeBytea(const unsigned char *strtext,
 499                                 size_t *retbuflen);
 500
 501 /* These forms are deprecated! */
 502 extern size_t PQescapeString(char *to, const char *from, size_t length);
 503 extern unsigned char *PQescapeBytea(const unsigned char *from, size_t from_length,
 504                           size_t *to_length);
 505
 506
 507
 508 /* === in fe-print.c === */
 509
 510 extern void PQprint(FILE *fout,                         /* output stream */
 511                 const PGresult *res,
 512                 const PQprintOpt *ps);  /* option structure */
 513
 514 /*
 515  * really old printing routines
 516  */
 517 extern void PQdisplayTuples(const PGresult *res,
 518                                 FILE *fp,               /* where to send the output */
 519                                 int fillAlign,  /* pad the fields with spaces */
 520                                 const char *fieldSep,   /* field separator */
 521                                 int printHeader,        /* display headers? */
 522                                 int quiet);
 523
 524 extern void PQprintTuples(const PGresult *res,
 525                           FILE *fout,           /* output stream */
 526                           int printAttName, /* print attribute names */
 527                           int terseOutput,      /* delimiter bars */
 528                           int width);           /* width of column, if 0, use variable width */
 529
 530
 531 /* === in fe-lobj.c === */
 532
 533 /* Large-object access routines */
 534 extern int      lo_open(PGconn *conn, Oid lobjId, int mode);
 535 extern int      lo_close(PGconn *conn, int fd);
 536 extern int      lo_read(PGconn *conn, int fd, char *buf, size_t len);
 537 extern int      lo_write(PGconn *conn, int fd, const char *buf, size_t len);
 538 extern int      lo_lseek(PGconn *conn, int fd, int offset, int whence);
 539 extern pg_int64 lo_lseek64(PGconn *conn, int fd, pg_int64 offset, int whence);
 540 extern Oid      lo_creat(PGconn *conn, int mode);
 541 extern Oid      lo_create(PGconn *conn, Oid lobjId);
 542 extern int      lo_tell(PGconn *conn, int fd);
 543 extern pg_int64 lo_tell64(PGconn *conn, int fd);
 544 extern int      lo_truncate(PGconn *conn, int fd, size_t len);
 545 extern int      lo_truncate64(PGconn *conn, int fd, pg_int64 len);
 546 extern int      lo_unlink(PGconn *conn, Oid lobjId);
 547 extern Oid      lo_import(PGconn *conn, const char *filename);
 548 extern Oid      lo_import_with_oid(PGconn *conn, const char *filename, Oid lobjId);
 549 extern int      lo_export(PGconn *conn, Oid lobjId, const char *filename);
 550
 551 /* === in fe-misc.c === */
 552
 553 /* Get the version of the libpq library in use */
 554 extern int      PQlibVersion(void);
 555
 556 /* Determine length of multibyte encoded char at *s */
 557 extern int      PQmblen(const char *s, int encoding);
 558
 559 /* Determine display length of multibyte encoded char at *s */
 560 extern int      PQdsplen(const char *s, int encoding);
 561
 562 /* Get encoding id from environment variable PGCLIENTENCODING */
 563 extern int      PQenv2encoding(void);
 564
 565 /* === in fe-auth.c === */
 566
 567 extern char *PQencryptPassword(const char *passwd, const char *user);
 568
 569 /* === in encnames.c === */
 570
 571 extern int      pg_char_to_encoding(const char *name);
 572 extern const char *pg_encoding_to_char(int encoding);
 573 extern int      pg_valid_server_encoding_id(int encoding);
 574
 575 #ifdef __cplusplus
 576 }
 577 #endif
 578
 579 #endif   /* LIBPQ_FE_H */