CodeIndex コマンドCodeIndex Command

CodeIndex コマンドを使用して、Team Foundation Server でコード インデックス作成を管理します。Use the CodeIndex command to manage code indexing on Team Foundation Server. たとえば、インデックスをリセットして CodeLens 情報を修正したり、コード インデックス作成をオフにしてサーバー パフォーマンスの問題を調査したりします。For example, you might want to reset the index to fix CodeLens information, or turn off indexing to investigate server performance issues.

必要なアクセス許可Required Permissions

CodeIndex コマンドを使用するには、Team Foundation 管理者セキュリティ グループのメンバーである必要があります。To use the CodeIndex command, you must be a member of the Team Foundation Administrators security group. Permissions and groups defined for Team Services and TFS」 (チーム サービスと TFS に定義されているアクセス許可とグループ) を参照してください。See Permissions and groups defined for Team Services and TFS.

注意

管理資格情報を使ってログオンしている場合でも、このコマンドを実行するには、昇格した特権でコマンド プロンプト ウィンドウを開く必要があります。Even if you log on with administrative credentials, you must open an elevated Command Prompt window to run this command. また、Team Foundation のアプリケーション層からこのコマンドを実行する必要があります。You must also run this command from the application tier for Team Foundation.

構文Syntax

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]  

パラメーターParameters

引数Argument 説明Description
CollectionName チーム プロジェクト コレクションの名前を指定します。Specifies the name of the team project collection. 名前に空白が含まれる場合は、"Fabrikam Web Site" のように引用符で囲みます。If the name has spaces, enclose the name with quotation marks, for example, "Fabrikam Web Site".
CollectionId チーム プロジェクト コレクションの ID 番号を指定します。Specifies the identification number of the team project collection.
ServerPath コード ファイルのパスを指定します。Specifies the path to a code file.
オプションOption 説明Description
/indexingStatus/indexingStatus コード インデックス作成サービスの状態と構成を表示します。Show the status and configuration of the code indexing service.
/setIndexing:[ on | off | keepupOnly ]/setIndexing:[ on | off | keepupOnly ] - on: すべての変更セットのインデックス作成を開始します。- on: Start indexing all changesets.
- off: すべての変更セットのインデックス作成を停止します。- off: Stop indexing all changesets.
- keepupOnly: 以前に作成された変更セットのインデックス作成を停止し、新しい変更セットのインデックス作成のみを開始します。- keepupOnly: Stop indexing previously created changesets and start indexing new changesets only.
/ignoreList:[ add | remove | removeAll | view ] ServerPath/ignoreList:[ add | remove | removeAll | view ] ServerPath

ワイルドカード文字 () を、サーバー パスの先頭、末尾、または両端に使用できます。You can use the wildcard character () at the start, end, or both ends of the server path.
インデックスを作成しないコード ファイルとそのパスの一覧を指定します。Specifies a list of code files and their paths that you don't want indexed.

- add: インデックスを作成しないファイルを無視ファイル リストに追加します。- add: Add the file that you don't want indexed to the ignored file list.
- remove: インデックスを作成するファイルを無視ファイル リストから削除します。- remove: Remove the file that you want indexed from the ignored file list.
- removeAll: 無視ファイル リストをクリアし、すべてのファイルのインデックス作成を開始します。- removeAll: Clear the ignored file list and start indexing all files.
- view: インデックスを作成しないすべてのファイルを表示します。- view: See all the files that aren't being indexed.
/listLargeFiles [/fileCount: FileCount /minSize: MinSize]/listLargeFiles [/fileCount: FileCount /minSize: MinSize] KB 単位で指定されたサイズを超えるファイルを指定された数だけ表示します。Shows the specified number of files that exceeds the specified size in KB. その後で、/ignoreList オプションを使用して、これらのファイルをインデックス作成から除外することができます。You can then use the /ignoreList option to exclude these files from indexing.
/reindexAll/reindexAll 以前にインデックスを作成したデータをクリアし、インデックス作成を再び開始します。Clear previously indexed data and restart indexing.
/destroyCodeIndex [/noPrompt]/destroyCodeIndex [/noPrompt] コード インデックスを削除し、すべてのインデックス データを削除します。Delete the code index and remove all indexed data. /noPrompt のオプションを使用する場合は、確認を要求されません。Does not require confirmation if you use the /noPrompt option.
/temporaryDataSizeLimit:[ view | <SizeInGBs> | disable ]/temporaryDataSizeLimit:[ view | <SizeInGBs> | disable ] 変更セットを処理するときに CodeLens が作成する一時データの量を制御します。Control how much temporary data that CodeLens creates when processing changesets. 制限の既定値は 2 GB です。The default limit is 2 GB.

- view: 現在のサイズ制限を表示します。- view: Show the current size limit.
- SizeInGBs: サイズの制限を変更します。- SizeInGBs: Change the size limit.
- disable: サイズの制限を削除します。- disable: Remove the size limit.

