My favorites | Sign in
Project Home Downloads Wiki
READ-ONLY: This project has been archived. For more information see this post.
Search
for
Module  
Documentation for pyodbc module
Updated Jul 1, 2012 by mkleehammer

Variables

version

The module version string in the format major.minor.revision

apilevel

The string constant '2.0' indicating this module supports DB API level 2.0.

lowercase

A Boolean that controls whether column names in result rows are lowercased. This can be changed any time and affects queries executed after the change. The default is False. This can be useful when database columns have inconsistent capitalization.

pooling

A Boolean indicating whether connection pooling is enabled. This is a global (HENV) setting, so it can only be modified before the first connection is made. The default is True, which enables ODBC connection pooling.

threadsafety

The integer 1, indicating that threads may share the module but not connections. Note that connections and cursors may be used by different threads, just not at the same time.

qmark

The string constant 'qmark' to indicate parameters are identified using question marks.

Functions

connect

connect(*connectionstring, **kwargs) --> Connection

Creates and returns a new connection to the database.

The optional connection string can be passed as a string or Unicode object (connectionstring), as keywords (kwargs), or both.

# a string
cnxn = connect('driver={SQL Server};server=localhost;database=test;uid=me;pwd=me2')
# keywords
cnxn = connect(driver='{SQL Server}', server='localhost', database='test', uid='me', pwd='me2')
# both
cnxn = connect('driver={SQL Server};server=localhost;database=test', uid='me', pwd='me2')

The DB API recommends some keywords that are not usually used in ODBC connection strings, so they are converted:

from converted to
host server
user uid
password pwd

Some keywords are used by pyodbc and are not passed to the odbc driver:

keyword description default
autocommit If False, Connection.commit must be called; otherwise each statement is automatically commited False
ansi If True, the driver does not support Unicode and SQLDriverConnectA should be used False
unicode_results If True, strings returned in result sets are always Unicode (2.1.5+) False
readonly If True, the connection is set to readonly False

The ansi keyword should only be used to work around driver bugs. pyodbc will determine if the Unicode connection function (SQLDriverConnectW) exists and always attempt to call it. If the driver returns IM001 indicating it does not support the Unicode version, the ANSI version is tried (SQLDriverConnectA). Any other SQLSTATE is turned into an exception. Setting ansi to true skips the Unicode attempt and only connects using the ANSI version. This is useful for drivers that return the wrong SQLSTATE (or if pyodbc is out of date and should support other SQLSTATEs).

For help on connection strings, see ConnectionStrings

dataSources

dataSources() -> { DSN : Description }

Returns a dictionary mapping available DSNs to their descriptions.

Comment by phisa...@gmail.com, Jun 18, 2012

I am able to connect to and existing database using: nxn = pyodbc.connect('Driver={Microsoft Access Driver (.mdb)};Dbq=.\DB - Access97.mdb;Uid=;Pwd=;')

How can I create a new database (with password protection)?

A step by step tutorial will be great

Comment by bg.newl...@gmail.com, May 3, 2013

Has anyone implemented this callback in Python, if so please show...

static int file_transfer_callback(void *, char *, int) { return 1; }
   …
 SQLSetConnectAttr(conn_handle, SA_REGISTER_VALIDATE_FILE_TRANSFER_CALLBACK,
                   (SQLPOINTER) &file_transfer_callback, SQL_IS_POINTER );
Comment by toastie...@gmail.com, Sep 14, 2013

With the unixODBC driver manager, it appears that dataSources() brings back DSN info from only the user's odbc.ini file (typically ~/.odbc.ini). As I understand it, this function should bring back DSN info from the system odbc.ini file (typically /etc/odbc.ini) as well. Looking at the code though, this is a bug in unixODBC, not pyodbc. If the unixODBC ODBC-standard SQLDataSources method finds a user odbc.ini file, it doesn't look for a system ODBC file as well.

Comment by seanrek...@gmail.com, Aug 25, 2014

Hello - unixODBC and pyodbc have been installed on Centos here, using the prescribed commands... however I can only successfully 'import pyodbc' if running python as root - I've verified (i.e. forced) the pyodbc.py(c) files and dirs to be readable by all, but that's not enough... what else needs to be "made" accessible to everyone so they can import pyodbc successfully?

Thanks
Comment by toastie...@gmail.com, Feb 23, 2015

Just FYI, the module variable 'qmark' is actually known as 'paramstyle', with a value of "qmark".

Powered by Google Project Hosting