From 477319829c2e7dd5097fe480c803265cba02aede Mon Sep 17 00:00:00 2001 From: Robert Haas Date: Mon, 9 Aug 2010 12:00:24 +0000 Subject: [PATCH] Provide stable target anchors for libpq functions. Daniele Varrazzo --- doc/src/sgml/libpq.sgml | 300 ++++++++++++++++++++-------------------- doc/src/sgml/lobj.sgml | 24 ++-- 2 files changed, 162 insertions(+), 162 deletions(-) diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 60f269f53d..3aa8d553e0 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -1,4 +1,4 @@ - + <application>libpq</application> - C Library @@ -91,7 +91,7 @@ - + PQconnectdbParamsPQconnectdbParams @@ -594,7 +594,7 @@ PGconn *PQconnectdbParams(const char **keywords, const char **values, int expand - + PQconnectdbPQconnectdb @@ -627,7 +627,7 @@ PGconn *PQconnectdb(const char *conninfo); - + PQsetdbLoginPQsetdbLogin @@ -659,7 +659,7 @@ PGconn *PQsetdbLogin(const char *pghost, - + PQsetdbPQsetdb @@ -681,7 +681,7 @@ PGconn *PQsetdb(char *pghost, - + PQconnectStartParamsPQconnectStartParams PQconnectStartPQconnectStart PQconnectPollPQconnectPoll @@ -798,7 +798,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); to provide feedback to the user for example. These statuses are: - + CONNECTION_STARTED @@ -807,7 +807,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_MADE @@ -816,7 +816,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_AWAITING_RESPONSE @@ -825,7 +825,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_AUTH_OK @@ -834,7 +834,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_SSL_STARTUP @@ -843,7 +843,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_SETENV @@ -894,7 +894,7 @@ switch(PQstatus(conn)) - + PQconndefaultsPQconndefaults @@ -940,7 +940,7 @@ typedef struct - + PQconninfoParsePQconninfoParse @@ -985,7 +985,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQfinishPQfinish @@ -1006,7 +1006,7 @@ void PQfinish(PGconn *conn); - + PQresetPQreset @@ -1026,7 +1026,7 @@ void PQreset(PGconn *conn); - + PQresetStartPQresetStart PQresetPollPQresetPoll @@ -1090,7 +1090,7 @@ PostgresPollingStatusType PQresetPoll(PGconn *conn); These values are fixed for the life of the PGconn object. - + PQdb @@ -1108,7 +1108,7 @@ char *PQdb(const PGconn *conn); - + PQuser @@ -1126,7 +1126,7 @@ char *PQuser(const PGconn *conn); - + PQpass @@ -1144,7 +1144,7 @@ char *PQpass(const PGconn *conn); - + PQhost @@ -1162,7 +1162,7 @@ char *PQhost(const PGconn *conn); - + PQport @@ -1181,7 +1181,7 @@ char *PQport(const PGconn *conn); - + PQtty @@ -1203,7 +1203,7 @@ char *PQtty(const PGconn *conn); - + PQoptions @@ -1228,7 +1228,7 @@ char *PQoptions(const PGconn *conn); are executed on the PGconn object. - + PQstatus @@ -1267,7 +1267,7 @@ ConnStatusType PQstatus(const PGconn *conn); - + PQtransactionStatus @@ -1303,7 +1303,7 @@ PGTransactionStatusType PQtransactionStatus(const PGconn *conn); - + PQparameterStatus @@ -1382,7 +1382,7 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName); - + PQprotocolVersion @@ -1409,7 +1409,7 @@ int PQprotocolVersion(const PGconn *conn); - + PQserverVersion @@ -1434,7 +1434,7 @@ int PQserverVersion(const PGconn *conn); - + PQerrorMessage @@ -1468,7 +1468,7 @@ char *PQerrorMessage(const PGconn *conn); - + PQsocketPQsocket @@ -1486,7 +1486,7 @@ int PQsocket(const PGconn *conn); - + PQbackendPIDPQbackendPID @@ -1511,7 +1511,7 @@ int PQbackendPID(const PGconn *conn); - + PQconnectionNeedsPasswordPQconnectionNeedsPassword @@ -1531,7 +1531,7 @@ int PQconnectionNeedsPassword(const PGconn *conn); - + PQconnectionUsedPasswordPQconnectionUsedPassword @@ -1550,7 +1550,7 @@ int PQconnectionUsedPassword(const PGconn *conn); - + PQgetsslPQgetssl @@ -1597,7 +1597,7 @@ SSL *PQgetssl(const PGconn *conn); - + PQexec @@ -1641,7 +1641,7 @@ PGresult *PQexec(PGconn *conn, const char *command); - + PQexecParams @@ -1828,7 +1828,7 @@ SELECT * FROM mytable WHERE x = $1::bigint; - + PQprepare PQprepare @@ -1905,7 +1905,7 @@ PGresult *PQprepare(PGconn *conn, - + PQexecPrepared @@ -1949,7 +1949,7 @@ PGresult *PQexecPrepared(PGconn *conn, - + PQdescribePrepared @@ -1989,7 +1989,7 @@ PGresult *PQdescribePrepared(PGconn *conn, const char *stmtName); - + PQdescribePortal @@ -2042,7 +2042,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); are subject to change in the future. - + PQresultStatus @@ -2062,7 +2062,7 @@ ExecStatusType PQresultStatus(const PGresult *res); PQresultStatus can return one of the following values: - + PGRES_EMPTY_QUERY @@ -2071,7 +2071,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_COMMAND_OK @@ -2080,7 +2080,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_TUPLES_OK @@ -2090,7 +2090,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_COPY_OUT @@ -2099,7 +2099,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_COPY_IN @@ -2108,7 +2108,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_BAD_RESPONSE @@ -2117,7 +2117,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_NONFATAL_ERROR @@ -2126,7 +2126,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_FATAL_ERROR @@ -2157,7 +2157,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PQresStatus @@ -2178,7 +2178,7 @@ char *PQresStatus(ExecStatusType status); - + PQresultErrorMessage @@ -2216,7 +2216,7 @@ char *PQresultErrorMessage(const PGresult *res); - + PQresultErrorFieldPQresultErrorField @@ -2237,7 +2237,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); The following field codes are available: - + PG_DIAG_SEVERITY @@ -2250,7 +2250,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + error codes libpq @@ -2269,7 +2269,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_MESSAGE_PRIMARY @@ -2279,7 +2279,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_MESSAGE_DETAIL @@ -2289,7 +2289,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_MESSAGE_HINT @@ -2301,7 +2301,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_STATEMENT_POSITION @@ -2313,7 +2313,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_INTERNAL_POSITION @@ -2327,7 +2327,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_INTERNAL_QUERY @@ -2337,7 +2337,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_CONTEXT @@ -2349,7 +2349,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_SOURCE_FILE @@ -2359,7 +2359,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_SOURCE_LINE @@ -2369,7 +2369,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_SOURCE_FUNCTION @@ -2403,7 +2403,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PQclearPQclear @@ -2445,7 +2445,7 @@ void PQclear(PGresult *res); - + PQntuples @@ -2467,7 +2467,7 @@ int PQntuples(const PGresult *res); - + PQnfields @@ -2487,7 +2487,7 @@ int PQnfields(const PGresult *res); - + PQfname @@ -2514,7 +2514,7 @@ char *PQfname(const PGresult *res, - + PQfnumber @@ -2555,7 +2555,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQftable @@ -2590,7 +2590,7 @@ Oid PQftable(const PGresult *res, - + PQftablecol @@ -2617,7 +2617,7 @@ int PQftablecol(const PGresult *res, - + PQfformat @@ -2643,7 +2643,7 @@ int PQfformat(const PGresult *res, - + PQftype @@ -2672,7 +2672,7 @@ Oid PQftype(const PGresult *res, - + PQfmod @@ -2700,7 +2700,7 @@ int PQfmod(const PGresult *res, - + PQfsize @@ -2728,7 +2728,7 @@ int PQfsize(const PGresult *res, - + PQbinaryTuples @@ -2756,7 +2756,7 @@ int PQbinaryTuples(const PGresult *res); - + PQgetvalue @@ -2806,7 +2806,7 @@ char *PQgetvalue(const PGresult *res, - + PQgetisnull @@ -2838,7 +2838,7 @@ int PQgetisnull(const PGresult *res, - + PQgetlength @@ -2868,7 +2868,7 @@ int PQgetlength(const PGresult *res, - + PQnparams @@ -2892,7 +2892,7 @@ int PQnparams(const PGresult *res); - + PQparamtype @@ -2917,7 +2917,7 @@ Oid PQparamtype(const PGresult *res, int param_number); - + PQprint @@ -2968,7 +2968,7 @@ typedef struct - + PQcmdStatus @@ -2995,7 +2995,7 @@ char *PQcmdStatus(PGresult *res); - + PQcmdTuples @@ -3029,7 +3029,7 @@ char *PQcmdTuples(PGresult *res); - + PQoidValue @@ -3054,7 +3054,7 @@ Oid PQoidValue(const PGresult *res); - + PQoidStatus @@ -3096,7 +3096,7 @@ char *PQoidStatus(const PGresult *res); - + PQescapeLiteral @@ -3160,7 +3160,7 @@ char *PQescapeLiteral(PGconn *conn, const char *str, size_t length); - + PQescapeIdentifier @@ -3215,7 +3215,7 @@ char *PQescapeIdentifier(PGconn *conn, const char *str, size_t length); - + PQescapeStringConn @@ -3270,7 +3270,7 @@ size_t PQescapeStringConn(PGconn *conn, - + PQescapeString @@ -3306,7 +3306,7 @@ size_t PQescapeString (char *to, const char *from, size_t length); - + PQescapeByteaConn @@ -3372,7 +3372,7 @@ unsigned char *PQescapeByteaConn(PGconn *conn, - + PQescapeBytea @@ -3412,7 +3412,7 @@ unsigned char *PQescapeBytea(const unsigned char *from, - + PQunescapeBytea @@ -3521,7 +3521,7 @@ unsigned char *PQunescapeBytea(const unsigned char *from, size_t *to_length); respectively. - + PQsendQuery @@ -3548,7 +3548,7 @@ int PQsendQuery(PGconn *conn, const char *command); - + PQsendQueryParams @@ -3581,7 +3581,7 @@ int PQsendQueryParams(PGconn *conn, - + PQsendPrepare @@ -3613,7 +3613,7 @@ int PQsendPrepare(PGconn *conn, - + PQsendQueryPrepared @@ -3646,7 +3646,7 @@ int PQsendQueryPrepared(PGconn *conn, - + PQsendDescribePrepared @@ -3673,7 +3673,7 @@ int PQsendDescribePrepared(PGconn *conn, const char *stmtName); - + PQsendDescribePortal @@ -3700,7 +3700,7 @@ int PQsendDescribePortal(PGconn *conn, const char *portalName); - + PQgetResult @@ -3755,7 +3755,7 @@ PGresult *PQgetResult(PGconn *conn); use of two more functions: - + PQconsumeInput @@ -3795,7 +3795,7 @@ int PQconsumeInput(PGconn *conn); - + PQisBusy @@ -3864,7 +3864,7 @@ int PQisBusy(PGconn *conn); can be used. - + PQsetnonblocking @@ -3901,7 +3901,7 @@ int PQsetnonblocking(PGconn *conn, int arg); - + PQisnonblocking @@ -3924,7 +3924,7 @@ int PQisnonblocking(const PGconn *conn); - + PQflush @@ -3972,7 +3972,7 @@ int PQflush(PGconn *conn); this section. - + PQgetCancel @@ -4002,7 +4002,7 @@ PGcancel *PQgetCancel(PGconn *conn); - + PQfreeCancel @@ -4025,7 +4025,7 @@ void PQfreeCancel(PGcancel *cancel); - + PQcancel @@ -4071,7 +4071,7 @@ int PQcancel(PGcancel *cancel, char *errbuf, int errbufsize); - + PQrequestCancel @@ -4343,7 +4343,7 @@ typedef struct pgNotify that are also used in connection with query results: - + PQnfields @@ -4359,7 +4359,7 @@ typedef struct pgNotify - + PQbinaryTuples @@ -4378,7 +4378,7 @@ typedef struct pgNotify - + PQfformat @@ -4419,7 +4419,7 @@ typedef struct pgNotify - + PQputCopyData @@ -4458,7 +4458,7 @@ int PQputCopyData(PGconn *conn, - + PQputCopyEnd @@ -4519,7 +4519,7 @@ int PQputCopyEnd(PGconn *conn, - + PQgetCopyData @@ -4596,7 +4596,7 @@ int PQgetCopyData(PGconn *conn, - + PQgetline @@ -4635,7 +4635,7 @@ int PQgetline(PGconn *conn, - + PQgetlineAsync @@ -4694,7 +4694,7 @@ int PQgetlineAsync(PGconn *conn, - + PQputline @@ -4735,7 +4735,7 @@ int PQputline(PGconn *conn, - + PQputnbytes @@ -4762,7 +4762,7 @@ int PQputnbytes(PGconn *conn, - + PQendcopy @@ -4827,7 +4827,7 @@ int PQendcopy(PGconn *conn); - + PQclientEncoding @@ -4853,7 +4853,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQsetClientEncoding @@ -4877,7 +4877,7 @@ int PQsetClientEncoding(PGconn *conn, const char * - + PQsetErrorVerbosity @@ -4913,7 +4913,7 @@ PGVerbosity PQsetErrorVerbosity(PGconn *conn, PGVerbosity verbosity); - + PQtrace @@ -4943,7 +4943,7 @@ void PQtrace(PGconn *conn, FILE *stream); - + PQuntrace @@ -4972,7 +4972,7 @@ void PQuntrace(PGconn *conn); - + PQfreemem @@ -5005,7 +5005,7 @@ void PQfreemem(void *ptr); - + PQconninfoFree @@ -5029,7 +5029,7 @@ void PQconninfoFree(PQconninfoOption *connOptions); - + PQencryptPassword @@ -5059,7 +5059,7 @@ char * PQencryptPassword(const char *passwd, const char *user); - + PQmakeEmptyPGresult @@ -5096,7 +5096,7 @@ PGresult *PQmakeEmptyPGresult(PGconn *conn, ExecStatusType status); - + PQfireResultCreateEvents @@ -5136,7 +5136,7 @@ int PQfireResultCreateEvents(PGconn *conn, PGresult *res); - + PQcopyResult @@ -5175,7 +5175,7 @@ PGresult *PQcopyResult(const PGresult *src, int flags); - + PQsetResultAttrs @@ -5203,7 +5203,7 @@ int PQsetResultAttrs(PGresult *res, int numAttributes, PGresAttDesc *attDescs); - + PQsetvalue @@ -5237,7 +5237,7 @@ int PQsetvalue(PGresult *res, int tup_num, int field_num, char *value, int len); - + PQresultAlloc @@ -5424,7 +5424,7 @@ defaultNoticeProcessor(void *arg, const char *message) - + PGEVT_REGISTER @@ -5454,7 +5454,7 @@ typedef struct - + PGEVT_CONNRESET @@ -5487,7 +5487,7 @@ typedef struct - + PGEVT_CONNDESTROY @@ -5516,7 +5516,7 @@ typedef struct - + PGEVT_RESULTCREATE @@ -5548,7 +5548,7 @@ typedef struct - + PGEVT_RESULTCOPY @@ -5583,7 +5583,7 @@ typedef struct - + PGEVT_RESULTDESTROY @@ -5618,7 +5618,7 @@ typedef struct Event Callback Procedure - + PGEventProc @@ -5673,7 +5673,7 @@ int eventproc(PGEventId evtId, void *evtInfo, void *passThrough) Event Support Functions - + PQregisterEventProc @@ -5713,7 +5713,7 @@ int PQregisterEventProc(PGconn *conn, PGEventProc proc, - + PQsetInstanceData @@ -5733,7 +5733,7 @@ int PQsetInstanceData(PGconn *conn, PGEventProc proc, void *data); - + PQinstanceData @@ -5752,7 +5752,7 @@ void *PQinstanceData(const PGconn *conn, PGEventProc proc); - + PQresultSetInstanceData @@ -5772,7 +5772,7 @@ int PQresultSetInstanceData(PGresult *res, PGEventProc proc, void *data); - + PQresultInstanceData @@ -6833,7 +6833,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*) - + PQinitOpenSSL @@ -6869,7 +6869,7 @@ void PQinitOpenSSL(int do_ssl, int do_crypto); - + PQinitSSL @@ -6928,7 +6928,7 @@ void PQinitSSL(int do_ssl); - + PQisthreadsafe diff --git a/doc/src/sgml/lobj.sgml b/doc/src/sgml/lobj.sgml index ea7d1c8dce..fd5bac03ed 100644 --- a/doc/src/sgml/lobj.sgml +++ b/doc/src/sgml/lobj.sgml @@ -1,4 +1,4 @@ - + Large Objects @@ -99,7 +99,7 @@ libpq library. - + Creating a Large Object @@ -158,7 +158,7 @@ inv_oid = lo_create(conn, desired_oid); - + Importing a Large Object @@ -200,7 +200,7 @@ Oid lo_import_with_oid(PGconn *conn, const char *filename, Oid lobjId); - + Exporting a Large Object @@ -218,7 +218,7 @@ int lo_export(PGconn *conn, Oid lobjId, const char *filename); - + Opening an Existing Large Object @@ -268,7 +268,7 @@ inv_fd = lo_open(conn, inv_oid, INV_READ|INV_WRITE); - + Writing Data to a Large Object @@ -286,7 +286,7 @@ int lo_write(PGconn *conn, int fd, const char *buf, size_t len); - + Reading Data from a Large Object @@ -304,7 +304,7 @@ int lo_read(PGconn *conn, int fd, char *buf, size_t len); - + Seeking in a Large Object @@ -324,7 +324,7 @@ int lo_lseek(PGconn *conn, int fd, int offset, int whence); - + Obtaining the Seek Position of a Large Object @@ -338,7 +338,7 @@ int lo_tell(PGconn *conn, int fd); - + Truncating a Large Object @@ -370,7 +370,7 @@ int lo_truncate(PGcon *conn, int fd, size_t len); - + Closing a Large Object Descriptor @@ -390,7 +390,7 @@ int lo_close(PGconn *conn, int fd); - + Removing a Large Object -- 2.40.0