如何使用需要用户定义类型表参数的 SQLAlchemy 调用存储过程

Question

我在 MSSQL 服务器上有一个存储过程“prc_add_names”，它采用表值参数。参数本身是自定义类型“StringTable”，定义如下：

CREATE TYPE [dbo].[StringTable] AS TABLE([strValue] [nvarchar](max) NULL)

我不知道如何使用 SQLAlchemy 执行此过程。我习惯于像这样使用session.execute 调用带有参数的过程：

result = session.execute('prc_do_something :pArg', {pArg:'foo'})

但是，如果我只是将字符串列表作为参数传递，这将不起作用：

result = session.execute('prc_add_names :pArg', {pArg: ['Name One', 'Name Two']})

导致：

sqlalchemy.exc.ProgrammingError: (pymssql.ProgrammingError) (102, "Incorrect syntax near 'Name One'.DB-Lib error message 20018, severity 15:
General SQL Server error: Check messages from the SQL Server
") [SQL: 'prc_add_names %(pArg)s'] [parameters: {'pArg': ['Name One', 'Name Two']}] (Background on this error at: http://sqlalche.me/e/f405)

显然，SQLAlchemy 不将我的字符串列表理解为创建我的 StringTable 类型参数的尝试，但在谷歌搜索和阅读文档几个小时后，我还没有弄清楚我应该如何处理这个问题。

仅供参考，我无法控制此数据库，因此无法修改存储过程或其他任何内容。

编辑：我没有嫁给 SQLAlchemy。如果有其他库可以处理这个问题，我很乐意使用它。

Answer 1

有一个真正支持 TVP 的驱动程序：Pytds。它不受官方支持，但有一个第 3 方方言实现：sqlalchemy-pytds。使用它们，您可以像这样调用您的存储过程：

In [1]: engine.execute(DDL("CREATE TYPE [dbo].[StringTable] AS TABLE([strValue] [nvarchar](max) NULL)"))
Out[1]: <sqlalchemy.engine.result.ResultProxy at 0x7f235809ae48>

In [2]: engine.execute(DDL("CREATE PROC test_proc (@pArg [StringTable] READONLY) AS BEGIN SELECT * FROM @pArg END"))
Out[2]: <sqlalchemy.engine.result.ResultProxy at 0x7f2358027b70>

In [3]: arg = ['Name One', 'Name Two']

In [4]: import pytds

In [5]: tvp = pytds.TableValuedParam(type_name='StringTable',
   ...:                              rows=((x,) for x in arg))

In [6]: engine.execute('EXEC test_proc %s', (tvp,))
Out[6]: <sqlalchemy.engine.result.ResultProxy at 0x7f294e699e10>

In [7]: _.fetchall()
Out[7]: [('Name One',), ('Name Two',)]

这样您可以将潜在的大量数据作为参数传递：

In [21]: tvp = pytds.TableValuedParam(type_name='StringTable',
    ...:                              rows=((str(x),) for x in range(100000)))

In [22]: engine.execute('EXEC test_proc %s', (tvp,))
Out[22]: <sqlalchemy.engine.result.ResultProxy at 0x7f294c6e9f98>

In [23]: _.fetchall()[-1]
Out[23]: ('99999',)

另一方面，如果您使用的是不支持 TVP 的驱动程序，您可以 declare a table variable，将值和 pass that as the argument 插入您的程序：

In [12]: engine.execute(
    ...:     """
    ...:     DECLARE @pArg AS [StringTable];
    ...:     INSERT INTO @pArg VALUES {placeholders};
    ...:     EXEC test_proc @pArg;
    ...:     """.format(placeholders=",".join(["(%s)"] * len(arg))),
    ...:     tuple(arg))
    ...:     
Out[12]: <sqlalchemy.engine.result.ResultProxy at 0x7f23580f2908>

In [15]: _.fetchall()
Out[15]: [('Name One',), ('Name Two',)]

请注意，您不能使用任何 executemany 方法，否则您最终将分别为每个表值调用该过程。这就是手动构造占位符并将表值作为单独参数传递的原因。必须注意不要将任何参数直接格式化到查询中，而是要为 DB-API 设置正确数量的占位符。行值仅限于 maximum of 1000。

如果底层 DB-API 驱动程序为表值参数提供适当的支持当然会很好，但至少我找不到使用 FreeTDS 的 pymssql 的方法。 reference to TVPs on the mailing list 明确表示它们不受支持。情况是not much better for PyODBC。

_{免责声明：我之前没有真正使用过 MS SQL Server。}

Answer 2

我认为您可以使用callproc() 方法并将输入参数作为列表传递。http://docs.sqlalchemy.org/en/latest/core/connections.html#calling-stored-procedures