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 NotInheritable Class FullTextIndex
	Inherits SqlSmoObject
	Implements ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable,
	IDropIfExists, IScriptable

NameDescription
System_CAPS_pubmethodFullTextIndex()

Initializes a new instance of the FullTextIndex class.

System_CAPS_pubmethodFullTextIndex(TableViewBase)

Initializes a new instance of the FullTextCatalog class on the specified parent table or view object.

NameDescription
System_CAPS_pubpropertyCatalogName

Gets or sets the full-text catalog that supports full-text queries for the referenced full-text index.

System_CAPS_pubpropertyChangeTracking

Gets or sets the type of change tracking that is used by the referenced full-text index.

System_CAPS_pubpropertyDocumentsProcessed

Gets the number of documents already processed in the current active crawl on the referenced full-text index.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyFilegroupName

Gets the name of the file group in which the full-text index is stored.

System_CAPS_pubpropertyIndexedColumns

Represents a collection of FullTextIndexColumn objects. Each FullTextIndexColumn object represents a full-text indexed column on the full-text index.

System_CAPS_pubpropertyIsEnabled

Gets the Boolean property value that specifies whether the referenced full-text index is configured to participate in Microsoft Search full-text indexing.

System_CAPS_pubpropertyItemCount

Gets the number of full-text indexed items.

System_CAPS_pubpropertyNumberOfFailures

Gets the number of documents that failed to be full-text indexed.

System_CAPS_pubpropertyParent

Gets the Table object that is the parent of the FullTextIndex object.

System_CAPS_pubpropertyPendingChanges

Gets the number of pending entries the full-text index has to process.

System_CAPS_pubpropertyPopulationStatus

Gets the type of population in progress.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertySearchPropertyListName

Gets or sets the String which contains the name of the SearchPropertyList associated with this object.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyStopListName

Gets the name of the full-text Search stop list.

System_CAPS_pubpropertyStopListOption

Gets the stop list option associated with the full-text index.

System_CAPS_pubpropertyUniqueIndexName

Gets or sets a unique name for the full-text index.

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any FullTextIndex object property changes on the instance of SQL Server. 

System_CAPS_pubmethodAlter(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. 

System_CAPS_pubmethodCreate()

Creates a full-text index on the instance of SQL Server as defined by the FullTextIndex object.

System_CAPS_pubmethodCreate(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.

System_CAPS_pubmethodDisable()

Disables the full-text index.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the full-text index from the instance of SQL Server.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnable()

Enables the full-text index.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the full-text index.(Overrides SqlSmoObject.Refresh().)

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the full-text index.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the full-text index as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodStartPopulation(IndexPopulationAction)

Starts the population of the full-text catalog.

System_CAPS_pubmethodStopPopulation()

Stops a full or incremental population of the full-text catalog.

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object())

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode.IsDesignMode

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.

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.

Return to top
Show: