Share via


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
Public method FullTextIndex() Initializes a new instance of the FullTextIndex class.
Public method FullTextIndex(TableViewBase) Initializes a new instance of the FullTextCatalog class on the specified parent table or view object.

Top

Properties

  Name Description
Public property CatalogName Gets or sets the full-text catalog that supports full-text queries for the referenced full-text index.
Public property ChangeTracking Gets or sets the type of change tracking that is used by the referenced full-text index.
Public property DocumentsProcessed Gets the number of documents already processed in the current active crawl on the referenced full-text index.
Public property FilegroupName Gets the name of the file group in which the full-text index is stored.
Public property IndexedColumns Represents a collection of FullTextIndexColumn objects. Each FullTextIndexColumn object represents a full-text indexed column on the full-text index.
Public property IsEnabled Gets the Boolean property value that specifies whether the referenced full-text index is configured to participate in Microsoft Search full-text indexing.
Public property ItemCount Gets the number of full-text indexed items.
Public property NumberOfFailures Gets the number of documents that failed to be full-text indexed.
Public property Parent Gets the Table object that is the parent of the FullTextIndex object.
Public property PendingChanges Gets the number of pending entries the full-text index has to process.
Public property PopulationStatus Gets the type of population in progress.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property SearchPropertyListName Gets or sets the String which contains the name of the SearchPropertyList associated with this object.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property StopListName Gets the name of the full-text Search stop list.
Public property StopListOption Gets the stop list option associated with the full-text index.
Public property UniqueIndexName Gets or sets a unique name for the full-text index.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter() Updates any FullTextIndex object property changes on the instance of SQL Server. 
Public method 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. 
Public method Create() Creates a full-text index on the instance of SQL Server as defined by the FullTextIndex object.
Public method 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.
Public method Disable Disables the full-text index.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the full-text index from the instance of SQL Server.
Public method Enable Enables the full-text index.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the full-text index. (Overrides SqlSmoObject.Refresh().)
Public method Script() Generates a Transact-SQL script that can be used to re-create the full-text index.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the full-text index as specified by the script options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method StartPopulation Starts the population of the full-text catalog.
Public method StopPopulation Stops a full or incremental population of the full-text catalog.
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

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