Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 5.01 KB

configure-the-cursor-threshold-server-configuration-option.md

File metadata and controls

92 lines (59 loc) · 5.01 KB
title description author ms.author ms.date ms.service ms.subservice ms.topic helpviewer_keywords
Server configuration: cursor threshold
Learn about the cursor threshold option. See how its value affects whether SQL Server generates cursor keysets asynchronously, and find out how to configure it.
rwestMSFT
randolphwest
10/18/2024
sql
configuration
conceptual
cursor threshold option

Server configuration: cursor threshold

[!INCLUDE SQL Server]

This article describes how to configure the cursor threshold server configuration option in [!INCLUDE ssnoversion] by using [!INCLUDE ssManStudioFull] or [!INCLUDE tsql]. The cursor threshold option specifies the number of rows in the cursor set at which cursor keysets are generated asynchronously. When cursors generate a keyset for a result set, the query optimizer estimates the number of rows that are returned for that result set. If the query optimizer estimates that the number of returned rows is greater than this threshold, the cursor is generated asynchronously, allowing the user to fetch rows from the cursor while the cursor continues to be populated. Otherwise, the cursor is generated synchronously, and the query waits until all rows are returned.

Limitations

[!INCLUDE ssNoVersion] doesn't support generating keyset-driven or static [!INCLUDE tsql] cursors asynchronously. [!INCLUDE tsql] cursor operations such as OPEN or FETCH are batched, so there's no need for the asynchronous generation of [!INCLUDE tsql] cursors. [!INCLUDE ssNoVersion] continues to support asynchronous keyset-driven or static application programming interface (API) server cursors where low latency OPEN is a concern, due to client round trips for each cursor operation.

The accuracy of the query optimizer to determine an estimate for the number of rows in a keyset depends on the currency of the statistics for each of the tables in the cursor.

Recommendations

This option is an advanced option and should be changed only by an experienced database administrator or certified [!INCLUDE ssNoVersion] professional.

If you set cursor threshold to -1, all keysets are generated synchronously, which benefits small cursor sets. If you set cursor threshold to 0, all cursor keysets are generated asynchronously. With other values, the query optimizer compares the number of expected rows in the cursor set and builds the keyset asynchronously if it exceeds the number set in cursor threshold. Don't set cursor threshold too low, because small result sets are better built synchronously.

Permissions

Execute permissions on sp_configure with no parameters or with only the first parameter are granted to all users by default. To execute sp_configure with both parameters to change a configuration option or to run the RECONFIGURE statement, a user must be granted the ALTER SETTINGS server-level permission. The ALTER SETTINGS permission is implicitly held by the sysadmin and serveradmin fixed server roles.

Use SQL Server Management Studio

  1. In Object Explorer, right-click a server and select Properties.

  2. Select the Advanced node.

  3. Under Miscellaneous, change the cursor threshold option to the value you want.

Use Transact-SQL

  1. Connect to the [!INCLUDE ssDE].

  2. From the Standard bar, select New Query.

  3. Copy and paste the following example into the query window and select Execute. This example shows how to use sp_configure to set the cursor threshold option to 0 so that cursor keysets are generated asynchronously.

    USE master;
GO

EXECUTE sp_configure 'show advanced options', 1;
GO

RECONFIGURE;
GO

EXECUTE sp_configure 'cursor threshold', 0;
GO

RECONFIGURE;
GO

EXECUTE sp_configure 'show advanced options', 0;
GO

RECONFIGURE;
GO

For more information, see Server configuration options.

Follow up: After you configure the cursor threshold option

The setting takes effect immediately without restarting the server.

Related content