FullTextCatalog Class

The FullTextCatalog object represents a Microsoft Search full-text catalog.

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.FullTextCatalog

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

Syntax

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

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class FullTextCatalog : ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IAlterable, IDroppable, 
    IScriptable

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class FullTextCatalog sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IAlterable, IDroppable, 
    IScriptable

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

public final class FullTextCatalog extends ScriptNameObjectBase implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IAlterable, IDroppable, IScriptable

The FullTextCatalog type exposes the following members.

Constructors

	Name	Description
	FullTextCatalog()	Initializes a new instance of the FullTextCatalog class.
	FullTextCatalog(Database, String)	Initializes a new instance of the FullTextCatalog class on the specified database and with the specified name.

Top

Properties

	Name	Description
	ErrorLogSize	Gets the size of the error log.
	FileGroup	Gets or sets the file group on which this catalog resides.
	FullTextIndexSize	Gets the size of the full-text index.
	HasFullTextIndexedTables	Gets a Boolean property value that specifies whether the full-text catalog is used by at least one table for index data storage.
	ID	Gets the ID value that uniquely identifies the Microsoft Search full-text catalog.
	IsAccentSensitive	Gets or sets the Boolean property value that specifies whether the referenced full-text catalog is accent sensitive.
	IsDefault	Gets or sets the Boolean property value that specifies whether the referenced full-text catalog is the default catalog for full-text index creation.
	ItemCount	Gets the total number of full-text indexed rows in the catalog.
	Name	Gets or sets a String which contains the name of the FullTextCatalog. (Overrides NamedSmoObject.Name.)
	Owner	Gets or sets the owner of the full-text catalog.
	Parent	Gets or sets the Database object that is the parent of the FullTextCatalog object.
	PopulationCompletionAge	Gets the time since the last successful full-text catalog population.
	PopulationCompletionDate	Gets the date and time of the last successful full-text catalog population.
	PopulationStatus	Gets the population status of the referenced full-text catalog.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	RootPath	Gets or sets the path to the operating system directory that is used as the primary path for Microsoft Search full-text catalog storage.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	UniqueKeyCount	Gets the approximate number of words uniquely addressable in the referenced full-text catalog.
	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 FullTextCatalog object property changes on the instance of Microsoft SQL Server.
	Create	Creates a full-text catalog on the instance of SQL Server as defined by the FullTextCatalog object.
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the full text catalog.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the full text catalog.
	Deny(ObjectPermissionSet, String, Boolean)	Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the full text catalog.
	Deny(ObjectPermissionSet, array<String[], Boolean)	Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the full text catalog.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops the full-text catalog that is represented by the FullTextCatalog object.
	EnumErrorLogs	Enumerates a list of error logs for the referenced full-text catalog.
	EnumObjectPermissions()	Enumerates a list of permissions for the full-text catalog.
	EnumObjectPermissions(String)	Enumerates a list of permissions for the full-text catalog that belongs to the specified user.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of permissions for the full-text catalog limited to the specified permission set.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of permissions for the full-text catalog that belong to the specified user and limited to the specified permission set.
	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.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the full text catalog.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the full text catalog.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission to the grantee and the ability to grant access to other users on the full text catalog.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants access to the specified permission to the grantees and the ability to grant access to other users on the full text catalog.
	Grant(ObjectPermissionSet, String, Boolean, String)	Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the full text catalog under an assumed role.
	Grant(ObjectPermissionSet, array<String[], Boolean, String)	Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the full text catalog under an assumed role.
	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.)
	ReadErrorLog()	Returns the information in the error log.
	ReadErrorLog(Int32)	Returns the information in the error log for the specified log number.
	Rebuild()	Rebuilds the entire full-text catalog.
	Rebuild(Boolean)	Rebuilds the entire full-text catalog with the option to alter the accent sensitivity.
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Reorganize	Forces a master merge of the referenced full-text catalog.
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the full text catalog.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the full text catalog.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes previously granted permissions from a grantee on the full text catalog and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean)	Revokes previously granted permissions from grantees on the full text catalog and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)	Revokes previously granted permissions from a grantee on the full text catalog and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String)	Revokes previously granted permissions from grantees on the full text catalog and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Script()	Generates a Transact-SQL script that can be used to re-create the full-text catalog.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the full-text catalog 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 the 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 the FullTextCatalog object properties, users must be a member of the public fixed server role.

To set the FullTextCatalog object properties, users must have ALTER permission on the full-text catalog.

To create a full-text catalog, users must have ALTER ANY DATABASE permission on the server or be a member of the db_owner or db_ddladmin fixed database roles.

To drop a full-text catalog, users must be a member of the db_owner or db_ddladmin fixed database roles.

To grant, deny, or revoke permission to other users on the full-text catalog, users must have CONTROL permission on the full-text catalog.

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 CATALOG (Transact-SQL)