CodeLens が新しい変更セットを処理する前に、この制限の検査が行われます。This limit is checked before CodeLens processes a new changeset. 一時データがこの制限を超える場合、CodeLens は過去の変更セット (新しい変更セットではない) の処理を一時停止します。If temporary data exceeds this limit, CodeLens will pause processing past changesets, not new ones. データがクリーンアップされ、この制限内に収まると、CodeLens は処理を再開します。CodeLens will restart processing after the data is cleaned up and falls below this limit. クリーンアップは 1 日に 1 度、自動的に行われます。Cleanup runs automatically once a day. このことは、クリーンアップの実行が始まるまでは、一時データがこの制限を超えている可能性があることを意味します。This means temporary data might exceed this limit until cleanup starts running.
/indexHistoryPeriod:[ view | all | <NumberOfMonths> ]/indexHistoryPeriod:[ view | all | <NumberOfMonths> ] 変更履歴のインデックスを作成する期間を制御します。Control how long to index your change history. これは、CodeLens の履歴の表示量に影響します。This affects how much history CodeLens shows you. 制限の既定値は 12 か月です。The default limit is 12 months. つまり、CodeLens が過去 12 か月間の変更履歴のみを表示するという意味です。This means CodeLens shows your change history from the last 12 months only.

- view: 現在の月数を表示します。- view: Show the current number of months.
- all: すべての変更履歴のインデックスを作成します。- all: Index all change history.
- NumberOfMonths: 変更履歴のインデックスの作成に使用する月数を変更します。- NumberOfMonths: Change the number of months used to index change history.
/collectionName: CollectionName/collectionName: CollectionName CodeIndex コマンドを実行する対象のチーム プロジェクト コレクションの名前を指定します。Specifies the name of the team project collection on which to run the CodeIndex command. /CollectionId を使用しない場合は必ず指定します。Required if you don't use /CollectionId.
/collectionId: CollectionId/collectionId: CollectionId CodeIndex コマンドを実行する対象のチーム プロジェクト コレクションの ID 番号を指定します。Specifies the identification number of the team project collection on which to run the CodeIndex command. /CollectionName を使用しない場合は必ず指定します。Required if you don't use /CollectionName.

Examples

注意

例として登場する企業、組織、製品、ドメイン名、電子メール アドレス、ロゴ、人物、場所、およびイベントはすべて架空のものです。The example companies, organizations, products, domain names, email addresses, logos, people, places, and events depicted herein are fictitious. 実在する会社、組織、製品、ドメイン名、電子メールアドレス、ロゴ、人物、場所、イベントなどとは一切関係ありません。No association with any real company, organization, product, domain name, email address, logo, person, places, or events is intended or should be inferred.

コード インデックス作成の状態と構成を表示するには:To see the code indexing status and configuration:

TFSConfig CodeIndex /indexingStatus /collectionName:"Fabrikam Web Site"  

すべての変更セットのインデックス作成を開始するには:To start indexing all changesets:

TFSConfig CodeIndex /setIndexing:on /collectionName:"Fabrikam Web Site"  

以前に作成された変更セットのインデックス作成を停止し、新しい変更セットのインデックス作成のみを開始するには:To stop indexing previously created changesets and start indexing new changesets only:

TFSConfig CodeIndex /setIndexing:keepupOnly /collectionName:"Fabrikam Web Site"  

10 KB を超えるファイルを最大 50 個検索するには:To find up to 50 files that are larger than 10 KB:

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

特定のファイルをインデックス作成から除外し、無視ファイル リストに追加するには:To exclude a specific file from indexing and add it to the ignored file list:

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

インデックスを作成しないすべてのファイルを表示するには:To see all the files that aren't indexed:

TFSConfig CodeIndex /ignoreList:view  

以前にインデックスを作成したデータをクリアし、インデックス作成を再び開始するには:To clear previously indexed data and restart indexing:

TFSConfig CodeIndex /reindexAll /collectionName:"Fabrikam Web Site"  

すべての変更履歴を保存するには:To save all changeset history:

TFSConfig CodeIndex /indexHistoryPeriod:all /collectionName:"Fabrikam Web Site"  

CodeLens 一時データのサイズ制限を取り払い、一時データのサイズに関係なくインデックス作成を続けるには:To remove the size limit on CodeLens temporary data and continue indexing regardless of temporary data size:

TFSConfig CodeIndex /temporaryDataSizeLimit:disable /collectionName:"Fabrikam Web Site"  

確認後にコード インデックスを削除するには:To delete the code index with confirmation:

TFSConfig CodeIndex /destroyCodeIndex /collectionName:"Fabrikam Web Site"  

関連項目See Also

CodeLens によるコード変更とその他の履歴の検索Find code changes and other history with CodeLens

TFSConfig でのサーバー構成の管理 Managing server configuration with TFSConfig
TFS のコマンド ライン ツールCommand-line tools for TFS