Skip to content

cursor-status-transact-sql.md

Latest commit

 

History

History
133 lines (95 loc) · 4.35 KB

cursor-status-transact-sql.md

File metadata and controls

133 lines (95 loc) · 4.35 KB
title CURSOR_STATUS (Transact-SQL)
description CURSOR_STATUS shows whether or not a cursor declaration has returned a cursor and result set.
author markingmyname
ms.author maghan
ms.reviewer randolphwest
ms.date 06/05/2025
ms.service sql
ms.subservice t-sql
ms.topic reference
ms.custom
ignite-2025
f1_keywords
CURSOR_STATUS
CURSOR_STATUS_TSQL
helpviewer_keywords
status information [SQL Server], cursors
CURSOR_STATUS function
cursors [SQL Server], status information
dev_langs
TSQL

CURSOR_STATUS (Transact-SQL)

[!INCLUDE SQL Server Azure SQL Database Azure SQL Managed Instance FabricSQLDB]

For a given parameter, CURSOR_STATUS shows whether or not a cursor declaration has returned a cursor and result set.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

CURSOR_STATUS
     (
          { 'local' , 'cursor_name' }
          | { 'global' , 'cursor_name' }
          | { 'variable' , 'cursor_variable' }
     )

Arguments

'local'

Specifies a constant indicating that the cursor source is a local cursor.

'global'

Specifies a constant indicating that the source of the cursor is a global cursor.

'variable'

Specifies a constant indicating that the source of the cursor is a local variable.

  • 'cursor_variable'

    The name of the cursor variable. A cursor variable must be defined using the cursor data type.

Return types

smallint

Return value Cursor name Cursor variable
1 The cursor result set has at least one row.

For insensitive and keyset cursors, the result set has at least one row.

For dynamic cursors, the result set can have zero, one, or more rows.		 The cursor allocated to this variable is open.

For insensitive and keyset cursors, the result set has at least one row.

For dynamic cursors, the result set can have zero, one, or more rows.
0 The cursor result set is empty. 1 The cursor allocated to this variable is open, but the result set is definitely empty.*
-1 The cursor is closed. The cursor allocated to this variable is closed.
-2 Not applicable. Has one of these possibilities:

The previously called procedure didn't assign a cursor to this OUTPUT variable.

The previously assigned procedure assigned a cursor to this OUTPUT variable, but the cursor was in a closed state when the procedure completed. Therefore, the cursor is deallocated, and not returned to the calling procedure.

No cursor is assigned to the declared cursor variable.
-3 A cursor with the specified name doesn't exist. A cursor variable with the specified name doesn't exist, or if one exists, no cursor is yet allocated to it.

1 Dynamic cursors never return this result.

Examples

This example uses the CURSOR_STATUS function to show the status of a cursor, after its declaration, after it opens, and after it closes.

CREATE TABLE #TMP (ii INT);
GO

INSERT INTO #TMP (ii) VALUES (1);
INSERT INTO #TMP (ii) VALUES (2);
INSERT INTO #TMP (ii) VALUES (3);
GO

-- Create a cursor
DECLARE cur CURSOR
FOR SELECT * FROM #TMP;

-- Display the status of the cursor before and after opening
-- and closing the cursor

SELECT CURSOR_STATUS('global', 'cur') AS 'After declare';

OPEN cur;
SELECT CURSOR_STATUS('global', 'cur') AS 'After Open';

CLOSE cur;
SELECT CURSOR_STATUS('global', 'cur') AS 'After Close';

-- Remove the cursor.
DEALLOCATE cur;

-- Drop the table.
DROP TABLE #TMP;

[!INCLUDE ssResult]

After declare
---------------
-1

After Open
----------
1

After Close
-----------
-1

Related content