Skip to content

Commit 97e50f9

Browse files
ghartnettdstorch
andauthored
Added a note to explain 6.0 change to mongosh (#113)
* Added a note to explain 6.0 change to mongosh * Added note - this is not supported externally * Apply suggestions from code review Co-authored-by: David Storch <[email protected]> * Added dstorch's change for the shell support and tweaked the language of the NOTE. Co-authored-by: David Storch <[email protected]>
1 parent 01d443d commit 97e50f9

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

33
Mongo-perf (not to be confused with mongoperf) is a micro benchmarking tool for the MongoDB server. It measures throughput of commands with regards to the number of threads.
44

5+
**NOTE: this tool is primarily for internal use by MongoDB's performance testing ecosystem. It is not supported for users outside MongoDB. Use at your own risk.**
6+
57
### OVERVIEW:
68
This repo contains scripts to run benchmark tests for MongoDB.
79

810
### DEPENDENCIES:
11+
Since 6.0, the legacy "mongo" shell has been replaced with "mongosh" which does not support benchRun(). To run this micro benchmark with MongoDB 6.0 you'll also need to download the 5.0 legacy "mongo" shell and ensure it's in your path. The legacy mongo shell is no longer officially supported for use with the MongoDB server, so there is no guarantee of forwards compatibility between the 5.0 legacy shell and more recent versions of the MongoDB server.
12+
913
*General Benchmarking Dependencies*
1014
* Python >= 3.0
1115
* mongo shell >= 2.7.7-pre- (at revision 881b3a97fb5080b4e5d5ce11ad016da73ea23931 or newer)

0 commit comments

Comments
 (0)