How to set a DB connection timeout for a python/pyodbc/unixODBC/MS ODBC Driver 11 for SQL Server/Linux stack?

14,412

https://stackoverflow.com/a/12946908/1552953

This answer refers to being able to set a timeout on the connection:

Timeout

An optional integer query timeout, in seconds. Use zero, the default, to disable.

The timeout is applied to all cursors created by the connection, so it cannot be changed for a given connection.

If a query timeout occurs, the database should raise an OperationalError with SQLSTATE HYT00 or HYT01.

Note: This attribute only affects queries. To set the timeout for the actual connection process, use the timeout keyword of the pyodbc.connect function.

result = None
with pyodbc.connect('DRIVER={SQL Server};SERVER=mydb;DATABASE=solarwinds;Trusted_Connection=True', timeout=1) as cnxn:
    cursor = cnxn.cursor()
    result = cursor.execute(query).fetchall()

So using the above code it didn't timeout within 1 second, or at least it didn't return a result within 1 second. But it did return a result much faster than without a timeout set.

Share:
14,412
mikenerone
Author by

mikenerone

Primarily a Python guy, but I dabble.

Updated on June 11, 2022

Comments

  • mikenerone
    mikenerone almost 2 years

    I've been unable to find a documented way to set a timeout for the initial connection that actually works. I'm not asking about a "query timeout", but rather a timeout on an initial connection attempt in the case that the DB server is completely down or unreachable, and there's no response at all. By default, such connections appear to timeout after 255 seconds - is there a way to set a shorter timeout?

    Edit: for clarity, I should reiterate the stack here:

    • python
    • pyodbc
    • unixODBC (not iODBC)
    • MS ODBC Driver 11 for SQL Server (not FreeTDS)
    • Linux
  • mikenerone
    mikenerone almost 9 years
    I'm no longer using the environment to test this, and despite the mention in that note, this feature is undocumented in the section on the pyodbc.connect function; but looking at the code, it looks like at the very least an attempt was made to honor this keyword. I'm accepting this answer as it seems like it should be the prescribed way to do it, but fair warning to everyone: YMMV, as the available underlying binary drivers simply have never been well-behaved.