Merge pull request #149 from alan-turing-institute/sql-server

Add instructions for SQL Server
alan-turing-institute · Oct 2, 2023 · 969f761 · 969f761
2 parents 73044ce + aaab007
commit 969f761
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
@@ -13,5 +13,7 @@ Which DBMSs does SqlSynthGen support?
 * SqlSynthGen most fully supports **PostgresSQL**, which it uses for its end-to-end functional tests.
 * SqlSynthGen also supports **MariaDB**, as long as you don't set ``use-asyncio: true`` in your config.
 * SqlSynthGen *might*, work with **SQLite** but this is largely untested.
+* SqlSynthGen may also work with SQL Server.
+  To connect to SQL Server, you will need to install `pyodbc <https://pypi.org/project/pyodbc/>`_ and an `ODBC driver <https://learn.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver16>`_, after which you should be able to use a DSN setting similar to ``SRC_DSN="mssql+pyodbc://username:password@hostname/dbname?driver=ODBC Driver 18 for SQL Server"``.
 
 Please open a GitHub issue if you would like to see support for another DBMS.