From 4e49ea084e190eb43561e96fa32a580e0054d9b5 Mon Sep 17 00:00:00 2001 From: Robert Haas Date: Mon, 9 Aug 2010 12:00:53 +0000 Subject: [PATCH] Provide stable target anchors for libpq functions. Daniele Varrazzo --- doc/src/sgml/libpq.sgml | 290 ++++++++++++++++++++-------------------- doc/src/sgml/lobj.sgml | 24 ++-- 2 files changed, 157 insertions(+), 157 deletions(-) diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index fcb6e62868f..66747e979a8 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -1,4 +1,4 @@ - + <application>libpq</application> - C Library @@ -90,7 +90,7 @@ - + PQconnectdbPQconnectdb @@ -455,7 +455,7 @@ - + PQsetdbLoginPQsetdbLogin @@ -487,7 +487,7 @@ PGconn *PQsetdbLogin(const char *pghost, - + PQsetdbPQsetdb @@ -509,7 +509,7 @@ PGconn *PQsetdb(char *pghost, - + PQconnectStartPQconnectStart PQconnectPollPQconnectPoll @@ -612,7 +612,7 @@ PGconn *PQsetdb(char *pghost, to provide feedback to the user for example. These statuses are: - + CONNECTION_STARTED @@ -621,7 +621,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_MADE @@ -630,7 +630,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_AWAITING_RESPONSE @@ -639,7 +639,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_AUTH_OK @@ -648,7 +648,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_SSL_STARTUP @@ -657,7 +657,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_SETENV @@ -708,7 +708,7 @@ switch(PQstatus(conn)) - + PQconndefaultsPQconndefaults @@ -754,7 +754,7 @@ typedef struct - + PQconninfoParsePQconninfoParse @@ -799,7 +799,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQfinishPQfinish @@ -820,7 +820,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQresetPQreset @@ -840,7 +840,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQresetStartPQresetStart PQresetPollPQresetPoll @@ -904,7 +904,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); These values are fixed for the life of the PGconn object. - + PQdb @@ -922,7 +922,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQuser @@ -940,7 +940,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQpass @@ -958,7 +958,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQhost @@ -976,7 +976,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQport @@ -995,7 +995,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQtty @@ -1017,7 +1017,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQoptions @@ -1042,7 +1042,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); are executed on the PGconn object. - + PQstatus @@ -1081,7 +1081,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQtransactionStatus @@ -1117,7 +1117,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQparameterStatus @@ -1194,7 +1194,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQprotocolVersion @@ -1221,7 +1221,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQserverVersion @@ -1246,7 +1246,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQerrorMessage @@ -1280,7 +1280,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQsocketPQsocket @@ -1298,7 +1298,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQbackendPIDPQbackendPID @@ -1323,7 +1323,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQconnectionNeedsPasswordPQconnectionNeedsPassword @@ -1343,7 +1343,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQconnectionUsedPasswordPQconnectionUsedPassword @@ -1362,7 +1362,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQgetsslPQgetssl @@ -1408,7 +1408,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQexec @@ -1452,7 +1452,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg); - + PQexecParams @@ -1639,7 +1639,7 @@ SELECT * FROM mytable WHERE x = $1::bigint; - + PQprepare PQprepare @@ -1716,7 +1716,7 @@ PGresult *PQprepare(PGconn *conn, - + PQexecPrepared @@ -1760,7 +1760,7 @@ PGresult *PQexecPrepared(PGconn *conn, - + PQdescribePrepared @@ -1800,7 +1800,7 @@ PGresult *PQdescribePrepared(PGconn *conn, const char *stmtName); - + PQdescribePortal @@ -1853,7 +1853,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); are subject to change in the future. - + PQresultStatus @@ -1873,7 +1873,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); PQresultStatus can return one of the following values: - + PGRES_EMPTY_QUERY @@ -1882,7 +1882,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PGRES_COMMAND_OK @@ -1891,7 +1891,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PGRES_TUPLES_OK @@ -1901,7 +1901,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PGRES_COPY_OUT @@ -1910,7 +1910,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PGRES_COPY_IN @@ -1919,7 +1919,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PGRES_BAD_RESPONSE @@ -1928,7 +1928,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PGRES_NONFATAL_ERROR @@ -1937,7 +1937,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PGRES_FATAL_ERROR @@ -1968,7 +1968,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PQresStatus @@ -1989,7 +1989,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PQresultErrorMessage @@ -2027,7 +2027,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PQresultErrorFieldPQresultErrorField @@ -2048,7 +2048,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); The following field codes are available: - + PG_DIAG_SEVERITY @@ -2061,7 +2061,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + error codes libpq @@ -2080,7 +2080,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_MESSAGE_PRIMARY @@ -2090,7 +2090,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_MESSAGE_DETAIL @@ -2100,7 +2100,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_MESSAGE_HINT @@ -2112,7 +2112,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_STATEMENT_POSITION @@ -2124,7 +2124,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_INTERNAL_POSITION @@ -2138,7 +2138,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_INTERNAL_QUERY @@ -2148,7 +2148,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_CONTEXT @@ -2160,7 +2160,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_SOURCE_FILE @@ -2170,7 +2170,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_SOURCE_LINE @@ -2180,7 +2180,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PG_DIAG_SOURCE_FUNCTION @@ -2214,7 +2214,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PQclearPQclear @@ -2256,7 +2256,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PQntuples @@ -2278,7 +2278,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PQnfields @@ -2298,7 +2298,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PQfname @@ -2325,7 +2325,7 @@ PGresult *PQdescribePortal(PGconn *conn, const char *portalName); - + PQfnumber @@ -2366,7 +2366,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQftable @@ -2401,7 +2401,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQftablecol @@ -2428,7 +2428,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQfformat @@ -2454,7 +2454,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQftype @@ -2483,7 +2483,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQfmod @@ -2511,7 +2511,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQfsize @@ -2539,7 +2539,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQbinaryTuples @@ -2567,7 +2567,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQgetvalue @@ -2617,7 +2617,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQgetisnull @@ -2649,7 +2649,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQgetlength @@ -2679,7 +2679,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQnparams @@ -2703,7 +2703,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQparamtype @@ -2728,7 +2728,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQprint @@ -2779,7 +2779,7 @@ typedef struct { - + PQcmdStatus @@ -2806,7 +2806,7 @@ typedef struct { - + PQcmdTuples @@ -2840,7 +2840,7 @@ typedef struct { - + PQoidValue @@ -2865,7 +2865,7 @@ typedef struct { - + PQoidStatus @@ -3013,7 +3013,7 @@ typedef struct { - + PQescapeByteaConn @@ -3079,7 +3079,7 @@ typedef struct { - + PQescapeBytea @@ -3119,7 +3119,7 @@ typedef struct { - + PQunescapeBytea @@ -3228,7 +3228,7 @@ typedef struct { respectively. - + PQsendQuery @@ -3255,7 +3255,7 @@ typedef struct { - + PQsendQueryParams @@ -3288,7 +3288,7 @@ typedef struct { - + PQsendPrepare @@ -3320,7 +3320,7 @@ typedef struct { - + PQsendQueryPrepared @@ -3353,7 +3353,7 @@ typedef struct { - + PQsendDescribePrepared @@ -3380,7 +3380,7 @@ typedef struct { - + PQsendDescribePortal @@ -3407,7 +3407,7 @@ typedef struct { - + PQgetResult @@ -3462,7 +3462,7 @@ typedef struct { use of two more functions: - + PQconsumeInput @@ -3502,7 +3502,7 @@ typedef struct { - + PQisBusy @@ -3571,7 +3571,7 @@ typedef struct { can be used. - + PQsetnonblocking @@ -3608,7 +3608,7 @@ typedef struct { - + PQisnonblocking @@ -3631,7 +3631,7 @@ typedef struct { - + PQflush @@ -3679,7 +3679,7 @@ typedef struct { this section. - + PQgetCancel @@ -3709,7 +3709,7 @@ typedef struct { - + PQfreeCancel @@ -3732,7 +3732,7 @@ typedef struct { - + PQcancel @@ -3778,7 +3778,7 @@ typedef struct { - + PQrequestCancel @@ -4049,7 +4049,7 @@ typedef struct { that are also used in connection with query results: - + PQnfields @@ -4065,7 +4065,7 @@ typedef struct { - + PQbinaryTuples @@ -4084,7 +4084,7 @@ typedef struct { - + PQfformat @@ -4125,7 +4125,7 @@ typedef struct { - + PQputCopyData @@ -4165,7 +4165,7 @@ typedef struct { - + PQputCopyEnd @@ -4226,7 +4226,7 @@ typedef struct { - + PQgetCopyData @@ -4303,7 +4303,7 @@ typedef struct { - + PQgetline @@ -4342,7 +4342,7 @@ typedef struct { - + PQgetlineAsync @@ -4401,7 +4401,7 @@ typedef struct { - + PQputline @@ -4442,7 +4442,7 @@ typedef struct { - + PQputnbytes @@ -4469,7 +4469,7 @@ typedef struct { - + PQendcopy @@ -4534,7 +4534,7 @@ typedef struct { - + PQclientEncoding @@ -4560,7 +4560,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQsetClientEncoding @@ -4584,7 +4584,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQsetErrorVerbosity @@ -4619,7 +4619,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQtrace @@ -4649,7 +4649,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQuntrace @@ -4678,7 +4678,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQfreemem @@ -4711,7 +4711,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQconninfoFree @@ -4735,7 +4735,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQencryptPassword @@ -4765,7 +4765,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQmakeEmptyPGresult @@ -4802,7 +4802,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQfireResultCreateEvents @@ -4842,7 +4842,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQcopyResult @@ -4881,7 +4881,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQsetResultAttrs @@ -4909,7 +4909,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQsetvalue @@ -4943,7 +4943,7 @@ char *pg_encoding_to_char(int encoding_id); - + PQresultAlloc @@ -5130,7 +5130,7 @@ defaultNoticeProcessor(void *arg, const char *message) - + PGEVT_REGISTER @@ -5160,7 +5160,7 @@ typedef struct - + PGEVT_CONNRESET @@ -5193,7 +5193,7 @@ typedef struct - + PGEVT_CONNDESTROY @@ -5222,7 +5222,7 @@ typedef struct - + PGEVT_RESULTCREATE @@ -5254,7 +5254,7 @@ typedef struct - + PGEVT_RESULTCOPY @@ -5289,7 +5289,7 @@ typedef struct - + PGEVT_RESULTDESTROY @@ -5324,7 +5324,7 @@ typedef struct Event Callback Procedure - + PGEventProc @@ -5379,7 +5379,7 @@ int eventproc(PGEventId evtId, void *evtInfo, void *passThrough) Event Support Functions - + PQregisterEventProc @@ -5419,7 +5419,7 @@ int eventproc(PGEventId evtId, void *evtInfo, void *passThrough) - + PQsetInstanceData @@ -5439,7 +5439,7 @@ int eventproc(PGEventId evtId, void *evtInfo, void *passThrough) - + PQinstanceData @@ -5458,7 +5458,7 @@ int eventproc(PGEventId evtId, void *evtInfo, void *passThrough) - + PQresultSetInstanceData @@ -5478,7 +5478,7 @@ int eventproc(PGEventId evtId, void *evtInfo, void *passThrough) - + PQresultInstanceData @@ -6462,7 +6462,7 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough) - + PQinitOpenSSL @@ -6498,7 +6498,7 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough) - + PQinitSSL @@ -6560,7 +6560,7 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough) - + PQisthreadsafe diff --git a/doc/src/sgml/lobj.sgml b/doc/src/sgml/lobj.sgml index 750b9c5c4ee..e19517b71b1 100644 --- a/doc/src/sgml/lobj.sgml +++ b/doc/src/sgml/lobj.sgml @@ -1,4 +1,4 @@ - + Large Objects @@ -84,7 +84,7 @@ libpq library. - + Creating a Large Object @@ -143,7 +143,7 @@ inv_oid = lo_create(conn, desired_oid); - + Importing a Large Object @@ -185,7 +185,7 @@ Oid lo_import_with_oid(PGconn *conn, const char *filename, Oid lobjId); - + Exporting a Large Object @@ -203,7 +203,7 @@ int lo_export(PGconn *conn, Oid lobjId, const char *filename); - + Opening an Existing Large Object @@ -253,7 +253,7 @@ inv_fd = lo_open(conn, inv_oid, INV_READ|INV_WRITE); - + Writing Data to a Large Object @@ -271,7 +271,7 @@ int lo_write(PGconn *conn, int fd, const char *buf, size_t len); - + Reading Data from a Large Object @@ -289,7 +289,7 @@ int lo_read(PGconn *conn, int fd, char *buf, size_t len); - + Seeking in a Large Object @@ -309,7 +309,7 @@ int lo_lseek(PGconn *conn, int fd, int offset, int whence); - + Obtaining the Seek Position of a Large Object @@ -323,7 +323,7 @@ int lo_tell(PGconn *conn, int fd); - + Truncating a Large Object @@ -355,7 +355,7 @@ int lo_truncate(PGcon *conn, int fd, size_t len); - + Closing a Large Object Descriptor @@ -375,7 +375,7 @@ int lo_close(PGconn *conn, int fd); - + Removing a Large Object