FULLTEXTCATALOGPROPERTY (Transact-SQL)FULLTEXTCATALOGPROPERTY (Transact-SQL)

ОБЛАСТЬ ПРИМЕНЕНИЯ: даSQL Server даБаза данных SQL Azure нетAzure Synapse Analytics (хранилище данных SQL) нетParallel Data WarehouseAPPLIES TO: yesSQL Server yesAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

Возвращает сведения о свойствах полнотекстовых каталогов в SQL Server 2019 (15.x)SQL Server 2019 (15.x).Returns information about full-text catalog properties in SQL Server 2019 (15.x)SQL Server 2019 (15.x).

Значок ссылки на раздел Синтаксические обозначения в Transact-SQLTopic link icon Transact-SQL Syntax Conventions

СинтаксисSyntax

  
FULLTEXTCATALOGPROPERTY ('catalog_name' ,'property')  

АргументыArguments

Примечание

Следующие свойства будут удалены в будущей версии SQL ServerSQL Server: LogSize и PopulateStatus.The following properties will be removed in a future release of SQL ServerSQL Server: LogSize and PopulateStatus. Избегайте использовать эти свойства в новых разработках и запланируйте изменение приложений, где они используются в настоящий момент.Avoid using these properties in new development work, and plan to modify applications that currently use any of them.

catalog_namecatalog_name
Выражение, содержащее имя полнотекстового каталога.Is an expression containing the name of the full-text catalog.

propertyproperty
Выражение, содержащее имя свойства полнотекстового каталога.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 DescriptionDescription
AccentSensitivityAccentSensitivity Настройка учета диакритических знаков:Accent-sensitivity setting.

0 = без учета диакритических знаков;0 = Accent insensitive

1 = с учетом диакритических знаков.1 = Accent sensitive
IndexSizeIndexSize Логический размер полнотекстового каталога в мегабайтах (МБ).Logical size of the full-text catalog in megabytes (MB). Включает размер индексов семантических ключевых фраз и индексов подобия документов.Includes the size of semantic key phrase and document similarity indexes.

Дополнительные сведения см. в подразделе «Примечания» далее в этом разделе.For more information, see "Remarks," later in this topic.
ItemCountItemCount Число проиндексированных элементов, включая все полнотекстовые индексы, индексы ключевых фраз и индексы сходства документов, содержащихся в каталогеNumber of indexed items including all full-text, keyphrase, and document similarity indexes in a catalog
LogSizeLogSize Поддерживается только для обеспечения обратной совместимости.Supported for backward compatibility only. Всегда возвращает 0.Always returns 0.

Размер в байтах связанного набора журналов ошибок, связанных с полнотекстовым каталогом MicrosoftMicrosoft Search Service.Size, in bytes, of the combined set of error logs associated with a MicrosoftMicrosoft Search Service full-text catalog.
MergeStatusMergeStatus Указывает, выполняется ли слияние в единый файл.Indicates whether a master merge is in progress.

0 = слияние в единый файл не выполняется.0 = master merge isn't in progress

1 = слияние в единый файл выполняется.1 = master merge is in progress
PopulateCompletionAgePopulateCompletionAge Разница в секундах между завершением последнего заполнения полнотекстового индекса и 01/01/1990 00:00:00.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. Возвращает значение 0, если заполнение не выполнялось.Returns 0 if no population has occurred.
PopulateStatusPopulateStatus 0 = бездействие0 = Idle

1 = идет полное заполнение1 = Full population in progress

2 = пауза2 = Paused

3 = ограниченный режим3 = Throttled

4 = восстановление4 = Recovering

5 = выключение5 = Shutdown

6 = идет добавочное заполнение6 = Incremental population in progress

7 = построение индекса7 = Building index

8 = диск заполнен.8 = Disk is full. приостановленоPaused.

9 = отслеживание изменений.9 = Change tracking
UniqueKeyCountUniqueKeyCount Количество уникальных ключей в полнотекстовом каталоге.Number of unique keys in the full-text catalog.
ImportStatusImportStatus Указывает, выполняется ли в настоящее время импорт полнотекстового каталога.Indicates whether the full-text catalog is being imported.

0 = импорт полнотекстового каталога не выполняется.0 = The full-text catalog isn't being imported.

1 = выполняется импорт полнотекстового каталога.1 = The full-text catalog is being imported.

Типы возвращаемых данныхReturn Types

intint

ИсключенияExceptions

Возвращает значение NULL в случае ошибки или если вызывающий объект не имеет разрешений для просмотра текущего объекта.Returns NULL on error or if a caller doesn't have permission to view the object.

