-
Notifications
You must be signed in to change notification settings - Fork 328
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PT-2235 - pt-mongodb-index-check does not support option --version (#653
) * PT-2235 - pt-mongodb-index-check does not support option --version Changed command version to flag version * PT-2235 - pt-mongodb-index-check does not support option --version Updated documentation
- Loading branch information
1 parent
ab4bf1b
commit 156372f
Showing
5 changed files
with
100 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
.. _pt-mongodb-index-check: | ||
|
||
================================= | ||
:program:`pt-mongodb-index-check` | ||
================================= | ||
|
||
Performs checks on MongoDB indexes. | ||
|
||
Checks available | ||
================ | ||
|
||
Duplicated indexes | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
Check for indexes that are the prefix of other indexes. For example if we have these 2 indexes | ||
|
||
.. code-block:: javascript | ||
db.getSiblingDB("testdb").test_col.createIndex({"f1": 1, "f2": -1, "f3": 1, "f4": 1}, {"name": "idx_01"}); | ||
db.getSiblingDB("testdb").test_col.createIndex({"f1": 1, "f2": -1, "f3": 1}, {"name": "idx_02"}); | ||
The index ``idx_02`` is the prefix of ``idx_01`` because it has the same | ||
keys in the same order so, ``idx_02`` can be dropped. | ||
|
||
Unused indexes. | ||
~~~~~~~~~~~~~~~ | ||
|
||
This check gets the ``$indexstats`` for all indexes and reports those | ||
having ``accesses.ops`` = 0. | ||
|
||
Usage | ||
===== | ||
|
||
Run the program as ``pt-mongodb-index-check <command> [flags]`` | ||
|
||
Available commands | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
================ ================================== | ||
Command Description | ||
================ ================================== | ||
check-duplicated Run checks for duplicated indexes. | ||
check-unused Run check for unused indexes. | ||
check-all Run all checks | ||
================ ================================== | ||
|
||
Available flags | ||
~~~~~~~~~~~~~~~ | ||
|
||
+----------------------------+----------------------------------------+ | ||
| Flag | Description | | ||
+============================+========================================+ | ||
| –all-databases | Check in all databases excluding | | ||
| | system dbs. | | ||
+----------------------------+----------------------------------------+ | ||
| –databases=DATABASES,… | Comma separated list of databases to | | ||
| | check. | | ||
+----------------------------+----------------------------------------+ | ||
| –all-collections | Check in all collections in the | | ||
| | selected databases. | | ||
+----------------------------+----------------------------------------+ | ||
| –collections=COLLECTIONS,… | Comma separated list of collections to | | ||
| | check. | | ||
+----------------------------+----------------------------------------+ | ||
| –mongodb.uri= | Connection URI | | ||
+----------------------------+----------------------------------------+ | ||
| –json | Show output as JSON | | ||
+----------------------------+----------------------------------------+ | ||
| –version | Show version information | | ||
+----------------------------+----------------------------------------+ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
package main | ||
|
||
import ( | ||
"os/exec" | ||
"regexp" | ||
"testing" | ||
) | ||
|
||
/* | ||
Option --version | ||
*/ | ||
func TestVersionOption(t *testing.T) { | ||
out, err := exec.Command("../../../bin/"+toolname, "--version").Output() | ||
if err != nil { | ||
t.Errorf("error executing %s --version: %s", toolname, err.Error()) | ||
} | ||
// We are using MustCompile here, because hard-coded RE should not fail | ||
re := regexp.MustCompile(toolname + `\n.*Version v?\d+\.\d+\.\d+\n`) | ||
if !re.Match(out) { | ||
t.Errorf("%s --version returns wrong result:\n%s", toolname, out) | ||
} | ||
} |