CodeIndex — polecenie

Użyj polecenia CodeIndex, aby zarządzać indeksowaniem kodu na serwerze Team Foundation Server. Na przykład możesz zresetować indeks, aby naprawić informacje CodeLens lub wyłączyć indeksowanie w celu zbadania problemów z wydajnością serwera.

Wymagane uprawnienia

Aby użyć polecenia CodeIndex , musisz być członkiem grupy zabezpieczeń Administratorzy team Foundation. Zobacz Uprawnienia i grupy zdefiniowane dla usług Azure DevOps Services i TFS.

Uwaga

Nawet jeśli logujesz się przy użyciu poświadczeń administracyjnych, musisz otworzyć okno wiersza polecenia z podwyższonym poziomem uprawnień, aby uruchomić to polecenie. Należy również uruchomić to polecenie z poziomu warstwy aplikacji dla programu Team Foundation.

Składnia

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]

Parametry

Argument Opis
CollectionName Określa nazwę kolekcji projektów. Jeśli nazwa zawiera spacje, podaj nazwę z cudzysłowami, na przykład "Witryna internetowa firmy Fabrikam".
CollectionId Określa numer identyfikacyjny kolekcji projektu.
ServerPath Określa ścieżkę do pliku kodu.
Opcja Opis
/indexingStatus Pokaż stan i konfigurację usługi indeksowania kodu.
/setIndexing:[ on | off | keepupOnly ] - on: Rozpocznij indeksowanie wszystkich zmian.
- wyłączone: Zatrzymaj indeksowanie wszystkich zestawów zmian.
- keepupOnly: zatrzymaj indeksowanie wcześniej utworzonych zestawów zmian i zacznij indeksować tylko nowe zestawy zmian.
/ignoreList:[ add | remove | removeAll | view ] ServerPath

Symbol wieloznaczny (*) można użyć na początku, na końcu lub na obu końcach ścieżki serwera.
Określa listę plików kodu i ich ścieżki, których nie chcesz indeksować.

- add: Dodaj plik, którego nie chcesz indeksować do listy ignorowanych plików.
- remove: Usuń plik, który chcesz zaindeksować z listy ignorowanych plików.
- removeAll: Wyczyść zignorowaną listę plików i rozpocznij indeksowanie wszystkich plików.
- view: Zobacz wszystkie pliki, które nie są indeksowane.
/listLargeFiles [/fileCount: /minSize: MinSizeFileCount ] Pokazuje określoną liczbę plików, które przekraczają określony rozmiar w KB. Następnie możesz użyć /ignoreList opcji, aby wykluczyć te pliki z indeksowania.
/reindexAll Wyczyść wcześniej indeksowane dane i ponownie uruchom indeksowanie.
/destroyCodeIndex [/noPrompt] Usuń indeks kodu i usuń wszystkie indeksowane dane. Nie wymaga potwierdzenia, jeśli używasz /noPrompt opcji.
/temporaryDataSizeLimit:[ view | | <SizeInGBs> disable ] Kontrolowanie ilości danych tymczasowych tworzonych przez funkcję CodeLens podczas przetwarzania zestawów zmian. Domyślny limit to 2 GB.

- view: Pokaż bieżący limit rozmiaru.
- SizeInGBs: Zmień limit rozmiaru.
- wyłącz: usuń limit rozmiaru.

Ten limit jest sprawdzany, zanim funkcja CodeLens przetworzy nowy zestaw zmian. Jeśli dane tymczasowe przekraczają ten limit, funkcja CodeLens wstrzyma przetwarzanie przeszłych zmian, a nie nowych. Funkcja CodeLens ponownie uruchomi przetwarzanie po wyczyszczeniu danych i spadnie poniżej tego limitu. Oczyszczanie jest uruchamiane automatycznie raz dziennie. Oznacza to, że dane tymczasowe mogą przekroczyć ten limit, dopóki czyszczenie nie zostanie uruchomione.
/indexHistoryPeriod:[ view | all | <NumberOfMonths> ] Określ, jak długo indeksować historię zmian. Ma to wpływ na to, ile pokazuje historia CodeLens. Domyślny limit to 12 miesięcy. Oznacza to, że funkcja CodeLens pokazuje historię zmian tylko z ostatnich 12 miesięcy.

- view: Pokaż bieżącą liczbę miesięcy.
- wszystkie: Indeksuj całą historię zmian.
- NumberOfMonths: zmień liczbę miesięcy używanych do indeksowania historii zmian.
/collectionName: CollectionName Określa nazwę kolekcji projektu, na której ma zostać uruchomione polecenie CodeIndex . Wymagane, jeśli nie używasz /CollectionId.
/collectionId: CollectionId Określa numer identyfikacyjny kolekcji projektu, na której ma zostać uruchomione polecenie CodeIndex . Wymagane, jeśli nie używasz /CollectionName.

Przykłady

Uwaga

Przykładowe firmy, organizacje, produkty, nazwy domen, adresy e-mail, logo, osoby, miejsca i wydarzenia przedstawione w niniejszym dokumencie są fikcyjne. Żadne skojarzenie z prawdziwą firmą, organizacją, produktem, nazwą domeny, adresem e-mail, logo, osobą, miejscami lub wydarzeniami jest zamierzone lub nie powinny być wnioskowane.

Aby wyświetlić stan i konfigurację indeksowania kodu:

TFSConfig CodeIndex /indexingStatus /collectionName:"Fabrikam Website"

Aby rozpocząć indeksowanie wszystkich zestawów zmian:

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

Aby zatrzymać indeksowanie wcześniej utworzonych zestawów zmian i zacząć indeksować tylko nowe zestawy zmian:

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

Aby znaleźć maksymalnie 50 plików, które są większe niż 10 KB:

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

Aby wykluczyć określony plik z indeksowania i dodać go do listy ignorowanych plików:

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

Aby wyświetlić wszystkie pliki, które nie są indeksowane:

TFSConfig CodeIndex /ignoreList:view

Aby wyczyścić wcześniej indeksowane dane i ponownie uruchomić indeksowanie:

TFSConfig CodeIndex /reindexAll /collectionName:"Fabrikam Website"

Aby zapisać całą historię zestawu zmian:

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

Aby usunąć limit rozmiaru danych tymczasowych CodeLens i kontynuować indeksowanie niezależnie od tymczasowego rozmiaru danych:

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

Aby usunąć indeks kodu z potwierdzeniem:

TFSConfig CodeIndex /destroyCodeIndex /collectionName:"Fabrikam Website"

Zobacz też