Index

Symbols

`!with` Connection

_

__build_version__ (in module psycopg.pq) __call__() (psycopg.rows.RowFactory method) (psycopg.rows.RowMaker method) __getitem__() (psycopg.types.TypesRegistry method)

__impl__ (in module psycopg.pq) _get_connection_params() (psycopg.AsyncConnection class method) (psycopg.Connection class method) _query (psycopg.Cursor attribute)

A

ABORTED (psycopg.pq.PipelineStatus attribute) ACTIVE (psycopg.pq.TransactionStatus attribute) Adaptation, [1] Boolean dict namedtuple numbers Objects, [1] Strings tuple AdaptContext (class in psycopg.abc) adapters (in module psycopg) (in module psycopg.crdb) (psycopg.abc.AdaptContext property) AdaptersMap (class in psycopg.adapt) add_notice_handler() (psycopg.Connection method) add_notify_handler() (psycopg.Connection method) advanced Query protocol ALLOCATED (psycopg.pq.ConnStatus attribute) args_row() (in module psycopg.rows)

as_bytes() (psycopg.sql.Composable method) as_string() (psycopg.sql.Composable method) AsyncClientCursor (class in psycopg) AsyncConnection (class in psycopg) AsyncConnectionPool (class in psycopg_pool) AsyncCopy (class in psycopg) AsyncCrdbConnection (class in psycopg.crdb) AsyncCursor (class in psycopg) Asynchronous Notifications, [1] asyncio AsyncLibpqWriter (class in psycopg.copy) AsyncNullConnectionPool (class in psycopg_pool) AsyncPipeline (class in psycopg) AsyncRawCursor (class in psycopg) AsyncRawServerCursor (class in psycopg) AsyncRowFactory (class in psycopg.rows) AsyncServerCursor (class in psycopg) AsyncTransaction (class in psycopg) AsyncWriter (class in psycopg.copy) AUTO (psycopg.adapt.PyFormat attribute) autocommit (psycopg.Connection attribute)

B

backend_pid (psycopg.ConnectionInfo attribute) BAD (psycopg.pq.ConnStatus attribute) BAD_RESPONSE (psycopg.pq.ExecStatus attribute) BaseRowFactory (class in psycopg.rows) Binary Parameters BINARY (psycopg.adapt.PyFormat attribute) (psycopg.pq.Format attribute) Binary string Binding Client-Side

blocking() (psycopg.pq.PGcancelConn method) Boolean Adaptation bqual (psycopg.Xid attribute) broken (psycopg.Connection attribute) bytea Adaptation bytearray Adaptation bytes Adaptation

C

cancel() (psycopg.Connection method) (psycopg.pq.PGcancel method) cancel_conn() (psycopg.pq.PGconn method) cancel_safe() (psycopg.AsyncConnection method) (psycopg.Connection method) CancellationTimeout Capabilities (class in psycopg) capabilities (in module psycopg) change_password() (psycopg.pq.PGconn method) channel (psycopg.Notify attribute) check() (psycopg_pool.AsyncConnectionPool method) (psycopg_pool.ConnectionPool method) (psycopg_pool.NullConnectionPool method) check_connection() (psycopg_pool.AsyncConnectionPool static method) (psycopg_pool.ConnectionPool static method) class_row() (in module psycopg.rows) Client-binding Cursor Client-Side Binding Client-side Cursor ClientCursor (class in psycopg) close() (psycopg.AsyncConnection method) (psycopg.AsyncCursor method) (psycopg.AsyncServerCursor method) (psycopg.Connection method) (psycopg.Cursor method) (psycopg.ServerCursor method) (psycopg_pool.AsyncConnectionPool method) (psycopg_pool.ConnectionPool method) closed (psycopg.Connection attribute) (psycopg.Cursor attribute) Column (class in psycopg) column_name (psycopg.errors.Diagnostic attribute) COLUMN_NAME (psycopg.pq.DiagnosticField attribute) COMMAND_OK (psycopg.pq.ExecStatus attribute) commit() (psycopg.AsyncConnection method) (psycopg.Connection method) Composable (class in psycopg.sql) Composed (class in psycopg.sql) Composite types Data types CompositeInfo (class in psycopg.types.composite) connect() (in module psycopg) (in module psycopg.crdb) (psycopg.AsyncConnection class method) (psycopg.Connection class method)

