sp_fulltext_service (T-SQL)

Changes Microsoft Search Service (Full-text Search) properties.

Syntax

sp_fulltext_service [@action =] 'action'
[,[@value =] 'value']

Arguments

[@action =] 'action'

Is the property to be changed or reset. action is varchar(20), with no default, and can be one of these values.

Value	Description
resource_usage	Specifies the amount of resources to be used for the Microsoft Search Service.
clean_up	Searches for and removes the full-text catalog resources in the file system that do not have corresponding entries in sysfulltextcatalogs.
connect_timeout	Is the number of seconds that Microsoft Search Service will wait for connections to Microsoft® SQL Server™ for full-text populations before timing out. If a time-out occurs before Microsoft SQL Server responds to a database request, the population fails to complete.

[@value =] 'value'

Is the value of the specified property. value is integer, with a default value of NULL. The table shows the required values for the properties.

Property	Value
resource_usage	1 (background) through 5 (dedicated), with a default of 3
clean_up	NULL
connect_timeout	Between 1 and 32767

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

There may be times when the metadata for a full-text catalog is changed (for example, when the full-text catalog is being dropped or the database is being dropped) while the Microsoft Search Service (MSSearch) is not running. The drop action changes the metadata related to the full-text catalogs, but is unable to complete execution because the Microsoft Search Service is not running. This leads to inconsistency between the full-text metadata in SQL Server and the associated physical full-text catalog in the file system. This inconsistency can be corrected by using the clean_up action of sp_fulltext_service. (Microsoft Search Service must be running, of course).

Permissions

Only members of the serveradmin fixed server role or the system administrator can execute sp_fulltext_service.

Examples

This example performs a cleanup operation on the full-text catalogs.

EXEC sp_fulltext_service 'clean_up'