Export (0) Print
Expand All

FullTextIndex Class

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

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

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

The FullTextIndex type exposes the following members.

  NameDescription
Public methodFullTextIndex()Initializes a new instance of the FullTextIndex class.
Public methodFullTextIndex(TableViewBase)Initializes a new instance of the FullTextCatalog class on the specified parent table or view object.
Top

  NameDescription
Public propertyCatalogNameGets or sets the full-text catalog that supports full-text queries for the referenced full-text index.
Public propertyChangeTrackingGets or sets the type of change tracking that is used by the referenced full-text index.
Public propertyDocumentsProcessedGets the number of documents already processed in the current active crawl on the referenced full-text index.
Public propertyFilegroupNameGets the name of the file group in which the full-text index is stored.
Public propertyIndexedColumnsRepresents a collection of FullTextIndexColumn objects. Each FullTextIndexColumn object represents a full-text indexed column on the full-text index.
Public propertyIsEnabledGets the Boolean property value that specifies whether the referenced full-text index is configured to participate in Microsoft Search full-text indexing.
Public propertyItemCountGets the number of full-text indexed items.
Public propertyNumberOfFailuresGets the number of documents that failed to be full-text indexed.
Public propertyParentGets the Table object that is the parent of the FullTextIndex object.
Public propertyPendingChangesGets the number of pending entries the full-text index has to process.
Public propertyPopulationStatusGets the type of population in progress.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertySearchPropertyListNameGets or sets the String which contains the name of the SearchPropertyList associated with this object.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyStopListNameGets the name of the full-text Search stop list.
Public propertyStopListOptionGets the stop list option associated with the full-text index.
Public propertyUniqueIndexNameGets or sets a unique name for the full-text index.
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlter()Updates any FullTextIndex object property changes on the instance of SQL Server. 
Public methodAlter(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 methodCreate()Creates a full-text index on the instance of SQL Server as defined by the FullTextIndex object.
Public methodCreate(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 methodDisableDisables the full-text index.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the full-text index from the instance of SQL Server.
Public methodEnableEnables the full-text index.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the full-text index. (Overrides SqlSmoObject::Refresh().)
Public methodScript()Generates a Transact-SQL script that can be used to re-create the full-text index.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the full-text index as specified by the script options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodStartPopulationStarts the population of the full-text catalog.
Public methodStopPopulationStops a full or incremental population of the full-text catalog.
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject::DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetParentGets 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 methodIAlienObject::GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetUrnGets 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 methodIAlienObject::ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider::GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode::IsDesignModeGets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft