Export (0) Print
Expand All

FullTextCatalog Class

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

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

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

The FullTextCatalog type exposes the following members.

  NameDescription
Public methodFullTextCatalog()Initializes a new instance of the FullTextCatalog class.
Public methodFullTextCatalog(Database, String)Initializes a new instance of the FullTextCatalog class on the specified database and with the specified name.
Top

  NameDescription
Public propertyErrorLogSizeGets the size of the error log.
Public propertyFileGroupGets or sets the file group on which this catalog resides.
Public propertyFullTextIndexSizeGets the size of the full-text index.
Public propertyHasFullTextIndexedTablesGets a Boolean property value that specifies whether the full-text catalog is used by at least one table for index data storage.
Public propertyIDGets the ID value that uniquely identifies the Microsoft Search full-text catalog.
Public propertyIsAccentSensitiveGets or sets the Boolean property value that specifies whether the referenced full-text catalog is accent sensitive.
Public propertyIsDefaultGets or sets the Boolean property value that specifies whether the referenced full-text catalog is the default catalog for full-text index creation.
Public propertyItemCountGets the total number of full-text indexed rows in the catalog.
Public propertyNameGets or sets a String which contains the name of the FullTextCatalog. (Overrides NamedSmoObject::Name.)
Public propertyOwnerGets or sets the owner of the full-text catalog.
Public propertyParentGets or sets the Database object that is the parent of the FullTextCatalog object.
Public propertyPopulationCompletionAgeGets the time since the last successful full-text catalog population.
Public propertyPopulationCompletionDateGets the date and time of the last successful full-text catalog population.
Public propertyPopulationStatusGets the population status of the referenced full-text catalog.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyRootPathGets or sets the path to the operating system directory that is used as the primary path for Microsoft Search full-text catalog storage.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUniqueKeyCountGets the approximate number of words uniquely addressable in the referenced full-text catalog.
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 methodAlterUpdates any FullTextCatalog object property changes on the instance of Microsoft SQL Server. 
Public methodCreateCreates a full-text catalog on the instance of SQL Server as defined by the FullTextCatalog object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the full text catalog.
Public methodDeny(ObjectPermissionSet, array<String>)Denies the specified set of permissions for the specified grantees on the full text catalog.
Public methodDeny(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 methodDeny(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 methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropDrops the full-text catalog that is represented by the FullTextCatalog object.
Public methodEnumErrorLogsEnumerates a list of error logs for the referenced full-text catalog.
Public methodEnumObjectPermissions()Enumerates a list of permissions for the full-text catalog.
Public methodEnumObjectPermissions(String)Enumerates a list of permissions for the full-text catalog that belongs to the specified user.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of permissions for the full-text catalog limited to the specified permission set.
Public methodEnumObjectPermissions(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 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 methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the full text catalog.
Public methodGrant(ObjectPermissionSet, array<String>)Grants the specified set of permissions to the specified grantees on the full text catalog.
Public methodGrant(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 methodGrant(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 methodGrant(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 methodGrant(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 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 methodReadErrorLog()Returns the information in the error log.
Public methodReadErrorLog(Int32)Returns the information in the error log for the specified log number.
Public methodRebuild()Rebuilds the entire full-text catalog.
Public methodRebuild(Boolean)Rebuilds the entire full-text catalog with the option to alter the accent sensitivity.
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Public methodReorganizeForces a master merge of the referenced full-text catalog.
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the full text catalog.
Public methodRevoke(ObjectPermissionSet, array<String>)Revokes a previously granted set of permissions from a list of grantees on the full text catalog.
Public methodRevoke(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 methodRevoke(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 methodRevoke(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 methodRevoke(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 methodScript()Generates a Transact-SQL script that can be used to re-create the full-text catalog.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the full-text catalog 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 the 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 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.

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