pg8000

pg8000 is a pure-Python PostgreSQL driver that complies with DB-API 2.0. pg8000's name comes from the belief that it is probably about the 8000th PostgreSQL interface for Python. pg8000 is distributed under the BSD 3-clause license.

<!-- mtoc-start -->

• Installation
• Native API Interactive Examples
  • Basic Example
  • Transactions
  • Query Using Functions
  • Interval Type
  • Point Type
  • Client Encoding
  • JSON
  • Retrieve Column Metadata From Results
  • Notices And Notifications
  • Parameter Statuses
  • LIMIT ALL
  • IN and NOT IN
  • Many SQL Statements Can't Be Parameterized
  • COPY FROM And TO A Stream
  • Execute Multiple SQL Statements
  • Quoted Identifiers in SQL
  • Custom adapter from a Python type to a PostgreSQL type
  • Custom adapter from a PostgreSQL type to a Python type
  • Could Not Determine Data Type Of Parameter
  • Prepared Statements
  • Use Environment Variables As Connection Defaults
  • Connect To PostgreSQL Over SSL
  • Server-Side Cursors
  • BLOBs (Binary Large Objects)
  • Replication Protocol
  • Extra Startup Parameters
  • PostgreSQL-Style Parameter Placeholders
• DB-API 2 Interactive Examples
  • Basic Example
  • Query Using Functions
  • Interval Type
  • Point Type
  • Numeric Parameter Style
  • Autocommit
  • Client Encoding
  • JSON
  • Retrieve Column Names From Results
  • COPY from and to a file
  • Server-Side Cursors
  • BLOBs (Binary Large Objects)
  • Parameter Limit
• Type Mapping
• Theory Of Operation
• Native API Docs
  • pg8000.native.Error
  • pg8000.native.InterfaceError
  • pg8000.native.DatabaseError
  • pg8000.native.Connection(user, host='localhost', database=None, port=5432, password=None, source_address=None, unix_sock=None, ssl_context=None, timeout=None, tcp_keepalive=True, application_name=None, replication=None, sock=None)
  • pg8000.native.Connection.notifications
  • pg8000.native.Connection.notices
  • pg8000.native.Connection.parameter_statuses
  • pg8000.native.Connection.run(sql, stream=None, types=None, **kwargs)
  • pg8000.native.Connection.row_count
  • pg8000.native.Connection.columns
  • pg8000.native.Connection.close()
  • pg8000.native.Connection.register_out_adapter(typ, out_func)
  • pg8000.native.Connection.register_in_adapter(oid, in_func)
  • pg8000.native.Connection.prepare(sql)
  • pg8000.native.PreparedStatement
    • pg8000.native.PreparedStatement.run(**kwargs)
    • pg8000.native.PreparedStatement.close()
  • pg8000.native.identifier(ident)
  • pg8000.native.literal(value)
• DB-API 2 Docs
  • Properties
    • pg8000.dbapi.apilevel
    • pg8000.dbapi.threadsafety
    • pg8000.dbapi.paramstyle
    • pg8000.dbapi.STRING
    • pg8000.dbapi.BINARY
    • pg8000.dbapi.NUMBER
    • pg8000.dbapi.DATETIME
    • pg8000.dbapi.ROWID
  • Functions
    • pg8000.dbapi.connect(user, host='localhost', database=None, port=5432, password=None, source_address=None, unix_sock=None, ssl_context=None, timeout=None, tcp_keepalive=True, applicationa_name=None, replication=None, sock=None)
    • pg8000.dbapi.Date(year, month, day)
    • pg8000.dbapi.Time(hour, minute, second)
    • pg8000.dbapi.Timestamp(year, month, day, hour, minute, second)
    • pg8000.dbapi.DateFromTicks(ticks)
    • pg8000.dbapi.TimeFromTicks(ticks)
    • pg8000.dbapi.TimestampFromTicks(ticks)
    • pg8000.dbapi.Binary(value)
  • Generic Exceptions
    • pg8000.dbapi.Warning
    • pg8000.dbapi.Error
    • pg8000.dbapi.InterfaceError
    • pg8000.dbapi.DatabaseError
    • pg8000.dbapi.DataError
    • pg8000.dbapi.OperationalError
    • pg8000.dbapi.IntegrityError
    • pg8000.dbapi.InternalError
    • pg8000.dbapi.ProgrammingError
    • pg8000.dbapi.NotSupportedError
  • Classes
    • pg8000.dbapi.Connection
    • pg8000.dbapi.Connection.autocommit
    • pg8000.dbapi.Connection.close()
    • pg8000.dbapi.Connection.cursor()
    • pg8000.dbapi.Connection.rollback()
    • pg8000.dbapi.Connection.tpc_begin(xid)
    • pg8000.dbapi.Connection.tpc_commit(xid=None)
    • pg8000.dbapi.Connection.tpc_prepare()
    • pg8000.dbapi.Connection.tpc_recover()
    • pg8000.dbapi.Connection.tpc_rollback(xid=None)
    • pg8000.dbapi.Connection.xid(format_id, global_transaction_id, branch_qualifier)
    • pg8000.dbapi.Cursor
      • pg8000.dbapi.Cursor.arraysize
      • pg8000.dbapi.Cursor.connection
      • pg8000.dbapi.Cursor.rowcount
      • pg8000.dbapi.Cursor.description
      • pg8000.dbapi.Cursor.close()
      • pg8000.dbapi.Cursor.execute(operation, args=None, stream=None)
      • pg8000.dbapi.Cursor.executemany(operation, param_sets)
      • pg8000.dbapi.Cursor.callproc(procname, parameters=None)
      • pg8000.dbapi.Cursor.fetchall()
      • pg8000.dbapi.Cursor.fetchmany(size=None)
      • pg8000.dbapi.Cursor.fetchone()
      • pg8000.dbapi.Cursor.setinputsizes(*sizes)
      • pg8000.dbapi.Cursor.setoutputsize(size, column=None)
    • pg8000.dbapi.Interval
• Design Decisions
• Tests
• Doing A Release Of pg8000
• Release Notes
  • Version 1.31.5, 2025-09-14
  • Version 1.31.4, 2025-07-20
  • Version 1.31.3, 2025-07-19
  • Version 1.31.2, 2024-04-28
  • Version 1.31.1, 2024-04-01
  • Version 1.31.0, 2024-03-31
  • Version 1.30.5, 2024-02-22
  • Version 1.30.4, 2024-01-03
  • Version 1.30.3, 2023-10-31
  • Version 1.30.2, 2023-09-17
  • [Version 1.30.1, 2023-07-29](#version-1301-2023-07