Skip to content

Commit 6abbca3

Browse files
authored
Merge pull request #36303 from rwestMSFT/rw-0119-landing-page
Revise landing pages
2 parents 6068620 + 402a3df commit 6abbca3

6 files changed

Lines changed: 553 additions & 312 deletions
Lines changed: 109 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -1,135 +1,118 @@
11
---
2-
title: "Full-Text Search DDL, functions, stored procedures, & views"
2+
title: "Full-Text Search DDL, Functions, Stored Procedures, and Views"
33
description: "Full-Text Search DDL, Functions, Stored Procedures, and Views"
44
author: rwestMSFT
55
ms.author: randolphwest
66
ms.reviewer: mikeray
7-
ms.date: "03/14/2017"
7+
ms.date: 01/19/2026
88
ms.service: sql
99
ms.subservice: search
10-
ms.topic: conceptual
11-
monikerRange: "=azuresqldb-current||>=sql-server-2016||>=sql-server-linux-2017||=azuresqldb-mi-current"
10+
ms.topic: article
11+
monikerRange: "=azuresqldb-current || >=sql-server-2016 || >=sql-server-linux-2017 || =azuresqldb-mi-current"
1212
---
13-
# Full-Text Search DDL, Functions, Stored Procedures, and Views
13+
# Full-Text Search DDL, functions, stored procedures, and views
14+
1415
[!INCLUDE [SQL Server Azure SQL Database Azure SQL Managed Instance](../../includes/applies-to-version/sql-asdb-asdbmi.md)]
15-
Lists the Transact-SQL statements and the [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] database objects that support full-text search, including the property search feature.
16-
17-
This list does not include deprecated objects.
18-
19-
For the list of database objects that support semantic search, see [Semantic Search DDL, Functions, Stored Procedures, and Views](../../relational-databases/search/semantic-search-ddl-functions-stored-procedures-and-views.md).
20-
21-
## <a name="ddl"></a> Transact-SQL Data Definition Language (DDL) Statements
22-
23-
- [CREATE FULLTEXT CATALOG &#40;Transact-SQL&#41;](../../t-sql/statements/create-fulltext-catalog-transact-sql.md)
24-
25-
- [CREATE FULLTEXT INDEX &#40;Transact-SQL&#41;](../../t-sql/statements/create-fulltext-index-transact-sql.md)
26-
27-
- [CREATE FULLTEXT STOPLIST &#40;Transact-SQL&#41;](../../t-sql/statements/create-fulltext-stoplist-transact-sql.md)
28-
29-
- [CREATE SEARCH PROPERTY LIST &#40;Transact-SQL&#41;](../../t-sql/statements/create-search-property-list-transact-sql.md)
30-
31-
- [ALTER FULLTEXT CATALOG &#40;Transact-SQL&#41;](../../t-sql/statements/alter-fulltext-catalog-transact-sql.md)
32-
33-
- [ALTER FULLTEXT INDEX &#40;Transact-SQL&#41;](../../t-sql/statements/alter-fulltext-index-transact-sql.md)
34-
35-
- [ALTER FULLTEXT STOPLIST &#40;Transact-SQL&#41;](../../t-sql/statements/alter-fulltext-stoplist-transact-sql.md)
36-
37-
- [ALTER SEARCH PROPERTY LIST &#40;Transact-SQL&#41;](../../t-sql/statements/alter-search-property-list-transact-sql.md)
38-
39-
- [DROP FULLTEXT CATALOG &#40;Transact-SQL&#41;](../../t-sql/statements/drop-fulltext-catalog-transact-sql.md)
40-
41-
- [DROP FULLTEXT INDEX &#40;Transact-SQL&#41;](../../t-sql/statements/drop-fulltext-index-transact-sql.md)
42-
43-
- [DROP FULLTEXT STOPLIST &#40;Transact-SQL&#41;](../../t-sql/statements/drop-fulltext-stoplist-transact-sql.md)
44-
45-
- [DROP SEARCH PROPERTY LIST &#40;Transact-SQL&#41;](../../t-sql/statements/drop-search-property-list-transact-sql.md)
46-
47-
## <a name="func"></a> System Predicates and Functions
48-
49-
- [CONTAINS &#40;Transact-SQL&#41;](../../t-sql/queries/contains-transact-sql.md)
50-
51-
- [CONTAINSTABLE &#40;Transact-SQL&#41;](../../relational-databases/system-functions/containstable-transact-sql.md)
52-
53-
- [FREETEXT &#40;Transact-SQL&#41;](../../t-sql/queries/freetext-transact-sql.md)
54-
55-
- [FREETEXTTABLE &#40;Transact-SQL&#41;](../../relational-databases/system-functions/freetexttable-transact-sql.md)
56-
57-
## <a name="meta"></a> System Metadata Functions
58-
59-
- [COLUMNPROPERTY &#40;Transact-SQL&#41;](../../t-sql/functions/columnproperty-transact-sql.md)
60-
61-
- [FULLTEXTCATALOGPROPERTY &#40;Transact-SQL&#41;](../../t-sql/functions/fulltextcatalogproperty-transact-sql.md)
62-
63-
- [FULLTEXTSERVICEPROPERTY &#40;Transact-SQL&#41;](../../t-sql/functions/fulltextserviceproperty-transact-sql.md)
64-
65-
- [INDEXPROPERTY &#40;Transact-SQL&#41;](../../t-sql/functions/indexproperty-transact-sql.md)
66-
67-
- [OBJECTPROPERTY &#40;Transact-SQL&#41;](../../t-sql/functions/objectproperty-transact-sql.md)
68-
69-
- [OBJECTPROPERTYEX &#40;Transact-SQL&#41;](../../t-sql/functions/objectpropertyex-transact-sql.md)
70-
71-
- [SERVERPROPERTY &#40;Transact-SQL&#41;](../../t-sql/functions/serverproperty-transact-sql.md)
72-
73-
## <a name="proc"></a> System Stored Procedures
74-
75-
- [sp_fulltext_keymappings &#40;Transact-SQL&#41;](../../relational-databases/system-stored-procedures/sp-fulltext-keymappings-transact-sql.md)
76-
77-
- [sp_fulltext_load_thesaurus_file &#40;Transact-SQL&#41;](../../relational-databases/system-stored-procedures/sp-fulltext-load-thesaurus-file-transact-sql.md)
78-
79-
- [sp_fulltext_pendingchanges &#40;Transact-SQL&#41;](../../relational-databases/system-stored-procedures/sp-fulltext-pendingchanges-transact-sql.md)
80-
81-
- [sp_fulltext_service &#40;Transact-SQL&#41;](../../relational-databases/system-stored-procedures/sp-fulltext-service-transact-sql.md)
82-
83-
- [sp_help_fulltext_system_components &#40;Transact-SQL&#41;](../../relational-databases/system-stored-procedures/sp-help-fulltext-system-components-transact-sql.md)
84-
85-
## <a name="cat"></a> System Views - Catalog Views
86-
87-
- [sys.fulltext_catalogs &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-catalogs-transact-sql.md)
88-
89-
- [sys.fulltext_document_types &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-document-types-transact-sql.md)
90-
91-
- [sys.fulltext_index_catalog_usages &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-index-catalog-usages-transact-sql.md)
92-
93-
- [sys.fulltext_index_columns &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-index-columns-transact-sql.md)
94-
95-
- [sys.fulltext_index_fragments &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-index-fragments-transact-sql.md)
96-
97-
- [sys.fulltext_indexes &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-indexes-transact-sql.md)
98-
99-
- [sys.fulltext_languages &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-languages-transact-sql.md)
100-
101-
- [sys.fulltext_stoplists &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-stoplists-transact-sql.md)
102-
103-
- [sys.fulltext_stopwords &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-stopwords-transact-sql.md)
104-
105-
- [sys.fulltext_system_stopwords &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-fulltext-system-stopwords-transact-sql.md)
106-
107-
- [sys.registered_search_properties &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-registered-search-properties-transact-sql.md)
108-
109-
- [sys.registered_search_property_lists &#40;Transact-SQL&#41;](../../relational-databases/system-catalog-views/sys-registered-search-property-lists-transact-sql.md)
110-
111-
## <a name="dmv"></a> System Views - Dynamic Management Views
112-
113-
- [sys.dm_fts_active_catalogs &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-active-catalogs-transact-sql.md)
114-
115-
- [sys.dm_fts_fdhosts &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-fdhosts-transact-sql.md)
116-
117-
- [sys.dm_fts_index_keywords &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-index-keywords-transact-sql.md)
118-
119-
- [sys.dm_fts_index_keywords_by_document &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-index-keywords-by-document-transact-sql.md)
120-
121-
- [sys.dm_fts_index_keywords_by_property &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-index-keywords-by-property-transact-sql.md)
122-
123-
- [sys.dm_fts_index_population &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-index-population-transact-sql.md)
124-
125-
- [sys.dm_fts_memory_buffers &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-memory-buffers-transact-sql.md)
126-
127-
- [sys.dm_fts_memory_pools &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-memory-pools-transact-sql.md)
128-
129-
- [sys.dm_fts_outstanding_batches &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-outstanding-batches-transact-sql.md)
130-
131-
- [sys.dm_fts_parser &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-parser-transact-sql.md)
132-
133-
- [sys.dm_fts_population_ranges &#40;Transact-SQL&#41;](../../relational-databases/system-dynamic-management-views/sys-dm-fts-population-ranges-transact-sql.md)
134-
135-
16+
17+
Lists the Transact-SQL statements and the [!INCLUDE [ssNoVersion](../../includes/ssnoversion-md.md)] database objects that support full-text search, including the property search feature.
18+
19+
This list doesn't include deprecated objects.
20+
21+
For the list of database objects that support semantic search, see [Semantic Search DDL, Functions, Stored Procedures, and Views](semantic-search-ddl-functions-stored-procedures-and-views.md).
22+
23+
<a id="ddl"></a>
24+
25+
## Transact-SQL Data Definition Language (DDL) statements
26+
27+
Use these statements to define, modify, and remove full-text search components such as catalogs, indexes, stoplists, and property lists. Typically, you use these statements when preparing a database or table for full-text search or when updating its configuration.
28+
29+
| Component | Create | Alter | Drop |
30+
| --- | --- | --- | --- |
31+
| **Full-text catalog**: Define a logical container for full-text indexes. | [CREATE](../../t-sql/statements/create-fulltext-catalog-transact-sql.md) | [ALTER](../../t-sql/statements/alter-fulltext-catalog-transact-sql.md) | [DROP](../../t-sql/statements/drop-fulltext-catalog-transact-sql.md) |
32+
| **Full-text index**: Define on a table column to enable full-text querying. | [CREATE](../../t-sql/statements/create-fulltext-index-transact-sql.md) | [ALTER](../../t-sql/statements/alter-fulltext-index-transact-sql.md) | [DROP](../../t-sql/statements/drop-fulltext-index-transact-sql.md) |
33+
| **Full-text stoplist**: Define a list of words to be ignored during full-text indexing. | [CREATE](../../t-sql/statements/create-fulltext-stoplist-transact-sql.md) | [ALTER](../../t-sql/statements/alter-fulltext-stoplist-transact-sql.md) | [DROP](../../t-sql/statements/drop-fulltext-stoplist-transact-sql.md) |
34+
| **Search property list**: Defines a mapping of document property names to MIME types for use in property search. | [CREATE](../../t-sql/statements/create-search-property-list-transact-sql.md) | [ALTER](../../t-sql/statements/alter-search-property-list-transact-sql.md) | [DROP](../../t-sql/statements/drop-search-property-list-transact-sql.md) |
35+
36+
<a id="func"></a>
37+
38+
## System predicates and functions
39+
40+
Full-text search extends Transact-SQL with predicates and table-valued functions that you can use to perform sophisticated text matching in queries.
41+
42+
| Object | Description |
43+
| --- | --- |
44+
| [CONTAINS](../../t-sql/queries/contains-transact-sql.md) | Predicate that tests whether specified text values meet full-text criteria (for example, words or phrases). |
45+
| [CONTAINSTABLE](../system-functions/containstable-transact-sql.md) | Table-valued function returning key values and rank of qualifying rows for a full-text query. |
46+
| [FREETEXT](../../t-sql/queries/freetext-transact-sql.md) | Predicate that matches text values against a natural-language search phrase. |
47+
| [FREETEXTTABLE](../system-functions/freetexttable-transact-sql.md) | Table-valued function similar to `FREETEXT`, returning ranking information. |
48+
49+
<a id="meta"></a>
50+
51+
## System metadata functions
52+
53+
These functions return metadata values related to full-text search or object properties. They're also used more broadly throughout SQL Server metadata queries.
54+
55+
| Object | Description |
56+
| --- | --- |
57+
| [COLUMNPROPERTY](../../t-sql/functions/columnproperty-transact-sql.md) | Returns information about a column's properties (for example, whether it is computed). |
58+
| [FULLTEXTCATALOGPROPERTY](../../t-sql/functions/fulltextcatalogproperty-transact-sql.md) | Returns property values for a full-text catalog. |
59+
| [FULLTEXTSERVICEPROPERTY](../../t-sql/functions/fulltextserviceproperty-transact-sql.md) | Returns values for full-text service configuration. |
60+
| [INDEXPROPERTY](../../t-sql/functions/indexproperty-transact-sql.md) | Returns information about an index. |
61+
| [OBJECTPROPERTY](../../t-sql/functions/objectproperty-transact-sql.md) | Returns information about database objects. |
62+
| [OBJECTPROPERTYEX](../../t-sql/functions/objectpropertyex-transact-sql.md) | Similar to `OBJECTPROPERTY` with extended property types. |
63+
| [SERVERPROPERTY](../../t-sql/functions/serverproperty-transact-sql.md) | Returns information about the SQL Server instance. |
64+
65+
<a id="proc"></a>
66+
67+
## System stored procedures
68+
69+
These stored procedures support management and diagnostic operations for full-text search subsystems.
70+
71+
| Object | Description |
72+
| --- | --- |
73+
| [sp_fulltext_keymappings](../system-stored-procedures/sp-fulltext-keymappings-transact-sql.md) | Reports mappings between full-text keys and index entries. This information is useful for understanding how key values relate to full-text indexes. |
74+
| [sp_fulltext_load_thesaurus_file](../system-stored-procedures/sp-fulltext-load-thesaurus-file-transact-sql.md) | Loads a thesaurus file for full-text search. Thesaurus files provide synonyms and expansions. |
75+
| [sp_fulltext_pendingchanges](../system-stored-procedures/sp-fulltext-pendingchanges-transact-sql.md) | Returns size or estimated status of pending full-text index changes. |
76+
| [sp_fulltext_service](../system-stored-procedures/sp-fulltext-service-transact-sql.md) | Provides administrative control over the full-text search service settings. |
77+
| [sp_help_fulltext_system_components](../system-stored-procedures/sp-help-fulltext-system-components-transact-sql.md) | Lists full-text search system components and their status. |
78+
79+
<a id="cat"></a>
80+
81+
## System catalog views
82+
83+
These views expose full-text search metadata defined in the database schema.
84+
85+
| Object | Description |
86+
| --- | --- |
87+
| [sys.fulltext_catalogs](../system-catalog-views/sys-fulltext-catalogs-transact-sql.md) | Lists full-text catalogs defined in the database. |
88+
| [sys.fulltext_document_types](../system-catalog-views/sys-fulltext-document-types-transact-sql.md) | Shows document types registered for full-text indexing. |
89+
| [sys.fulltext_index_catalog_usages](../system-catalog-views/sys-fulltext-index-catalog-usages-transact-sql.md) | Shows associations between full-text indexes and catalogs. |
90+
| [sys.fulltext_index_columns](../system-catalog-views/sys-fulltext-index-columns-transact-sql.md) | Lists the columns participating in full-text indexes. |
91+
| [sys.fulltext_index_fragments](../system-catalog-views/sys-fulltext-index-fragments-transact-sql.md) | Provides fragmentation metadata for full-text indexes. |
92+
| [sys.fulltext_indexes](../system-catalog-views/sys-fulltext-indexes-transact-sql.md) | Lists tables that have a full-text index and key index information. |
93+
| [sys.fulltext_languages](../system-catalog-views/sys-fulltext-languages-transact-sql.md) | Lists languages supported for full-text indexing. |
94+
| [sys.fulltext_stoplists](../system-catalog-views/sys-fulltext-stoplists-transact-sql.md) | Lists stoplists available in the database. |
95+
| [sys.fulltext_stopwords](../system-catalog-views/sys-fulltext-stopwords-transact-sql.md) | Lists stopwords defined in custom stoplists. |
96+
| [sys.fulltext_system_stopwords](../system-catalog-views/sys-fulltext-system-stopwords-transact-sql.md) | Lists system stopwords built into SQL Server. |
97+
| [sys.registered_search_properties](../system-catalog-views/sys-registered-search-properties-transact-sql.md) | Lists search properties registered for property search. |
98+
| [sys.registered_search_property_lists](../system-catalog-views/sys-registered-search-property-lists-transact-sql.md) | Lists property lists used by property search. |
99+
100+
<a id="dmv"></a>
101+
102+
## System dynamic management views
103+
104+
These DMVs provide real-time monitoring and internal status information related to full-text indexing and population.
105+
106+
| Object | Description |
107+
| --- | --- |
108+
| [sys.dm_fts_active_catalogs](../system-dynamic-management-views/sys-dm-fts-active-catalogs-transact-sql.md) | Shows full-text catalogs currently active. |
109+
| [sys.dm_fts_fdhosts](../system-dynamic-management-views/sys-dm-fts-fdhosts-transact-sql.md) | Details host processes supporting full-text indexing. |
110+
| [sys.dm_fts_index_keywords](../system-dynamic-management-views/sys-dm-fts-index-keywords-transact-sql.md) | Lists keywords stored in full-text indexes. |
111+
| [sys.dm_fts_index_keywords_by_document](../system-dynamic-management-views/sys-dm-fts-index-keywords-by-document-transact-sql.md) | Keywords mapped by document. |
112+
| [sys.dm_fts_index_keywords_by_property](../system-dynamic-management-views/sys-dm-fts-index-keywords-by-property-transact-sql.md) | Keywords mapped by registered property. |
113+
| [sys.dm_fts_index_population](../system-dynamic-management-views/sys-dm-fts-index-population-transact-sql.md) | Tracks population status of full-text indexes. |
114+
| [sys.dm_fts_memory_buffers](../system-dynamic-management-views/sys-dm-fts-memory-buffers-transact-sql.md) | Shows memory buffer usage for full-text indexing. |
115+
| [sys.dm_fts_memory_pools](../system-dynamic-management-views/sys-dm-fts-memory-pools-transact-sql.md) | Provides memory pool statistics for full-text search. |
116+
| [sys.dm_fts_outstanding_batches](../system-dynamic-management-views/sys-dm-fts-outstanding-batches-transact-sql.md) | Reports outstanding index update batches. |
117+
| [sys.dm_fts_parser](../system-dynamic-management-views/sys-dm-fts-parser-transact-sql.md) | Examines how text is parsed into tokens for full-text indexing. |
118+
| [sys.dm_fts_population_ranges](../../relational-databases/system-dynamic-management-views/sys-dm-fts-population-ranges-transact-sql.md) | Shows ranges of data being processed during index population. |

0 commit comments

Comments
 (0)