~ubuntu-branches/ubuntu/trusty/postgresql-9.3/trusty-updates : contents of doc/src/sgml/html/libpq.html at revision 27

~ubuntu-branches/ubuntu/trusty/postgresql-9.3/trusty-updates : (revision 27)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>libpq - C Library</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.3.13 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Client Interfaces"
HREF="client-interfaces.html"><LINK
REL="PREVIOUS"
TITLE="Client Interfaces"
HREF="client-interfaces.html"><LINK
REL="NEXT"
TITLE="Database Connection Control Functions"
HREF="libpq-connect.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2016-05-09T21:13:26"></HEAD
><BODY
CLASS="CHAPTER"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.3.13 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="Client Interfaces"
HREF="client-interfaces.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="client-interfaces.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="Database Connection Control Functions"
HREF="libpq-connect.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="LIBPQ"
></A
>Chapter 31. <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> - C Library</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>31.1. <A
HREF="libpq-connect.html"
>Database Connection Control Functions</A
></DT
><DD
><DL
><DT
>31.1.1. <A
HREF="libpq-connect.html#LIBPQ-CONNSTRING"
>Connection Strings</A
></DT
><DT
>31.1.2. <A
HREF="libpq-connect.html#LIBPQ-PARAMKEYWORDS"
>Parameter Key Words</A
></DT
></DL
></DD
><DT
>31.2. <A
HREF="libpq-status.html"
>Connection Status Functions</A
></DT
><DT
>31.3. <A
HREF="libpq-exec.html"
>Command Execution Functions</A
></DT
><DD
><DL
><DT
>31.3.1. <A
HREF="libpq-exec.html#LIBPQ-EXEC-MAIN"
>Main Functions</A
></DT
><DT
>31.3.2. <A
HREF="libpq-exec.html#LIBPQ-EXEC-SELECT-INFO"
>Retrieving Query Result Information</A
></DT
><DT
>31.3.3. <A
HREF="libpq-exec.html#LIBPQ-EXEC-NONSELECT"
>Retrieving Other Result Information</A
></DT
><DT
>31.3.4. <A
HREF="libpq-exec.html#LIBPQ-EXEC-ESCAPE-STRING"
>Escaping Strings for Inclusion in SQL Commands</A
></DT
></DL
></DD
><DT
>31.4. <A
HREF="libpq-async.html"
>Asynchronous Command Processing</A
></DT
><DT
>31.5. <A
HREF="libpq-single-row-mode.html"
>Retrieving Query Results Row-By-Row</A
></DT
><DT
>31.6. <A
HREF="libpq-cancel.html"
>Canceling Queries in Progress</A
></DT
><DT
>31.7. <A
HREF="libpq-fastpath.html"
>The Fast-Path Interface</A
></DT
><DT
>31.8. <A
HREF="libpq-notify.html"
>Asynchronous Notification</A
></DT
><DT
>31.9. <A
HREF="libpq-copy.html"
>Functions Associated with the <TT
CLASS="COMMAND"
>COPY</TT
> Command</A
></DT
><DD
><DL
><DT
>31.9.1. <A
HREF="libpq-copy.html#LIBPQ-COPY-SEND"
>Functions for Sending <TT
CLASS="COMMAND"
>COPY</TT
> Data</A
></DT
><DT
>31.9.2. <A
HREF="libpq-copy.html#LIBPQ-COPY-RECEIVE"
>Functions for Receiving <TT
CLASS="COMMAND"
>COPY</TT
> Data</A
></DT
><DT
>31.9.3. <A
HREF="libpq-copy.html#LIBPQ-COPY-DEPRECATED"
>Obsolete Functions for <TT
CLASS="COMMAND"
>COPY</TT
></A
></DT
></DL
></DD
><DT
>31.10. <A
HREF="libpq-control.html"
>Control Functions</A
></DT
><DT
>31.11. <A
HREF="libpq-misc.html"
>Miscellaneous Functions</A
></DT
><DT
>31.12. <A
HREF="libpq-notice-processing.html"
>Notice Processing</A
></DT
><DT
>31.13. <A
HREF="libpq-events.html"
>Event System</A
></DT
><DD
><DL
><DT
>31.13.1. <A
HREF="libpq-events.html#LIBPQ-EVENTS-TYPES"
>Event Types</A
></DT
><DT
>31.13.2. <A
HREF="libpq-events.html#LIBPQ-EVENTS-PROC"
>Event Callback Procedure</A
></DT
><DT
>31.13.3. <A
HREF="libpq-events.html#LIBPQ-EVENTS-FUNCS"
>Event Support Functions</A
></DT
><DT
>31.13.4. <A
HREF="libpq-events.html#LIBPQ-EVENTS-EXAMPLE"
>Event Example</A
></DT
></DL
></DD
><DT
>31.14. <A
HREF="libpq-envars.html"
>Environment Variables</A
></DT
><DT
>31.15. <A
HREF="libpq-pgpass.html"
>The Password File</A
></DT
><DT
>31.16. <A
HREF="libpq-pgservice.html"
>The Connection Service File</A
></DT
><DT
>31.17. <A
HREF="libpq-ldap.html"
>LDAP Lookup of Connection Parameters</A
></DT
><DT
>31.18. <A
HREF="libpq-ssl.html"
>SSL Support</A
></DT
><DD
><DL
><DT
>31.18.1. <A
HREF="libpq-ssl.html#LIBQ-SSL-CERTIFICATES"
>Client Verification of Server Certificates</A
></DT
><DT
>31.18.2. <A
HREF="libpq-ssl.html#LIBPQ-SSL-CLIENTCERT"
>Client Certificates</A
></DT
><DT
>31.18.3. <A
HREF="libpq-ssl.html#LIBPQ-SSL-PROTECTION"
>Protection Provided in Different Modes</A
></DT
><DT
>31.18.4. <A
HREF="libpq-ssl.html#LIBPQ-SSL-FILEUSAGE"
>SSL Client File Usage</A
></DT
><DT
>31.18.5. <A
HREF="libpq-ssl.html#LIBPQ-SSL-INITIALIZE"
>SSL Library Initialization</A
></DT
></DL
></DD
><DT
>31.19. <A
HREF="libpq-threading.html"
>Behavior in Threaded Programs</A
></DT
><DT
>31.20. <A
HREF="libpq-build.html"
>Building <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> Programs</A
></DT
><DT
>31.21. <A
HREF="libpq-example.html"
>Example Programs</A
></DT
></DL
></DIV
><P
>  <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> is the <ACRONYM
CLASS="ACRONYM"
>C</ACRONYM
>
  application programmer's interface to <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
