CodeIndex, commandeCodeIndex command

Utilisez la commande CodeIndex pour gérer l’indexation de code dans Team Foundation Server.Use the CodeIndex command to manage code indexing on Team Foundation Server. Par exemple, vous pouvez réinitialiser l'index pour corriger des informations CodeLens ou pour désactiver l'indexation afin d'analyser les problèmes de performances du serveur.For example, you might want to reset the index to fix CodeLens information, or turn off indexing to investigate server performance issues.

Autorisations requisesRequired permissions

Pour utiliser la commande CodeIndex, vous devez être membre du groupe de sécurité Team Foundation Administrators.To use the CodeIndex command, you must be a member of the Team Foundation Administrators security group. Consultez Autorisations et groupes définis pour Team Services et TFS.See Permissions and groups defined for Team Services and TFS.

Note

Même si vous vous connectez en tant qu'administrateur, vous devez ouvrir une fenêtre d'invite de commandes avec élévation de privilèges pour exécuter cette commande.Even if you log on with administrative credentials, you must open an elevated Command Prompt window to run this command. Vous devez également exécuter cette commande depuis la couche Application pour Team Foundation.You must also run this command from the application tier for Team Foundation.

SyntaxeSyntax

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]

ParamètresParameters

ArgumentArgument DescriptionDescription
CollectionName Spécifie le nom de la collection du projet d’équipe.Specifies the name of the team project collection. Si le nom contient des espaces, placez-le entre guillemets. Exemple : "Fabrikam Website".If the name has spaces, enclose the name with quotation marks, for example, "Fabrikam Website".
CollectionId Spécifie le numéro d'identification de la collection de projets d'équipe.Specifies the identification number of the team project collection.
ServerPath Spécifie le chemin d’accès d’un fichier de code.Specifies the path to a code file.
OptionOption DescriptionDescription
/indexingStatus/indexingStatus Affichez l'état et la configuration du service d'indexation de code.Show the status and configuration of the code indexing service.
/setIndexing:[ on | off | keepupOnly ]/setIndexing:[ on | off | keepupOnly ] - on : démarrer l’indexation de tous les ensembles de modifications.- on: Start indexing all changesets.
- off : arrêter l’indexation de tous les ensembles de modifications.- off: Stop indexing all changesets.
- off : arrêter l’indexation des ensembles de modifications créés précédemment et commencer l’indexation de nouveaux ensembles de modifications uniquement.- keepupOnly: Stop indexing previously created changesets and start indexing new changesets only.
/ignoreList:[ add | remove | removeAll | view ] ServerPath/ignoreList:[ add | remove | removeAll | view ] ServerPath

Vous pouvez utiliser le caractère générique (*) au début, à la fin ou aux deux extrémités du chemin d’accès au serveur.You can use the wildcard character (*) at the start, end, or both ends of the server path.
Spécifie une liste de fichiers de code et leurs chemins d’accès à ne pas indexer.Specifies a list of code files and their paths that you don't want indexed.

- add : ajouter le fichier à ne pas indexer à la liste des fichiers ignorés.- add: Add the file that you don't want indexed to the ignored file list.
- remove : supprimer le fichier à indexer de la liste des fichiers ignorés.- remove: Remove the file that you want indexed from the ignored file list.
- removeAll : effacer la liste des fichiers ignorés et démarrer l’indexation de tous les fichiers.- removeAll: Clear the ignored file list and start indexing all files.
- view : afficher tous les fichiers qui ne sont pas indexés.- view: See all the files that aren't being indexed.
/listLargeFiles [/fileCount: FileCount /minSize: MinSize]/listLargeFiles [/fileCount: FileCount /minSize: MinSize] Indique le nombre spécifié de fichiers qui dépassent la taille spécifiée en Ko.Shows the specified number of files that exceeds the specified size in KB. Vous pouvez ensuite utiliser l’option /ignoreList pour exclure ces fichiers de l’indexation.You can then use the /ignoreList option to exclude these files from indexing.
/reindexAll/reindexAll Effacez les données indexées précédemment et redémarrez l'indexation.Clear previously indexed data and restart indexing.
/destroyCodeIndex [/noPrompt]/destroyCodeIndex [/noPrompt] Supprimez l'index de code et supprimez toutes les données indexées.Delete the code index and remove all indexed data. Confirmation inutile si vous utilisez l’option /noPrompt.Does not require confirmation if you use the /noPrompt option.
/temporaryDataSizeLimit:[ view | <SizeInGBs> | disable ]/temporaryDataSizeLimit:[ view | <SizeInGBs> | disable ] Contrôle la quantité de données temporaires que CodeLens crée lors du traitement des ensembles de modifications.Control how much temporary data that CodeLens creates when processing changesets. La limite par défaut est 2 Go.The default limit is 2 GB.

