summaryrefslogtreecommitdiff
path: root/src/mongo/db/storage/two_phase_index_build_knobs.idl
blob: f14e7c9bd6025fbd3be632a7cc19b042a2b68d3c (plain)
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# Copyright (C) 2019-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"

server_parameters:
  # Commit quorum option is supported only for two phase index builds.
  enableIndexBuildCommitQuorum:
    description: "Support for using commit quorum for two phase index builds."
    set_at: startup
    cpp_vartype: bool
    cpp_varname: "enableIndexBuildCommitQuorum"
    default: true

  maxNumActiveUserIndexBuilds:
    description: >
      Specifies the maximum number of active user index builds that can be built simultaneously on
      the primary node. Index builds initiated by the system are not subject to this limitation.

      Additionally, active index builds initiated by the system count towards the limit and can
      delay scheduling user index builds even when the number of active user index builds is below
      the limit.
    set_at: [ startup, runtime ]
    cpp_vartype: AtomicWord<int>
    cpp_varname: maxNumActiveUserIndexBuilds
    default: 3
    validator:
      gte: 0

  resumableIndexBuildMajorityOpTimeTimeoutMillis:
    description: >
      Time in milliseconds a node waits for the last optime before installing the interceptors to
      be majority committed for a resumable index build. Once the interceptors are installed, the
      index build process will start the collection scan phase.
      If the majority commit point is not reached by the end of this waiting period, the index
      build will proceed as a non-resumable index build.
      Set to 0 to skip the wait. This will also disable resumable index builds.
      Set to a negative value to wait indefinitely for the majority commit point.
    set_at: startup
    cpp_vartype: long long
    cpp_varname: gResumableIndexBuildMajorityOpTimeTimeoutMillis
    default: 10000

  enableResumableIndexBuilds:
    # TODO(SERVER-50745): Remove this feature flag.
    description: "Support for using resumable index builds."
    set_at: startup
    cpp_vartype: bool
    cpp_varname: "enableResumableIndexBuilds"
    default: true