percona/percona-toolkit
1
0
Fork 0
mirror of https://github.com/percona/percona-toolkit.git synced 2025-09-18 01:33:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make documentation for Go tools to use symlinks to README.rst

Browse Source 
- Currently, documentation for Go tools is duplicated in the user manual
  and README files. This PR makes README files single source of truth
and creates a symlincs inside docs directory.
- Fixed link to the forum in
  config/sphinx-build/_static/_templates/theme/relbar2.html (previously
mentioned PSMDB forum instead of Percona Toolkit's)
- Updated 3.6.0 release date in docs/percona-toolkit.pod
- Updated documentation for option --version in docs/percona-toolkit.pod
This commit is contained in:
Sveta Smirnova
2024-09-04 00:33:24 +03:00
parent e78da8d151
commit bf3d2ffab4
19 changed files with 562 additions and 1695 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/pt-mongodb-index-check.rst
View File

@@ -1,72 +0,0 @@
.. _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 |
+----------------------------+----------------------------------------+

1
docs/pt-mongodb-index-check.rst Symbolic link
View File

@@ -0,0 +1 @@
../src/go/pt-mongodb-index-check/README.rst