FullTextService Class

The FullTextService object allows programmatic access to the Microsoft Search full-text settings.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.FullTextService

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class FullTextService _
    Inherits ScriptNameObjectBase _
    Implements IAlterable, IScriptable
'Usage
Dim instance As FullTextService

public sealed class FullTextService : ScriptNameObjectBase, 
    IAlterable, IScriptable

public ref class FullTextService sealed : public ScriptNameObjectBase, 
    IAlterable, IScriptable

[<SealedAttribute>]
type FullTextService =  
    class 
        inherit ScriptNameObjectBase 
        interface IAlterable 
        interface IScriptable 
    end

public final class FullTextService extends ScriptNameObjectBase implements IAlterable, IScriptable

The FullTextService type exposes the following members.

Properties

	Name	Description
	AllowUnsignedBinaries	Gets or sets the Boolean property value that specifies whether unsigned binaries can be loaded by Microsoft Search.
	CatalogUpgradeOption	Gets or sets the upgrade option for the full-text service.
	ConnectTimeout	Gets or sets the time interval allowed for Microsoft Search to try a connection to an instance of SQL Server before timing out.
	DataTimeout	Gets or sets the time interval allowed for Microsoft Search to wait for data to be returned during full-text index population before timing out.
	DefaultPath	Gets the default operating system path that specifies the root directory in the implementation of the Microsoft Search full-text catalog.
	LoadOSResourcesEnabled	Gets or sets the Boolean property value that specifies whether operating system components are allowed.
	Name	Gets or sets the String which contains the name of the FullTextService. (Overrides NamedSmoObject.Name.)
	Parent	Gets the Server object that is the parent of the FullTextService object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ResourceUsage	Gets or sets the relative execution priority operating-system setting for the Microsoft Search service.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Updates any FullTextService object property changes on the instance of SQL Server.
	Cleanup	Finds and removes full-text catalog resources in the file system that do not have corresponding entries in the full-text related system table.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	EnumLanguages	Enumerates a list of all the languages supported by Microsoft Search service.
	EnumSemanticLanguages	Enumerates the semantic languages models.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Script()	Generates a Transact-SQL script that can be used to re-create the Microsoft Search service settings.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the Microsoft Search service settings as specified by the script options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	UpdateLanguageResources	Updates language strings used at index and query time that are registered with Microsoft Search.
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

To get FullTextService object properties, users can be a member of the public fixed server role.

To set FullTextService object properties, users must be a member of the sysadmin fixed server role.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Implementing Full-Text Search

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

DEL - Full-Text Search Overview

CREATE FULLTEXT INDEX (Transact-SQL)

CREATE FULLTEXT CATALOG (Transact-SQL)