Connection `!with` Pool Connection (class in psycopg) connection (psycopg.abc.AdaptContext property) (psycopg.AsyncCursor attribute) (psycopg.AsyncTransaction attribute) (psycopg.Cursor attribute) (psycopg.Transaction attribute) connection() (psycopg_pool.AsyncConnectionPool method) (psycopg_pool.ConnectionPool method) ConnectionInfo (class in psycopg) ConnectionPool (class in psycopg_pool) ConnectionTimeout Conninfo (class in psycopg.pq) conninfo_to_dict() (in module psycopg.conninfo) ConnStatus (class in psycopg.pq) constraint_name (psycopg.errors.Diagnostic attribute) CONSTRAINT_NAME (psycopg.pq.DiagnosticField attribute) context (psycopg.errors.Diagnostic attribute) CONTEXT (psycopg.pq.DiagnosticField attribute) COPY SQL command Copy (class in psycopg) copy() (psycopg.AsyncCursor method) (psycopg.Cursor method) COPY_BOTH (psycopg.pq.ExecStatus attribute) COPY_IN (psycopg.pq.ExecStatus attribute) COPY_OUT (psycopg.pq.ExecStatus attribute) CrdbConnection (class in psycopg.crdb) CrdbConnectionInfo (class in psycopg.crdb) Ctrl-C Cursor Client-binding Client-side Named Server-side Cursor (class in psycopg) cursor() (psycopg.AsyncConnection method) (psycopg.Connection method) cursor_factory (psycopg.AsyncConnection attribute) (psycopg.Connection attribute)

D

Data types Adaptation, [1] Composite types geometry hstore range, [1] database (psycopg.Xid attribute) DatabaseError DataError datatype_name (psycopg.errors.Diagnostic attribute) DATATYPE_NAME (psycopg.pq.DiagnosticField attribute) DateStyle dbname (psycopg.ConnectionInfo attribute) Decimal Adaptation DEFAULT (in module psycopg.sql)

deferrable (psycopg.Connection attribute) description (psycopg.Cursor attribute) diag (psycopg.Error attribute) Diagnostic (class in psycopg.errors) DiagnosticField (class in psycopg.pq) dict Adaptation dict_row() (in module psycopg.rows) Differences psycopg2 disconnections display_size (psycopg.Column attribute) dsn (psycopg.ConnectionInfo attribute) dump() (psycopg.abc.Dumper method) (psycopg.adapt.Dumper method) Dumper (class in psycopg.abc) (class in psycopg.adapt)

E

EMPTY_QUERY (psycopg.pq.ExecStatus attribute) Encoding SQL_ASCII encoding (psycopg.ConnectionInfo attribute) encrypt_password() (psycopg.pq.PGconn method) enum (psycopg.types.enum.EnumInfo attribute) EnumInfo (class in psycopg.types.enum) environment variable PATH PGCONNECT_TIMEOUT PSYCOPG_IMPL, [1], [2] Error Class error_message (psycopg.ConnectionInfo attribute) error_message() (in module psycopg.pq) Escaping (class in psycopg.pq)

Example Usage Exceptions DB-API PostgreSQL ExecStatus (class in psycopg.pq) execute() (psycopg.AsyncConnection method) (psycopg.AsyncCursor method) (psycopg.AsyncServerCursor method) (psycopg.Connection method) (psycopg.Cursor method) (psycopg.ServerCursor method) executemany() (psycopg.AsyncCursor method) (psycopg.AsyncServerCursor method) (psycopg.Cursor method) (psycopg.ServerCursor method)

F

FAILED (psycopg.pq.PollingStatus attribute) FATAL_ERROR (psycopg.pq.ExecStatus attribute) fetch() (psycopg.types.TypeInfo class method) fetchall() (psycopg.AsyncCursor method) (psycopg.AsyncServerCursor method) (psycopg.Cursor method) (psycopg.ServerCursor method) fetchmany() (psycopg.AsyncCursor method) (psycopg.AsyncServerCursor method) (psycopg.Cursor method) (psycopg.ServerCursor method) fetchone() (psycopg.AsyncCursor method) (psycopg.AsyncServerCursor method) (psycopg.Cursor method) (psycopg.ServerCursor method)

