# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http:#www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

global:
    cpp_namespace: "mongo::explain"
  
enums:
    Verbosity:
        description: "The various supported verbosity levels for explain. The order is significant: 
                      the enum values are assigned in order of increasing verbosity"
        type: string
        values:
            # At all verbosities greater than or equal to kQueryPlanner, we display information
            # about the plan selected and alternate rejected plans. Does not include any
            # execution-related info. String alias is "queryPlanner".
            kQueryPlanner: "queryPlanner"

            # At all verbosities greater than or equal to kExecStats, we display a section of output
            # containing both overall execution stats, and stats per stage in the execution tree.
            # String alias is "executionStats".
            kExecStats: "executionStats"

            # At this verbosity level, we generate the execution stats for each rejected plan as
            # well as the winning plan. String alias is "allPlansExecution".
            kExecAllPlans: "allPlansExecution"