sp_describe_cursor (Transact-SQL)

Выводит атрибуты серверного курсора.

Соглашения о синтаксисе в Transact-SQL

Синтаксис

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' ] 
     } 

Аргументы

• [ @cursor_return = ] output_cursor_variable OUTPUT
  Имя объявленной переменной для получения выходных данных курсора. Аргумент output_cursor_variable имеет тип cursor, не имеет значения по умолчанию и не должен быть связан ни с одним курсором при вызове процедуры sp_describe_cursor. Возвращенный курсор имеет свойства scrollable, dynamic и read-only.

• [ @cursor_source = ] { N'local' | N'global' | N'variable' }
  Задает, был ли переданный курсор определен с помощью имени локального курсора, глобального курсора или переменной курсора. Аргумент имеет тип nvarchar(30).

• [ @cursor_identity = ] N'local_cursor_name' ]
  Имя курсора, созданного с помощью инструкции DECLARE CURSOR, которая либо содержала ключевое слово LOCAL, либо выполнялась при установке по умолчанию LOCAL. Аргумент local_cursor_name имеет тип nvarchar(128).

• [ @cursor_identity = ] N'global_cursor_name' ]
  Имя курсора, созданного с помощью инструкции DECLARE CURSOR, которая либо содержала ключевое слово GLOBAL, либо выполнялась при установке по умолчанию GLOBAL. Аргумент global_cursor_name имеет тип nvarchar(128).

  Аргумент global_cursor_name может также быть именем серверного курсора API, открытого приложением ODBC и названного с помощью функции SQLSetCursorName.

• [ @cursor_identity = ] N'input_cursor_variable' ]
  Имя переменной, связанной с открытым курсором. Аргумент input_cursor_variable имеет тип nvarchar(128).

Значения кодов возврата

Нет

Замечания

Процедура sp_describe_cursor описывает такие глобальные для серверного курсора атрибуты как возможность прокрутки и обновления. Используйте процедуру sp_describe_cursor_columns для описания атрибутов результирующего набора, возвращаемого курсором. Используйте процедуру sp_describe_cursor_tables для получения отчета о базовых таблицах, на которые ссылается курсор. Для получения отчета о серверных курсорах языка Transact-SQL, видимых при подключении, воспользуйтесь процедурой sp_cursor_list.

Инструкция DECLARE CURSOR может затребовать тип курсора, который не поддерживается SQL Server с помощью инструкции SELECT, содержащейся в DECLARE CURSOR. SQL Server неявно преобразует курсор к типу, который может поддерживаться с использованием инструкции SELECT. Если в инструкции DECLARE CURSOR указано TYPE_WARNING, SQL Server посылает в приложение информационное сообщение о завершении преобразования. Процедура sp_describe_cursor может быть вызвана для определения типа полученного курсора.

Разрешения

Необходимо быть членом роли public.

Возвращенные курсоры

Процедура sp_describe_cursor помещает результирующий набор в выходной параметр Transact-SQL cursor. Это позволяет пакетам, хранимым процедурам и триггерам Transact-SQL работать с отдельной строкой. Это также означает, что процедуру нельзя вызывать напрямую из API-функций, предназначенных для работы с базами данных. Выходной параметр cursor должен быть привязан к программной переменной, но API-функции для работы с базами данных не поддерживают связывание параметров cursor или переменных.

В приведенной ниже таблице показан формат курсора, возвращенного процедурой sp_describe_cursor. Формат курсора такой же, что и формат, возвращаемый процедурой sp_cursor_list.

Примеры

В следующем примере открывается глобальный курсор и используется процедура sp_describe_cursor для получения отчета об атрибутах курсора.

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

См. также

Справочник

CURSOR_STATUS (Transact-SQL)
DECLARE CURSOR (Transact-SQL)
sp_cursor_list (Transact-SQL)
sp_describe_cursor_columns (Transact-SQL)
sp_describe_cursor_tables (Transact-SQL)

Другие ресурсы

Курсоры (ядро СУБД)

Справка и поддержка

Получение помощи по SQL Server 2005