fileno() (psycopg.Connection method) FileWriter (class in psycopg.copy) finish() (psycopg.copy.AsyncWriter method) (psycopg.copy.Writer method) (psycopg.pq.PGcancelConn method) Float Adaptation Format (class in psycopg.pq) format (psycopg.abc.Dumper attribute) (psycopg.abc.Loader attribute) (psycopg.adapt.Dumper attribute) (psycopg.adapt.Loader attribute) (psycopg.Cursor attribute) format() (psycopg.sql.SQL method) format_id (psycopg.Xid attribute) free() (psycopg.pq.PGcancel method)

G

geometry Data types get() (psycopg.types.TypesRegistry method) get_by_subtype() (psycopg.types.TypesRegistry method) get_cancel() (psycopg.pq.PGconn method) get_dumper() (psycopg.adapt.AdaptersMap method) get_dumper_by_oid() (psycopg.adapt.AdaptersMap method) get_key() (psycopg.abc.Dumper method) (psycopg.adapt.Dumper method)

get_loader() (psycopg.adapt.AdaptersMap method) get_oid() (psycopg.types.TypesRegistry method) get_parameters() (psycopg.ConnectionInfo method) get_stats() (psycopg_pool.ConnectionPool method) getconn() (psycopg_pool.AsyncConnectionPool method) (psycopg_pool.ConnectionPool method) gevent gtrid (psycopg.Xid attribute)

H

has_cancel_safe() (psycopg.Capabilities method) has_encrypt_password() (psycopg.Capabilities method) has_hostaddr() (psycopg.Capabilities method) has_pipeline() (psycopg.Capabilities method) has_send_close_prepared() (psycopg.Capabilities method)

has_set_trace_flags() (psycopg.Capabilities method) has_stream_chunked() (psycopg.Capabilities method) host (psycopg.ConnectionInfo attribute) hostaddr (psycopg.ConnectionInfo attribute) hstore Data types

I

Identifier (class in psycopg.sql) IDLE (psycopg.pq.TransactionStatus attribute) idle in transaction INERROR (psycopg.pq.TransactionStatus attribute) InFailedSqlTransaction info (psycopg.Connection attribute) Integer Adaptation IntegrityError InterfaceError internal_position (psycopg.errors.Diagnostic attribute) INTERNAL_POSITION (psycopg.pq.DiagnosticField attribute)

internal_query (psycopg.errors.Diagnostic attribute) INTERNAL_QUERY (psycopg.pq.DiagnosticField attribute) internal_size (psycopg.Column attribute) InternalError IntervalStyle INTRANS (psycopg.pq.TransactionStatus attribute) is_crdb() (psycopg.crdb.CrdbConnection class method) is_supported() (psycopg.Pipeline class method) isempty (psycopg.types.range.Range attribute) isolation_level (psycopg.Connection attribute) IsolationLevel (class in psycopg) itersize (psycopg.ServerCursor attribute)

J

join() (psycopg.sql.Composed method) (psycopg.sql.SQL method)

Json (class in psycopg.types.json) Jsonb (class in psycopg.types.json)

K

kwargs_row() (in module psycopg.rows)

L

labels (psycopg.types.enum.EnumInfo attribute) libpq LibpqWriter (class in psycopg.copy) LISTEN SQL command, [1] Literal (class in psycopg.sql) load() (psycopg.abc.Loader method) (psycopg.adapt.Loader method)

Loader (class in psycopg.abc) (class in psycopg.adapt) lookup() (in module psycopg.errors) lower (psycopg.types.range.Range attribute) lower_inc (psycopg.types.range.Range attribute) lower_inf (psycopg.types.range.Range attribute)

M

