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_tables_cursor (Transact-SQL) |
sp_help_fulltext_tables_cursor uses a cursor to return a list of tables that are registered for full-text indexing. |
markingmyname |
maghan |
randolphwest |
08/22/2024 |
sql |
system-objects |
reference |
|
|
|
>=aps-pdw-2016 || >=sql-server-2016 || >=sql-server-linux-2017 || =azuresqldb-mi-current |
[!INCLUDE sql-asdbmi-pdw]
Uses a cursor to return a list of tables that are registered for full-text indexing.
Important
[!INCLUDE ssNoteDepFutureAvoid] Use the new sys.fulltext_indexes
catalog view instead. For more information, see sys.fulltext_indexes.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions
sp_help_fulltext_tables_cursor
[ @cursor_return = ] cursor_return OUTPUT
[ , [ @fulltext_catalog_name = ] N'fulltext_catalog_name' ]
[ , [ @table_name = ] N'table_name' ]
[ ; ]
The output variable of type cursor. 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 @fulltext_catalog_name is omitted or is
NULL
, all full-text indexed tables associated with the database are returned. -
If @fulltext_catalog_name is specified, but @table_name is omitted or is
NULL
, the full-text index information is retrieved for every full-text indexed table associated with this catalog. -
If both @fulltext_catalog_name and @table_name are specified, a row is returned if @table_name is associated with @fulltext_catalog_name; otherwise, an error is raised.
The one-part or two-part table name for which the full-text metadata is requested. @table_name is nvarchar(517), with a default value of NULL
. If only @table_name is specified, only the row relevant to @table_name is returned.
0
(success) or 1
(failure).
Column name | Data type | Description |
---|---|---|
TABLE_OWNER |
sysname | Table owner. This is the name of the database user that created the table. |
TABLE_NAME |
sysname | Table name. |
FULLTEXT_KEY_INDEX_NAME |
sysname | Index imposing the UNIQUE constraint on the column designated as the unique key column. |
FULLTEXT_KEY_COLID |
int | Column ID of the unique index identified by FULLTEXT_KEY_INDEX_NAME . |
FULLTEXT_INDEX_ACTIVE |
int | Specifies whether columns marked for full-text indexing in this table are eligible for queries:0 = Inactive1 = Active |
FULLTEXT_CATALOG_NAME |
sysname | Full-text catalog in which the full-text index data resides. |
Execute permissions default to members of the public role.
The following example returns the names of the full-text indexed tables associated with the Cat_Desc
full-text catalog.
USE AdventureWorks2022;
GO
DECLARE @mycursor CURSOR;
EXEC sp_help_fulltext_tables_cursor @mycursor OUTPUT, 'Cat_Desc';
FETCH NEXT FROM @mycursor;
WHILE (@@FETCH_STATUS <> -1)
BEGIN
FETCH NEXT FROM @mycursor;
END;
CLOSE @mycursor;
DEALLOCATE @mycursor;
GO