>.
  <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> is a set of library functions that allow
  client programs to pass queries to the <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
>
  backend server and to receive the results of these queries.
 </P
><P
>  <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> is also the underlying engine for several
  other <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> application interfaces, including
  those written for C++, Perl, Python, Tcl and <SPAN
CLASS="APPLICATION"
>ECPG</SPAN
>.
  So some aspects of <SPAN
CLASS="APPLICATION"
>libpq</SPAN
>'s behavior will be
  important to you if you use one of those packages.  In particular,
  <A
HREF="libpq-envars.html"
>Section 31.14</A
>,
  <A
HREF="libpq-pgpass.html"
>Section 31.15</A
> and
  <A
HREF="libpq-ssl.html"
>Section 31.18</A
>
  describe behavior that is visible to the user of any application
  that uses <SPAN
CLASS="APPLICATION"
>libpq</SPAN
>.
 </P
><P
>  Some short programs are included at the end of this chapter (<A
HREF="libpq-example.html"
>Section 31.21</A
>) to show how
  to write programs that use <SPAN
CLASS="APPLICATION"
>libpq</SPAN
>.  There are also several
  complete examples of <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> applications in the
  directory <TT
CLASS="FILENAME"
>src/test/examples</TT
> in the source code distribution.
 </P
><P
>  Client programs that use <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> must
  include the header file
  <TT
CLASS="FILENAME"
>libpq-fe.h</TT
>
  and must link with the <SPAN
CLASS="APPLICATION"
>libpq</SPAN
> library.
 </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="client-interfaces.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="libpq-connect.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Client Interfaces</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="client-interfaces.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Database Connection Control Functions</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>