sp_describe_undeclared_parameters (Transact-SQL)

Devuelve un conjunto de resultados que contiene metadatos sobre parámetros no declarados en un lote de Transact-SQL. Considera cada parámetro que se utiliza en el lote @tsql, pero no se declara en @params. Se devuelve un conjunto de resultados que contiene una fila para cada parámetro, con la información de tipo deducida de dicho parámetro El procedimiento devuelve un conjunto de resultados vacío si el lote de entrada de @tsql no tiene ningún parámetro excepto los declarados en @params.

Convenciones de sintaxis de Transact-SQL

Se aplica a: SQL Server (SQL Server 2012 a versión actual), Windows Azure SQL Database (Versión inicial a versión actual).

Sintaxis

sp_describe_undeclared_parameters 
    [ @tsql = ] 'Transact-SQL_batch' 
    [ , [ @params = ] N'parameters' data type ] [, ...n]

Argumentos

• [ @tsql = ] 'Transact-SQL_batch'
  Una o varias instrucciones de Transact-SQL. Transact-SQL_batch puede ser de tipo nvarchar(n) o nvarchar(max).

• [ @params = ] N'parameters'
  @params proporciona una cadena de declaración para los parámetros del lote de Transact-SQL, de forma similar al modo en que funciona sp_executesql. Parameters puede ser de tipo nvarchar(n) o nvarchar(max).

  Es una cadena que contiene las definiciones de todos los parámetros que se han incrustado en Transact-SQL_batch. La cadena debe ser una constante Unicode o una variable Unicode. Cada definición de parámetro se compone de un nombre de parámetro y un tipo de datos. n es un marcador de posición que indica definiciones de parámetros adicionales. Si el lote o la instrucción de Transact-SQL de la instrucción no contiene parámetros, @params no es necesario. El valor predeterminado de este parámetro es NULL.

• Datatype
  Tipo de datos del parámetro.

Valores del código de retorno

sp_describe_undeclared_parameters siempre devuelve el estado de retorno cero si se ejecuta correctamente. Si el procedimiento produce un error y se llama al procedimiento como un RPC, el estado de retorno es rellenado por el tipo de error según se describe en la columna error_type de sys.dm_exec_describe_first_result_set. Si se llama al procedimiento desde Transact-SQL, el valor devuelto siempre es cero, incluso si se produce un error.

Conjuntos de resultados

sp_describe_undeclared_parameters devuelve el siguiente conjunto de resultados.

