Skip to content

Commit ba37b3c

Browse files
JamesJBarnettJamesJBarnett
authored
Merge pull request #25416 from rwestMSFT/rw-1230-help-fulltext
Refresh sp_help_fulltext_system_components article
2 parents 204565c + e8caac1 commit ba37b3c

1 file changed

Lines changed: 138 additions & 128 deletions

File tree

‎docs/relational-databases/system-stored-procedures/sp-help-fulltext-system-components-transact-sql.md‎

Lines changed: 138 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,141 +1,151 @@
11
---
2-
description: "sp_help_fulltext_system_components (Transact-SQL)"
3-
title: "sp_help_fulltext_system_components (Transact-SQL) | Microsoft Docs"
4-
ms.custom: ""
5-
ms.date: "03/14/2017"
2+
title: "sp_help_fulltext_system_components (Transact-SQL)"
3+
description: "sp_help_fulltext_system_components Returns information for the registered word-breakers, filter, and protocol handlers."
4+
author: markingmyname
5+
ms.author: maghan
6+
ms.reviewer: randolphwest
7+
ms.date: 12/30/2022
68
ms.service: sql
7-
ms.reviewer: ""
89
ms.subservice: system-objects
910
ms.topic: "reference"
10-
f1_keywords:
11+
f1_keywords:
1112
- "sp_help_fulltext_components_TSQL"
1213
- "sp_help_fulltext_components"
13-
dev_langs:
14-
- "TSQL"
15-
helpviewer_keywords:
14+
helpviewer_keywords:
1615
- "sp_help_fulltext_system_components"
17-
ms.assetid: ac1fc7a0-7f46-4a12-8c5c-8d378226a8ce
18-
author: markingmyname
19-
ms.author: maghan
16+
dev_langs:
17+
- "TSQL"
2018
monikerRange: "=azure-sqldw-latest||>=sql-server-2016||>=sql-server-linux-2017||=azuresqldb-mi-current"
2119
---
2220
# sp_help_fulltext_system_components (Transact-SQL)
2321

2422
[!INCLUDE[sql-asa](../../includes/applies-to-version/sql-asa.md)]
2523

