Skip to main content
Version: TeamForge 23.0

SearchReindex.py

Overview

You can use this script to reindex the entire TeamForge data or you can choose to reindex the subset of data types. Usage

Run this script as follows:

./SearchReindex.py --<component name>

Example

  • To perform a search reindex for the tracker, run this command:
    ./SearchReindex.py --trackers-only
  • To perform a search reindex for the wiki, run this command:
    ./SearchReindex.py --wiki-only
  • To perform a search reindex for documents run this command:
    ./SearchReindex.py --documents-only

Options

--single-item itemId, | -i
Schedules a re-index for just the given item. If the item id is for a project the scheduling results in the server re-indexing all of the project data.
---force-index | -f
Force indexing (doesn't check if item is searchable already).
--artifacts only | -a
Reindex all artifacts on the site that are currently not searchable or all artifacts if option f is selected.
--documents only | -d
Reindex all documents on the site that are currently not searchable or all artifacts if option f is selected.
---posts only
Reindex all posts on the site that are currently not searchable or all artifacts if option f is selected.
---trackers only
Reindex all trackers on the site.
---document_folders-only
Reindex all document folders on the site.
---topics-only
Reindex all topics.
---forums-only
Reindex all forums on the site.
---news-only
Reindex all news.
---project_pages-only
Reindex all project pages.
---packages
Reindex all packages.
---commits-only
Reindex all commits.
---frs_files-only
Reindex all frs files.
---releases-only
Reindex all releases.
---wikis-only
Reindex all wikis.
--project-id projectID | -p
Limit the re-indexing to data for single project when re-indexing only artifacts and or documents.
--verify | -x
Searches for each item that is scheduled for re-indexing. There is a one minute wait limit for each item to be re-indexed by the server.
--dryrun | -r
Executes all the steps for scheduling a re-index without actually sending any re-index requests to the server. This provides a list of items that need re-indexing.
output-file filePath, | -o
Prints the output for the given file.
--verbose | -v
Chronicles the process of scheduling the re-index a bit more.