FullTextIndex Class

The FullTextIndex object represents a Microsoft Search full-text index.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.FullTextIndex

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class FullTextIndex _
    Inherits SqlSmoObject _
    Implements ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable,  _
    IScriptable
'Usage
Dim instance As FullTextIndex

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class FullTextIndex : SqlSmoObject, 
    ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IScriptable

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class FullTextIndex sealed : public SqlSmoObject, 
    ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IScriptable

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type FullTextIndex =  
    class 
        inherit SqlSmoObject 
        interface ISfcSupportsDesignMode 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IScriptable 
    end

public final class FullTextIndex extends SqlSmoObject implements ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IScriptable

The FullTextIndex type exposes the following members.

Constructors

	Name	Description
	FullTextIndex()	Initializes a new instance of the FullTextIndex class.
	FullTextIndex(TableViewBase)	Initializes a new instance of the FullTextCatalog class on the specified parent table or view object.

Top

Properties

	Name	Description
	CatalogName	Gets or sets the full-text catalog that supports full-text queries for the referenced full-text index.
	ChangeTracking	Gets or sets the type of change tracking that is used by the referenced full-text index.
	DocumentsProcessed	Gets the number of documents already processed in the current active crawl on the referenced full-text index.
	FilegroupName	Gets the name of the file group in which the full-text index is stored.
	IndexedColumns	Represents a collection of FullTextIndexColumn objects. Each FullTextIndexColumn object represents a full-text indexed column on the full-text index.
	IsEnabled	Gets the Boolean property value that specifies whether the referenced full-text index is configured to participate in Microsoft Search full-text indexing.
	ItemCount	Gets the number of full-text indexed items.
	NumberOfFailures	Gets the number of documents that failed to be full-text indexed.
	Parent	Gets the Table object that is the parent of the FullTextIndex object.
	PendingChanges	Gets the number of pending entries the full-text index has to process.
	PopulationStatus	Gets the type of population in progress.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	SearchPropertyListName	Gets or sets the String which contains the name of the SearchPropertyList associated with this object.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	StopListName	Gets the name of the full-text Search stop list.
	StopListOption	Gets the stop list option associated with the full-text index.
	UniqueIndexName	Gets or sets a unique name for the full-text index.
	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 FullTextIndex object property changes on the instance of SQL Server.
	Alter(Boolean)	Updates any FullTextIndex object property changes on the instance of SQL Server with the option to specify whether the full-text index is automatically populated after columns are added or removed.
	Create()	Creates a full-text index on the instance of SQL Server as defined by the FullTextIndex object.
	Create(Boolean)	Creates a full-text index on the instance of SQL Server as defined by the FullTextIndex object with the option to specify whether the full-text index is automatically populated after columns are added or removed.
	Disable	Disables the full-text index.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the full-text index from the instance of SQL Server.
	Enable	Enables the full-text index.
	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 full-text index. (Overrides SqlSmoObject.Refresh().)
	Script()	Generates a Transact-SQL script that can be used to re-create the full-text index.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the full-text index as specified by the script options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	StartPopulation	Starts the population of the full-text catalog.
	StopPopulation	Stops a full or incremental population of the full-text catalog.
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	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.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

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

To set FullTextIndex object properties, users must be a member of the sysadmin fixed server role or the db_owner or db_ddladmin fixed database roles.

To create or drop a full-text index, users must be a member of the sysadmin fixed server role or the db_owner or db_ddladmin fixed database roles.

To enable, disable, start or stop populating the full-text index, users must be a member of the sysadmin fixed server role or the db_owner or db_ddladmin fixed database roles.

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)