Article
10/01/2010

sp_help_fulltext_catalogs_cursor (Transact-SQL)

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

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Use the sys.fulltext_catalogs catalog view instead.

Topic link icon Transact-SQL Syntax Conventions

Syntax

sp_help_fulltext_catalogs_cursor [ @cursor_return= ] @cursor_variable OUTPUT , 
     [ @fulltext_catalog_name= ] 'fulltext_catalog_name'

Arguments

[ @cursor_return=] @cursor\_variable OUTPUT
Is the output variable of type cursor. The cursor is a read-only, scrollable, dynamic cursor.
[ @fulltext_catalog_name=] 'fulltext_catalog_name'
Is the name of the full-text catalog. fulltext_catalog_name is sysname. 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 Sets

Column name	Data type	Description
fulltext_catalog_id	smallint	Full-text catalog identifier.
NAME	sysname	Name of the full-text catalog.
PATH	nvarchar(260)	Beginning with SQL Server 2008, 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 AdventureWorks;
GO
DECLARE @mycursor CURSOR;
EXEC 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

Change History

Updated content
Updated the PATH description.

Share via