sp_help_fulltext_system_components (Transact-SQL)

  • Article

Returns information for the registered word-breakers, filter, and protocol handlers. sp_help_fulltext_system_components also returns a list of identifiers of databases and full-text catalogs that have used the specified component.

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_help_fulltext_system_components 
         { 'all'| [ @component_type = ] component_type }
  , [ @param = ] param

Arguments

  • [ @component_type= ] component_type
    Is the type of component. Can be one of the following:

    • wordbreaker
    • filter
    • protocol handler
    • fullpath

    If fullpath is specified, param must also be specified with the full path to the component DLL, or an error message is returned.

    If 'all' is specified, information is returned for all the components.

  • [ @param= ] param
    Depending on component type, this is one of the following: a locale identifier (LCID), the file extension with "." prefix, the full progid identifying the protocol handler, or the full path to the component DLL.

Return Code Values

0 (success) or (1) failure

Result Sets

The following result set is returned for the system components.

Column name Data type Description

componenttype

sysname

Type of component. One of the following:

  • filter
  • protocol handler
  • wordbreaker

componentname

sysname

Name of the component.

clsid

uniqueidentifier

Class identifier of the component.

fullpath

nvarchar(256)

Path to the location of the component.

NULL = Caller not a member of serveradmin fixed server role.

version

nvarchar(30)

Version of the component.

manufacturer

sysname

Name of the manufacturer of the component.

The following result set is returned only if one or more than one full-text catalog exists that uses component_type.

Column name Data type Description

dbid

int

ID of the database.

ftcatid

int

ID of the full-text catalog.

Remarks

This method is of particular importance when preparing for an upgrade. Execute the stored procedure within a particular database, and use the output to determine whether a particular catalog will be impacted by the upgrade.

Permissions

Requires membership in the public role; however, users can only see information about the full-text catalogs for which they have VIEW DEFINITION permission. Only members of the serveradmin fixed server role can see values in the fullpath column.

See Also

Reference

Full-Text Search Stored Procedures (Transact-SQL)

Help and Information

Getting SQL Server 2005 Assistance

Change History

Release History

14 April 2006
Changed content:
  • Corrected syntax. Updated security information.