You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: clarify Oracle testing status and simplify driver documentation
- Add prominent warning that Oracle is NOT tested in CI or integration tests
- Simplify Database Drivers section by removing redundant driver list,
keeping only SQLAlchemy documentation link
- Add Notes section with MSSQL ODBC driver installation requirement
- Document Oracle Database Free limitation across all relevant files:
- README.md
- CLAUDE.md
- .github/workflows/python-package.yml
- db.docker-compose.yml
- scripts/run-test.sh
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: CLAUDE.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,13 @@ cd tests
38
38
docker compose up --abort-on-container-exit
39
39
```
40
40
41
+
> **Note:** Oracle testing requires **Oracle Database Enterprise/Standard Edition**. Oracle Database Free (23c/23ai) does NOT support `DBMS_LOCK.REQUEST` which is required for distributed lock functionality. This is a fundamental limitation of the Free/Express edition, not related to the container image flavor.
42
+
43
+
For local Oracle testing, ensure you have a full Oracle Database installation or use the official Oracle image:
> Oracle Database Free (23c/23ai) does NOT support `DBMS_LOCK.REQUEST`. We do NOT test Oracle in CI or integration tests. Use with Oracle Enterprise/Standard Edition at your own risk.
22
25
23
26
---
24
27
@@ -59,34 +62,15 @@ pip install sqlalchemy-dlock
59
62
60
63
### Database Drivers
61
64
62
-
This library requires a database driver to be installed separately. Since you're already using SQLAlchemy, you likely have the appropriate driver installed.
63
-
64
-
**MySQL / MariaDB:**
65
-
-`mysqlclient` - Recommended C extension (synchronous)
66
-
-`pymysql` - Pure Python (synchronous)
67
-
-`aiomysql` - Async I/O
68
-
69
-
**PostgreSQL:**
70
-
-`psycopg2` or `psycopg2-binary` - v2 (synchronous)
This library requires a database driver to be installed separately. Since you're already using SQLAlchemy, you likely have the appropriate driver installed. For a complete list of SQLAlchemy-supported drivers, see the [SQLAlchemy Dialects documentation](https://docs.sqlalchemy.org/en/latest/dialects/).
78
66
79
-
**Oracle:**
80
-
-`oracledb` - Official driver (synchronous & asynchronous, recommended)
81
-
-`cx_Oracle` - Legacy driver (synchronous)
82
-
83
-
> ℹ️ **Note:**\
84
-
> The drivers listed above are commonly used options. In general, any driver supported by SQLAlchemy for your target database should work with sqlalchemy-dlock. For a complete list of SQLAlchemy-supported drivers, see the [SQLAlchemy Dialects documentation](https://docs.sqlalchemy.org/en/latest/dialects/).
> Oracle Database Free (23c/23ai) does NOT support `DBMS_LOCK.REQUEST` which is required for distributed lock functionality. For production use with Oracle, a full Oracle Database (Enterprise/Standard Edition) installation is required.
0 commit comments