Skip to main content

DB API 2.0-compliant driver for SQL Server

Project description

cTDS is a full Python DB API-2.0-compliant SQL Server database library for Linux, Windows, and Mac OS X supporting both Python 2 and Python 3.

The full documentation for cTDS can be found here.


  • Supports Microsoft SQL Server 2008 and up.
  • Complete DB API-2.0 support.
  • Python 2.6, Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7, and Python 3.8 support.
  • Bulk insert (bcp) support.
  • Written entirely in C.


See installation instructions for more information on installing FreeTDS.


Publishing new versions of the egg and documentation is automated using travis-ci deployment. Official releases are marked using git tags. Pushing the tag to the git remote will trigger the automated deployment. E.g.

git tag -a v1.2.3 -m 'v1.2.3'
git push --tags


Generate documentation using the following:

make doc
# Generated to ./.gh-pages

Documentation is hosted on GitHub Pages. As such, the source code for the documentation pages must be committed to the gh-pages branch in order to update the live documentation.


Local development and testing is supported on Linux-based systems running Docker. Docker containers are used for both running a local instance of SQL Server on Linux and creating containers for each combination of Python and FreeTDS version supported. Only Docker and GNU make are required for running tests locally on Linux or OS X systems.

If desired, local development can be done by installing ctds against the system versions of FreeTDS and Python. Additionally there is a virtualenv target which will download and compile a recent version of FreeTDS and then install ctds into a virtualenv using the local version of FreeTDS.

# Install as a "develop" egg
pip install -e .

# Install tests.
pip install -e .[tests]

# Run tests (requires SQL Server running)
python test

However, given the various supported combinations of FreeTDS and Python, it is easier to create a separate Docker container for each. The matrix of FreeTDS and Python is driven using GNU make.

Development and testing will require an instance of SQL Server on Linux running for validation. A script is provided to start a Docker container running the database and create the login used by the tests.

# Start a docker-based SQL Server instance.
make start-sqlserver

# Run tests as needed ...

# Stop the docker-base SQL Server instance.
make stop-sqlserver


Testing is designed to be relatively seamless using Docker containers and SQL Server on Linux. All test targets will ensure a running database instance docker container exists and is accessible prior to running.

To run the tests against the most recent versions of FreeTDS and Python, use:

make test

To run the tests against an arbitrary version of FreeTDS and Python:

# Python X.Y & FreeTDS Z.ZZ.ZZ
make test_X.Y_Z.ZZ.ZZ

To run tests against all supported versions of FreeTDS and Python and additional linting and metadata checks:

make check

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ctds, version 1.12.0
Filename, size File type Python version Upload date Hashes
Filename, size ctds-1.12.0.tar.gz (72.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page