make_conninfo() (in module psycopg.conninfo) max_size (psycopg_pool.ConnectionPool attribute) memoryview Adaptation message_detail (psycopg.errors.Diagnostic attribute) MESSAGE_DETAIL (psycopg.pq.DiagnosticField attribute) message_hint (psycopg.errors.Diagnostic attribute) MESSAGE_HINT (psycopg.pq.DiagnosticField attribute) message_primary (psycopg.errors.Diagnostic attribute) MESSAGE_PRIMARY (psycopg.pq.DiagnosticField attribute) min_size (psycopg_pool.ConnectionPool attribute) module psycopg psycopg._dns psycopg.abc psycopg.adapt psycopg.conninfo psycopg.crdb psycopg.errors psycopg.pq psycopg.rows psycopg.sql psycopg.types psycopg_pool

mogrify() (psycopg.ClientCursor method) Multirange (class in psycopg.types.multirange) MultirangeInfo (class in psycopg.types.multirange)

N

name (psycopg.Column attribute) (psycopg.ServerCursor attribute) (psycopg_pool.ConnectionPool attribute) Named Cursor namedtuple Adaptation namedtuple_row() (in module psycopg.rows) needs_password (psycopg.pq.PGconn attribute) News, [1] nextset() (psycopg.Cursor method) NO_ATTEMPT (psycopg.pq.Ping attribute)

NO_RESPONSE (psycopg.pq.Ping attribute) NONFATAL_ERROR (psycopg.pq.ExecStatus attribute) Notifications Asynchronous, [1] notifies() (psycopg.AsyncConnection method) (psycopg.Connection method) NOTIFY SQL command, [1] Notify (class in psycopg) NotSupportedError NULL (in module psycopg.sql) NullConnectionPool (class in psycopg_pool)

O

Objects Adaptation, [1] OFF (psycopg.pq.PipelineStatus attribute) oid (psycopg.abc.Dumper attribute) OK (psycopg.pq.ConnStatus attribute) (psycopg.pq.Ping attribute) (psycopg.pq.PollingStatus attribute)

ON (psycopg.pq.PipelineStatus attribute) open() (psycopg_pool.AsyncConnectionPool method) (psycopg_pool.ConnectionPool method) OperationalError options (psycopg.ConnectionInfo attribute) owner (psycopg.Xid attribute)

P

parameter_status() (psycopg.ConnectionInfo method) Parameters Binary Query password (psycopg.ConnectionInfo attribute) PATH payload (psycopg.Notify attribute) PgBouncer, [1] PGcancel (class in psycopg.pq) PGcancelConn (class in psycopg.pq) PGconn (class in psycopg.pq) pgconn (psycopg.Connection attribute) (psycopg.Error attribute) pgconn_ptr (psycopg.pq.PGconn attribute) PGCONNECT_TIMEOUT PGresult (class in psycopg.pq) pgresult (psycopg.Cursor attribute) (psycopg.Error attribute) pgresult_ptr (psycopg.pq.PGresult attribute) pid (psycopg.Notify attribute) Ping (class in psycopg.pq) Pipeline (class in psycopg) pipeline() (psycopg.AsyncConnection method) (psycopg.Connection method) PIPELINE_ABORTED (psycopg.pq.ExecStatus attribute) pipeline_status (psycopg.ConnectionInfo attribute) PIPELINE_SYNC (psycopg.pq.ExecStatus attribute) PipelineAborted PipelineStatus (class in psycopg.pq) Placeholder (class in psycopg.sql) PollingStatus (class in psycopg.pq) Pool Connection PoolClosed (class in psycopg_pool) PoolTimeout (class in psycopg_pool) pop_stats() (psycopg_pool.ConnectionPool method) port (psycopg.ConnectionInfo attribute) Portal PostGIS Data types precision (psycopg.Column attribute)

prepare_threshold (psycopg.Connection attribute) prepared (psycopg.Xid attribute) Prepared statements prepared_max (psycopg.Connection attribute) ProgrammingError psycopg module psycopg._dns module psycopg.abc module psycopg.adapt module psycopg.conninfo module psycopg.crdb module psycopg.errors module psycopg.pq module psycopg.rows module psycopg.sql module psycopg.types module psycopg.types.shapely.register_shapely() (in module psycopg) psycopg2 Differences PSYCOPG_IMPL, [1], [2] psycopg_pool module putconn() (psycopg_pool.AsyncConnectionPool method) (psycopg_pool.ConnectionPool method) PyFormat (class in psycopg.adapt) Python Enhancement Proposals PEP 0484 PEP 475 PEP 675, [1], [2], [3] python_type (psycopg.types.composite.CompositeInfo attribute)

