Share via


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
Public method FullTextCatalog() Initializes a new instance of the FullTextCatalog class.
Public method FullTextCatalog(Database, String) Initializes a new instance of the FullTextCatalog class on the specified database and with the specified name.

Top

Properties

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