Psycopg is the most popular PostgreSQL database adapter for the Python programming language. Its main features are the complete implementation of the Python DB API 2.0 specification and the thread safety (several threads can share the same connection). YugabyteDB has full support for Psycopg2. psycopg2 is based on libpq and supports the SCRAM-SHA-256 authentication method.
For details on using psycopg2, see Psycopg documentation.
For a tutorial on building a sample Python application that uses psycopg2, see Connect an application.
Learn how to perform common tasks required for Python application development using the PostgreSQL Psycopg2 driver.
Download the driver dependency
If prerequisites are met, you can install psycopg like any other Python package, using pip to download it from PyPI:
$ pip install psycopg2
Or, you can use the setup.py script if you've downloaded the source package locally:
$ python setup.py build $ sudo python setup.py install
You can also obtain a stand-alone package, not requiring a compiler or external libraries, by installing the psycopg2-binary package from PyPI:
$ pip install psycopg2-binary
The binary package is a practical choice for development and testing but in production it is recommended to use the package built from sources.
Connect to YugabyteDB database
Python applications can connect to and query the YugabyteDB database using the following:
Import the psycopg2 package.
The Connection details can be provided as a string or a dictionary.
"dbname=database_name host=hostname port=port user=username password=password"
user = 'username', password='xxx', host = 'hostname', port = 'port', dbname = 'database_name'
The following table describes the connection parameters required to connect to the YugabyteDB database
|host||hostname of the YugabyteDB instance||localhost|
|port||Listen port for YSQL||5433|
|user||User for connecting to the database||yugabyte|
|password||Password for the user||yugabyte|
The following is an example connection string for connecting to YugabyteDB.
conn = psycopg2.connect(dbname='yugabyte',host='localhost',port='5433',user='yugabyte',password='yugabyte')
Create a cursor
To execute any SQL commands, a cursor needs to be created after a connection is made. It allows Python code to execute PostgreSQL commands in a database session. Cursors are created by the
connection.cursor() method; they are bound to the connection for the entire lifetime, and all the commands are executed in the context of the database session wrapped by the connection.
cur = conn.cursor()
Tables can be created in YugabyteDB by passing the
CREATE TABLE DDL statement to the
cursor.execute(statement) method, using the following example:
CREATE TABLE IF NOT EXISTS employee (id int PRIMARY KEY, name varchar, age int, language text)
conn = psycopg2.connect(dbname='yugabyte',host='localhost',port='5433',user='yugabyte',password='yugabyte') cur = conn.cursor() cur.execute('CREATE TABLE IF NOT EXISTS employee (id int PRIMARY KEY, name varchar, age int, language varchar)')
Read and write data
To write data into YugabyteDB, execute the
INSERT statement using the
INSERT INTO employee VALUES (1, 'John', 35, 'Java')
conn = psycopg2.connect(dbname='yugabyte',host='localhost',port='5433',user='yugabyte',password='yugabyte') cur = conn.cursor() cur.execute('INSERT INTO employee VALUES (1, 'John', 35, 'Java')')
To query data from YugabyteDB tables, execute the
SELECT statement using
cursor.execute(statement) method followed by
fetchall() fetches all the rows of a query result, returning them as a list of tuples. An empty list is returned if there are no records to fetch.
SELECT * from employee;
conn = psycopg2.connect(dbname='yugabyte',host='localhost',port='5433',user='yugabyte',password='yugabyte') cur = conn.cursor() cur.execute('SELECT * from employee') rows = cur.fetchall() for row in rows: print("\nQuery returned: %s, %s, %s" % (row, row, row))
Psycopg2 supports several SSL modes, as follows:
|SSL mode||Client driver behavior|
By default, the driver supports the
prefer SSL mode. And in the
require mode, a root CA certificate isn't required to be configured.
verify-full, you need to provide the path to the root CA certificate in the connection string using the
sslrootcert parameter. The default location is
~/.postgresql/root.crt. If the root certificate is in a different file, specify it in the
conn = psycopg2.connect("host=<hostname> port=5433 dbname=yugabyte user=<username> password=<password> sslmode=verify-full sslrootcert=/Users/my-user/Downloads/root.crt")
The difference between
verify-full depends on the policy of the root CA. If you're using a public CA, verify-ca allows connections to a server that somebody else may have registered with the CA. Because of this behavior, you should always use verify-full with a public CA. If you're using a local CA, or even a self-signed certificate, using verify-ca may provide enough protection, but the best security practice is to always use verify-full.