diff --git a/docs/contributing.md b/docs/contributing.md index 45aad3d..2e43083 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -75,6 +75,11 @@ To run the linting, use: $ hatch fmt ``` +!!! Note + If you get stuck into segfaults, you might want to use the environment parameter: `TEST_NO_RISK_SEGFAULTS=true`. + MSSQL and odbc may can segfault, though seldom. + This parameter is active for github actions. + ### Documentation Improving the documentation is quite easy and it is placed inside the `databasez/docs` folder. diff --git a/docs/index.md b/docs/index.md index 466f437..64ca6fe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -116,10 +116,7 @@ $ pip install databasez[aioodbc] ``` !!! Note - Note that if you are using any synchronous SQLAlchemy functions such as `engine.create_all()` - or [alembic][alembic] migrations then you still have to install a synchronous DB driver: - [psycopg][psycopg] for PostgreSQL, [pymysql][pymysql] for MySQL and - [pyodbc][pyodbc] for SQL Server. + MSSQL and odbc may segfaults with threading (sometimes but in tests it can be more often). ---