Nombre de la columna	Tipo de datos	Descripción
parameter_ordinal	int NOT NULL	Contiene la posición ordinal del parámetro en el conjunto de resultados. La posición del primer parámetro se especificará como 1.
name	sysname NOT NULL	Contiene el nombre del parámetro.
suggested_system_type_id	int NOT NULL	Contiene el system_type_id del tipo de datos del parámetro tal y como se especifica en sys.types. En el caso de los tipos de CLR, aunque la columna system_type_name devuelva NULL, esta columna devolverá el valor 240.
suggested_system_type_name	nvarchar (256) NULL	Contiene el nombre del tipo de datos. Incluye los argumentos (como length, precision y scale) especificados para el tipo de datos del parámetro. Si el tipo de datos es un tipo de alias definido por el usuario, el tipo de sistema subyacente se especifica aquí. Si es un tipo de datos definido por el usuario de CLR, NULL se devuelve en esta columna. Si no se puede deducir el tipo del parámetro, se devuelve NULL.
suggested_max_length	smallint NOT NULL	Vea sys.columns. para obtener la descripción de la columna max_length.
suggested_precision	tinyint NOT NULL	Vea sys.columns. para obtener la descripción de la columna de precisión.
suggested_scale	tinyint NOT NULL	Vea sys.columns. para obtener la descripción de la columna de escala.
suggested_user_type_id	int NULL	Para los tipos de alias y CLR, contiene el user_type_id del tipo de datos de la columna tal y como se especifica en sys.types. De lo contrario, es NULL.
suggested_user_type_database	sysname NULL	Para los tipos de alias y CLR, contiene el nombre de la base de datos en la que se define el tipo. De lo contrario, es NULL.
suggested_user_type_schema	sysname NULL	Para los tipos de alias y CLR, contiene el nombre del esquema en el que se define el tipo. De lo contrario, es NULL.
suggested_user_type_name	sysname NULL	Para los tipos de alias y CLR, contiene el nombre del tipo. De lo contrario, es NULL.
suggested_assembly_qualified_type_name	nvarchar (4000) NULL	Para los tipos de CLR, devuelve el nombre del ensamblado y la clase que define el tipo. De lo contrario, es NULL.
suggested_xml_collection_id	int NULL	Contiene el xml_collection_id del tipo de datos del parámetro tal y como se especifica en sys.columns. Esta columna devolverá NULL si el tipo devuelto no está asociado a una colección de esquema XML.
suggested_xml_collection_database	sysname NULL	Contiene la base de datos en la que se define la colección de esquema XML asociado a este tipo. Esta columna devolverá NULL si el tipo devuelto no está asociado a una colección de esquema XML.
suggested_xml_collection_schema	sysname NULL	Contiene el esquema en el que se define la colección de esquema XML asociado a este tipo. Esta columna devolverá NULL si el tipo devuelto no está asociado a una colección de esquema XML.
suggested_xml_collection_name	sysname NULL	Contiene el nombre de la colección de esquema XML asociado a este tipo. Esta columna devolverá NULL si el tipo devuelto no está asociado a una colección de esquema XML.
suggested_is_xml_document	bit NOT NULL	Devuelve 1 si el tipo que se va a devolver es XML y se garantiza que es un documento XML. De lo contrario, devuelve 0.
suggested_is_case_sensitive	bit NOT NULL	Devuelve 1 si la columna es de un tipo de cadena con distinción entre mayúsculas y minúsculas, y 0 en caso contrario.
suggested_is_fixed_length_clr_type	bit NOT NULL	Devuelve 1 si la columna es de un tipo CLR de longitud fija y 0 en caso contrario.
suggested_is_input	bit NOT NULL	Devuelve 1 si el parámetro se utiliza en cualquier otro lugar que no sea el lado izquierdo de una asignación. De lo contrario, devuelve 0.
suggested_is_output	bit NOT NULL	Devuelve 1 si el parámetro se utiliza en el lado izquierdo de una asignación o se pasa a un parámetro de salida de un procedimiento almacenado. De lo contrario, devuelve 0.
formal_parameter_name	sysname NULL	Si el parámetro es un argumento para un procedimiento almacenado o una función definida por el usuario, devuelve el nombre del parámetro formal correspondiente. De lo contrario, devuelve NULL.
suggested_tds_type_id	int NOT NULL	Para uso interno.
suggested_tds_length	int NOT NULL	Para uso interno.

Comentarios

sp_describe_undeclared_parameters siempre devuelve el estado de retorno cero.

El uso más común es cuando se proporciona a una aplicación una instrucción de Transact-SQL que podría contener parámetros y debe procesarlos de alguna manera. Un ejemplo es una interfaz de usuario (como ODBCTest o RowsetViewer) donde el usuario proporciona una consulta con la sintaxis de parámetros de ODBC. La aplicación debe detectar el número de parámetros dinámicamente y pedir confirmación al usuario para cada uno.

Otro ejemplo es cuando no hay datos proporcionados por el usuario y una aplicación debe crear un bucle en los parámetros y obtener los datos para ellos a partir de alguna otra ubicación (como una tabla). En este caso, la aplicación no tiene que pasar toda la información de parámetros a la vez. En su lugar, la aplicación puede obtener toda la información de parámetros del proveedor y obtener el propio dato de la tabla. El código que usa sp_describe_undeclared_parameters es más genérico y es menos probable que tenga que modificarse si la estructura de datos cambia más adelante.

sp_describe_undeclared_parameters devuelve un error en los siguientes casos.

• Si la entrada @tsql no es un lote de Transact-SQL válido. La validez se determina analizando el lote de Transact-SQL. Los errores que ocasione el lote durante la optimización o la ejecución de consultas no se consideran al determinar si el lote de Transact-SQL es válido.

• Si @params no es NULL y contiene un cadena que no es una cadena de declaración sintácticamente válida para los parámetros o si contiene una cadena que declara algún parámetro más de una vez.

• Si el lote de Transact-SQL de entrada declara una variable local con el mismo nombre que un parámetro declarado en @params.

• Si la instrucción crea alguna tabla temporal.

Si @tsql no tiene ningún parámetro, excepto los declarados en @params, el procedimiento devuelve un conjunto de resultados vacío.

Algoritmo de selección de parámetros

En una consulta con parámetros no declarados, la deducción de su tipo de datos se realiza en tres pasos.

Paso 1

El primer paso de la deducción del tipo de datos de una consulta con parámetros no declarados es encontrar los tipos de datos de todas las subexpresiones cuyos tipos de datos no dependen de los parámetros no declarados. El tipo se puede determinar para las siguientes expresiones:

