CData Python Connector for API

Build 26.0.9655

Connecting

Connecting With a Dialect URL

Establishing a connection using SQLAlchemy requires a specific URL format.
from sqlalchemy import create_engine
engine = create_engine("api:///?Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>")

For SQLAlchemy 2.0, the dialect name is api_2. To establish a connection, use the following URL format:

from sqlalchemy import create_engine
engine = create_engine("api_2:///?Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>")

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655