sp_describe_cursor_columns (Transact-SQL)

Artículo
06/18/2013

Informa acerca de los atributos de las columnas en el conjunto de resultados de un cursor de servidor.

Icono de vínculo a temas Convenciones de sintaxis de Transact-SQL

Sintaxis

sp_describe_cursor_columns 
   [ @cursor_return = ] output_cursor_variable OUTPUT 
    { [ , [ @cursor_source = ] N'local' , 
          [ @cursor_identity = ] N'local_cursor_name' ] 
    | [ , [ @cursor_source = ] N'global' , 
          [ @cursor_identity = ] N'global_cursor_name' ] 
    | [ , [ @cursor_source = ] N'variable' , 
          [ @cursor_identity = ] N'input_cursor_variable' ] 
   }

Argumentos

[ @cursor\_return= ] output_cursor_variable OUTPUT
Es el nombre de una variable de cursor declarada que recibirá la salida del cursor. output_cursor_variable es de tipo cursor, no tiene valor predeterminado y no debe estar asociado a ningún cursor en el momento en que se llame a sp_describe_cursor_columns. El cursor devuelto es un cursor desplazable, dinámico y de solo lectura.
[ @cursor\_source= ] { N'local' | N'global' | N'variable' }
Especifica si el cursor del que se informa está especificado con el nombre de un cursor local, un cursor global o una variable de cursor. El parámetro es de tipo nvarchar(30).
[ @cursor\_identity= ] N'local_cursor_name'
Es el nombre de un cursor creado por una instrucción DECLARE CURSOR que tiene la palabra clave LOCAL u obtuvo el valor predeterminado LOCAL. local_cursor_name es de tipo nvarchar(128).
[ @cursor\_identity= ] N'global_cursor_name'
Es el nombre de un cursor creado por una instrucción DECLARE CURSOR que tiene la palabra clave GLOBAL u obtuvo el valor predeterminado GLOBAL. global_cursor_name es de tipo nvarchar(128).

global_cursor_name también puede ser el nombre de un cursor de servidor API que se abrió con una aplicación ODBC y que, a continuación, se denominó al llamar a SQLSetCursorName.
[ @cursor\_identity= ] N'input_cursor_variable'
Es el nombre de una variable de cursor asociada a un cursor abierto. input_cursor_variable es de tipo nvarchar(128).

Valores del código de retorno

Ninguno

Cursores devueltos

sp_describe_cursor_columns encapsula su informe como un parámetro de salida de tipo cursor de Transact-SQL. De esta forma, los lotes, los procedimientos almacenados y los desencadenadores de Transact-SQL pueden trabajar con la salida de fila en fila. También significa que no se puede llamar al procedimiento directamente desde funciones de una API de base de datos. El parámetro de salida de tipo cursor debe estar enlazado a una variable del programa, pero las API de base de datos no admiten el enlace de parámetros o variables de cursor.

En la siguiente tabla se muestra el formato del cursor devuelto usando sp_describe_cursor_columns.

Nombre de la columna	Tipo de datos	Descripción
column_name	sysname (acepta valores NULL)	Nombre asignado a la columna del conjunto de resultados. La columna es NULL en el caso de que se especificara sin una cláusula de acompañamiento AS.
ordinal_position	int	Posición relativa de la columna desde la primera columna de la izquierda en el conjunto de resultados. La primera columna está en la posición 0.
column_characteristics_flags	int	Máscara de bits que indica la información almacenada en DBCOLUMNFLAGS dentro de OLE DB. Puede tener uno o una combinación de los valores siguientes: 1 = Marcador 2 = Longitud fija 4 = Acepta valores NULL 8 = Versiones de fila 16 = Columna que se puede actualizar (configurada para columnas previstas de un cursor sin cláusula FOR UPDATE y, en caso de existir esa columna, solo puede ser una por cursor). Cuando se combinan valores de bit, se aplican las características de los valores de bit combinados. Por ejemplo, si el valor de bit es 6, la columna es una columna que acepta valores NULL (4) de longitud fija (2).
column_size	int	Tamaño máximo posible para un valor de esta columna.
data_type_sql	smallint	Número que indica el tipo de datos de SQL Server de la columna.
column_precision	tinyint	Precisión máxima de la columna de acuerdo con el valor bPrecision en OLE DB.
column_scale	tinyint	Número de dígitos a la derecha del separador decimal para los tipos de datos numeric o decimal, de acuerdo con el valor bScale en OLE DB.
order_position	int	Si la columna participa en la ordenación del conjunto de resultados, es la posición de la columna en la clave de orden relativa a la columna situada en el extremo izquierdo.
order_direction	varchar(1) (acepta valores NULL)	A = La columna se encuentra en la clave de orden y la ordenación es ascendente. D = La columna se encuentra en la clave de orden y la ordenación es descendente. NULL = La columna no participa en la ordenación.
hidden_column	smallint	0 = Esta columna aparece en la lista de selección. 1 = Reservado para uso futuro.
columnid	int	Id. de columna para la columna base. Si se generó la columna del conjunto de resultados a partir de una expresión, columnid es -1.
objectid	int	Id. de objeto del objeto o la tabla base que proporciona la columna. Si se generó la columna del conjunto de resultados a partir de una expresión, objectid es -1.
dbid	int	Id. de la base de datos que contiene la tabla base que proporciona la columna. Si se generó la columna del conjunto de resultados a partir de una expresión, dbid es -1.
dbname	sysname (acepta valores NULL)	Nombre de la base de datos que contiene la tabla base que proporciona la columna. Si se generó la columna del conjunto de resultados a partir de una expresión, dbname es NULL.

Comentarios

sp_describe_cursor_columns describe los atributos de las columnas en el conjunto de resultados de un cursor de servidor, como, por ejemplo, el nombre y el tipo de datos de cada cursor. Utilice sp_describe_cursor para obtener una descripción de los atributos globales del cursor de servidor. Use sp_describe_cursor_tables para obtener un informe de las tablas base a las que hace referencia el cursor. Para obtener un informe de los cursores de servidor de Transact-SQL visibles en la conexión, use sp_cursor_list.

Permisos

Requiere la pertenencia al rol public.

Ejemplos

En el ejemplo siguiente se abre un cursor global y se utiliza sp_describe_cursor_columns para obtener un informe de las columnas utilizadas en el cursor.

USE AdventureWorks2012;
GO
-- Declare and open a global cursor.
DECLARE abc CURSOR KEYSET FOR
SELECT LastName
FROM Person.Person;
GO
OPEN abc;

-- Declare a cursor variable to hold the cursor output variable
-- from sp_describe_cursor_columns.
DECLARE @Report CURSOR;

-- Execute sp_describe_cursor_columns into the cursor variable.
EXEC master.dbo.sp_describe_cursor_columns
    @cursor_return = @Report OUTPUT
    ,@cursor_source = N'global' 
    ,@cursor_identity = N'abc';

-- Fetch all the rows from the sp_describe_cursor_columns output cursor.
FETCH NEXT from @Report;
WHILE (@@FETCH_STATUS <> -1)
BEGIN
   FETCH NEXT from @Report;
END

-- Close and deallocate the cursor from sp_describe_cursor_columns.
CLOSE @Report;
DEALLOCATE @Report;
GO
-- Close and deallocate the original cursor.
CLOSE abc;
DEALLOCATE abc;
GO