• Columnas, constantes, variables y parámetros declarados.

• Los resultados de una llamada a una función definida por el usuario (UDF).

• Una expresión con tipos de datos que no dependen de los parámetros no declarados para todas las entradas.

Por ejemplo, considere la consulta SELECT dbo.tbl(@p1) + c1 FROM t1 WHERE c2 = @p2 + 2. Las expresiones dbo.tbl(@p1) + c1 y c2 tienen tipos de datos y la expresión @p1 y @p2 + 2 no.

Después de este paso, si alguna expresión (excepto una llamada a un UDF) tiene dos argumentos sin tipos de datos, la deducción del tipo da un error. Por ejemplo, todo lo siguiente produce errores:

SELECT * FROM t1 WHERE @p1 = @p2
SELECT * FROM t1 WHERE c1 = @p1 + @p2
SELECT * FROM t1 WHERE @p1 = SUBSTRING(@p2, 2, 3)

En el siguiente ejemplo no se genera un error:

SELECT * FROM t1 WHERE @p1 = dbo.tbl(c1, @p2, @p3)

Paso 2

Para un parámetro dado no declarado @p, el algoritmo de deducción de tipo busca la expresión más profunda E(@p) que contiene a @p y es una de las siguientes:

• Un argumento de un operador de asignación o comparación.

• Un argumento de una función definida por el usuario (incluido un UDF con valor de tabla), procedimiento o método.

• Un argumento de una cláusula VALUES de una instrucción INSERT.

• Un argumento de CAST o CONVERT.

El algoritmo de deducción de tipo busca un TT de tipo de datos de destino (@p) para E (@p). Los tipos de datos de destino de los ejemplos anteriores son los siguientes:

• El tipo de datos del otro lado de la comparación o asignación.

• El tipo de datos declarado del parámetro al que se pasa este argumento.

• El tipo de datos de la columna en la que se inserta este valor.

• El tipo de datos al que la instrucción se va a convertir.

Por ejemplo, considere la consulta SELECT * FROM t WHERE @p1 = dbo.tbl(@p2 + c1). Entonces, E(@p1) = @p1, E (@p2) = @p2 + c1, TT(@p1) es el tipo de datos devuelto declarado de dbo.tbl y TT(@p2) es el tipo de datos de parámetro declarado para el dbo.tbl.

Si @p no está contenido en ninguna expresión enumerada al principio del paso 2, el algoritmo de deducción de tipo determina que E(@p) es la expresión escalar más grande que contiene a @p y el algoritmo de deducción de tipo no calcula un tipo de datos de destino TT(@p) para E(@p). Por ejemplo, si la consulta es SELECT @p + 2 entonces E(@p) = @p + 2 y no hay ningún TT(@p).

Paso 3

Ahora que están identificados E(@p) y TT(@p), el algoritmo de deducción de tipo deduce un tipo de datos para @p en una de las siguientes dos maneras:

• Deducción simple

  Si E(@p) = @p y TT(@p) existe, es decir, si @p es directamente un argumento de una de las expresiones enumeradas al principio del paso 2, el algoritmo de deducción de tipo deduce el tipo de datos de @p para ser TT(@p). Por ejemplo:

  SELECT * FROM t WHERE c1 = @p1 AND @p2 = dbo.tbl(@p3)
  

  El tipo de datos para @p1, @p2 y @p3 será el tipo de datos de c1, el tipo de datos devuelto de dbo.tbl y el tipo de datos de parámetro para dbo.tbl respectivamente.

  Como caso especial, si @p es un argumento de un operador <, >, <= o >=, las reglas de deducción simples no se aplican. El algoritmo de deducción de tipo utilizará las reglas de deducción generales explicadas en la sección siguiente. Por ejemplo, si c1 es una columna del tipo de datos char(30), considere las siguientes dos consultas:

  SELECT * FROM t WHERE c1 = @p
  SELECT * FROM t WHERE c1 > @p
  

  En el primer caso, el algoritmo de deducción de tipo deduce char(30) como tipo de datos para @p según las reglas anteriores de este tema. En el segundo caso, el algoritmo de deducción de tipo deduce varchar(8000) según las reglas de deducción generales de la sección siguiente.

