Package com.mongodb
Enum Class ExplainVerbosity
- All Implemented Interfaces:
Serializable
,Comparable<ExplainVerbosity>
,java.lang.constant.Constable
An enumeration of the verbosity levels available for explaining query execution.
- Since:
- 3.0
- Since server release
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionRuns the query optimizer and chooses the winning plan, but then runs all generated plans to completion.Runs the query optimizer, and then runs the winning plan to completion.Runs the query planner and chooses the winning plan, but does not actually execute it. -
Method Summary
Modifier and TypeMethodDescriptionstatic ExplainVerbosity
Returns the enum constant of this class with the specified name.static ExplainVerbosity[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
QUERY_PLANNER
Runs the query planner and chooses the winning plan, but does not actually execute it. The use case for this verbosity level is "Which plan will MongoDB choose to run my query." -
EXECUTION_STATS
Runs the query optimizer, and then runs the winning plan to completion. In addition to the planner information, this makes execution stats available. The use case for this verbosity level is "Is my query performing well." -
ALL_PLANS_EXECUTIONS
Runs the query optimizer and chooses the winning plan, but then runs all generated plans to completion. This makes execution stats available for all of the query plans. The use case for this verbosity level is "I have a problem with this query, and I want as much information as possible in order to diagnose why it might be slow."
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-