Skip to content

Commit 580fb3a

Browse files
authored
(DOCSP-12235) Support query plan cache methods (#47)
* (DOCSP-12235) Support query plan cache methods
1 parent ddceb6c commit 580fb3a

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

source/reference/methods.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -667,6 +667,42 @@ standalone and replica set deployments.
667667

668668
- Returns the free cloud monitoring status for your deployment.
669669

670+
Query Plan Cache Methods
671+
------------------------
672+
673+
.. list-table::
674+
:widths: 30 70
675+
:header-rows: 1
676+
677+
* - Method
678+
679+
- Description
680+
681+
* - :method:`db.collection.getPlanCache()`
682+
683+
- Returns an interface to access the query plan cache object and
684+
associated ``PlanCache`` methods for a collection.
685+
686+
* - :method:`PlanCache.clear()`
687+
688+
- Removes all cached query plans for a collection.
689+
690+
* - :method:`PlanCache.clearPlansByQuery()`
691+
692+
- Clears the cached query plans for the specified
693+
:term:`query shape`.
694+
695+
* - :method:`PlanCache.help()`
696+
697+
- Lists the methods available to view and modify a collection’s
698+
query plan cache.
699+
700+
* - :method:`PlanCache.list()`
701+
702+
- Returns an array of
703+
:manual:`plan cache entries </core/query-plans/>`
704+
for a collection.
705+
670706
Server Status Methods
671707
---------------------
672708

0 commit comments

Comments
 (0)