Edit

sp_help_fulltext_system_components (Transact-SQL)

  • Article

Applies to: SQL Server Azure Synapse Analytics

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.

Transact-SQL syntax conventions

Syntax

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

Arguments

'all'

Returns information for all full-text components.

[ @component_type = ] 'component_type'

Specifies the type of component. component_type can be one of the following options:

  • wordbreaker
  • filter
  • protocol handler
  • fullpath

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

[ @param = ] 'param'

Depending on component type, param is one of the following options:

  • a locale identifier (LCID)
  • the file extension with "." prefix
  • the full component name of the protocol handler
  • the full path to the component DLL

Return code values

0 (success) or 1 (failure).

Result set

The following result set is returned for the system components.

Column name Data type Description
componenttype sysname Type of component. One of the following options:

- 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

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.

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 affected by the upgrade.

Examples

A. List all full-text system components

The following example lists all of the full-text system components that have been registered on the server instance.

EXEC sp_help_fulltext_system_components 'all';
GO

B. List word breakers

The following example lists all the word breakers registered on the service instance.

EXEC sp_help_fulltext_system_components 'wordbreaker';
GO

C. Determine whether a specific word breaker is registered

The following example will list the word breaker for the Turkish language (LCID = 1055) if it's been installed on the system and registered on the service instance. This example specifies the parameter names, @component_type and @param.

EXEC sp_help_fulltext_system_components @component_type = 'wordbreaker', @param = 1055;
GO

By default, this word breaker isn't installed, so the result set is empty.

D. Determine whether a specific filter has been registered

The following example lists the filter for the .xdoc component if it's been manually installed on the system and registered on the server instance.

EXEC sp_help_fulltext_system_components 'filter', '.xdoc';
GO

By default, this filter isn't installed, so the result set is empty.

E. List a specific .dll file

The following example lists a specific .ddl file, nlhtml.dll, which is installed by default.

EXEC sp_help_fulltext_system_components 'fullpath',
   'C:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\Binn\nlhtml.dll';
GO

Related content