Edit

sys.registered_search_properties (Transact-SQL)

  • Article

Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance

Contains a row for each search property contained by any search property list on the current database.

Column name Data type Description
property_list_id int ID of the search property list to which this property belongs.
property_set_guid uniqueidentifier Globally unique identifier GUID that identifies the property set to which the search property belongs.
property_int_id int Integer that identifies this search property within the property set. property_int_id is unique within the property set.
property_name nvarchar(64) Name that uniquely identifies this search property in the search property list.

Note: To search on a property, specify this property name in the CONTAINS predicate.
property_description nvarchar(512) Description of the property.
property_id int Internal property ID of the search property within the search property list identified by the property_list_id value.

When a given property is added to a given search property list, the Full-Text Engine registers the property and assigns it an internal property ID that is specific to that property list. The internal property ID, which is an integer, is unique to a given search property list. If a given property is registered for multiple search property lists, a different internal property ID might be assigned for each search property list.

Note: The internal property ID is distinct from the property integer identifier that is specified when adding the property to the search property list. For more information, see Search Document Properties with Search Property Lists.

To view all property-related content in the full-text index:
sys.dm_fts_index_keywords_by_property (Transact-SQL)

Remarks

For more information about search property lists, see Search Document Properties with Search Property Lists.

Permissions

Visibility of the metadata for search properties is limited to those that are in search property lists that you either own or on which you have been granted some REFERENCE permission.

Note

The search property list owner can grant REFERENCE or CONTROL permissions on the list. Users with CONTROL permission can also grant REFERENCE permission to other users.

Examples

The following example lists all of the metadata for registered search properties.

USE AdventureWorks2022;  
GO  
SELECT * FROM sys.registered_search_properties;   
GO

See Also

ALTER FULLTEXT INDEX (Transact-SQL)
sys.fulltext_indexes (Transact-SQL)
Search Document Properties with Search Property Lists