Skip to content

Commit 73c0e3d

Browse files
authored
Update README.md (#1)
Adjust names to comply with Trademark fair use
1 parent c641764 commit 73c0e3d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# MongoDB Workload Generator
1+
# Workload Generator for MongoDB
22

3-
MongoDB Workload Generator was designed to help MongoDB users effortlessly generate data and simulate workloads for both sharded and non-sharded clusters. The generated workloads include standard CRUD operations, reflecting real-world usage patterns of a MongoDB environment.
3+
Workload Generator for MongoDB was designed to help MongoDB users effortlessly generate data and simulate workloads for both sharded and non-sharded clusters. The generated workloads include standard CRUD operations, reflecting real-world usage patterns of a MongoDB environment.
44

55
Additionally, the tool supports the creation of realistic workloads by incorporating all CRUD operations through a set of queries that simulate common usage scenarios. Users can also define custom queries to run against collections created by the tool, further enhancing its flexibility and applicability.
66

@@ -20,13 +20,13 @@ The tool consists of 4 files:
2020
* [mongodbWorkload.py](mongodbWorkload.py)
2121
* [app.py](app.py)
2222

23-
The only required configuration is in [mongodbCreds.py](mongodbCreds.py), where you define the connection details for your MongoDB cluster. The file is self-explanatory and includes examples to help you set up your environment correctly. You may also extend this file to include additional parameters as needed.
23+
The only required configuration is in [Creds.py](Creds.py), where you define the connection details for your cluster. The file is self-explanatory and includes examples to help you set up your environment correctly. You may also extend this file to include additional parameters as needed.
2424

2525
Custom queries can be defined in [mongodbLoadQueries.py](mongodbLoadQueries.py), but this is not a requirement. When adding new queries, ensure they target existing collections and fields generated by the tool to avoid runtime errors.
2626

2727
#### Pre-reqs
2828

29-
MongoDB Workload Generator relies on a few additional Python libraries that are not included by default. To ensure proper functionality, please install the following dependencies:
29+
Workload Generator for MongoDB relies on a few additional Python libraries that are not included by default. To ensure proper functionality, please install the following dependencies:
3030

3131
- [faker](https://pypi.org/project/Faker/) – Used to generate random fictional data, ideal for bootstrapping databases, stress testing, and creating randomized datasets.
3232
- [joblib](https://joblib.readthedocs.io/en/stable/) – Enables parallel execution of tasks by leveraging multiple CPU cores.
@@ -99,7 +99,7 @@ You can customize various aspects of the workload, such as execution time, the n
9999
./mongodbWorkload.py --help
100100
usage: mongodbWorkload.py [-h] [--collection_name COLLECTION_NAME] [--collections COLLECTIONS] [--recreate] [--shard] [--runtime RUNTIME] [--batch_size BATCH_SIZE] [--threads THREADS] [--skip_update] [--skip_delete] [--skip_insert] [--skip_select] [--insert_ratio INSERT_RATIO] [--update_ratio UPDATE_RATIO] [--delete_ratio DELETE_RATIO] [--select_ratio SELECT_RATIO] [--report_interval REPORT_INTERVAL] [--cpu_ops] [--optimized] [--cpu CPU] [--log [LOG]]
101101
102-
MongoDB Workload Generator
102+
Workload Generator for MongoDB
103103
104104
options:
105105
-h, --help show this help message and exit

0 commit comments

Comments
 (0)