Skip to content

Connect to CUBRID in 5 Minutes

Get from pip install to a working CRUD script with explicit transaction handling.

Prerequisites

  • CUBRID server and broker are running
  • Python 3.10+
  • Access to a target database (for example, testdb)

Note

Default local connection values in pycubrid examples are: host="localhost", port=33000, user="dba", password="".

1) Install pycubrid

pip install pycubrid

Tip

Use a virtual environment to isolate dependencies: python -m venv .venv && source .venv/bin/activate.

2) Open a connection and run a query

from __future__ import annotations

import pycubrid

conn = pycubrid.connect(
    host="localhost",
    port=33000,
    database="testdb",
    user="dba",
    password="",
)

cur = conn.cursor()
cur.execute("SELECT 1 + 1")
print(cur.fetchone())  # (2,)

cur.close()
conn.close()

3) Run simple CRUD operations

from __future__ import annotations

import pycubrid

conn = pycubrid.connect(database="testdb")
cur = conn.cursor()

cur.execute(
    """
    CREATE TABLE IF NOT EXISTS qs_users (
        id INT AUTO_INCREMENT PRIMARY KEY,
        name VARCHAR(100) NOT NULL,
        age INT NOT NULL
    )
    """
)

# INSERT
cur.execute("INSERT INTO qs_users (name, age) VALUES (?, ?)", ["Alice", 30])

# SELECT
cur.execute("SELECT id, name, age FROM qs_users ORDER BY id")
print(cur.fetchall())

# UPDATE
cur.execute("UPDATE qs_users SET age = ? WHERE name = ?", [31, "Alice"])

# DELETE
cur.execute("DELETE FROM qs_users WHERE name = ?", ["Alice"])

conn.commit()
cur.close()
conn.close()

Warning

pycubrid uses ? placeholders (qmark style), not %s.

4) Use explicit transaction handling

from __future__ import annotations

import pycubrid

conn = pycubrid.connect(database="testdb")
cur = conn.cursor()

try:
    cur.execute("INSERT INTO qs_users (name, age) VALUES (?, ?)", ["Bob", 25])
    cur.execute("INSERT INTO qs_users (name, age) VALUES (?, ?)", ["Carol", 28])
    conn.commit()
except pycubrid.Error:
    conn.rollback()
    raise
finally:
    cur.close()
    conn.close()

Tip

For automatic commit/rollback and close, use with pycubrid.connect(...) as conn:.

Quickstart workflow

mermaid flowchart TD A[Install pycubrid] --> B[Connect with pycubrid.connect] B --> C[Create cursor] C --> D[Execute CRUD SQL] D --> E{Success?} E -->|Yes| F[Commit] E -->|No| G[Rollback] F --> H[Close cursor and connection] G --> H

Next steps