Obtaining Full-Text Property Values Using Transact-SQL Functions
Several Transact-SQL functions such as OBJECTPROPERTYEX and FULLTEXTCATALOGPROPERTY can be used to obtain the value of various full-text properties.
The following table contains a complete list of full-text properties and their related Transact-SQL functions.
Note
Many of these properties are useful only for full-text administration.
| Property | Function |
|---|---|
IsFulltextIndexed |
COLUMNPROPERTY |
FullTextTypeColumn |
COLUMNPROPERTY |
IsFullTextInstalled |
SERVERPROPERTY |
IsFulltextEnabled |
DATABASEPROPERTYEX |
IsFulltextKey |
INDEXPROPERTY |
TableFulltextBackgroundUpdateIndexOn |
OBJECTPROPERTYEX |
TableFulltextCatalogId |
OBJECTPROPERTYEX |
TableFulltextChangeTrackingOn |
OBJECTPROPERTYEX |
TableFulltextDocsProcessed |
OBJECTPROPERTYEX |
TableFulltextFailCount |
OBJECTPROPERTYEX |
TableFulltextItemCount |
OBJECTPROPERTYEX |
TableFulltextKeyColumn |
OBJECTPROPERTYEX |
TableFulltextPendingChanges |
OBJECTPROPERTYEX |
TableFulltextPopulateStatus |
OBJECTPROPERTYEX |
TableHasActiveFulltextIndex |
OBJECTPROPERTYEX |
AccentSensitivity |
FULLTEXTCATALOGPROPERTY |
IndexSize |
FULLTEXTCATALOGPROPERTY |
ItemCount |
FULLTEXTCATALOGPROPERTY |
LogSize |
FULLTEXTCATALOGPROPERTY |
MergeStatus |
FULLTEXTCATALOGPROPERTY |
PopulateCompletionAge |
FULLTEXTCATALOGPROPERTY |
PopulateStatus |
FULLTEXTCATALOGPROPERTY |
UniqueKeyCount |
FULLTEXTCATALOGPROPERTY |
ResourceUsage |
FULLTEXTSERVICEPROPERTY |
ConnectTimeout |
FULLTEXTSERVICEPROPERTY |
IsFullTextInstalled |
FULLTEXTSERVICEPROPERTY |
DataTimeout |
FULLTEXTSERVICEPROPERTY |
LoadOSResources |
FULLTEXTSERVICEPROPERTY |
VerifySignature |
FULLTEXTSERVICEPROPERTY |
Transact-SQL Functions That Return Full-Text Properties
These Transact-SQL functions return information about the full-text properties of database objects.
SERVERPROPERTY
- IsFullTextInstalled
Indicates that the full-text component is installed with the current instance of Microsoft SQL Server. This property is the counterpart of the FULLTEXTSERVICEPROPERTY function property with the same name
For more information, see SERVERPROPERTY (Transact-SQL)
DATABASEPROPERTYEX
- IsFulltextEnabled
Indicates whether a database has been enabled for full-text indexing.
For more information, see DATABASEPROPERTYEX (Transact-SQL)
OBJECTPROPERTYEX
- TableFullTextBackgroundUpdateIndexOn
Indicates whether a table has full-text background update indexing
- TableFullTextCatalogId
Provides the full-text catalog ID in which the full-text index data for the table resides.
- TableFullTextKeyColumn
Provides the column ID of the full-text unique key column.
- TableFullTextPopulateStatus
Indicates the population status of a full-text table.
- TableHasActiveFulltextIndex
Indicates whether a table has an active full-text index.
For more information, see OBJECTPROPERTYEX (Transact-SQL).
COLUMNPROPERTY
- IsFullTextIndexed
Indicates whether a column has been enabled for full-text indexing.
For more information, see COLUMNPROPERTY (Transact-SQL).
INDEXPROPERTY
- IsFulltextKey
Indicates whether the index is the full-text key for a table.
For more information, see INDEXPROPERTY (Transact-SQL)
Full-text Related Transact-SQL Functions
Transact-SQL has functions that specifically return full-text properties.
| Function | Description |
|---|---|
FULLTEXTCATALOGPROPERTY |
Returns information about full-text catalog properties: PopulateStatus, ItemCount, IndexSize, UniqueKeyCount, LogSize, and PopulateCompletionAge. For more information, see FULLTEXTCATALOGPROPERTY (Transact-SQL). |
FULLTEXTSERVICEPROPERTY |
Returns information about the full-text service-level properties: ResourceUsage, ConnectTimeout, DataTimeout, and IsFulltextInstalled. IsFulltextInstalled returns the same information as the SERVERPROPERTY property of the same name. For more information, see FULLTEXTSERVICEPROPERTY (Transact-SQL). |
Examples
The following example checks to see whether full-text querying is enabled for the AdventureWorks database. A return value of 1 indicates that AdventureWorks is enabled for full-text querying. 0 indicates that AdventureWorks has not been enabled for full-text querying.
USE AdventureWorks;
GO
SELECT DATABASEPROPERTY('AdventureWorks', 'IsFullTextEnabled');
GO
See Also
Other Resources
COLUMNPROPERTY (Transact-SQL)
DATABASEPROPERTY (Transact-SQL)
DATABASEPROPERTYEX (Transact-SQL)
FULLTEXTCATALOGPROPERTY (Transact-SQL)
FULLTEXTSERVICEPROPERTY (Transact-SQL)
INDEXPROPERTY (Transact-SQL)
OBJECTPROPERTY (Transact-SQL)