Psycopg 3 API

This sections is a reference for all the public objects exposed by the psycopg module. For a more conceptual description you can take a look at Getting started with Psycopg 3 and More advanced topics.

Contents:

• The psycopg module
  • connect()
  • capabilities
  • adapters
• Connection classes
  • The Connection class
  • The AsyncConnection class
• Cursor classes
  • The Cursor class
  • The RawCursor class
  • The ClientCursor class
  • The ServerCursor class
  • Async cursor classes
• COPY-related objects
  • Main Copy objects
  • Writer objects
• Other top-level objects
  • Connection information
  • Libpq capabilities information
  • The description Column object
  • Notifications
  • Pipeline-related objects
  • Transaction-related objects
  • Two-Phase Commit related objects
• sql – SQL string composition
  • Module usage
  • sql objects
  • Utility functions
• rows – row factory implementations
  • tuple_row()
  • dict_row()
  • namedtuple_row()
  • scalar_row()
  • class_row()
  • args_row()
  • kwargs_row()
  • Formal rows protocols
• errors – Package exceptions
  • DB-API exceptions
  • Error diagnostics
  • SQLSTATE exceptions
• psycopg_pool – Connection pool implementations
  • The ConnectionPool class
  • Pool exceptions
  • The AsyncConnectionPool class
  • Null connection pools
• conninfo – manipulate connection strings
  • conninfo_to_dict()
  • make_conninfo()
• adapt – Types adaptation
  • Dumpers and loaders
  • Other objects used in adaptations
• types – Types information and adapters
  • Types information
  • JSON adapters
• abc – Psycopg abstract classes
  • Dumper
  • Loader
  • AdaptContext
• pq – libpq wrapper module
  • pq module implementations
  • Module content
  • Objects wrapping libpq structures and functions
  • Enumerations
• crdb – CockroachDB support
  • Main differences from PostgreSQL
  • CockroachDB-specific objects
• _dns – DNS resolution utilities
  • resolve_srv()
  • resolve_srv_async()
  • Connection._get_connection_params()
  • AsyncConnection._get_connection_params()
  • resolve_hostaddr_async()