Поделиться через


Команда CodeIndex

Команда CodeIndex используется для управления индексацией кода на сервере Team Foundation Server. Например, может потребоваться сбросить индекс, чтобы исправить данные CodeLens, или отключить индексацию, чтобы разобраться с проблемами производительности сервера.

Необходимые разрешения

Для использования команды CodeIndex необходимо являться членом группы безопасности Администраторы Team Foundation. См. статью Разрешения и группы, определенные для Azure DevOps Services и TFS.

Примечание.

Для выполнения этой команды необходимо открыть окно командной строки с повышенными привилегиями, даже если вы вошли в систему, используя учетные данные администратора. Также эту команду необходимо выполнять для Team Foundation с уровня приложения.

Синтаксис

TFSConfig CodeIndex /indexingStatus | /setIndexing:[ on | off | keepupOnly ] | /ignoreList:[ add | remove | removeAll | view ] ServerPath | /listLargeFiles [/fileCount:FileCount] [/minSize:MinSize] | /reindexAll | /destroyCodeIndex [/noPrompt] | /temporaryDataSizeLimit:[ view | <SizeInGBs> | disable ] | /indexHistoryPeriod:[ view | all | <NumberOfMonths> ] [/collectionName:CollectionName | /collectionId:CollectionId]

Параметры

Argument Description
CollectionName Задает имя коллекции проектов. Если имя содержит пробелы, заключите его в кавычки, например "веб-сайт компании Fabrikam".
CollectionId Задает идентификационный номер коллекции проектов.
ServerPath Задает путь к файлу с кодом.
Параметр Description
/indexingStatus Отображает состояние и конфигурацию службы индексации кода.
/setIndexing:[ on | off | keepupOnly ] - on: запустить индексацию всех наборов изменений.
- off: остановить индексацию всех наборов изменений.
- keepupOnly: остановить индексацию созданных ранее наборов изменений и запустить индексацию только новых наборов изменений.
/ignoreList:[ add | remove | removeAll | view ] ServerPath

Можно использовать подстановочный знак (*) в начале, в конце, или на обоих концах серверного пути.
Определяет список файлов исходного кода и путей к ним, которые необходимо исключить из индексирования.

- add: добавить файл, который необходимо исключить из индексации, в список игнорируемых файлов.
- remove: удалить файл, который необходимо включить в индексацию, из списка игнорируемых файлов.
- removeAll: очистить список игнорируемых файлов и начать индексировать все файлы.
- view: просмотреть полный список файлов, которые не будут индексироваться.
/listLargeFiles [/fileCount: FileCount /minSize: MinSize] Просмотреть определенное количество файлов, размер которых превышает заданный размер в кБ. Можно воспользоваться параметром /ignoreList, чтобы исключить эти файлы из индексации.
/reindexAll Очистить ранее индексированные данные и перезапустить индексирование.
/destroyCodeIndex [/noPrompt] Удалить индекс кода и все индексированные данные. Не требует подтверждения, если используется параметр /noPrompt.
/temporaryDataSizeLimit:[ view | <SizeInGBs> | disable ] Управляйте количеством временных данных, которые создает CodeLens при обработке наборов изменений. Ограничение по умолчанию составляет 2 ГБ.

- view: отображение текущего ограничения на размер.
- SizeInGBs: изменение ограничения на размер.
- disable: удаление ограничения на размер.

Проверка этого ограничения выполняется перед тем, как CodeLens обрабатывает новый набор изменений. Если временные данные превышают данное ограничение, то CodeLens приостановит обработку ранних наборов изменений, но не новых. После того как данные будут очищены и их размер станет меньше указанного ограничения, элемент CodeLens перезапустит процесс обработки. Очистка выполняется автоматически раз в день. Это означает, что временные данные могут превысить ограничение перед выполнением очистки.
/indexHistoryPeriod:[ view | all | <NumberOfMonths> ] Управляйте длительностью индексирования журнала изменений. Это влияет на объем отображаемого журнала CodeLens. Ограничение по умолчанию составляет 12 месяцев. Это означает, что CodeLens показывает журнал изменений только за последние 12 месяцев.

- view: отображение текущего количества месяцев.
- all: индексирование всего журнала изменений.
- NumberOfMonths: изменение количества месяцев, используемых для индексирования журнала изменений.
/collectionName: CollectionName Задает имя коллекции проектов, для которой необходимо выполнить команду CodeIndex. Является обязательным, если не используется параметр /CollectionId.
/collectionId: CollectionId Задает идентификационный номер коллекции проектов, для которой необходимо выполнить команду CodeIndex. Является обязательным, если не используется параметр /CollectionName.

Примеры

Примечание.

Использованные в примерах компании, организации, продукты, доменные имена, адреса электронной почты, логотипы, имена людей, географические названия и события являются вымышленными. Любые совпадения с реальными именами и названиями случайны.

Просмотр состояния и конфигурации индексации кода:

TFSConfig CodeIndex /indexingStatus /collectionName:"Fabrikam Website"

Запуск индексации всех наборов изменений:

TFSConfig CodeIndex /setIndexing:on /collectionName:"Fabrikam Website"

Остановка индексации созданных ранее наборов изменений и запуск индексации только новых наборов изменений:

TFSConfig CodeIndex /setIndexing:keepupOnly /collectionName:"Fabrikam Website"

Чтобы найти до 50 файлов с размером, превышающим 10 кБ:

TFSConfig CodeIndex /listLargeFiles /fileCount:50 /minSize:10 /collectionName:"Fabrikam Website"

Исключение определенного файла из индексации и добавление его в список игнорируемых файлов:

TFSConfig CodeIndex /ignoreList:add "$/Fabrikam Website/Catalog.cs" /collectionName:"Fabrikam Website"

Чтобы просмотреть полный список файлов, которые не будут индексироваться:

TFSConfig CodeIndex /ignoreList:view

Очистка индексированных данных и перезапуск индексации:

TFSConfig CodeIndex /reindexAll /collectionName:"Fabrikam Website"

Чтобы сохранить весь журнал набора изменений:

TFSConfig CodeIndex /indexHistoryPeriod:all /collectionName:"Fabrikam Website"

Чтобы удалить ограничение размера для временных данных элемента CodeLens и продолжения индексации независимо от размера временных данных:

TFSConfig CodeIndex /temporaryDataSizeLimit:disable /collectionName:"Fabrikam Website"

Удаление индекса кода с подтверждением:

TFSConfig CodeIndex /destroyCodeIndex /collectionName:"Fabrikam Website"

См. также