forked from mongodb/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiargs-dbcommand-explain-field.yaml
34 lines (32 loc) · 1.1 KB
/
apiargs-dbcommand-explain-field.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
arg_name: field
description: |
A document specifying the command for which to return the execution
information. For details on the specific command document, see :dbcommand:`count`,
:dbcommand:`distinct`, :dbcommand:`group`, :dbcommand:`find`,
:dbcommand:`findAndModify`, :dbcommand:`delete`, and :dbcommand:`update`.
interface: dbcommand
name: explain
operation: explain
optional: false
position: 1
type: document
---
arg_name: field
description: |
A string specifying the mode in which to run :dbcommand:`explain`.
The mode affects the behavior of :dbcommand:`explain` and determines
the amount of information to return.
Possible modes are: :ref:`"queryPlanner" <explain-queryPlanner>`,
:ref:`"executionStats" <explain-executionStats>`, and
:ref:`"allPlansExecution" <explain-allPlansExecution>`. For more
information on the modes, see :ref:`explain behavior
<explain-command-behavior>`.
By default, :dbcommand:`explain` runs in :ref:`"allPlansExecution"
<explain-allPlansExecution>` mode.
interface: dbcommand
name: verbosity
operation: explain
optional: true
position: 2
type: string
...