- view : afficher la limite de taille actuelle.- view: Show the current size limit.
- SizeInGBs : modifier la limite de taille.- SizeInGBs: Change the size limit.
- disable : supprimer la limite de taille.- disable: Remove the size limit.

Cette limite est vérifiée avant que CodeLens ne traite un nouvel ensemble de modifications.This limit is checked before CodeLens processes a new changeset. Si les données temporaires dépassent cette limite, CodeLens suspend le traitement des ensembles de modifications passés, pas celui des nouveaux.If temporary data exceeds this limit, CodeLens will pause processing past changesets, not new ones. CodeLens redémarre le traitement une fois que les données sont nettoyées et que leur taille est inférieure à cette limite.CodeLens will restart processing after the data is cleaned up and falls below this limit. Le nettoyage s'exécute automatiquement une fois par jour.Cleanup runs automatically once a day. Cela signifie que les données temporaires peuvent dépasser cette limite tant que l'opération de nettoyage n'a pas commencé.This means temporary data might exceed this limit until cleanup starts running.
/indexHistoryPeriod:[ view | all | <NumberOfMonths> ]/indexHistoryPeriod:[ view | all | <NumberOfMonths> ] Contrôler la durée d'indexation de votre historique des modifications.Control how long to index your change history. Cela affecte la quantité d'historique que CodeLens affiche.This affects how much history CodeLens shows you. La limite par défaut est 12 mois.The default limit is 12 months. Cela signifie que l'historique des modifications affiché par CodeLens englobe uniquement les 12 derniers mois.This means CodeLens shows your change history from the last 12 months only.

- view : afficher le nombre de mois actuel.- view: Show the current number of months.
- all : indexer tout l’historique des modifications.- all: Index all change history.
- NumberOfMonths : modifier le nombre de mois utilisés pour indexer l’historique des modifications.- NumberOfMonths: Change the number of months used to index change history.
/collectionName: CollectionName/collectionName: CollectionName Spécifie le nom de la collection de projets d’équipe sur laquelle exécuter la commande CodeIndex.Specifies the name of the team project collection on which to run the CodeIndex command. Nécessaire si vous n’utilisez pas /CollectionId.Required if you don't use /CollectionId.
/collectionId : CollectionId/collectionId: CollectionId Spécifie le numéro d’identification de la collection de projets d’équipe sur laquelle exécuter la commande CodeIndex.Specifies the identification number of the team project collection on which to run the CodeIndex command. Nécessaire si vous n’utilisez pas /CollectionName.Required if you don't use /CollectionName.

ExemplesExamples

Note

Les noms de sociétés, d'organisations, de produits, de domaines, d'adresses de messagerie, de logos, de personnes, de lieux et d'événements mentionnés dans les exemples sont fictifs.The example companies, organizations, products, domain names, email addresses, logos, people, places, and events depicted herein are fictitious. Toute ressemblance avec des noms ou des événements réels est purement fortuite et involontaire.No association with any real company, organization, product, domain name, email address, logo, person, places, or events is intended or should be inferred.

Pour consulter l'état et la configuration d'indexation du code :To see the code indexing status and configuration:

TFSConfig CodeIndex /indexingStatus /collectionName:"Fabrikam Website"

Pour démarrer l'indexation de tous les ensembles de modifications :To start indexing all changesets:

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

Pour arrêter l'indexation des ensembles de modifications créés précédemment et commencer l'indexation de nouveaux ensembles de modifications uniquement :To stop indexing previously created changesets and start indexing new changesets only:

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

Pour trouver jusqu'à 50 fichiers dont la taille est supérieure à 10 Ko :To find up to 50 files that are larger than 10 KB:

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

Pour exclure un fichier spécifique de l'indexation et l'ajouter à la liste des fichiers ignorés :To exclude a specific file from indexing and add it to the ignored file list:

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

Pour afficher tous les fichiers qui ne sont pas indexés :To see all the files that aren't indexed:

TFSConfig CodeIndex /ignoreList:view

Pour effacer les données précédemment indexées et redémarrer l'indexation :To clear previously indexed data and restart indexing:

TFSConfig CodeIndex /reindexAll /collectionName:"Fabrikam Website"

Pour enregistrer la totalité de l'historique des ensembles de modifications :To save all changeset history:

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

Pour supprimer la limite de taille sur les données temporaire CodeLens et poursuivre l'indexation indépendamment de la taille des données temporaires :To remove the size limit on CodeLens temporary data and continue indexing regardless of temporary data size:

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

Pour supprimer l'index de code avec confirmation :To delete the code index with confirmation:

TFSConfig CodeIndex /destroyCodeIndex /collectionName:"Fabrikam Website"

Voir aussiSee also