sp_describe_cursor (Transact-SQL)

Syntaxe

sp_describe_cursor [ @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' ] 
     } 

Arguments

• [ @cursor_return = ] output_cursor_variable OUTPUT
  Nom d'une variable curseur déclarée devant recevoir la sortie du curseur. L'argument output_cursor_variable est de type cursor, n'a pas de valeur par défaut et ne doit pas être associé à des curseurs au moment où la procédure sp_describe_cursor est appelée. Le curseur retourné est un curseur en lecture seule, dynamique et permettant les défilements.

• [ @cursor_source = ] { N'local' | N'global' | N'variable' }
  Indique si le curseur qui fait l'objet du rapport est défini en utilisant le nom d'un curseur local, d'un curseur global ou d'une variable curseur. Le paramètre est du type nvarchar(30).

• [ @cursor_identity = ] N'local_cursor_name' ]
  Nom d'un curseur créé par une instruction DECLARE CURSOR contenant soit le mot clé LOCAL, soit celui défini par défaut pour LOCAL. local_cursor_name est de type nvarchar(128).

• [ @cursor_identity = ] N'global_cursor_name' ]
  Nom d'un curseur créé par une instruction DECLARE CURSOR contenant soit le mot clé GLOBAL, soit celui défini par défaut pour GLOBAL. global_cursor_name est de type nvarchar(128).

  global_cursor_name peut aussi être le nom d'un curseur côté serveur d'API ouvert par une application ODBC, puis nommé en appelant SQLSetCursorName.

• [ @cursor_identity = ] N'input_cursor_variable' ]
  Nom d'une variable curseur associée à un curseur ouvert. input_cursor_variable est de type nvarchar(128).

Valeurs des codes retournés

Aucune

Curseurs retournés

sp_describe_cursor encapsule son jeu de résultats dans un paramètre de sortie Transact-SQLcursor. Ceci permet aux traitements, procédures stockées et déclencheurs Transact-SQL d'utiliser une seule ligne de résultat à la fois. Cela signifie aussi que la procédure ne peut pas être appelée directement à partir des fonctions d'API de base de données. Le paramètre de résultat cursor doit être lié à une variable de programme, mais les API de base de données ne prennent pas en charge les paramètres ou les variables cursor de liaison.

La table suivante indique le format du curseur qui est retourné en utilisant sp_describe_cursor. C'est le même format que celui qui est retourné par sp_cursor_list.

Notes

sp_describe_cursor décrit les attributs globaux d'un curseur de serveur, comme la possibilité de défiler ou d'être mis à jour. Utilisez sp_describe_cursor_columns pour obtenir la description des attributs du jeu de résultats retourné par le curseur. Utilisez sp_describe_cursor_tables pour générer un rapport sur les tables de base référencées par le curseur. Utilisez sp_cursor_list pour obtenir un rapport sur les curseurs de serveur Transact-SQL visibles lors de la connexion.

Une instruction DECLARE CURSOR peut demander un type de curseur que SQL Server ne peut pas prendre en charge en utilisant l'instruction SELECT contenue dans DECLARE CURSOR. SQL Server convertit de manière implicite le curseur en un type qu'il ne peut prendre en charge en utilisant l'instruction SELECT. Si l'option TYPE_WARNING est spécifiée dans l'instruction DECLARE CURSOR, SQL Server envoie à l'application un message d'information lui indiquant qu'une conversion a été effectuée. La procédure sp_describe_cursor peut ensuite être appelée pour déterminer le type de curseur implémenté.

Autorisations

Nécessite l'appartenance au rôle public.

Exemples

Cet exemple ouvre un curseur global et utilise sp_describe_cursor pour fournir un rapport des attributs du curseur.

USE AdventureWorks;
GO
-- Declare and open a global cursor.
DECLARE abc CURSOR STATIC FOR
SELECT LastName
FROM Person.Contact

OPEN abc

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

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

-- Fetch all the rows from the sp_describe_cursor 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.
CLOSE @Report
DEALLOCATE @Report
GO

-- Close and deallocate the original cursor.
CLOSE abc
DEALLOCATE abc
GO

Voir aussi

Référence

Concepts