• Article

sp_help_fulltext_columns_cursor (Transact-SQL)

Uses a cursor to return the columns designated for full-text indexing.

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_index_columns catalog view instead.

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_help_fulltext_columns_cursor [ @cursor_return= ] @cursor_variable OUTPUT 
     [ , [ @table_name= ] 'table_name' ] 
     [ , [ @column_name= ] 'column_name' ]

Arguments

  • [ @cursor_return =] @cursor_variable OUTPUT
    Is the output variable of type cursor. The resulting cursor is a read-only, scrollable, dynamic cursor.

  • [ @table_name =] 'table_name'
    Is the one- or two-part table name for which full-text index information is requested. table_name is nvarchar(517), with a default value of NULL. If table_name is omitted, full-text index column information is retrieved for every full-text indexed table.

  • [ @column_name =] 'column_name'
    Is the name of the column for which full-text index metadata is desired. column_name is sysname with a default value of NULL. If column_name is omitted or is NULL, full-text column information is returned for every full-text indexed column for table_name. If table_name is also omitted or is NULL, full-text index column information is returned for every full-text indexed column for all tables in the database.

Return Code Values

0 (success) or (1) failure

Result Sets

Column name

Data type

Description

TABLE_OWNER

sysname

Table owner. This is the name of the database user that created the table.

TABLE_ID

int

ID of the table.

TABLE_NAME

sysname

Table name.

FULLTEXT_COLUMN_NAME

sysname

Column in a full-text indexed table that is designated for indexing.

FULLTEXT_COLID

int

Column ID of the full-text indexed column.

FULLTEXT_BLOBTP_COLNAME

sysname

Column in a full-text indexed table that specifies the document type of the full-text indexed column. This value is only applicable when the full-text indexed column is a varbinary(max) or image column.

FULLTEXT_BLOBTP_COLID

int

Column ID of the document type column. This value is only applicable when the full-text indexed column is a varbinary(max) or image column.

FULLTEXT_LANGUAGE

sysname

Language used for the full-text search of the column.

Permissions

Execute permissions default to members of the public role.

Examples

The following example returns information about the columns that have been designated for full-text indexing in all of the tables in the database.

USE AdventureWorks2008R2;
GO
DECLARE @mycursor CURSOR;
EXEC sp_help_fulltext_columns_cursor @mycursor OUTPUT
FETCH NEXT FROM @mycursor;
WHILE (@@FETCH_STATUS <> -1)
   BEGIN
      FETCH NEXT FROM @mycursor;
   END;
CLOSE @mycursor;
DEALLOCATE @mycursor;
GO