Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
P
Postgres FD Implementation
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Abuhujair Javed
Postgres FD Implementation
Commits
a0423ec0
Commit
a0423ec0
authored
Jan 12, 2011
by
Bruce Momjian
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Apply libpq documentation patches submitted by Leslie S Satenstein and
reviewed by Robert Haas.
parent
d487afbb
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
13 additions
and
12 deletions
+13
-12
doc/src/sgml/libpq.sgml
doc/src/sgml/libpq.sgml
+13
-12
No files found.
doc/src/sgml/libpq.sgml
View file @
a0423ec0
...
@@ -397,8 +397,8 @@ PGconn *PQconnectdbParams(const char **keywords, const char **values, int expand
...
@@ -397,8 +397,8 @@ PGconn *PQconnectdbParams(const char **keywords, const char **values, int expand
<row>
<row>
<entry><literal>verify-ca</></entry>
<entry><literal>verify-ca</></entry>
<entry>only try an <acronym>SSL</> connection, and verify that
<entry>only try an <acronym>SSL</> connection, and verify that
the server certificate is issued by a trusted
<acronym>CA</>
the server certificate is issued by a trusted
certificate
</entry>
authority (<acronym>CA</>)
</entry>
</row>
</row>
<row>
<row>
...
@@ -791,8 +791,8 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn);
...
@@ -791,8 +791,8 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn);
<para>
<para>
At any time during connection, the status of the connection can be
At any time during connection, the status of the connection can be
checked by calling <function>PQstatus</>. If this
give
s <symbol>CONNECTION_BAD</>, then the
checked by calling <function>PQstatus</>. If this
call return
s <symbol>CONNECTION_BAD</>, then the
connection procedure has failed; if
it give
s <function>CONNECTION_OK</>, then the
connection procedure has failed; if
the call return
s <function>CONNECTION_OK</>, then the
connection is ready. Both of these states are equally detectable
connection is ready. Both of these states are equally detectable
from the return value of <function>PQconnectPoll</>, described above. Other states might also occur
from the return value of <function>PQconnectPoll</>, described above. Other states might also occur
during (and only during) an asynchronous connection procedure. These
during (and only during) an asynchronous connection procedure. These
...
@@ -956,7 +956,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg);
...
@@ -956,7 +956,7 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg);
<para>
<para>
Parses a connection string and returns the resulting options as an
Parses a connection string and returns the resulting options as an
array; or returns <symbol>NULL</> if there is a problem with the connection
array; or returns <symbol>NULL</> if there is a problem with the connection
string. This
can be used to determine
string. This
function can be used to extract
the <function>PQconnectdb</function> options in the provided
the <function>PQconnectdb</function> options in the provided
connection string. The return value points to an array of
connection string. The return value points to an array of
<structname>PQconninfoOption</structname> structures, which ends
<structname>PQconninfoOption</structname> structures, which ends
...
@@ -1486,9 +1486,10 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName);
...
@@ -1486,9 +1486,10 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName);
<synopsis>
<synopsis>
int PQprotocolVersion(const PGconn *conn);
int PQprotocolVersion(const PGconn *conn);
</synopsis>
</synopsis>
Applications might wish to use this to determine whether certain
Applications might wish to use this
function
to determine whether certain
features are supported. Currently, the possible values are 2 (2.0
features are supported. Currently, the possible values are 2 (2.0
protocol), 3 (3.0 protocol), or zero (connection bad). This will
protocol), 3 (3.0 protocol), or zero (connection bad). The
protocol version will
not change after connection startup is complete, but it could
not change after connection startup is complete, but it could
theoretically change during a connection reset. The 3.0 protocol
theoretically change during a connection reset. The 3.0 protocol
will normally be used when communicating with
will normally be used when communicating with
...
@@ -1513,7 +1514,7 @@ int PQprotocolVersion(const PGconn *conn);
...
@@ -1513,7 +1514,7 @@ int PQprotocolVersion(const PGconn *conn);
<synopsis>
<synopsis>
int PQserverVersion(const PGconn *conn);
int PQserverVersion(const PGconn *conn);
</synopsis>
</synopsis>
Applications might use this to determine the version of the database
Applications might use this
function
to determine the version of the database
server they are connected to. The number is formed by converting
server they are connected to. The number is formed by converting
the major, minor, and revision numbers into two-decimal-digit
the major, minor, and revision numbers into two-decimal-digit
numbers and appending them together. For example, version 8.1.5
numbers and appending them together. For example, version 8.1.5
...
@@ -1547,7 +1548,7 @@ char *PQerrorMessage(const PGconn *conn);
...
@@ -1547,7 +1548,7 @@ char *PQerrorMessage(const PGconn *conn);
Nearly all <application>libpq</> functions will set a message for
Nearly all <application>libpq</> functions will set a message for
<function>PQerrorMessage</function> if they fail. Note that by
<function>PQerrorMessage</function> if they fail. Note that by
<application>libpq</application> convention, a nonempty
<application>libpq</application> convention, a nonempty
<function>PQerrorMessage</function> result can
be
multiple lines,
<function>PQerrorMessage</function> result can
consist of
multiple lines,
and will include a trailing newline. The caller should not free
and will include a trailing newline. The caller should not free
the result directly. It will be freed when the associated
the result directly. It will be freed when the associated
<structname>PGconn</> handle is passed to
<structname>PGconn</> handle is passed to
...
@@ -1717,8 +1718,8 @@ PGresult *PQexec(PGconn *conn, const char *command);
...
@@ -1717,8 +1718,8 @@ PGresult *PQexec(PGconn *conn, const char *command);
</varlistentry>
</varlistentry>
</variablelist>
</variablelist>
It is allowed to include multiple SQL commands (separated by semicolons)
The command string can include multiple SQL commands
in the command string
. Multiple queries sent in a single
(separated by semicolons)
. Multiple queries sent in a single
<function>PQexec</> call are processed in a single transaction, unless
<function>PQexec</> call are processed in a single transaction, unless
there are explicit <command>BEGIN</command>/<command>COMMIT</command>
there are explicit <command>BEGIN</command>/<command>COMMIT</command>
commands included in the query string to divide it into multiple
commands included in the query string to divide it into multiple
...
@@ -4142,7 +4143,7 @@ int PQcancel(PGcancel *cancel, char *errbuf, int errbufsize);
...
@@ -4142,7 +4143,7 @@ int PQcancel(PGcancel *cancel, char *errbuf, int errbufsize);
<para>
<para>
The return value is 1 if the cancel request was successfully
The return value is 1 if the cancel request was successfully
dispatched and 0 if not. If not, <parameter>errbuf</> is filled
dispatched and 0 if not. If not, <parameter>errbuf</> is filled
with an e
rror message explaining why not
. <parameter>errbuf</>
with an e
xplanatory error message
. <parameter>errbuf</>
must be a char array of size <parameter>errbufsize</> (the
must be a char array of size <parameter>errbufsize</> (the
recommended size is 256 bytes).
recommended size is 256 bytes).
</para>
</para>
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment