sp_describe_first_result_set (Transact-SQL)

返回 Transact-SQL 批处理的第一个可能结果集的元数据。 如果批处理没有返回结果，则返回一个空的结果集。 如果数据库引擎无法确定将通过执行静态分析来执行的第一个查询的元数据，则引发错误。 动态管理视图 sys.dm_exec_describe_first_result_set (Transact-SQL) 返回相同的信息。

Transact-SQL 语法约定

语法

sp_describe_first_result_set [ @tsql = ] N'Transact-SQL_batch' 
    [ , [ @params = ] N'parameters' ] 
    [ , [ @browse_information_mode = ] <tinyint> ] ]

参数

• [ @tsql = ] 'Transact-SQL_batch'
  一个或多个 Transact-SQL 语句。 Transact-SQL_batch  可以是 nvarchar(n) 或 nvarchar(max)。

• [ @params = ] N'parameters'
  @params 为 Transact-SQL 批处理参数提供声明字符串，它类似于 sp_executesql。 参数的数据类型可以是 nvarchar(n) 或 nvarchar(max)。

  一个字符串，它包含 Transact-SQL_batch 中嵌入的所有参数的定义。 字符串必须是 Unicode 常量或 Unicode 变量。 每个参数定义由参数名称和数据类型组成。 n 是表示附加参数定义的占位符。 在语句中指定的每个参数都必须在 @params 中定义。 如果 Transact-SQL 语句或语句中的批处理不包含参数，则不需要使用 @params。 该参数的默认值为 NULL。

• [ @browse_information_mode = ] tinyint
  指定是否返回其他键列和源表信息。 如果设置为 1，则分析每个查询，就好像它在查询中包含 FOR BROWSE 选项一样。 将返回其他键列和源表信息。

  • 如果设置为 0，则无信息返回。

  • 如果设置为 1，则分析每个查询，就好像它在查询中包含 FOR BROWSE 选项一样。 该参数将返回用作源列信息的基表名称。

  • 如果设置为 2，则分析每个查询，就好像它用于准备或执行游标一样。 该参数将返回用作源列信息的视图名称。

返回代码值

sp_describe_first_result_set 对成功始终返回零状态。如果该过程引发错误并且是作为 RPC 调用的，则返回状态将由 sys.dm_exec_describe_first_result_set 的 error_type 列中描述的错误类型填充。 如果从 Transact-SQL 中调用此过程，则返回值始终为零，甚至在出现错误时也不例外。

结果集

此公共元数据将作为结果集返回，其中结果元数据中的每列对应于一行。 每一行以下面一节所说明的格式描述列的类型和为 Null 性。 如果对于每个控制路径不存在第一个语句，则返回的结果集不包含任何行。

注释

sp_describe_first_result_set 确保如果此过程返回某个假设批处理 A 的第一个结果集元数据，并且后续执行批处理 (A)，则此批处理架构出现以下任一行为：(1) 引发优化时错误；(2) 引发运行时错误；(3) 不返回结果集；或者 (4) 返回第一个结果集，其中具有 sp_describe_first_result_set 描述的相同元数据。

名称、为 Null 性和数据类型可能不同。 如果 sp_describe_first_result_set 返回空结果集，则可保证批处理执行将不返回结果集。

此保证假定在服务器上没有相关的架构更改。 服务器上的相关架构更改不包括在调用 sp_describe_first_result_set 的时间与在执行期间返回结果集的时间之间，在批处理 A 中创建临时表或表变量，但包括批处理 B 进行的架构更改。

sp_describe_first_result_set 在以下任一一种情况下都会返回错误。

• 如果输入 @tsql 不是有效的 Transact-SQL 批处理。 有效性是通过解析和分析 Transact-SQL 批处理来确定的。 当确定 Transact-SQL 批处理是否有效时，将不考虑由批处理在查询优化或执行过程中导致的任何错误。

• 如果 @params 不为 NULL，并且包含的某个字符串在语法上不是有效的参数声明字符串，或者如果它包含一个将任何参数声明多次的字符串。

