Export (0) Print
Expand All
Expand Minimize

FULLTEXTCATALOGPROPERTY (Transact-SQL)

Updated: 17 July 2006

Returns information about full-text catalog properties.

Topic link icon Transact-SQL Syntax Conventions


FULLTEXTCATALOGPROPERTY ('catalog_name' ,'property')

catalog_name

Is an expression containing the name of the full-text catalog.

property

Is an expression containing the name of the full-text catalog property. The table lists the properties and provides descriptions of the information returned.

Property Description

AccentSensitivity

Accent-sensitivity setting.

0 = Accent insensitive

1 = Accent sensitive

IndexSize

Size of the full-text catalog in megabytes (MB).

ItemCount

Number of full-text indexed items currently in the full-text catalog.

LogSize

Supported for backward compatibility only. Always returns 0.

Size, in bytes, of the combined set of error logs associated with a Microsoft Search Service full-text catalog.

MergeStatus

Master merge is in progress.

0 = master merge not in progress

1 = master merge in progress

PopulateCompletionAge

The difference in seconds between the completion of the last full-text index population and 01/01/1990 00:00:00.

Only updated for full and incremental crawls. Returns 0 if no population has occurred.

PopulateStatus

0 = Idle

1 = Full population in progress

2 = Paused

3 = Throttled

4 = Recovering 5 = Shutdown

6 = Incremental population in progress

7 = Building index

8 = Disk is full. Paused.

9 = Change tracking

UniqueKeyCount

Number of unique keys in the full-text catalog.

Returns NULL on error or if a caller does not have permission to view the object.

In SQL Server 2005, a user can only view the metadata of securables that the user owns or on which the user has been granted permission. This means that metadata-emitting, built-in functions such as FULLTEXTCATALOGPROPERTY may return NULL if the user does not have any permission on the object. For more information, see Metadata Visibility Configuration and Troubleshooting Metadata Visibility.

It is important that applications do not wait in a tight loop, checking for the PopulateStatus property to become idle (indicating that population has completed) because this takes CPU cycles away from the database and full-text search processes, and causes time outs. In addition, it is usually a better option to check the corresponding PopulateStatus property at the table level, TableFullTextPopulateStatus in the OBJECTPROPERTYEX system function. This and other new full-text properties in OBJECTPROPERTYEX provide more granular information about full-text indexing tables. For more information, see OBJECTPROPERTYEX (Transact-SQL).

The following example returns the number of full-text indexed items in a full-text catalog named Cat_Desc.

USE AdventureWorks;
GO
SELECT fulltextcatalogproperty('Cat_Desc', 'ItemCount');
GO

Release History

17 July 2006

New content:
  • Added the "Exceptions" section.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft