sqlalchemy-cubrid 1.4.3

CUBRID dialect for SQLAlchemy

sqlalchemy-cubrid

SQLAlchemy 2.0–2.1 dialect for the CUBRID database — Python ORM, schema reflection, Alembic migrations, and type mapping for SQLAlchemy and CUBRID-specific types.

🇰🇷 한국어 · 🇺🇸 English · 🇨🇳 中文 · 🇮🇳 हिन्दी · 🇩🇪 Deutsch · 🇷🇺 Русский

---

Status: Production/Stable — sqlalchemy-cubrid is a maintained SQLAlchemy dialect for CUBRID supporting SQLAlchemy 2.0–2.1 and CUBRID 10.2–11.4.

Why sqlalchemy-cubrid?

CUBRID is a high-performance open-source relational database, widely adopted in Korean public-sector and enterprise applications. Until now, there was no actively maintained SQLAlchemy dialect that supports the modern 2.0–2.1 API.

sqlalchemy-cubrid bridges that gap:

• Full SQLAlchemy 2.0–2.1 dialect with statement caching and PEP 561 typing
• Extensive offline test suite with high code coverage (CI badge above) — no database required to run them
• Concurrency stress tests — QueuePool sync threaded + asyncio.gather workloads validated against live CUBRID
• SQLAlchemy 2.2-ready compat shim — private API access wrapped in _compat.py (still pinned <2.2 until full SA 2.2 validation)
• Tested against 4 CUBRID versions (10.2, 11.0, 11.2, 11.4) across Python 3.10 -- 3.14
• CUBRID-specific DML constructs: ON DUPLICATE KEY UPDATE, MERGE, REPLACE INTO
• Alembic migration support out of the box
• Three driver options — C-extension (cubrid://), pure Python (cubrid+pycubrid://), or async pure Python (cubrid+aiopycubrid://)

Support Status

• Status: Production/Stable
• Supported matrix: SQLAlchemy >=2.0,<2.2, CUBRID 10.2, 11.0, 11.2, 11.4, Python 3.10–3.14
• Integration CI exercises Python 3.10 and 3.14 against all four CUBRID versions on every PR; intermediate versions (3.11–3.13) are supported and validated via the offline test suite
• SQLAlchemy 2.2 remains canary-only until explicitly added to the supported matrix
• See Known Limitations for behavior boundaries and unsupported features

Architecture

flowchart TD
    app["Application"] --> sa["SQLAlchemy Core/ORM"]
    sa --> dialect["CubridDialect"]
    dialect --> pycubrid["pycubrid driver"]
    dialect --> cext["CUBRIDdb driver"]
    dialect --> aio["pycubrid.aio async driver"]
    pycubrid --> server["CUBRID Server"]
    cext --> server
    aio --> server

flowchart TD
    expr["SQL Expression"] --> compiler["CubridSQLCompiler"] --> sql["SQL String"]

Requirements

• Python 3.10+
• SQLAlchemy 2.0 – 2.1
• CUBRID-Python (C-extension) or pycubrid (pure Python)

Installation

pip install sqlalchemy-cubrid

With the pure Python driver (no C build needed):

pip install "sqlalchemy-cubrid[pycubrid]"

With Alembic support:

pip install "sqlalchemy-cubrid[alembic]"

Quick Start

Core (Connection-Level)

from sqlalchemy import create_engine, text

engine = create_engine("cubrid://dba:password@localhost:33000/demodb")

with engine.connect() as conn:
    result = conn.execute(text("SELECT 1"))
    print(result.scalar())

ORM (Session-Level)

from sqlalchemy import create_engine, String
from sqlalchemy.orm import DeclarativeBase, Mapped, Session, mapped_column


class Base(DeclarativeBase):
    pass


class User(Base):
    __tablename__ = "users"

    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
    name: Mapped[str] = mapped_column(String(100))
    email: Mapped[str] = mapped_column(String(200), unique=True)


engine = create_engine("cubrid://dba:password@localhost:33000/demodb")
Base.metadata.create_all(engine)

with Session(engine) as session:
    user = User(name="Alice", email="[e-mail]")
    session.add(user)
    session.commit()

Async

from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession
from sqlalchemy import text

engine = create_async_engine("cubrid+aiopycubrid://dba:password@localhost:33000/demodb")

async with AsyncSession(engine) as session:
    result = await session.execute(text("SELECT 1"))
    print(result.scalar())

Features

• Type mapping for SQLAlchemy standard and CUBRID-specific types — numeric, string, date/time, bit, LOB, collection, and JSON types
• SQL compilation -- SELECT, JOIN, CAST, LIMIT/OFFSET, subqueries, CTEs, window functions
• DML extensions -- ON DUPLICATE KEY UPDATE, MERGE, REPLACE INTO, FOR UPDATE, TRUNCATE
• DDL support -- COMMENT, IF NOT EXISTS / IF EXISTS, AUTO_INCREMENT
• Schema reflection -- tables, views, columns, PKs, FKs, indexes, unique constraints, comments
• Alembic migrations via CubridImpl (auto-discovered entry point)
• All 6 CUBRID isolation levels (dual-granularity: class-level + instance-level)
• Async support — create_async_engine("cubrid+aiopycubrid://...") via pycubrid.aio

Known Limitations

• No RETURNING — INSERT/UPDATE/DELETE ... RETURNING not supported; use cursor.lastrowid or SELECT LAST_INSERT_ID() after the statement
• No sequences — CUBRID uses AUTO_INCREMENT only
• No multi-schema — single schema per database
• DDL auto-commits — migrations are not transactional (transactional_ddl = False); use Alembic batch migrations and test rollback scenarios manually
• SQLAlchemy 2.0–2.1 only — pinned to <2.2 due to internal API dependencies (details)
• Async requires pycubrid >= 1.3.2,<2.0 — the cubrid+aiopycubrid:// driver needs the async-capable pycubrid package line currently supported by this project
• CARDINALITY() broken — func.cardinality() raises CompileError with workaround guidance; the CUBRID server has a known bug
• Reserved words auto-quoted — Column names matching CUBRID reserved words (day, count, value, etc.) are automatically double-quoted in DDL; see reserved word list
• Timezone type fidelity — CUBRID TIMESTAMPTZ is reflected as TIMESTAMP; timezone offset is preserved in the stored value but the dialect does not distinguish TZ vs LTZ semantics at the SQLAlchemy type level. In practice this means datetime objects round-trip correctly but explicit TZ/LTZ type introspection is not available

Documentation

Guide	Description
Connection	Connection strings, URL format, driver setup, pool tuning
Type Mapping	Full type mapping, CUBRID-specific types, collection types
DML Extensions	ON DUPLICATE KEY UPDATE, MERGE, REPLACE INTO, query trace
Isolation Levels	All 6 CUBRID isolation levels, configuration
Alembic Migrations	Setup, configuration, limitations, batch workarounds
Feature Support	Comparison with MySQL, PostgreSQL, SQLite
ORM Cookbook	Practical ORM examples, relationships, queries
Development	Dev setup, testing, Docker, coverage, CI/CD
Driver Compatibility	CUBRID-Python driver versions and known issues
Troubleshooting	Common issues, error solutions, debugging techniques
Async Connection	Async engine setup with cubrid+aiopycubrid://

Compatibility Matrix

Component	Supported versions
Python	3.10, 3.11, 3.12, 3.13, 3.14
CUBRID	10.2, 11.0, 11.2, 11.4
SQLAlchemy	2.0–2.1
Alembic	>=1.7
pycubrid (sync)	>=1.3.2,<2.0
pycubrid (async)	>=1.3.2,<2.0

FAQ

How do I connect to CUBRID with SQLAlchemy?

from sqlalchemy import create_engine
engine = create_engine("cubrid://dba:password@localhost:33000/demodb")

For the pure Python driver (no C build needed): create_engine("cubrid+pycubrid://dba@localhost:33000/demodb")

Does sqlalchemy-cubrid support SQLAlchemy 2.0–2.1?

Yes. sqlalchemy-cubrid is built for SQLAlchemy 2.0–2.1 and supports the 2.0-style API including Session.execute(), typed Mapped[] columns, and statement caching.

Does sqlalchemy-cubrid support Alembic migrations?

Yes. Install with pip install "sqlalchemy-cubrid[alembic]". The dialect auto-registers via entry point. Note that CUBRID auto-commits DDL, so migrations are not transactional.

What Python versions are supported?

Python 3.10, 3.11, 3.12, 3.13, and 3.14.

Does CUBRID support RETURNING clauses?

No. CUBRID does not support INSERT ... RETURNING or UPDATE ... RETURNING. Use cursor.lastrowid or SELECT LAST_INSERT_ID() instead.

How do I use ON DUPLICATE KEY UPDATE with CUBRID?

from sqlalchemy_cubrid import insert
stmt = insert(users).values(name="Alice").on_duplicate_key_update(name="Alice Updated")

What's the difference between cubrid:// and cubrid+pycubrid://?

cubrid:// uses the C-extension driver (CUBRIDdb) which requires compilation. cubrid+pycubrid:// uses the pure Python driver which installs with pip alone — no build tools needed. cubrid+aiopycubrid:// uses the async variant of the pure Python driver for use with create_async_engine and AsyncSession.

Does sqlalchemy-cubrid support async?

Yes. Use create_async_engine("cubrid+aiopycubrid://...") with the pycubrid async driver. Requires pycubrid>=1.3.2,<2.0. Both pycubrid dialects use native Connection.ping(False) / AsyncConnection.ping(False) for pool_pre_ping, and all Core and ORM features work with AsyncSession.

Related Projects

• pycubrid — Pure Python DB-API 2.0 driver for CUBRID
• cubrid-cookbook-python — Production-ready Python examples for CUBRID

Roadmap

See ROADMAP.md for this project's direction and next milestones.

For the ecosystem-wide view, see the CUBRID Labs Ecosystem Roadmap and Project Board.

Contributing

See CONTRIBUTING.md for guidelines and docs/DEVELOPMENT.md for development setup.

Security

Report vulnerabilities via email -- see SECURITY.md. Do not open public issues for security concerns.

License

MIT -- see LICENSE.