• 如果输入 Transact-SQL 批处理声明的某个局部变量与在 @params 中声明的某个参数同名。

• 如果该语句将使用某个临时表。

• 查询包括创建随后要查询的永久表。

如果所有其他检查都获得成功，则将考虑输入批处理内所有可能的控制流路径。 这会考虑所有控制流语句（GOTO、IF/ELSE、WHILE 和 Transact-SQL TRY/CATCH 块）以及任何过程、动态 Transact-SQL 批处理或触发器，它们是由以下语句从输入批处理中调用的：EXEC 语句、DDL 语句（导致激发 DDL）或 DML 语句（导致对目标表或由于对外键约束执行层叠操作而修改的表激发触发器）。 在很多可能的控制路径的情况下，算法将在某个点停止。

对于每个控制流路径，返回结果集的第一个语句（如果有）将由 sp_describe_first_result_set 确定。

当在一个批处理中找到多个可能的第一个语句时，其结果可能在列数、列名称、为 Null 性以及数据类型等方面存在不同。 此处详细介绍了如何处理这些差异：

• 如果列数不同，则会引发一个错误，但不返回任何结果。

• 如果列名称不同，则返回的列名称将设置为 NULL。

• 如果为 Null 性不同，则返回的为 Null 性将允许 NULL。

