libpq - C Library
- Table of Contents
- 32.1. Database Connection Control Functions
- 32.2. Connection Status Functions
- 32.3. Command Execution Functions
- 32.4. Asynchronous Command Processing
- 32.5. Retrieving Query Results Row-By-Row
- 32.6. Canceling Queries in Progress
- 32.7. The Fast-Path Interface
- 32.8. Asynchronous Notification
- 32.9. Functions Associated with the COPY Command
- 32.10. Control Functions
- 32.11. Miscellaneous Functions
- 32.12. Notice Processing
- 32.13. Event System
- 32.14. Environment Variables
- 32.15. The Password File
- 32.16. The Connection Service File
- 32.17. LDAP Lookup of Connection Parameters
- 32.18. SSL Support
- 32.19. Behavior in Threaded Programs
- 32.20. Building libpq Programs
- 32.21. Example Programs
libpq is the C application programmer's interface to PostgreSQL. libpq is a set of library functions that allow client programs to pass queries to the PostgreSQL backend server and to receive the results of these queries.
libpq is also the underlying engine for several other PostgreSQL application interfaces, including those written for C++, Perl, Python, Tcl and ECPG. So some aspects of libpq's behavior will be important to you if you use one of those packages. In particular, Section 32.14, Section 32.15 and Section 32.18 describe behavior that is visible to the user of any application that uses libpq.
Some short programs are included at the end of this chapter (Section 32.21) to show how to write programs that use libpq. There are also several complete examples of libpq applications in the directory src/test/examples in the source code distribution.
Client programs that use libpq must include the header file libpq-fe.h and must link with the libpq library.