Connect an SQLAlchemy application to Neon
Set up a Neon project in seconds and connect from an SQLAlchemy application
SQLAlchemy is a Python SQL toolkit and Object Relational Mapper (ORM) that provides application developers with the full power and flexibility of SQL. This guide describes how to create a Neon project and connect to it from SQLAlchemy.
To complete the steps in this topic, ensure that you have an SQLAlchemy installation with a Postgres driver. The following instructions use
psycopg2, the default driver for Postgres in SQLAlchemy. For SQLAlchemy installation instructions, refer to the SQLAlchemy Installation Guide.
psycopg2 installation instructions are provided below.
To connect to Neon from SQLAlchemy:
- Create a Neon project
- Install psycopg2
- Create the "hello neon" program
- Create an SQLAlchemy engine for your Neon project
Create a Neon project
If you do not have one already, create a Neon project. Save your connection details, including your password. They are required when defining connection settings.
- Navigate to the Projects page in the Neon Console.
- Click New Project.
- Specify your project settings and click Create Project.
Psycopg2 is a popular python library for running raw Postgres queries.
For most operating systems, the quickest installation method is using the PIP package manager. For example:
For additional information about installing
psycopg2, refer to the psycopg2 installation documentation.
Create the "hello neon" program
You can find all of the connection details mentioned above in the Connection Details widget on the Neon Dashboard. For more information, see Connect from any application.
This example was tested with Python 3 and psycopg2 version 2.9.3.
Create an SQLAlchemy engine for your Neon project
SQLAlchemy uses engine abstraction to manage database connections and exposes a
create_engine function as the primary endpoint for engine initialization.
The following example creates an SQLAlchemy engine that points to your Neon branch:
You can find all of the connection details listed above in the Connection Details widget on the Neon Dashboard. For more information, see Connect from any application.
For additional information about connecting from SQLAlchemy, refer to the following topics in the SQLAlchemy documentation:
Last updated on