.. pymssql documentation master file, created by
   sphinx-quickstart on Sat Dec 28 22:08:07 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=======
pymssql
=======

A simple database interface for `Python`_ that builds on top of `FreeTDS`_ to
provide a Python DB-API (`PEP-249`_) interface to `Microsoft SQL Server`_.

The wheels of pymssql are built against the latest release of FreeTDS and could be
found on `PyPI Project`_.


Resources
---------

* `Project Home`_

  * :doc:`Quick Start <pymssql_examples>`
  * :doc:`FAQ & Troubleshooting <faq>`

* `PyPI Project`_
* GitHub_
* Discussion_
* `FreeTDS User Guide`_


Features
--------

* Unicode friendly
* Python 3 friendly
* Works on most popular operating systems
* Written in Cython_ for performance
* Includes a supported and documented low-level module (``_mssql``) that you
  can use instead of the DB-API
* Supports stored procedures with both return values and output parameters
* Supports bulk copy
* A comprehensive test suite
* Compatible with cooperative multi-tasking systems (gevent, etc.)
* Can be used to connect to Azure

License
-------

pymssql is licensed under the terms of the GNU LGPL license.

.. _Project Home: https://github.com/pymssql/pymssql
.. _Python: http://www.python.org/
.. _FreeTDS: http://www.freetds.org/
.. _PEP-249: http://www.python.org/dev/peps/pep-0249/
.. _Microsoft SQL Server: http://www.microsoft.com/sqlserver/
.. _Cython: http://cython.org
.. _PyPI Project: https://pypi.python.org/pypi/pymssql/
.. _GitHub: https://github.com/pymssql/pymssql
.. _FreeTDS User Guide:  http://www.freetds.org/userguide/
.. _Discussion: https://github.com/pymssql/pymssql/discussions


Documentation
-------------

.. toctree::
   :maxdepth: 2

   intro
   pymssql_examples
   _mssql_examples
   release_notes
   freetds
   ref/pymssql
   ref/_mssql
   migrate_1_x_to_2_x
   faq
   building_and_developing
   freetds_and_dates
   azure
   docker
   changelog
   todo

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`