psycopg2

Package psycopg2

[show private | hide private]

Package psycopg2

A Python driver for PostgreSQL

psycopg is a PostgreSQL database adapter for the Python programming language. This is version 2, a complete rewrite of the original code to provide new-style classes for connection and cursor objects and other sweet candies. Like the original, psycopg 2 was written with the aim of being very small and fast, and stable as a rock.

Homepage: http://initd.org/projects/psycopg2

Submodules
`extensions`: psycopg extensions to the DBAPI-2.0 `extras`: Miscellaneous goodies for psycopg2 `pool`: Connection pooling for psycopg2 `psycopg1`: psycopg 1.1.x compatibility module `tz`: tzinfo implementations for psycopg2 `_psycopg`: psycopg PostgreSQL driver

Exceptions
`DatabaseError`	Error related to the database engine.
`DataError`	Error related to problems with the processed data.
`Error`	Base class for error exceptions.
`IntegrityError`	Error related to database integrity.
`InterfaceError`	Error related to the database interface.
`InternalError`	The database encountered an internal error.
`NotSupportedError`	A not supported datbase API was called.
`OperationalError`	Error related to database operation (disconnect, memory allocation etc).
`ProgrammingError`	Error related to database programming (SQL error, table not found etc).
`Warning`	A database warning.

Function Summary
Connections creation
`extensions.connection`	`connect(dsn, ...)` Create a new database connection.
Value objects constructors
new binary object	`Binary(buffer)` Build an object capable to hold a bynary string value.
new date	`Date(year, month, day)` Build an object holding a date value.
new date	`DateFromTicks(ticks)` Build an object holding a date value from the given ticks value.
new time	`Time(hour, minutes, seconds, tzinfo)` Build an object holding a time value.
new time	`TimeFromTicks(ticks)` Build an object holding a time value from the given ticks value.
new timestamp	`Timestamp(year, month, day, hour, minutes, seconds, tzinfo)` Build an object holding a timestamp value.
new timestamp	`TimestampFromTicks(ticks)` Build an object holding a timestamp value from the given ticks value.

Function Details

connect(dsn, ...)

Create a new database connection.

This function supports two different but equivalent sets of arguments. A single data source name or dsn string can be used to specify the connection parameters, as follows:

psycopg2.connect("dbname=xxx user=xxx ...")

If dsn is not provided it is possible to pass the parameters as keyword arguments; e.g.:

psycopg2.connect(database='xxx', user='xxx', ...)

The full list of available parameters is:

dbname -- database name (only in 'dsn')
database -- database name (only as keyword argument)
host -- host address (defaults to UNIX socket if not provided)
port -- port number (defaults to 5432 if not provided)
user -- user name used to authenticate
password -- password used to authenticate
sslmode -- SSL mode (see PostgreSQL documentation)

If the connection_factory keyword argument is not provided this function always return an instance of the connection class. Else the given sub-class of extensions.connection will be used to instantiate the connection object.

Returns:: New database connection
(type=extensions.connection)

Binary(buffer)

Build an object capable to hold a bynary string value.

Returns:: new binary object

Date(year, month, day)

Build an object holding a date value.

Returns:: new date

DateFromTicks(ticks)

Build an object holding a date value from the given ticks value.

Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).

Returns:: new date

Time(hour, minutes, seconds, tzinfo=None)

Build an object holding a time value.

Returns:: new time

TimeFromTicks(ticks)

Build an object holding a time value from the given ticks value.

Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).

Returns:: new time

Timestamp(year, month, day, hour, minutes, seconds, tzinfo=None)

Build an object holding a timestamp value.

Returns:: new timestamp

TimestampFromTicks(ticks)

Build an object holding a timestamp value from the given ticks value.

Ticks are the number of seconds since the epoch; see the documentation of the standard Python time module for details).

Returns:: new timestamp