sp_help_fulltext_columns_cursor

Transact-SQL Reference

Transact-SQL Reference

sp_help_fulltext_columns_cursor

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

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 integer ID of the table.
TABLE_NAME sysname Table name.
FULLTEXT_COLID integer Column ID of the full-text indexed column.
FULLTEXT_COLUMN_NAME sysname Column in a full-text indexed table that is designated for indexing.
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 an image column.
FULLTEXT_BLOBTP_COLID integer Column ID of the document type column. This value is only applicable when the full-text indexed column is an 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

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

USE Northwind
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 

See Also

COLUMNPROPERTY

sp_fulltext_column

sp_help_fulltext_columns

System Stored Procedures