Using the CData ODBC Driver for Supabase in PyCharm
The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Supabase from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.
To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Supabase as well as PyCharm.
Add Pyodbc to the Project
Follow the steps below to add the pyodbc module to your project.
- Click File -> Settings to open the project settings window.
- Click Project Interpreter from the Project: YourProjectName menu.
- To add pyodbc, click the + button and enter pyodbc.
- Click Install Package to install pyodbc.
Connect to Supabase
You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.
Start by setting the Profile connection property to the location of the Supabase Profile on disk (e.g. C:\profiles\Supabase.apip). Next, set the ProfileSettings connection property to the connection string for Supabase (see below).
Supabase API Profile Settings
Log into your Supabase account and navigate to Account Settings > Access Tokens to generate a new personal access token.
Below is the syntax for a DSN:
[CData API Source] Driver = CData ODBC Driver for Supabase Description = My Description Profile = C:\profiles\Supabase.apip ProfileSettings = 'APIKey = your_api_key'
Execute SQL to Supabase
Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.
import pyodbc
cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};Profile = C:\profiles\Supabase.apip;ProfileSettings = 'APIKey = your_api_key';')
cursor = cnxn.cursor()
cursor.execute("SELECT Ref, PostgresVersion FROM Branch WHERE Status = 'active'")
rows = cursor.fetchall()
for row in rows:
print(row.Ref, row.PostgresVersion)
After connecting to Supabase in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Supabase data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].