From: Bruce Momjian Date: Sun, 2 Sep 2007 01:13:55 +0000 (+0000) Subject: Clean up whitespace. X-Git-Tag: REL9_0_0~5105 X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=fcfe801ab84c124d4103f9afb1140c9c2558cb54;p=pg-rex%2Fsyncrep.git Clean up whitespace. --- diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 0e137b266b..448a24d074 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -1,4 +1,4 @@ - + <application>libpq</application> - C Library @@ -129,7 +129,7 @@ TCP/IP communication is always used when a nonempty string is specified for this parameter. - + Using hostaddr instead of host allows the application to avoid a host name look-up, which might be important in @@ -150,7 +150,7 @@ the connection in ~/.pgpass (see ). - + Without either a host name or host address, libpq will connect using a @@ -159,7 +159,7 @@ - + port @@ -386,16 +386,16 @@ PGconn *PQsetdb(char *pghost, nonblocking connection Make a connection to the database server in a nonblocking manner. - + PGconn *PQconnectStart(const char *conninfo); - + PostgresPollingStatusType PQconnectPoll(PGconn *conn); - + These two functions are used to open a connection to a database server such that your application's thread of execution is not blocked on remote I/O @@ -405,7 +405,7 @@ PGconn *PQsetdb(char *pghost, PQconnectdb, and so the application can manage this operation in parallel with other activities. - + The database connection is made using the parameters taken from the string conninfo, passed to PQconnectStart. This string is in @@ -422,14 +422,14 @@ PGconn *PQsetdb(char *pghost, these parameters under PQconnectdb above for details. - + If you call PQtrace, ensure that the stream object into which you trace will not block. - + You ensure that the socket is in the appropriate state @@ -438,7 +438,7 @@ PGconn *PQsetdb(char *pghost, - + To begin a nonblocking connection request, call conn = PQconnectStart("connection_info_string"). If conn is null, then libpq has been unable to allocate a new PGconn @@ -447,7 +447,7 @@ PGconn *PQsetdb(char *pghost, PQconnectStart, call status = PQstatus(conn). If status equals CONNECTION_BAD, PQconnectStart has failed. - + If PQconnectStart succeeds, the next stage is to poll libpq so that it can proceed with the connection sequence. @@ -470,7 +470,7 @@ PGconn *PQsetdb(char *pghost, has failed, or PGRES_POLLING_OK, indicating the connection has been successfully made. - + At any time during connection, the status of the connection can be checked by calling PQstatus. If this gives CONNECTION_BAD, then the @@ -480,7 +480,7 @@ PGconn *PQsetdb(char *pghost, during (and only during) an asynchronous connection procedure. These indicate the current stage of the connection procedure and might be useful to provide feedback to the user for example. These statuses are: - + CONNECTION_STARTED @@ -490,7 +490,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_MADE @@ -499,7 +499,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_AWAITING_RESPONSE @@ -508,7 +508,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_AUTH_OK @@ -517,7 +517,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_SSL_STARTUP @@ -526,7 +526,7 @@ PGconn *PQsetdb(char *pghost, - + CONNECTION_SETENV @@ -536,7 +536,7 @@ PGconn *PQsetdb(char *pghost, - + Note that, although these constants will remain (in order to maintain compatibility), an application should never rely upon these occurring in a particular order, or at all, or on the status always being one of these @@ -559,7 +559,7 @@ switch(PQstatus(conn)) } - + The connect_timeout connection parameter is ignored when using PQconnectPoll; it is the application's @@ -568,7 +568,7 @@ switch(PQstatus(conn)) PQconnectPoll loop is equivalent to PQconnectdb. - + Note that if PQconnectStart returns a non-null pointer, you must call PQfinish when you are finished with it, in order to dispose of @@ -577,7 +577,7 @@ switch(PQstatus(conn)) - + PQconndefaultsPQconndefaults @@ -602,7 +602,7 @@ typedef struct } PQconninfoOption; - + Returns a connection options array. This can be used to determine all possible PQconnectdb options and their @@ -614,16 +614,16 @@ typedef struct will depend on environment variables and other context. Callers must treat the connection options data as read-only. - + After processing the options array, free it by passing it to PQconninfoFree. If this is not done, a small amount of memory is leaked for each call to PQconndefaults. - + - + PQfinishPQfinish @@ -634,7 +634,7 @@ typedef struct void PQfinish(PGconn *conn); - + Note that even if the server connection attempt fails (as indicated by PQstatus), the application should call PQfinish @@ -644,7 +644,7 @@ typedef struct - + PQresetPQreset @@ -654,7 +654,7 @@ typedef struct void PQreset(PGconn *conn); - + This function will close the connection to the server and attempt to reestablish a new @@ -2390,7 +2390,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQgetvalue @@ -2398,7 +2398,7 @@ PQfnumber(res, "\"BAR\"") 1 PQgetvalue - + Returns a single field value of one row of a @@ -2412,7 +2412,7 @@ PQfnumber(res, "\"BAR\"") 1 int column_number); - + For data in text format, the value returned by PQgetvalue is a null-terminated character @@ -2423,13 +2423,13 @@ PQfnumber(res, "\"BAR\"") 1 this case too, but that is not ordinarily useful, since the value is likely to contain embedded nulls.) - + An empty string is returned if the field value is null. See PQgetisnull to distinguish null values from empty-string values. - + The pointer returned by PQgetvalue points to storage that is part of the PGresult @@ -2440,7 +2440,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQgetisnull @@ -2452,7 +2452,7 @@ PQfnumber(res, "\"BAR\"") 1 in libpq - + Tests a field for a null value. Row and column numbers start @@ -2463,7 +2463,7 @@ PQfnumber(res, "\"BAR\"") 1 int column_number); - + This function returns 1 if the field is null and 0 if it contains a non-null value. (Note that @@ -2472,14 +2472,14 @@ PQfnumber(res, "\"BAR\"") 1 - + PQgetlength PQgetlength - + Returns the actual length of a field value in bytes. Row and @@ -2490,7 +2490,7 @@ PQfnumber(res, "\"BAR\"") 1 int column_number); - + This is the actual data length for the particular data value, that is, the size of the object pointed to by @@ -2502,7 +2502,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQnparams @@ -2510,7 +2510,7 @@ PQfnumber(res, "\"BAR\"") 1 PQnparams - + Returns the number of parameters of a prepared statement. @@ -2518,7 +2518,7 @@ PQfnumber(res, "\"BAR\"") 1 int PQnparams(const PGresult *res); - + This function is only useful when inspecting the result of PQdescribePrepared. For other types of queries it @@ -2526,7 +2526,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQparamtype @@ -2534,7 +2534,7 @@ PQfnumber(res, "\"BAR\"") 1 PQparamtype - + Returns the data type of the indicated statement parameter. @@ -2543,7 +2543,7 @@ PQfnumber(res, "\"BAR\"") 1 Oid PQparamtype(const PGresult *res, int param_number); - + This function is only useful when inspecting the result of PQdescribePrepared. For other types of queries it @@ -2551,7 +2551,7 @@ PQfnumber(res, "\"BAR\"") 1 - + PQprint @@ -2559,7 +2559,7 @@ PQfnumber(res, "\"BAR\"") 1 PQprint - + Prints out all the rows and, optionally, the column names to @@ -4425,7 +4425,7 @@ typedef struct { - + PQtrace @@ -4433,7 +4433,7 @@ typedef struct { PQtrace - + Enables tracing of the client/server communication to a debugging file stream. @@ -4441,7 +4441,7 @@ typedef struct { void PQtrace(PGconn *conn, FILE *stream); - + On Windows, if the libpq library and an application are @@ -4452,10 +4452,10 @@ typedef struct { library and all applications using that library. - + - + PQuntrace @@ -4463,7 +4463,7 @@ typedef struct { PQuntrace - + Disables tracing started by PQtrace. @@ -4474,9 +4474,9 @@ typedef struct { - + - + Miscellaneous Functions