gem5/util/helper_scripts_for_mongodb/README.md

Overview

This utility contains various scripts that are helpful when maintaining the gem5 resources MongoDB database. The scripts in this directory use external libraries. Please install the required libraries mentioned in the requirements.txt by running the following command:

 pip3 install -r requirements.txt

add-json-to-mongo.py

This script adds a list of resources from a JSON file to a specified collection in a MongoDB database. The JSON file should be in the format of a list of dictionaries, where each dictionary represents a resource.

To run this script you use the following command:

 python3 ./add-json-to-mongo.py --uri <uri> --db_name <db_name> --collection_name <collection_name> --json_file <json_file>

backup-db.py

This script grabs all documents from a specified collection in a MongoDB database and saves them to a JSON file.

To run this script you use the following command:

 python3 ./backup-db.py --uri <uri> --db_name <db_name> --collection_name <collection_name>

create-new-collection.py

This script grabs all documents from a specified collection in a MongoDB database and creates a new collection with the same documents.

To run this script you use the following command:

 python3 ./create-new-collection.py --uri <uri> --db_name <db_name> --collection_name <collection_name> --new_collection_name <new_collection_name>

update-gem5-versions.py

This script grabs all resources categorically from a specified collection in a MongoDB database and adds a new gem5 version to the gem5_versions field of each resource.

To run this script you use the following command:

python3 ./update-gem5-versions.py --uri <uri> --db <db_name> --collection <collection_name> --version <version> --category <category> --outfile <outfile>

helper.py

This script contains helper functions for the scripts in this directory.