Bewerken

Share via

sp_help_fulltext_columns_cursor (Transact-SQL)

  • Artikel

Applies to: SQL Server

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

Important

This feature will be removed in a future version of 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.

Transact-SQL syntax conventions

Syntax

sp_help_fulltext_columns_cursor
    [ @cursor_return = ] cursor_return OUTPUT
    [ , [ @table_name = ] N'table_name' ]
    [ , [ @column_name = ] N'column_name' ]
[ ; ]

Arguments

[ @cursor_return = ] cursor_return OUTPUT

@cursor_return is an OUTPUT parameter of type int. The resulting cursor is a read-only, scrollable, dynamic cursor.

[ @table_name = ] N'table_name'

The one- or two-part table name for which full-text index information is requested. @table_name is nvarchar(517), with a default of NULL.

If @table_name is omitted, full-text index column information is retrieved for every full-text indexed table.

[ @column_name = ] N'column_name'

The name of the column for which full-text index metadata is desired. @column_name is sysname, with a default 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 set

Column name Data type Description
TABLE_OWNER sysname Table owner. The owner 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 are designated for full-text indexing in all of the tables in the database.

USE AdventureWorks2022;
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

Related content