Export (0) Print
Expand All

sp_help_fulltext_tables_cursor (Transact-SQL)

Applies To: SQL Server 2014, SQL Server 2016 Preview

Topic Status: Some information in this topic is preview and subject to change in future releases. Preview information describes new features or changes to existing features in Microsoft SQL Server 2016 Community Technology Preview 2 (CTP2).

Uses a cursor to return a list of tables that are registered for full-text indexing.

Important note 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 new sys.fulltext_indexes catalog view instead. For more information, see sys.fulltext_indexes (Transact-SQL).

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

Topic link icon Transact-SQL Syntax Conventions

sp_help_fulltext_tables_cursor [ @cursor_return = ] @cursor_variable OUTPUT 
     [ , [ @fulltext_catalog_name = ] 'fulltext_catalog_name' ] 
     [ , [ @table_name = ] 'table_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, 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.

[ @table_name=] 'table_name'

Is the one- 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_NAME.

FULLTEXT_INDEX_ACTIVE

int

Specifies whether columns marked for full-text indexing in this table are eligible for queries:

0 = Inactive

1 = 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 AdventureWorks2012;
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 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft