ó
¿b›]c           @   sm  d  Z  d d l Z d d l Z d d l m Z d d l m Z d d l m Z d d l m Z d d	 l m	 Z	 d d
 l m
 Z d d l m Z d d l m Z d e f d „  ƒ  YZ d e e j f d „  ƒ  YZ d e e j f d „  ƒ  YZ d e f d „  ƒ  YZ d e e f d „  ƒ  YZ d e e f d „  ƒ  YZ d e f d „  ƒ  YZ d e e f d „  ƒ  YZ e Z d S(   s  
.. dialect:: mssql+pyodbc
    :name: PyODBC
    :dbapi: pyodbc
    :connectstring: mssql+pyodbc://<username>:<password>@<dsnname>
    :url: http://pypi.python.org/pypi/pyodbc/

Connecting to PyODBC
--------------------

The URL here is to be translated to PyODBC connection strings, as
detailed in `ConnectionStrings <https://code.google.com/p/pyodbc/wiki/ConnectionStrings>`_.

DSN Connections
^^^^^^^^^^^^^^^

A DSN-based connection is **preferred** overall when using ODBC.  A
basic DSN-based connection looks like::

    engine = create_engine("mssql+pyodbc://scott:tiger@some_dsn")

Which above, will pass the following connection string to PyODBC::

    dsn=mydsn;UID=user;PWD=pass

If the username and password are omitted, the DSN form will also add
the ``Trusted_Connection=yes`` directive to the ODBC string.

Hostname Connections
^^^^^^^^^^^^^^^^^^^^

Hostname-based connections are **not preferred**, however are supported.
The ODBC driver name must be explicitly specified::

    engine = create_engine("mssql+pyodbc://scott:tiger@myhost:port/databasename?driver=SQL+Server+Native+Client+10.0")

.. versionchanged:: 1.0.0 Hostname-based PyODBC connections now require the
   SQL Server driver name specified explicitly.  SQLAlchemy cannot
   choose an optimal default here as it varies based on platform
   and installed drivers.

Other keywords interpreted by the Pyodbc dialect to be passed to
``pyodbc.connect()`` in both the DSN and hostname cases include:
``odbc_autotranslate``, ``ansi``, ``unicode_results``, ``autocommit``.

Pass through exact Pyodbc string
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A PyODBC connection string can also be sent exactly as specified in
`ConnectionStrings <https://code.google.com/p/pyodbc/wiki/ConnectionStrings>`_
into the driver using the parameter ``odbc_connect``.  The delimeters must be
URL escaped, however, as illustrated below using ``urllib.parse.quote_plus``::

    import urllib
    params = urllib.parse.quote_plus("DRIVER={SQL Server Native Client 10.0};SERVER=dagger;DATABASE=test;UID=user;PWD=password")

    engine = create_engine("mssql+pyodbc:///?odbc_connect=%s" % params)


Driver / Unicode Support
-------------------------

PyODBC works best with Microsoft ODBC drivers, particularly in the area
of Unicode support on both Python 2 and Python 3.

Using the FreeTDS ODBC drivers on Linux or OSX with PyODBC is **not**
recommended; there have been historically many Unicode-related issues
in this area, including before Microsoft offered ODBC drivers for Linux
and OSX.   Now that Microsoft offers drivers for all platforms, for
PyODBC support these are recommended.  FreeTDS remains relevant for
non-ODBC drivers such as pymssql where it works very well.


Rowcount Support
----------------

Pyodbc only has partial support for rowcount.  See the notes at
:ref:`mssql_rowcount_versioning` for important notes when using ORM
versioning.

.. _mssql_pyodbc_fastexecutemany:

Fast Executemany Mode
---------------------

The Pyodbc driver has added support for a "fast executemany" mode of execution
which greatly reduces round trips for a DBAPI ``executemany()`` call when using
Microsoft ODBC drivers.  The feature is enabled by setting the flag
``.fast_executemany`` on the DBAPI cursor when an executemany call is to be
used.   The SQLAlchemy pyodbc SQL Server dialect supports setting this flag
automatically when the ``.fast_executemany`` flag is passed to
:func:`.create_engine`; note that the ODBC driver must be the Microsoft driver
in order to use this flag::

    engine = create_engine(
        "mssql+pyodbc://scott:tiger@mssql2017:1433/test?driver=ODBC+Driver+13+for+SQL+Server",
        fast_executemany=True)

.. versionadded:: 1.3

.. seealso::

    `fast executemany <https://github.com/mkleehammer/pyodbc/wiki/Features-beyond-the-DB-API#fast_executemany>`_
    - on github


iÿÿÿÿNi   (   t   BINARY(   t	   MSDialect(   t   MSExecutionContext(   t	   VARBINARYi   (   t   exc(   t   types(   t   util(   t   PyODBCConnectort   _ms_numeric_pyodbcc           B   s)   e  Z d  Z d „  Z d „  Z d „  Z RS(   s¡   Turns Decimals with adjusted() < 0 or > 7 into strings.

    The routines here are needed for older pyodbc versions
    as well as current mxODBC versions.

    c            s;   t  t ˆ  ƒ j | ƒ ‰ | j s% ˆ S‡  ‡ f d †  } | S(   Nc            st   ˆ  j  r\ t |  t j ƒ r\ |  j ƒ  } | d k  r@ ˆ  j |  ƒ S| d k r\ ˆ  j |  ƒ Sn  ˆ rl ˆ |  ƒ S|  Sd  S(   Ni    i   (   t	   asdecimalt
   isinstancet   decimalt   Decimalt   adjustedt   _small_dec_to_stringt   _large_dec_to_string(   t   valueR   (   t   selft   super_process(    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyt   process‘   s    
(   t   superR   t   bind_processort   _need_decimal_fix(   R   t   dialectR   (    (   R   R   s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR   Š   s
    	c         C   sc   d | d k  r d p d d t  | j ƒ  ƒ d d j g  | j ƒ  d D] } t | ƒ ^ qF ƒ f S(   Ns   %s0.%s%si    t   -t    t   0i   (   t   absR   t   joint   as_tuplet   str(   R   R   t   nint(    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR   £   s    c         C   s„  | j  ƒ  d } d t | ƒ k r„ d | d k  r7 d p: d d j g  | D] } t | ƒ ^ qG ƒ d | j ƒ  t | ƒ d f } nü t | ƒ d | j ƒ  k r+d | d k  rµ d p¸ d d j g  | D] } t | ƒ ^ qÅ d | j ƒ  d !ƒ d j g  | D] } t | ƒ ^ qû | j ƒ  d ƒ f } nU d	 | d k  r@d pCd d j g  | D] } t | ƒ ^ qPd | j ƒ  d !ƒ f } | S(
   Ni   t   Es   %s%s%si    R   R   R   s   %s%s.%ss   %s%s(   R   R   R   R   t   len(   R   R   t   _intt   st   result(    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR   ª   s    %%6==(   t   __name__t
   __module__t   __doc__R   R   R   (    (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR      s   		t   _MSNumeric_pyodbcc           B   s   e  Z RS(    (   R%   R&   (    (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR(   Á   s   t   _MSFloat_pyodbcc           B   s   e  Z RS(    (   R%   R&   (    (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR)   Å   s   t   _ms_binary_pyodbcc           B   s   e  Z d  Z d „  Z RS(   sÿ   Wraps binary values in dialect-specific Binary wrapper.
    If the value is null, return a pyodbc-specific BinaryNull
    object to prevent pyODBC [and FreeTDS] from defaulting binary
    NULL types to SQLWCHAR and causing implicit conversion errors.
    c            s5   ˆ j  d  k r d  Sˆ j  j ‰  ‡  ‡ f d †  } | S(   Nc            s$   |  d  k	 r ˆ  |  ƒ Sˆ j j Sd  S(   N(   t   Nonet   dbapit
   BinaryNull(   R   (   t   DBAPIBinaryR   (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR   Ö   s    
(   R,   R+   t   Binary(   R   R   R   (    (   R.   R   s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR   Ð   s
    (   R%   R&   R'   R   (    (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR*   É   s   t   _VARBINARY_pyodbcc           B   s   e  Z RS(    (   R%   R&   (    (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR0   à   s   t   _BINARY_pyodbcc           B   s   e  Z RS(    (   R%   R&   (    (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR1   ä   s   t   MSExecutionContext_pyodbcc           B   s    e  Z e Z d  „  Z d „  Z RS(   c         C   sZ   t  t |  ƒ j ƒ  |  j rV |  j j rV t |  j d ƒ rV t |  _	 |  j
 d 7_
 n  d S(   sº  where appropriate, issue "select scope_identity()" in the same
        statement.

        Background on why "scope_identity()" is preferable to "@@identity":
        http://msdn.microsoft.com/en-us/library/ms190315.aspx

        Background on why we attempt to embed "scope_identity()" into the same
        statement as the INSERT:
        http://code.google.com/p/pyodbc/wiki/FAQs#How_do_I_retrieve_autogenerated/identity_values?

        i    s   ; select scope_identity()N(   R   R2   t   pre_exect   _select_lastrowidR   t   use_scope_identityR!   t
   parameterst   Truet   _embedded_scope_identityt	   statement(   R   (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR3   ë   s    		c         C   s…   |  j  rn xL t rW y |  j j ƒ  d } PWq |  j j j k
 rS |  j j ƒ  q Xq Wt | d ƒ |  _	 n t
 t |  ƒ j ƒ  d  S(   Ni    (   R8   R7   t   cursort   fetchallR   R,   t   Errort   nextsett   intt
   _lastrowidR   R2   t	   post_exec(   R   t   row(    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR@     s    		(   R%   R&   t   FalseR8   R3   R@   (    (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR2   è   s   	t   MSDialect_pyodbcc           B   s†   e  Z e Z e j e j i e e	 j
 6e e	 j 6e e 6e e 6e e	 j 6e e	 j 6ƒ Z d e d  „ Z d „  Z d d „ Z d „  Z RS(   c         K   sŒ   d | k r! | j  d ƒ |  _ n  t t |  ƒ j |   |  j o[ |  j o[ t |  j j d ƒ |  _ |  j oy |  j	 ƒ  d k  |  _
 | |  _ d  S(   Nt   description_encodingR=   i   i   i   (   i   i   i   (   t   popRD   R   RC   t   __init__R5   R,   t   hasattrt   Cursort   _dbapi_versionR   t   fast_executemany(   R   RD   RJ   t   params(    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyRF   -  s    		  c         C   s«   y | j  d ƒ } Wn- t j k
 rB t t |  ƒ j | d t ƒSXg  } t j d ƒ } xB | j	 | ƒ D]1 } y | j
 t | ƒ ƒ Wqh t k
 r˜ qh Xqh Wt | ƒ Sd  S(   Ns8   SELECT CAST(SERVERPROPERTY('ProductVersion') AS VARCHAR)t   allow_charss   [.\-](   t   scalarR   t
   DBAPIErrorR   RC   t   _get_server_version_infoRB   t   ret   compilet   splitt   appendR>   t
   ValueErrort   tuple(   R   t
   connectiont   rawt   versiont   rt   n(    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyRO   ?  s    c         C   s;   |  j  r t | _  n  t t |  ƒ j | | | d | ƒd  S(   Nt   context(   RJ   R7   R   RC   t   do_executemany(   R   R:   R9   R6   R[   (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyR\   W  s    	c      	   C   s[   t  | |  j j ƒ r? x' d
 D] } | t | ƒ k r t Sq Wn  t t |  ƒ j | | | ƒ S(   Nt   08S01t   01002t   08003t   08007t   08S02t   08001t   HYT00t   HY010t   10054(	   R]   R^   R_   R`   Ra   Rb   Rc   Rd   Re   (   R
   R,   R<   R   R7   R   RC   t   is_disconnect(   R   t   eRV   R:   t   code(    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyRf   ^  s            
N(   R%   R&   R2   t   execution_ctx_clsR   t   update_copyR   t   colspecsR(   t   sqltypest   NumericR)   t   FloatR1   R    R0   R   t   LargeBinaryR+   RB   RF   RO   R\   Rf   (    (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyRC     s   


	(   R'   R   RP   t   baseR    R   R   R   R   R   R   Rl   R   t   connectors.pyodbcR   t   objectR   Rm   R(   Rn   R)   R*   R0   R1   R2   RC   R   (    (    (    s?   lib/python2.7/site-packages/sqlalchemy/dialects/mssql/pyodbc.pyt   <module>r   s&   @2X