ODBC 表值参数 API 摘要

适用于:SQL ServerAzure SQL 数据库Azure SQL 托管实例Azure Synapse Analytics

ODBC 通过对多个现有 API 函数的增强,支持表值参数(表值参数)。 这些函数协同工作,描述表值参数模式,绑定和传输行集,获取元数据,并管理描述符记录。
以下章节将相关的ODBC函数组织成逻辑组,帮助您理解表值参数流水线的每个部分如何运作。

表值参数模式发现与元数据函数

这些函数可帮助应用程序发现表值参数的结构,包括列元数据、参数定义和可用的 SQL 数据类型。

功能 目的
SQLColumns 检索表值参数或表类型的列元数据
SQLDescribeParam 返回表值参数的元数据,包括类型、精度和缩放
SQLGetTypeInfo 检索驱动支持的表值参数列的SQL数据类型
SQLPrimaryKeys 提供使用表值参数的表类型中关键列的信息
SQLProcedureColumns 检索表值参数相关存储过程参数的元数据
SQLTables 列出可作为表值参数声明来源的表和表类型

表值参数绑定与数据传输

这些函数处理将结构化数据绑定到参数、将数据传递到服务器或在执行过程中流式处理行。

功能 目的
SQLBindParameter 将表值参数绑定到应用程序缓冲区或行集
SQLParamData 在使用执行时数据时,获取流式表值参数参数的下一部分
SQLPutData 在执行时数据操作期间,将表值参数数据分块发送

表值参数的语句执行

这些函数执行引用表值参数的SQL语句,并管理执行生命周期。

功能 目的
SQLExecDirect 在未事先准备的情况下执行使用表值参数的SQL语句
SQLExecute 执行包含表值参数的事先准备好的SQL语句

表值参数的描述符和属性管理

使用这些函数可以管理正确描述行集和结构化参数所需的描述符字段和语句属性。

功能 目的
SQLGetDescField 检索表值参数列或行集的描述符元数据
SQLSetDescField 表值参数列或行集的描述符元数据集
SQLSetDescRec 为结构化表值参数数据设置完整的描述符记录
SQLGetStmtAttr 检索影响表值参数执行行为的语句属性
SQLSetStmtAttr 设置语句属性,如行集大小或流标志,用于表值参数操作

表值参数的诊断与错误处理

利用这些函数帮助你的应用程序在表值参数绑定和执行过程中检测错误、警告或状态消息。

功能 目的
SQLGetDiagField 检索表值参数处理过程中生成的诊断信息