В SQL Server 2019 (15.x)SQL Server 2019 (15.x) пользователь может просматривать только метаданные защищаемых объектов.In SQL Server 2019 (15.x)SQL Server 2019 (15.x), a user can only view the metadata of securables. Пользователь владеет этими защищаемыми объектами или на них пользователю были предоставлены разрешения.These securables are ones that the user owns or on which the user has been granted permission. Таким образом, встроенные функции, такие как FULLTEXTCATALOGPROPERTY, создающие метаданные, могут вернуть значение NULL, если пользователь не имеет разрешений на объект.As such, built-in functions that emit metadata, such as FULLTEXTCATALOGPROPERTY, may return NULL if the user doesn't have any permission on the object. Дополнительные сведения см. в статье sp_help_fulltext_catalogs (Transact-SQL).For more information, see sp_help_fulltext_catalogs (Transact-SQL).

RemarksRemarks

Функция FULLTEXTCATALOGPROPERTY (catalog_name, IndexSize) анализирует только фрагменты с состоянием 4 или 6, указанным в представлении sys.fulltext_index_fragments.FULLTEXTCATALOGPROPERTY ('catalog_name','IndexSize') looks at only fragments with status 4 or 6 as shown in sys.fulltext_index_fragments. Данные фрагменты являются частью логического индекса.These fragments are part of the logical index. Таким образом, свойство IndexSize возвращает только логический размер индекса.As such, the IndexSize property returns only the logical index size.

При слиянии индексов фактический размер индекса может в два раза превышать его логический размер.During an index merge, however, the actual index size might be double its logical size. Чтобы определить фактический размер, который занимает полнотекстовый индекс при слиянии, используйте системную хранимую процедуру sp_spaceused.To find the actual size that is being consumed by a full-text index during a merge, use the sp_spaceused system stored procedure. При выполнении этой процедуры анализируются все фрагменты, связанные с полнотекстовым индексом.That procedure looks at all fragments associated with a full-text index.

Заполнение полнотекстового индекса может завершиться ошибкой.The full-text population may fail. Это может произойти, если ограничить рост файла полнотекстового каталога и не оставить достаточно места для процесса слияния.It may fail if you restrict the growth of the full-text catalog file and don't allow enough space for the merge process. В этом случае инструкция FULLTEXTCATALOGPROPERTY (catalog_name, IndexSize) возвращает значение 0, а сообщение об ошибке записывается в журнал полнотекстовых операций.In this case, FULLTEXTCATALOGPROPERTY ('catalog_name','IndexSize') returns 0 and the following error is written to the full-text log:

Error: 30059, Severity: 16, State: 1. A fatal error occurred during a full-text population and caused the population to be cancelled. Population type is: FULL; database name is FTS_Test (id: 13); catalog name is t1_cat (id: 5); table name t1 (id: 2105058535). Fix the errors that are logged in the full-text crawl log. Then, resume the population. The basic Transact-SQL syntax for this is: ALTER FULLTEXT INDEX ON table_name RESUME POPULATION.

Важно, чтобы приложение не ожидало в непрерывном цикле, проверяя, пока свойство PopulateStatus не будет в состоянии бездействия.It's important that applications don't wait in a tight loop, checking for the PopulateStatus property to become idle. Переход в состояние бездействия означает, что заполнение завершено.Becoming idle indicates that population has completed. Эта проверка отвлекает ресурсы ЦП от обработки базы данных и процессов полнотекстового поиска и приводит к превышениям времени ожидания.This check takes CPU cycles away from the database and full-text search processes, and causes timeouts. Обычно лучший параметр для проверки соответствующего свойства PopulateStatus на уровне таблицы — свойство TableFullTextPopulateStatus в системной функции OBJECTPROPERTYEX.It's usually a better option to check the corresponding PopulateStatus property at the table level, TableFullTextPopulateStatus in the OBJECTPROPERTYEX system function. Это и другие полнотекстовые свойства в функции OBJECTPROPERTYEX предоставляют более подробные сведения о таблицах с полнотекстовым индексированием.This and other new full-text properties in OBJECTPROPERTYEX provide more granular information about full-text indexing tables. Дополнительные сведения см. в разделе OBJECTPROPERTYEX (Transact-SQL).For more information, see OBJECTPROPERTYEX (Transact-SQL).

ПримерыExamples

Следующий пример возвращает количество полнотекстовых индексированных элементов в полнотекстовом каталоге Cat_Desc.The following example returns the number of full-text indexed items in a full-text catalog named Cat_Desc.

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

См. также:See Also

FULLTEXTSERVICEPROPERTY (Transact-SQL) FULLTEXTSERVICEPROPERTY (Transact-SQL)
Функции метаданных (Transact-SQL) Metadata Functions (Transact-SQL)
sp_help_fulltext_catalogs (Transact-SQL)sp_help_fulltext_catalogs (Transact-SQL)