Q2DB: Lightweight Python DB API Wrapper & ORM
Q2DB is a lightweight Python library that wraps standard DB API connectors for MySQL, PostgreSQL, and SQLite, providing a simple ORM-like interface for database operations. It enables easy schema definition and migration, supports basic CRUD operations, and offers a convenient cursor abstraction for querying and manipulating data. Q2DB is designed for rapid prototyping, small projects, and educational purposes, focusing on simplicity and minimal configuration.
Key features include:
- Unified API for MySQL, PostgreSQL, and SQLite
- Schema definition and migration (ADD COLUMN only)
- Simple ORM-like CRUD operations (insert, update, delete, get)
- Foreign key checks and logging of changes
- Cursor abstraction for flexible queries and record navigation
- Docker support for quick setup and testing
Features:
Connect
from q2db.db import Q2Db
database_sqlite = Q2Db("sqlite3", database_name=":memory:")
# or just
database_sqlite = Q2Db()
database_mysql = Q2Db(
"mysql",
user="root",
password="q2test"
host="0.0.0.0",
port="3308",
database_name="q2test",
)
# or just
database_mysql = Q2Db(url="mysql://root:q2test@0.0.0.0:3308/q2test")
database_postgresql = Q2Db(
"postgresql",
user="q2user",
password="q2test"
host="0.0.0.0",
port=5432,
database_name="q2test1",
)
Define & migrate database schema (ADD COLUMN only).
q2db.schema import Q2DbSchema
schema = Q2DbSchema()
schema.add(table="topic_table", column="uid", datatype="int", datalen=9, pk=True)
schema.add(table="topic_table", column="name", datatype="varchar", datalen=100)
schema.add(table="message_table", column="uid", datatype="int", datalen=9, pk=True)
schema.add(table="message_table", column="message", datatype="varchar", datalen=100)
schema.add(
table="message_table",
column="parent_uid",
to_table="topic_table",
to_column="uid",
related="name"
)
database.set_schema(schema)
INSERT, UPDATE, DELETE
database.insert("topic_table", {"name": "topic 0"})
database.insert("topic_table", {"name": "topic 1"})
database.insert("topic_table", {"name": "topic 2"})
database.insert("topic_table", {"name": "topic 3"})
database.insert("message_table", {"message": "Message 0 in 0", "parent_uid": 0})
database.insert("message_table", {"message": "Message 1 in 0", "parent_uid": 0})
database.insert("message_table", {"message": "Message 0 in 1", "parent_uid": 1})
database.insert("message_table", {"message": "Message 1 in 1", "parent_uid": 1})
# this returns False because there is no value 2 in topic_table.id - schema works!
database.insert("message_table", {"message": "Message 1 in 1", "parent_uid": 2})
database.delete("message_table", {"uid": 2})
database.update("message_table", {"uid": 0, "message": "updated message"})
Cursor
cursor = database.cursor(table_name="topic_table")
cursor = database.cursor(
table_name="topic_table",
where=" name like '%2%'",
order="name desc"
)
cursor.insert({"name": "insert record via cursor"})
cursor.delete({"uid": 2})
cursor.update({"uid": 0, "message": "updated message"})
cursor = database.cursor(sql="select name from topic_table")
for x in cursor.records():
print(x)
print(cursor.r.name)
cursor.record(0)['name']
cursor.row_count()
cursor.first()
cursor.last()
cursor.next()
cursor.prev()
cursor.bof()
cursor.eof()
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
q2db-0.1.67.tar.gz
(23.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
q2db-0.1.67-py3-none-any.whl
(25.3 kB
view details)
File details
Details for the file q2db-0.1.67.tar.gz.
File metadata
- Download URL: q2db-0.1.67.tar.gz
- Upload date:
- Size: 23.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.5.0 CPython/3.11.7 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
debb8db65e0bfdcc2eebad8764456a3799c0d95684db27fdc98511b3562aac9a
|
|
| MD5 |
b0a071114d2534f9931b5303d3674de3
|
|
| BLAKE2b-256 |
563d4309850cbc82954bb79b6458da0dc13ca083eeb26a86493121821170be3a
|
File details
Details for the file q2db-0.1.67-py3-none-any.whl.
File metadata
- Download URL: q2db-0.1.67-py3-none-any.whl
- Upload date:
- Size: 25.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.5.0 CPython/3.11.7 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
824de3ce2e436ea511d1713794ef74e514bf056f0036670237b80b02eb4b37c0
|
|
| MD5 |
2045ae4bd8669a7769d6ab9c3af0b29e
|
|
| BLAKE2b-256 |
6130e6c4c5f49836b0b4f323d2e55ee8cdf3989dff87abb8517820ae3e37bb2c
|