26-
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.
27-
28-
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: [Transact-SQL syntax conventions](../../t-sql/language-elements/transact-sql-syntax-conventions-transact-sql.md)
29-
30-
## Syntax
31-
32-
```
33-
34-
sp_help_fulltext_system_components
35-
{ 'all'| [ @component_type = ] 'component_type' }
36-
, [ @param = ] 'param'
37-
```
38-
39-
## Arguments
40-
'all'
41-
Returns information for all full-text components.
42-
43-
`[ @component_type = ] component_type`
44-
Specifies the type of component. *component_type* can be one of the following:
45-
46-
- **wordbreaker**
47-
48-
- **filter**
49-
50-
- **protocol handler**
51-
52-
- **fullpath**
53-
54-
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.
55-
56-
`[ @param = ] param`
57-
Depending on component type, this is one of the following: a locale identifier (LCID), the file extension with "." prefix, the full component name of the protocol handler, or the full path to the component DLL.
58-
59-
## Return Code Values
60-
0 (success) or (1) failure
61-
62-
## Result Sets
63-
The following result set is returned for the system components.
64-
65-
|Column name|Data type|Description|
66-
|-----------------|---------------|-----------------|
67-
|**componenttype**|**sysname**|Type of component. One of the following:<br /><br /> filter<br /><br /> protocol handler<br /><br /> wordbreaker|
68-
|**componentname**|**sysname**|Name of the component.|
69-
|**clsid**|**uniqueidentifier**|Class identifier of the component.|
70-
|**fullpath**|**nvarchar(256)**|Path to the location of the component.<br /><br /> NULL = Caller not a member of **serveradmin** fixed server role.|
71-
|**version**|**nvarchar(30)**|Version of the component.|
72-
|**manufacturer**|**sysname**|Name of the manufacturer of the component.|
73-
74-
The following result set is returned only if one or more than one full-text catalog exists that uses *component_type*.
75-
76-
|Column name|Data type|Description|
77-
|-----------------|---------------|-----------------|
78-
|**dbid**|**int**|ID of the database.|
79-
|**ftcatid**|**int**|ID of the full-text catalog.|
80-
81-
## Permissions
82-
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.
83-
84-
## Remarks
85-
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.
86-
87-
## Examples
88-
89-
### A. Listing all full-text system components
90-
The following example lists all of the full-text system components that have been registered on the server instance.
91-
92-
```
93-
EXEC sp_help_fulltext_system_components 'all';
94-
GO
95-
```
96-
97-
### B. Listing word breakers
98-
The following example lists all the word breakers registered on the service instance.
99-
100-
```
101-
EXEC sp_help_fulltext_system_components 'wordbreaker';
102-
GO
103-
```
104-
105-
### C. Determining whether a specific word breaker is registered
106-
The following example will list the word breaker for the Turkish language (LCID = 1055) if it has been installed on the system and registered on the service instance. This example specifies the parameter names, **\@component_type** and **\@param**.
107-
108-
```
109-
EXEC sp_help_fulltext_system_components @component_type = 'wordbreaker', @param = 1055;
110-
GO
111-
```
112-
113-
By default, this word breaker is not installed, so the result set is empty.
114-
115-
### D. Determining whether a specific filter has been registered
116-
The following example lists the filter for the .xdoc component if it has been manually installed on the system and registered on the server instance.
117-
118-
```
119-
EXEC sp_help_fulltext_system_components 'filter', '.xdoc';
120-
GO
121-
```
122-
123-
By default, this filter is not installed, so the result set is empty.
124-
125-
### E. Listing a specific .dll file
126-
The following example lists a specific .ddl file, `nlhtml.dll`, which is installed by default.
127-
128-
```
129-
EXEC sp_help_fulltext_system_components 'fullpath',
130-
'C:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\Binn\nlhtml.dll';
131-
GO
132-
133-
```
134-
135-
## See Also
136-
[View or Change Registered Filters and Word Breakers](../../relational-databases/search/view-or-change-registered-filters-and-word-breakers.md)
137-
[Configure and Manage Word Breakers and Stemmers for Search](../../relational-databases/search/configure-and-manage-word-breakers-and-stemmers-for-search.md)
138-
[Configure and Manage Filters for Search](../../relational-databases/search/configure-and-manage-filters-for-search.md)
139-
[Full-Text Search and Semantic Search Stored Procedures &#40;Transact-SQL&#41;](../../relational-databases/system-stored-procedures/full-text-search-and-semantic-search-stored-procedures-transact-sql.md)
140-
141-
24+
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.
25+
26+
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: [Transact-SQL syntax conventions](../../t-sql/language-elements/transact-sql-syntax-conventions-transact-sql.md)
27+
28+
## Syntax
29+
30+
```syntaxsql
31+
sp_help_fulltext_system_components
32+
{ 'all' | [ @component_type = ] 'component_type' }
33+
, [ @param = ] 'param'
34+
```
35+
36+
## Arguments
37+
38+
#### 'all'
39+
40+
Returns information for all full-text components.
41+
42+
#### [ @component_type = ] '*component_type*'
43+
44+
Specifies the type of component. *component_type* can be one of the following options:
45+
46+
- `wordbreaker`
47+
- `filter`
48+
- `protocol handler`
49+
- `fullpath`
50+
51+
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.
52+
53+
#### [ @param = ] '*param*'
54+
55+
Depending on component type, *param* is one of the following options:
56+
57+
- a locale identifier (LCID)
58+
- the file extension with "." prefix
59+
- the full component name of the protocol handler
60+
- the full path to the component DLL
61+
62+
## Return code values
63+
64+
`0` (success) or `1` (failure).
65+
66+
## Result sets
67+
68+
The following result set is returned for the system components.
69+
70+
| Column name | Data type | Description |
71+
| --- | --- | --- |
72+
| **componenttype** | **sysname** | Type of component. One of the following options:<br /><br />- filter<br />- protocol handler<br />- wordbreaker |
73+
| **componentname** | **sysname** | Name of the component |
74+
| **clsid** | **uniqueidentifier** | Class identifier of the component |
75+
| **fullpath** | **nvarchar(256)** | Path to the location of the component.<br /><br />NULL = Caller not a member of **serveradmin** fixed server role |
76+
| **version** | **nvarchar(30)** | Version of the component |
77+
| **manufacturer** | **sysname** | Name of the manufacturer of the component |
78+
79+
The following result set is returned only if one or more than one full-text catalog exists that uses *component_type*.
80+
81+
| Column name | Data type | Description |
82+
| --- | --- | --- |
83+
| **dbid** | **int** | ID of the database |
84+
| **ftcatid** | **int** | ID of the full-text catalog |
85+
86+
## Permissions
87+
88+
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.
89+
90+
## Remarks
91+
92+
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.
93+
94+
## Examples
95+
96+
### A. List all full-text system components
97+
98+
The following example lists all of the full-text system components that have been registered on the server instance.
99+
100+
```sql
101+
EXEC sp_help_fulltext_system_components 'all';
102+
GO
103+
```
104+
105+
### B. List word breakers
106+
107+
The following example lists all the word breakers registered on the service instance.
108+
109+
```sql
110+
EXEC sp_help_fulltext_system_components 'wordbreaker';
111+
GO
112+
```
113+
114+
### C. Determine whether a specific word breaker is registered
115+
116+
The following example will list the word breaker for the Turkish language (LCID = 1055) if it has been installed on the system and registered on the service instance. This example specifies the parameter names, `@component_type` and `@param`.
117+
118+
```sql
119+
EXEC sp_help_fulltext_system_components @component_type = 'wordbreaker', @param = 1055;
120+
GO
121+
```
122+
123+
By default, this word breaker isn't installed, so the result set is empty.
124+
125+
### D. Determine whether a specific filter has been registered
126+
127+
The following example lists the filter for the `.xdoc` component if it has been manually installed on the system and registered on the server instance.
128+
129+
```sql
130+
EXEC sp_help_fulltext_system_components 'filter', '.xdoc';
131+
GO
132+
```
133+
134+
By default, this filter isn't installed, so the result set is empty.
135+
136+
### E. List a specific .dll file
137+
138+
The following example lists a specific .ddl file, `nlhtml.dll`, which is installed by default.
139+
140+
```sql
141+
EXEC sp_help_fulltext_system_components 'fullpath',
142+
'C:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\Binn\nlhtml.dll';
143+
GO
144+
```
145+
146+
## Next steps
147+
148+
- [View or Change Registered Filters and Word Breakers](../../relational-databases/search/view-or-change-registered-filters-and-word-breakers.md)
149+
- [Configure and Manage Word Breakers and Stemmers for Search](../../relational-databases/search/configure-and-manage-word-breakers-and-stemmers-for-search.md)
150+
- [Configure and Manage Filters for Search](../../relational-databases/search/configure-and-manage-filters-for-search.md)
151+
- [Full-Text Search and Semantic Search Stored Procedures (Transact-SQL)](../../relational-databases/system-stored-procedures/full-text-search-and-semantic-search-stored-procedures-transact-sql.md)

0 commit comments

Comments
 (0)