sp_help_fulltext_catalogs_cursor (Transact-SQL)


THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)yesAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

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

System_CAPS_ICON_important.jpg 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.

Applies to: SQL Server (SQL Server 2008 through current version), SQL Database V12.

Topic link icon Transact-SQL Syntax Conventions

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

[ @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.

0 (success) or (1) failure

Column nameData typeDescription
fulltext_catalog_idsmallintFull-text catalog identifier.
NAMEsysnameName of the full-text catalog.
PATHnvarchar(260)Beginning with SQL Server 2008, this clause has no effect.
STATUSintFull-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_TABLESintNumber of full-text indexed tables associated with the catalog.

Execute permissions default to the public role.

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

USE AdventureWorks2012;  
DECLARE @mycursor CURSOR;  
EXEC sp_help_fulltext_catalogs_cursor @mycursor OUTPUT, 'Cat_Desc';  
FETCH NEXT FROM @mycursor;  
      FETCH NEXT FROM @mycursor;  
CLOSE @mycursor;  
DEALLOCATE @mycursor;  

sp_fulltext_catalog (Transact-SQL)
sp_help_fulltext_catalogs (Transact-SQL)
System Stored Procedures (Transact-SQL)

Community Additions