Skip to content

Connecting to Postgres using Opteryx

This short guide demonstrates how to connect to Postgres using Opteryx using SQLAlchemy.


Install Opteryx and libraries for connecting to Postgres.

$ pip install opteryx
$ pip install sqlalchemy
$ pip install psycopg2-binary

Registering Postgres with Opteryx

Create a SQLAlchemy Engine and register it as a store with Opteryx.

import opteryx
from opteryx.connectors import SqlConnector
from sqlalchemy import create_engine
# Replace with your connection string.
# For more information on SQLAlchemy Engine, see:
connection_string = "postgresql+psycopg2://<user>:<password>@<server>/"
sqlalchemy_engine = create_engine(connection_string)

# Register as a store, so we know queries for relations with the
# provided prefix should be directed to this database
    prefix="postgres_example",  # can be any string
    remove_prefix=True,  # the prefix isn't part of the Postgres table name

Parameters Explained

  • prefix A string to identify which queries should be directed to this database.
  • connector The type of connector to use.
  • remove_prefix Boolean flag to indicate if the prefix should be removed when querying the actual Postgres table.
  • engine SQLAlchemy Engine to connect to Postgres.

Querying Postgres from Opteryx

# Execute query against the store.
result = opteryx.query("SELECT * FROM postgres_example.planets LIMIT 5;")

Other Services

Opteryx supports connecting to other SQL engines using this method, such as MySQL, CockroachDB and DuckDB.