Q

Query Parameters Query protocol advanced simple

quote() (in module psycopg.sql) (psycopg.abc.Dumper method) (psycopg.adapt.Dumper method)

R

range Data types, [1] Range (class in psycopg.types.range) RangeInfo (class in psycopg.types.range) RawCursor (class in psycopg) RawServerCursor (class in psycopg) read() (psycopg.AsyncCopy method) (psycopg.Copy method) READ_COMMITTED (psycopg.IsolationLevel attribute) read_only (psycopg.Connection attribute) read_row() (psycopg.AsyncCopy method) (psycopg.Copy method) READ_UNCOMMITTED (psycopg.IsolationLevel attribute) READING (psycopg.pq.PollingStatus attribute) register() (psycopg.types.TypeInfo method) register_composite() (in module psycopg.types.composite) register_dumper() (psycopg.adapt.AdaptersMap method) register_enum() (in module psycopg.types.enum) register_hstore() (in module psycopg.types.hstore) register_loader() (psycopg.adapt.AdaptersMap method) register_multirange() (in module psycopg.types.multirange) register_range() (in module psycopg.types.range) REGRESS_MODE (psycopg.pq.Trace attribute) REJECT (psycopg.pq.Ping attribute) Release notes, [1]

remove_notice_handler() (psycopg.Connection method) remove_notify_handler() (psycopg.Connection method) REPEATABLE_READ (psycopg.IsolationLevel attribute) resize() (psycopg_pool.AsyncConnectionPool method) (psycopg_pool.ConnectionPool method) (psycopg_pool.NullConnectionPool method) resolve_hostaddr_async() (in module psycopg._dns) resolve_srv() (in module psycopg._dns) resolve_srv_async() (in module psycopg._dns) RFC RFC 2782 Rollback rollback() (psycopg.AsyncConnection method) (psycopg.Connection method) row factories Row Factory Row Maker row_factory (psycopg.AsyncConnection attribute) (psycopg.Connection attribute) (psycopg.Cursor attribute) rowcount (psycopg.Cursor attribute) RowFactory (class in psycopg.rows) RowMaker (class in psycopg.rows) rownumber (psycopg.Cursor attribute) rows() (psycopg.AsyncCopy method) (psycopg.Copy method)

S

savepoint_name (psycopg.Transaction attribute) scalar_row() (in module psycopg.rows) scale (psycopg.Column attribute) schema_name (psycopg.errors.Diagnostic attribute) SCHEMA_NAME (psycopg.pq.DiagnosticField attribute) scroll() (psycopg.AsyncCursor method) (psycopg.AsyncServerCursor method) (psycopg.Cursor method) (psycopg.ServerCursor method) scrollable (psycopg.ServerCursor attribute) Security SERIALIZABLE (psycopg.IsolationLevel attribute) Server-side Cursor server_cursor_factory (psycopg.AsyncConnection attribute) (psycopg.Connection attribute) server_version (psycopg.ConnectionInfo attribute) (psycopg.crdb.CrdbConnectionInfo attribute) ServerCursor (class in psycopg) set_autocommit() (psycopg.AsyncConnection method) (psycopg.Connection method) set_deferrable() (psycopg.AsyncConnection method) (psycopg.Connection method) set_isolation_level() (psycopg.AsyncConnection method) (psycopg.Connection method) set_json_dumps() (in module psycopg.types.json) set_json_loads() (in module psycopg.types.json) set_read_only() (psycopg.AsyncConnection method) (psycopg.Connection method) set_trace_flags() (psycopg.pq.PGconn method) set_types() (psycopg.Copy method) severity (psycopg.errors.Diagnostic attribute) SEVERITY (psycopg.pq.DiagnosticField attribute)

