sp_help_fulltext_catalogs_cursor (T-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.

Syntax

sp_help_fulltext_catalogs [@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
ftcatid smallint Full-text catalog identifier.
NAME sysname Name of the full-text catalog.
PATH nvarchar(260) Physical location of the full-text catalog root directory. NULL indicates the default directory determined during installation. (This is the Ftdata subdirectory under the Microsoft® SQL Server™ directory; for example, C:\Mssql7\Ftdata.)
STATUS integer 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 = Updating index
NUMBER_FULLTEXT_TABLES integer Number of full-text indexed tables associated with the catalog.

Permissions

Execute permissions default to the public role.

Examples

This example returns information about the Cat_Desc full-text catalog.

USE Northwind

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

  

See Also
FULLTEXTCATALOGPROPERTY sp_help_fulltext_catalogs
sp_fulltext_catalog System Stored Procedures

  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.