From 6d8ae3fa081540fbae447e6250d02f152396eb8c Mon Sep 17 00:00:00 2001 From: Robert Haas Date: Mon, 9 Aug 2010 12:00:39 +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 ad5cb8cce2..a25c4c2151 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 @@ -572,7 +572,7 @@ PGconn *PQconnectdbParams(const char **keywords, const char **values, int expand - + PQconnectdbPQconnectdb @@ -605,7 +605,7 @@ PGconn *PQconnectdb(const char *conninfo); - + PQsetdbLoginPQsetdbLogin @@ -637,7 +637,7 @@ PGconn *PQsetdbLogin(const char *pghost, - + PQsetdbPQsetdb @@ -659,7 +659,7 @@ PGconn *PQsetdb(char *pghost, - + PQconnectStartParamsPQconnectStartParams PQconnectStartPQconnectStart PQconnectPollPQconnectPoll @@ -776,7 +776,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); to provide feedback to the user for example. These statuses are: - + CONNECTION_STARTED @@ -785,7 +785,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_MADE @@ -794,7 +794,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_AWAITING_RESPONSE @@ -803,7 +803,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_AUTH_OK @@ -812,7 +812,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_SSL_STARTUP @@ -821,7 +821,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + CONNECTION_SETENV @@ -872,7 +872,7 @@ switch(PQstatus(conn)) - + PQconndefaultsPQconndefaults @@ -918,7 +918,7 @@ typedef struct - + PQconninfoParsePQconninfoParse @@ -963,7 +963,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQfinishPQfinish @@ -984,7 +984,7 @@ void PQfinish(PGconn *conn); - + PQresetPQreset @@ -1004,7 +1004,7 @@ void PQreset(PGconn *conn); - + PQresetStartPQresetStart PQresetPollPQresetPoll @@ -1068,7 +1068,7 @@ PostgresPollingStatusType PQresetPoll(PGconn *conn); These values are fixed for the life of the PGconn object. - + PQdb @@ -1086,7 +1086,7 @@ char *PQdb(const PGconn *conn); - + PQuser @@ -1104,7 +1104,7 @@ char *PQuser(const PGconn *conn); - + PQpass @@ -1122,7 +1122,7 @@ char *PQpass(const PGconn *conn); - + PQhost @@ -1140,7 +1140,7 @@ char *PQhost(const PGconn *conn); - + PQport @@ -1159,7 +1159,7 @@ char *PQport(const PGconn *conn); - + PQtty @@ -1181,7 +1181,7 @@ char *PQtty(const PGconn *conn); - + PQoptions @@ -1206,7 +1206,7 @@ char *PQoptions(const PGconn *conn); are executed on the PGconn object. - + PQstatus @@ -1245,7 +1245,7 @@ ConnStatusType PQstatus(const PGconn *conn); - + PQtransactionStatus @@ -1281,7 +1281,7 @@ PGTransactionStatusType PQtransactionStatus(const PGconn *conn); - + PQparameterStatus @@ -1360,7 +1360,7 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName); - + PQprotocolVersion @@ -1387,7 +1387,7 @@ int PQprotocolVersion(const PGconn *conn); - + PQserverVersion @@ -1412,7 +1412,7 @@ int PQserverVersion(const PGconn *conn); - + PQerrorMessage @@ -1446,7 +1446,7 @@ char *PQerrorMessage(const PGconn *conn); - + PQsocketPQsocket @@ -1464,7 +1464,7 @@ int PQsocket(const PGconn *conn); - + PQbackendPIDPQbackendPID @@ -1489,7 +1489,7 @@ int PQbackendPID(const PGconn *conn); - + PQconnectionNeedsPasswordPQconnectionNeedsPassword @@ -1509,7 +1509,7 @@ int PQconnectionNeedsPassword(const PGconn *conn); - + PQconnectionUsedPasswordPQconnectionUsedPassword @@ -1528,7 +1528,7 @@ int PQconnectionUsedPassword(const PGconn *conn); - + PQgetsslPQgetssl @@ -1575,7 +1575,7 @@ SSL *PQgetssl(const PGconn *conn); - + PQexec @@ -1619,7 +1619,7 @@ PGresult *PQexec(PGconn *conn, const char *command); - + PQexecParams @@ -1806,7 +1806,7 @@ SELECT * FROM mytable WHERE x = $1::bigint; - + PQprepare PQprepare @@ -1883,7 +1883,7 @@ PGresult *PQprepare(PGconn *conn, - + PQexecPrepared @@ -1927,7 +1927,7 @@ PGresult *PQexecPrepared(PGconn *conn, - + PQdescribePrepared @@ -1967,7 +1967,7 @@ PGresult *PQdescribePrepared(PGconn *conn, const char *stmtName); - + PQdescribePortal @@ -2020,7 +2020,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); are subject to change in the future. - + PQresultStatus @@ -2040,7 +2040,7 @@ ExecStatusType PQresultStatus(const PGresult *res); PQresultStatus can return one of the following values: - + PGRES_EMPTY_QUERY @@ -2049,7 +2049,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_COMMAND_OK @@ -2058,7 +2058,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_TUPLES_OK @@ -2068,7 +2068,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_COPY_OUT @@ -2077,7 +2077,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_COPY_IN @@ -2086,7 +2086,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_BAD_RESPONSE @@ -2095,7 +2095,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_NONFATAL_ERROR @@ -2104,7 +2104,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PGRES_FATAL_ERROR @@ -2135,7 +2135,7 @@ ExecStatusType PQresultStatus(const PGresult *res); - + PQresStatus @@ -2156,7 +2156,7 @@ char *PQresStatus(ExecStatusType status); - + PQresultErrorMessage @@ -2194,7 +2194,7 @@ char *PQresultErrorMessage(const PGresult *res); - + PQresultErrorFieldPQresultErrorField @@ -2215,7 +2215,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); The following field codes are available: - + PG_DIAG_SEVERITY @@ -2228,7 +2228,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + error codes libpq @@ -2247,7 +2247,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_MESSAGE_PRIMARY @@ -2257,7 +2257,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_MESSAGE_DETAIL @@ -2267,7 +2267,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_MESSAGE_HINT @@ -2279,7 +2279,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_STATEMENT_POSITION @@ -2291,7 +2291,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_INTERNAL_POSITION @@ -2305,7 +2305,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_INTERNAL_QUERY @@ -2315,7 +2315,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_CONTEXT @@ -2327,7 +2327,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_SOURCE_FILE @@ -2337,7 +2337,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_SOURCE_LINE @@ -2347,7 +2347,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PG_DIAG_SOURCE_FUNCTION @@ -2381,7 +2381,7 @@ char *PQresultErrorField(const PGresult *res, int fieldcode); - + PQclearPQclear @@ -2423,7 +2423,7 @@ void PQclear(PGresult *res); - + PQntuples @@ -2445,7 +2445,7 @@ int PQntuples(const PGresult *res); - + PQnfields @@ -2465,7 +2465,7 @@ int PQnfields(const PGresult *res); - + PQfname @@ -2492,7 +2492,7 @@ char *PQfname(const PGresult *res, - + PQfnumber @@ -2533,7 +2533,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQftable @@ -2568,7 +2568,7 @@ Oid PQftable(const PGresult *res, - + PQftablecol @@ -2595,7 +2595,7 @@ int PQftablecol(const PGresult *res, - + PQfformat @@ -2621,7 +2621,7 @@ int PQfformat(const PGresult *res, - + PQftype @@ -2650,7 +2650,7 @@ Oid PQftype(const PGresult *res, - + PQfmod @@ -2678,7 +2678,7 @@ int PQfmod(const PGresult *res, - + PQfsize @@ -2706,7 +2706,7 @@ int PQfsize(const PGresult *res, - + PQbinaryTuples @@ -2734,7 +2734,7 @@ int PQbinaryTuples(const PGresult *res); - + PQgetvalue @@ -2784,7 +2784,7 @@ char *PQgetvalue(const PGresult *res, - + PQgetisnull @@ -2816,7 +2816,7 @@ int PQgetisnull(const PGresult *res, - + PQgetlength @@ -2846,7 +2846,7 @@ int PQgetlength(const PGresult *res, - + PQnparams @@ -2870,7 +2870,7 @@ int PQnparams(const PGresult *res); - + PQparamtype @@ -2895,7 +2895,7 @@ Oid PQparamtype(const PGresult *res, int param_number); - + PQprint @@ -2946,7 +2946,7 @@ typedef struct - + PQcmdStatus @@ -2973,7 +2973,7 @@ char *PQcmdStatus(PGresult *res); - + PQcmdTuples @@ -3007,7 +3007,7 @@ char *PQcmdTuples(PGresult *res); - + PQoidValue @@ -3032,7 +3032,7 @@ Oid PQoidValue(const PGresult *res); - + PQoidStatus @@ -3074,7 +3074,7 @@ char *PQoidStatus(const PGresult *res); - + PQescapeLiteral @@ -3138,7 +3138,7 @@ char *PQescapeLiteral(PGconn *conn, const char *str, size_t length); - + PQescapeIdentifier @@ -3193,7 +3193,7 @@ char *PQescapeIdentifier(PGconn *conn, const char *str, size_t length); - + PQescapeStringConn @@ -3248,7 +3248,7 @@ size_t PQescapeStringConn(PGconn *conn, - + PQescapeString @@ -3284,7 +3284,7 @@ size_t PQescapeString (char *to, const char *from, size_t length); - + PQescapeByteaConn @@ -3350,7 +3350,7 @@ unsigned char *PQescapeByteaConn(PGconn *conn, - + PQescapeBytea @@ -3390,7 +3390,7 @@ unsigned char *PQescapeBytea(const unsigned char *from, - + PQunescapeBytea @@ -3499,7 +3499,7 @@ unsigned char *PQunescapeBytea(const unsigned char *from, size_t *to_length); respectively. - + PQsendQuery @@ -3526,7 +3526,7 @@ int PQsendQuery(PGconn *conn, const char *command); - + PQsendQueryParams @@ -3559,7 +3559,7 @@ int PQsendQueryParams(PGconn *conn, - + PQsendPrepare @@ -3591,7 +3591,7 @@ int PQsendPrepare(PGconn *conn, - + PQsendQueryPrepared @@ -3624,7 +3624,7 @@ int PQsendQueryPrepared(PGconn *conn, - + PQsendDescribePrepared @@ -3651,7 +3651,7 @@ int PQsendDescribePrepared(PGconn *conn, const char *stmtName); - + PQsendDescribePortal @@ -3678,7 +3678,7 @@ int PQsendDescribePortal(PGconn *conn, const char *portalName); - + PQgetResult @@ -3733,7 +3733,7 @@ PGresult *PQgetResult(PGconn *conn); use of two more functions: - + PQconsumeInput @@ -3773,7 +3773,7 @@ int PQconsumeInput(PGconn *conn); - + PQisBusy @@ -3842,7 +3842,7 @@ int PQisBusy(PGconn *conn); can be used. - + PQsetnonblocking @@ -3879,7 +3879,7 @@ int PQsetnonblocking(PGconn *conn, int arg); - + PQisnonblocking @@ -3902,7 +3902,7 @@ int PQisnonblocking(const PGconn *conn); - + PQflush @@ -3950,7 +3950,7 @@ int PQflush(PGconn *conn); this section. - + PQgetCancel @@ -3980,7 +3980,7 @@ PGcancel *PQgetCancel(PGconn *conn); - + PQfreeCancel @@ -4003,7 +4003,7 @@ void PQfreeCancel(PGcancel *cancel); - + PQcancel @@ -4049,7 +4049,7 @@ int PQcancel(PGcancel *cancel, char *errbuf, int errbufsize); - + PQrequestCancel @@ -4321,7 +4321,7 @@ typedef struct pgNotify that are also used in connection with query results: - + PQnfields @@ -4337,7 +4337,7 @@ typedef struct pgNotify - + PQbinaryTuples @@ -4356,7 +4356,7 @@ typedef struct pgNotify - + PQfformat @@ -4397,7 +4397,7 @@ typedef struct pgNotify - + PQputCopyData @@ -4436,7 +4436,7 @@ int PQputCopyData(PGconn *conn, - + PQputCopyEnd @@ -4497,7 +4497,7 @@ int PQputCopyEnd(PGconn *conn, - + PQgetCopyData @@ -4574,7 +4574,7 @@ int PQgetCopyData(PGconn *conn, - + PQgetline @@ -4613,7 +4613,7 @@ int PQgetline(PGconn *conn, - + PQgetlineAsync @@ -4672,7 +4672,7 @@ int PQgetlineAsync(PGconn *conn, - + PQputline @@ -4713,7 +4713,7 @@ int PQputline(PGconn *conn, - + PQputnbytes @@ -4740,7 +4740,7 @@ int PQputnbytes(PGconn *conn, - + PQendcopy @@ -4805,7 +4805,7 @@ int PQendcopy(PGconn *conn); - + PQclientEncoding @@ -4831,7 +4831,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQsetClientEncoding @@ -4855,7 +4855,7 @@ int PQsetClientEncoding(PGconn *conn, const char * - + PQsetErrorVerbosity @@ -4891,7 +4891,7 @@ PGVerbosity PQsetErrorVerbosity(PGconn *conn, PGVerbosity verbosity); - + PQtrace @@ -4921,7 +4921,7 @@ void PQtrace(PGconn *conn, FILE *stream); - + PQuntrace @@ -4950,7 +4950,7 @@ void PQuntrace(PGconn *conn); - + PQfreemem @@ -4983,7 +4983,7 @@ void PQfreemem(void *ptr); - + PQconninfoFree @@ -5007,7 +5007,7 @@ void PQconninfoFree(PQconninfoOption *connOptions); - + PQencryptPassword @@ -5037,7 +5037,7 @@ char * PQencryptPassword(const char *passwd, const char *user); - + PQmakeEmptyPGresult @@ -5074,7 +5074,7 @@ PGresult *PQmakeEmptyPGresult(PGconn *conn, ExecStatusType status); - + PQfireResultCreateEvents @@ -5114,7 +5114,7 @@ int PQfireResultCreateEvents(PGconn *conn, PGresult *res); - + PQcopyResult @@ -5153,7 +5153,7 @@ PGresult *PQcopyResult(const PGresult *src, int flags); - + PQsetResultAttrs @@ -5181,7 +5181,7 @@ int PQsetResultAttrs(PGresult *res, int numAttributes, PGresAttDesc *attDescs); - + PQsetvalue @@ -5215,7 +5215,7 @@ int PQsetvalue(PGresult *res, int tup_num, int field_num, char *value, int len); - + PQresultAlloc @@ -5402,7 +5402,7 @@ defaultNoticeProcessor(void *arg, const char *message) - + PGEVT_REGISTER @@ -5432,7 +5432,7 @@ typedef struct - + PGEVT_CONNRESET @@ -5465,7 +5465,7 @@ typedef struct - + PGEVT_CONNDESTROY @@ -5494,7 +5494,7 @@ typedef struct - + PGEVT_RESULTCREATE @@ -5526,7 +5526,7 @@ typedef struct - + PGEVT_RESULTCOPY @@ -5561,7 +5561,7 @@ typedef struct - + PGEVT_RESULTDESTROY @@ -5596,7 +5596,7 @@ typedef struct Event Callback Procedure - + PGEventProc @@ -5651,7 +5651,7 @@ int eventproc(PGEventId evtId, void *evtInfo, void *passThrough) Event Support Functions - + PQregisterEventProc @@ -5691,7 +5691,7 @@ int PQregisterEventProc(PGconn *conn, PGEventProc proc, - + PQsetInstanceData @@ -5711,7 +5711,7 @@ int PQsetInstanceData(PGconn *conn, PGEventProc proc, void *data); - + PQinstanceData @@ -5730,7 +5730,7 @@ void *PQinstanceData(const PGconn *conn, PGEventProc proc); - + PQresultSetInstanceData @@ -5750,7 +5750,7 @@ int PQresultSetInstanceData(PGresult *res, PGEventProc proc, void *data); - + PQresultInstanceData @@ -6801,7 +6801,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*) - + PQinitOpenSSL @@ -6837,7 +6837,7 @@ void PQinitOpenSSL(int do_ssl, int do_crypto); - + PQinitSSL @@ -6896,7 +6896,7 @@ void PQinitSSL(int do_ssl); - + PQisthreadsafe diff --git a/doc/src/sgml/lobj.sgml b/doc/src/sgml/lobj.sgml index ea7d1c8dce..32efd81841 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