使用SQLAlchemy调用MSSQL表值函数报错，需带条件生成DataFrame

在Python中使用SQLAlchemy调用MSSQL的表值函数时遇到问题，需求是：

• 给查询添加特定WHERE子句
• 指定要查询的列
• 将函数返回结果转换为DataFrame

原代码如下：

from sqlalchemy import create_engine, text, func, null, and_, or_, select
import pandas as pd
query= (select([func.Custom.tfnXXX(213, 107301)])
        .where(
                and_(func.PXXX > 0,
                or_(func.WXXX == '',func.WXXX == None))
                )
        .apply_labels()
        )
engine = create_engine(
    'mssql+pyodbc://server/database?trusted_connection=yes&driver=ODBC+Driver+17+for+SQL+Server&ApplicationIntent=ReadOnly')

with engine.connect() as conn:
    result = conn.execute(query).fetchall()
df = pd.DataFrame(result, columns=query.c.keys())

运行后出现错误：

ArgumentError: Column expression, FROM clause, or other columns clause element expected, got [<sqlalchemy.sql.functions.Function at 0x1cc2102e700; tfnXXX>]. Did you mean to say select(<sqlalchemy.sql.functions.Function at 0x1cc2102e700; tfnXXX>)?

错误原因 #

表值函数需要当作**数据源（表）**来处理，不能直接放在select()的参数列表里（那是标量函数的用法）。同时原代码中判断NULL的写法func.WXXX == None不符合SQLAlchemy规范，需要改用is_(None)。

修正后的代码 #

from sqlalchemy import create_engine, func, and_, or_, select
import pandas as pd

# 创建表值函数的引用，并起别名方便后续列引用
tvf = func.Custom.tfnXXX(213, 107301).alias('tvf_result')

# 构建查询：指定要查询的列，从表值函数获取数据，添加WHERE条件
query = select(
    tvf.c.PXXX,  # 指定需要的列
    tvf.c.WXXX,
    # 这里可以继续添加其他需要的列
).select_from(tvf).where(
    and_(
        tvf.c.PXXX > 0,
        or_(
            tvf.c.WXXX == '',
            tvf.c.WXXX.is_(None)  # SQLAlchemy中判断NULL的正确写法
        )
    )
)

engine = create_engine(
    'mssql+pyodbc://server/database?trusted_connection=yes&driver=ODBC+Driver+17+for+SQL+Server&ApplicationIntent=ReadOnly')

with engine.connect() as conn:
    # 直接用pandas的read_sql更简便，无需手动处理结果集
    df = pd.read_sql(query, conn)

print(df)

关键说明 #

1. 表值函数的正确调用：用.alias()给表值函数结果起别名，这样可以通过别名.c.列名的方式引用函数返回的列。
2. 指定查询列：在select()中明确列出需要的列，避免返回所有不必要的数据。
3. NULL判断：SQLAlchemy中不能用== None判断NULL，必须使用is_(None)，否则会生成错误的SQL语句。
4. 简化DataFrame转换：使用pd.read_sql()可以直接将查询结果转为DataFrame，省去手动处理fetchall()和列名的步骤。

内容的提问来源于stack exchange，提问作者user14018499