Skip to content

sp-help-fulltext-catalogs-cursor-transact-sql.md

Latest commit

 

History

History
98 lines (70 loc) · 3.57 KB

sp-help-fulltext-catalogs-cursor-transact-sql.md

File metadata and controls

98 lines (70 loc) · 3.57 KB
title sp_help_fulltext_catalogs_cursor (Transact-SQL)
description Uses a cursor to return the ID, name, root directory, status, and number of full-text indexed tables for the specified full-text catalog.
author markingmyname
ms.author maghan
ms.reviewer randolphwest
ms.date 06/23/2025
ms.service sql
ms.subservice system-objects
ms.topic reference
f1_keywords
sp_help_fulltext_catalogs_cursor
sp_help_fulltext_catalogs_cursor_TSQL
helpviewer_keywords
sp_help_fulltext_catalogs_cursor
dev_langs
TSQL
monikerRange =azuresqldb-current || >=sql-server-2016 || >=sql-server-linux-2017 || =azuresqldb-mi-current

sp_help_fulltext_catalogs_cursor (Transact-SQL)

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

Uses a cursor to return the ID, name, root directory, status, and number of full-text indexed tables for the specified full-text catalog.

Important

[!INCLUDE ssNoteDepFutureAvoid] Use the sys.fulltext_catalogs catalog view instead.

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

Syntax

sp_help_fulltext_catalogs_cursor
    [ @cursor_return = ] cursor_return OUTPUT
    [ , [ @fulltext_catalog_name = ] N'fulltext_catalog_name' ]
[ ; ]

Arguments

[ @cursor_return = ] cursor_return OUTPUT

@cursor_return is an OUTPUT parameter of type int. The cursor is a read-only, scrollable, dynamic cursor.

[ @fulltext_catalog_name = ] N'fulltext_catalog_name'

The name of the full-text catalog. @fulltext_catalog_name is sysname, with a default of NULL. If this parameter is omitted or is NULL, information about all full-text catalogs associated with the current database is returned.

Return code values

0 (success) or 1 (failure).

Result set

Column name Data type Description
fulltext_catalog_id smallint Full-text catalog identifier.
NAME sysname Name of the full-text catalog.
PATH nvarchar(260) This clause has no effect.
STATUS int Full-text index population status of the catalog:

0 = Idle
1 = Full population in progress
2 = Paused
3 = Throttled
4 = Recovering
5 = Shutdown
6 = Incremental population in progress
7 = Building index
8 = Disk is full. Paused
9 = Change tracking
NUMBER_FULLTEXT_TABLES int Number of full-text indexed tables associated with the catalog.

Permissions

Execute permissions default to the public role.

Examples

The following example returns information about the Cat_Desc full-text catalog.

USE AdventureWorks2022;
GO

DECLARE @mycursor AS CURSOR;

EXECUTE sp_help_fulltext_catalogs_cursor @mycursor OUTPUT, 'Cat_Desc';

FETCH NEXT FROM @mycursor;

WHILE (@@FETCH_STATUS <> -1)
    BEGIN
        FETCH NEXT FROM @mycursor;
    END

CLOSE @mycursor;

DEALLOCATE @mycursor;
GO

Related content