• 如果数据类型不同，则将引发错误而不返回任何结果，但以下情况除外：

  • varchar(a) 改为 varchar(a')，其中 a' > a。

  • varchar(a) tovarchar(max)

  • nvarchar(a) 改为 nvarchar(a')，其中 a' > a。

  • nvarchar(a) tonvarchar(max)

  • varbinary(a) 改为 varbinary(a')，其中 a' > a。

  • varbinary(a) tovarbinary(max)

sp_describe_first_result_set 不支持间接递归。

权限

要求具有执行 @tsql 参数的权限。

示例

典型示例

A.简单示例

下面的示例描述从单个查询中返回的结果集。

sp_describe_first_result_set @tsql = N'SELECT object_id, name, type_desc FROM sys.indexes'

下面的示例显示了从包含一个参数的单个查询中返回的结果集。

sp_describe_first_result_set @tsql = 
N'SELECT object_id, name, type_desc 
FROM sys.indexes 
WHERE object_id = @id1'
, @params = N'@id1 int'

B.浏览模式示例

以下三个示例演示了不同浏览信息模式之间的主要差异。 只有相关的列会包含在查询结果中。

以下示例使用 0，指示无信息返回。

CREATE TABLE dbo.t (a int PRIMARY KEY, b1 int);
GO
CREATE VIEW dbo.v AS SELECT b1 AS b2 FROM dbo.t;
GO
EXEC sp_describe_first_result_set N'SELECT b2 AS b3 FROM dbo.v', null, 0;

下面是结果集。

以下示例使用 1，指示它将返回信息，就好像它在查询中包含 FOR BROWSE 选项一样。

EXEC sp_describe_first_result_set N'SELECT b2 AS b3 FROM v', null, 1

下面是结果集。

以下示例使用 2，指示执行分析，就好像您在准备游标一样。

EXEC sp_describe_first_result_set N'SELECT b2 AS b3 FROM v', null, 2

下面是结果集。

问题示例

下面的示例对所有示例使用两个表。 请执行以下语句以创建示例表。

CREATE TABLE dbo.t1 (a int NULL, b varchar(10) NULL, c nvarchar(10) NULL);
CREATE TABLE dbo.t2 (a smallint NOT NULL, d varchar(20) NOT NULL, e int NOT NULL);

由于列数不同而出错

在此示例中，可能的第一个结果集中的列数不同。

sp_describe_first_result_set @tsql = 
N'
IF(1=1)
    SELECT a FROM t1;
ELSE
    SELECT a, b FROM t1;
SELECT * FROM t; -- Ignored, not a possible first result set.'

由于数据类型不同而出错

列类型在不同的第一个可能结果集中不同。

sp_describe_first_result_set @tsql = 
N'
IF(1=1)
    SELECT a FROM t1;
ELSE
    SELECT a FROM t2;

结果：错误，类型不匹配（int 与 smallint).

无法确定列名称

对于同一个变量长度类型、为 Null 性以及列名称，可能的第一个结果集的列因长度不同而不同：

sp_describe_first_result_set @tsql = 
N'
IF(1=1)
    SELECT b FROM t1;
ELSE
    SELECT d FROM t2; '

结果：<未知列名称> varchar(20) NULL

通过别名强制列名称完全相同

与前面的例子相同，但通过列别名，列具有相同名称。

sp_describe_first_result_set @tsql = 
N'
IF(1=1)
    SELECT b FROM t1;
ELSE
    SELECT d AS b FROM t2;'

结果：b varchar(20) NULL

由于列类型无法匹配而出错

列类型在不同的第一个可能结果集中不同。

sp_describe_first_result_set @tsql = 
N'
IF(1=1)
    SELECT b FROM t1;
ELSE
    SELECT c FROM t1;'

结果：错误，类型不匹配（varchar(10) 与 nvarchar(10)).

结果集可以返回一个错误

第一次结果集是错误或结果集。

sp_describe_first_result_set @tsql = 
N'
IF(1=1)
    RAISERROR(''Some Error'', 16, 1);

ELSE
    SELECT a FROM t1;
SELECT e FROM t2; -- Ignored, not a possible first result set.;'

结果：一个 int NULL

某些代码路径不返回任何结果

第一次结果集是 Null 或结果集。

sp_describe_first_result_set @tsql = 
N'
IF(1=1)
    RETURN;
SELECT a FROM t1;'

结果：一个 int NULL

动态 SQL 中的结果

第一个结果集是可发现的动态 SQL，因为它是文字字符串。

sp_describe_first_result_set @tsql = 
N'EXEC(N''SELECT a FROM t1'');'

结果：一个 INT NULL

动态 SQL 中的结果失败

第一个结果集因为动态 SQL 而未定义。

sp_describe_first_result_set @tsql = 
N'
DECLARE @SQL NVARCHAR(max);
SET @SQL = N''SELECT a FROM t1 WHERE 1 = 1 '';
IF(1=1)
    SET @SQL += N'' AND e > 10 '';
EXEC(@SQL); '

结果：错误。 结果由于动态 SQL 而无法发现。

用户指定的结果集

第一个结果集由用户手动指定。

sp_describe_first_result_set @tsql = 
N'
DECLARE @SQL NVARCHAR(max);
SET @SQL = N''SELECT a FROM t1 WHERE 1 = 1 '';
IF(1=1)
    SET @SQL += N'' AND e > 10 '';
EXEC(@SQL)
    WITH RESULT SETS(
        (Column1 BIGINT NOT NULL)
    ); '

结果：Column1 bigint NOT NULL

不明确的结果集导致的错误

本示例假定名为 user1 的另一个用户在具有列的默认架构 s1 中具有名为 t1 的表(int NOT NULL）。

sp_describe_first_result_set @tsql = 
N'
    IF(@p > 0)
    EXECUTE AS USER = ''user1'';
    SELECT * FROM t1;'
, @params = N'@p int'

结果：错误。 t1 可以为 dbo.t1 或 s1.t1，每个具有不同数目的列。

在使用不明确的结果集时的结果

与前一个示例采用相同的假设。

sp_describe_first_result_set @tsql = 
N'
    IF(@p > 0)
    EXECUTE AS USER = ''user1'';
    SELECT a FROM t1;'

结果：int NULL，因为 dbo.t1.a 和 s1.t1.a 同时具有类型 int 和不同的为 Null 性。

请参阅

参考

sp_describe_undeclared_parameters (Transact-SQL)

sys.dm_exec_describe_first_result_set (Transact-SQL)

sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)