severity_nonlocalized (psycopg.errors.Diagnostic attribute) SEVERITY_NONLOCALIZED (psycopg.pq.DiagnosticField attribute) simple Query protocol SINGLE_TUPLE (psycopg.pq.ExecStatus attribute) source_file (psycopg.errors.Diagnostic attribute) SOURCE_FILE (psycopg.pq.DiagnosticField attribute) source_function (psycopg.errors.Diagnostic attribute) SOURCE_FUNCTION (psycopg.pq.DiagnosticField attribute) source_line (psycopg.errors.Diagnostic attribute) SOURCE_LINE (psycopg.pq.DiagnosticField attribute) SQL (class in psycopg.sql) SQL command COPY LISTEN, [1] NOTIFY, [1] SQL injection SQL_ASCII Encoding sqlstate (psycopg.Error attribute) (psycopg.errors.Diagnostic attribute) SQLSTATE (psycopg.pq.DiagnosticField attribute) start() (psycopg.pq.PGcancelConn method) statement_position (psycopg.errors.Diagnostic attribute) STATEMENT_POSITION (psycopg.pq.DiagnosticField attribute) status (psycopg.ConnectionInfo attribute) statusmessage (psycopg.Cursor attribute) stream() (psycopg.AsyncCursor method) (psycopg.Cursor method) Strings Adaptation SUPPRESS_TIMESTAMPS (psycopg.pq.Trace attribute) sync() (psycopg.AsyncPipeline method) (psycopg.Pipeline method)

T

table_name (psycopg.errors.Diagnostic attribute) TABLE_NAME (psycopg.pq.DiagnosticField attribute) TEXT (psycopg.adapt.PyFormat attribute) (psycopg.pq.Format attribute) threads timezone (psycopg.ConnectionInfo attribute) TooManyRequests (class in psycopg_pool) tpc_begin() (psycopg.Connection method) tpc_commit() (psycopg.AsyncConnection method) (psycopg.Connection method) tpc_prepare() (psycopg.AsyncConnection method) (psycopg.Connection method) tpc_recover() (psycopg.AsyncConnection method) (psycopg.Connection method) tpc_rollback() (psycopg.AsyncConnection method) (psycopg.Connection method) Trace (class in psycopg.pq) trace() (psycopg.pq.PGconn method) Transaction Two-phase commit

Transaction (class in psycopg) transaction() (psycopg.AsyncConnection method) (psycopg.Connection method) transaction_status (psycopg.ConnectionInfo attribute) Transactions management TransactionStatus (class in psycopg.pq) Transformer (class in psycopg.adapt) tuple Adaptation tuple_row() (in module psycopg.rows) TUPLES_CHUNK (psycopg.pq.ExecStatus attribute) TUPLES_OK (psycopg.pq.ExecStatus attribute) Two-phase commit Transaction type_code (psycopg.Column attribute) type_display (psycopg.Column attribute) TypeInfo (class in psycopg.types) types (psycopg.adapt.AdaptersMap attribute) TypesRegistry (class in psycopg.types)

U

Unicode Adaptation UNKNOWN (psycopg.pq.TransactionStatus attribute) untrace() (psycopg.pq.PGconn method) upgrade() (psycopg.abc.Dumper method) (psycopg.adapt.Dumper method)

upper (psycopg.types.range.Range attribute) upper_inc (psycopg.types.range.Range attribute) upper_inf (psycopg.types.range.Range attribute) Usage Example used_password (psycopg.pq.PGconn attribute) user (psycopg.ConnectionInfo attribute)

V

vendor (psycopg.ConnectionInfo attribute) (psycopg.crdb.CrdbConnectionInfo attribute)

version() (in module psycopg.pq)

W

wait() (psycopg_pool.AsyncConnectionPool method) (psycopg_pool.ConnectionPool method) (psycopg_pool.NullConnectionPool method) Warning with withhold (psycopg.ServerCursor attribute) write() (psycopg.AsyncCopy method) (psycopg.Copy method) (psycopg.copy.AsyncWriter method) (psycopg.copy.Writer method)

write_row() (psycopg.AsyncCopy method) (psycopg.Copy method) Writer (class in psycopg.copy) WRITING (psycopg.pq.PollingStatus attribute)

X

Xid (class in psycopg)

xid() (psycopg.Connection method)