Build a Python application
AttentionThis page documents an earlier version. Go to the latest (v2.3) version.
The following tutorial creates a simple Python application that connects to a YugabyteDB cluster using the
psycopg2 database adapter, performs a few basic database operations — creating a table, inserting data, and running a SQL query — and prints the results to the screen.
Before you begin
This tutorial assumes that you have satisfied the following prerequisites.
YugabyteDB is up and running. If you are new to YugabyteDB, you can have YugabyteDB up and running within five minutes by following the steps in Quick start.
Python 3, or later, is installed.
psycopg2 database adapter
Psycopg,the popular PostgreSQL database adapter for Python, is installed. To install a binary version of
psycopg2, run the following
$ pip3 install psycopg2-binary
For details about using this database adapter, see Psycopg documentation.
Create the sample Python application
Create a file
yb-sql-helloworld.py and add the following content to it.
import psycopg2 # Create the database connection. conn = psycopg2.connect("host=127.0.0.1 port=5433 dbname=yugabyte user=yugabyte password=yugabyte") # Open a cursor to perform database operations. # The default mode for psycopg2 is "autocommit=false". conn.set_session(autocommit=True) cur = conn.cursor() # Create the table. (It might preexist.) cur.execute( """ DROP TABLE IF EXISTS employee """) cur.execute( """ CREATE TABLE employee (id int PRIMARY KEY, name varchar, age int, language varchar) """) print("Created table employee") cur.close() # Take advantage of ordinary, transactional behavior for DMLs. conn.set_session(autocommit=False) cur = conn.cursor() # Insert a row. cur.execute("INSERT INTO employee (id, name, age, language) VALUES (%s, %s, %s, %s)", (1, 'John', 35, 'Python')) print("Inserted (id, name, age, language) = (1, 'John', 35, 'Python')") # Query the row. cur.execute("SELECT name, age, language FROM employee WHERE id = 1") row = cur.fetchone() print("Query returned: %s, %s, %s" % (row, row, row)) # Commit and close down. conn.commit() cur.close() conn.close()
Run the application
To use the application, run the following Python script you just created.
$ python yb-sql-helloworld.py
You should see the following output.
Created table employee Inserted (id, name, age, language) = (1, 'John', 35, 'Python') Query returned: John, 35, Python