使用 CodeIndex 命令管理 Team Foundation Server 中的代码索引。 例如，你可能希望重置该索引以修复 CodeLens 信息，或关闭索引以调查服务器性能问题。
所需的权限
若要使用 CodeIndex 命令，必须是“Team Foundation Administrators”安全组的成员。 请参阅为 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 | 说明 |
|---|---|
CollectionName |
指定项目集合的名称。 如果名称包含空格，则用引号将该名称引起来，例如“Fabrikam 网站”。 |
CollectionId |
指定项目集合的标识号。 |
ServerPath |
指定代码文件的路径。 |
| 选项 | 说明 |
|---|---|
| /indexingStatus | 显示代码索引服务的状态和配置。 |
| /setIndexing:[ on | off | keepupOnly ] | - on：开始为所有变更集创建索引。 - off：停止为所有变更集创建索引。 - keepupOnly：停止为之前创建的变更集创建索引，开始仅为新的变更集创建索引。 |
/ignoreList:[ add | remove | removeAll | view ] ServerPath可以在服务器路径的开头、末尾或两端使用通配符 (*)。 |
指定你不希望编制索引的代码文件的列表及其路径。 - add：将不希望编制索引的文件添加到已忽略文件列表。 - remove：从已忽略文件列表中移除希望编制索引的文件。 - removeAll：清理忽略的文件列表，并开始为所有文件创建索引。 - view：查看所有不要编制索引的文件。 |
/listLargeFiles [/fileCount: FileCount /minSize: MinSize] |
显示超出指定大小（以 KB 为单位）的文件的指定数量。 然后可使用 /ignoreList 选项从编制索引中排除这些文件。 |
| /reindexAll | 清理以前的索引数据并重新开始创建索引。 |
| /destroyCodeIndex [/noPrompt] | 删除代码索引并移除所有索引的数据。 如果使用 /noPrompt 选项，则无需确认。 |
/temporaryDataSizeLimit:[ view | <SizeInGBs> | disable ] |
控制处理变更集时 CodeLens 创建的临时数据量。 默认限制为 2 GB。 - 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 KB 的文件：
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"
另请参阅
- 使用 CodeLens 查找代码更改和其他历史记录
- Managing server configuration with TFSConfig（使用 TFSConfig 管理服务器配置）