• Deducción general

  Si la deducción simple no se aplica, los siguientes tipos de datos se consideran para los parámetros no declarados:

  • Tipos de datos enteros (bit, tinyint, smallint, int, bigint)

  • Tipo de datos money (smallmoney, money)

  • Tipos de datos de coma flotante (float, real)

  • numeric(38, 19): otros tipos de datos numéricos o decimales no se consideran.

  • varchar(8000), varchar(max), nvarchar(4000) y nvarchar(max): otros tipos de datos de cadena (como text, char(8000), nvarchar(30), etc.) no se consideran.

  • varbinary(8000) y varbinary(max): otros tipos de datos binarios no se consideran (como image, binary(8000), varbinary(30), etc.).

  • date, time(7), smalldatetime, datetime, datetime2(7), datetimeoffset(7): otros tipos de fecha y hora, como time(4), no se consideran.

  • sql_variant

  • xml

  • Tipos definidos por el sistema CLR (hierarchyid, geometry, geography)

  • Tipos definidos por el usuario CLR

Criterios de selección

De los tipos de datos candidatos, se rechaza cualesquiera que invalidara la consulta. De los tipos de datos candidatos restantes, el algoritmo de deducción de tipo selecciona uno según las siguientes reglas.

1. Se selecciona el tipo de datos que genera el menor número de conversiones implícitas en E(@p). Si un tipo de datos determinado genera un tipo de datos para E(@p) que es diferente de TT(@p), el algoritmo de deducción de tipo considera que es una conversión implícita adicional del tipo de datos E(@p) a TT(@p).

   Por ejemplo:

   SELECT * FROM t WHERE Col_Int = Col_Int + @p
   

   En este caso, E(@p) es Col_Int + @p y TT(@p) es int. Se elige int para @p porque no genera ninguna conversión implícita. Cualquier otra opción de tipo de datos genera al menos una conversión implícita.

2. Si hay varios tipos de datos que coinciden en el número menor de conversiones, se utiliza el tipo de datos con mayor prioridad. Por ejemplo

   SELECT * FROM t WHERE Col_Int = Col_smallint + @p
   

   En este caso, int y smallint generan una conversión. Otros tipos de datos generan más de una conversión. Dado que int tiene precedencia sobre smallint, int se utiliza para @p. Para obtener más información acerca de la precedencia de los tipos de datos, vea Prioridad de tipo de datos (Transact-SQL).

   Esta regla solo se aplica si hay una conversión implícita entre cada tipo de datos que coincide según la regla 1 y el tipo de datos con la precedencia máxima. Si no hay ninguna conversión implícita, la deducción del tipo de datos no se puede realizar y genera un error. Por ejemplo, en la consulta SELECT @p FROM t, la deducción del tipo de datos no se puede realizar porque cualquier tipo de datos para @p sería igual de bueno. Por ejemplo, no hay ninguna conversión implícita de int a xml.

3. Si dos tipos de datos similares cumplen la regla 1, por ejemplo varchar(8000) y varchar(max), se elige el menor (varchar(8000)). El mismo principio se aplica a los tipos de datos nvarchar y varbinary.

4. Para los fines de la regla 1, el algoritmo de deducción de tipo prefiere ciertas conversiones sobre otras. Las conversiones, en orden de mejor a peor, son:

   1. Conversión entre el mismo tipo de datos básico de longitud diferente.

   2. Conversión entre la versión de longitud fija y la de longitud variable de los mismos tipos de datos (por ejemplo, char a varchar).

   3. Conversión entre NULL e int.

   4. Cualquier otra conversión.

Por ejemplo, para la consulta SELECT * FROM t WHERE [Col_varchar(30)] > @p, se elige varchar(8000) porque la conversión (a) es mejor. Para la consulta SELECT * FROM t WHERE [Col_char(30)] > @p, se sigue eligiendo varchar(8000) porque produce una conversión de tipo (b) y porque otra opción (como varchar(4000)) produciría una conversión de tipo (d).

Como último ejemplo, dada una consulta SELECT NULL + @p, int se elige para @p porque produce una conversión de tipo (c).

Permisos

Se requiere permiso para ejecutar el argumento @tsql.

Ejemplos

En el siguiente ejemplo se devuelve información como el tipo de datos esperado para los parámetros @name e @id no declarados.

sp_describe_undeclared_parameters @tsql = 
N'SELECT object_id, name, type_desc 
FROM sys.indexes
WHERE object_id = @id OR name = @name'

Cuando se proporciona el parámetro @id como una referencia @params, el parámetro @id se omite del conjunto de resultados y solo se describe el parámetro @name.

sp_describe_undeclared_parameters @tsql = 
N'SELECT object_id, name, type_desc 
FROM sys.indexes
WHERE object_id = @id OR NAME = @name',
@params = N'@id int'

Vea también

Referencia

sp_describe_first_result_set (Transact-SQL)

sys.dm_exec_describe_first_result_set (Transact-SQL)

sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)