title | description | author | ms.author | ms.reviewer | ms.date | ms.service | ms.subservice | ms.topic | f1_keywords | helpviewer_keywords | dev_langs | monikerRange | ||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. |
markingmyname |
maghan |
randolphwest |
05/14/2024 |
sql |
system-objects |
reference |
|
|
|
=azuresqldb-current || >=sql-server-2016 || >=sql-server-linux-2017 || =azuresqldb-mi-current |
[!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
sp_help_fulltext_catalogs_cursor
[ @cursor_return = ] cursor_return OUTPUT
[ , [ @fulltext_catalog_name = ] N'fulltext_catalog_name' ]
[ ; ]
@cursor_return is an OUTPUT parameter of type int. The cursor is a read-only, scrollable, dynamic cursor.
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.
0
(success) or 1
(failure).
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 = Idle1 = Full population in progress2 = Paused3 = Throttled4 = Recovering5 = Shutdown6 = Incremental population in progress7 = Building index8 = Disk is full. Paused9 = Change tracking |
NUMBER_FULLTEXT_TABLES |
int | Number 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 AdventureWorks2022;
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