Skip to content

FEAT: Expose SQLSTATE (and native error number) as attributes on exception objects #581

@dlevy-msft-sql

Description

@dlevy-msft-sql

Summary

mssql_python discards the SQLSTATE code after using it to choose an exception subclass, so callers cannot programmatically classify errors by SQLSTATE. The only stable hook left is substring-matching the English driver_error text, which is brittle and forces every consumer to duplicate the driver's internal SQLSTATE → text table.

Please expose SQLSTATE as a public attribute on the exception (and ideally also the native SQL Server error number).

Why this matters

SQLSTATE is the one stable, standardized, locale-independent error identifier in ODBC. It's exactly what application code needs to decide things like:

  • Is this transient? Retry it. (e.g. HYT00, 08S01, 40001)
  • Is this a deadlock specifically vs. some other operational error? (40001)
  • Is this an Azure SQL throttling response? (engine 40501 under 42000)
  • Is this an auth failure that means "refresh the access token"? (28000)

Today none of that is possible without one of two bad options:

  1. Substring-match driver_error against a frozenset of English phrases copied out of exceptions.py. This pins user code to internal driver constants, breaks if the strings are ever reworded or localized, and forces every consumer to maintain their own copy of the SQLSTATE-to-phrase mapping.
  2. Regex-scrape ddbc_error for Error NNNN to recover the SQL Server engine number. Fragile and explicitly not a stable contract.

Compare to peer drivers:

Driver Stable error identifier
pyodbc exc.args[0] is the 5-char SQLSTATE
pymssql exc.args[0] is the SQL Server engine error number
mssql-python Neither; SQLSTATE is consumed and discarded in sqlstate_to_exception()

PEP 249 doesn't standardize this, but every mature driver exposes something. mssql-python is currently the odd one out.

Proposed change

In mssql_python/exceptions.py:

  1. Add sqlstate (and optionally native_error) as keyword args to Exception.__init__ and store them on self.
  2. Update sqlstate_to_exception(sqlstate, ddbc_error) to pass sqlstate=sqlstate into every constructor call (it already has the value in hand).
  3. Update the DatabaseError fallback in raise_exception() to pass the SQLSTATE through as well.

Roughly:

class Exception(builtins.Exception):
    def __init__(self, driver_error: str, ddbc_error: str,
                 sqlstate: Optional[str] = None,
                 native_error: Optional[int] = None) -> None:
        self.driver_error = driver_error
        self.ddbc_error = truncate_error_message(ddbc_error)
        self.sqlstate = sqlstate
        self.native_error = native_error
        ...

This is fully backward compatible: existing callers that only read driver_error / ddbc_error / str(exc) keep working unchanged.

How callers would use it

TRANSIENT_SQLSTATES = frozenset({
    "HYT00", "HYT01",   # Timeouts
    "08001", "08S01", "08007",  # Connection failures
    "40001", "40003",   # Deadlock / indeterminate completion
})

def is_transient(exc: BaseException) -> bool:
    return getattr(exc, "sqlstate", None) in TRANSIENT_SQLSTATES

This is what retry-logic samples in the official SQL Server docs would prefer to show, instead of the current English-text frozenset.

Related

PR #562 (fix for #532) is already plumbing SQLSTATE through Connection::checkError() into sqlstate_to_exception(). The value is now reaching the exception constructor from both the cursor path and the connection path. Exposing it on self is the natural next step and is essentially free once #562 lands.

Environment

  • mssql-python 1.5.0
  • Verified empirically: dir(exc) on OperationalError, ProgrammingError, DataError shows no sqlstate, native_error, errno, or code attribute.

Metadata

Metadata

Assignees

Labels

triage neededFor new issues, not triaged yet.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions