summaryrefslogtreecommitdiff
path: root/src/mongo/db/pipeline/legacy_runtime_constants.idl
blob: 02a35485c0490a2baa51b0f96de5d0463e652488 (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
# 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.
#

# Runtime constants IDL file

global:
   cpp_namespace: "mongo"

imports:
    - "mongo/db/basic_types.idl"

structs:
  LegacyRuntimeConstants:
      description: A collection of values that do not change once computed. It is shipped as part
                   of an aggregation request so all shards participating in a query see the same
                   values.
      fields:
          localNow:
              cpp_name: localNow
              type: date
              description: A value of the $$NOW variable.
              stability: stable
          clusterTime:
              cpp_name: clusterTime
              type: timestamp
              description: A value of the $$CLUSTER_TIME variable.
              stability: stable
          jsScope:
              cpp_name: jsScope
              type: object
              optional: true
              description: Optional scope variables accessible from internal javacsript expressions.
              stability: stable
          isMapReduce:
              cpp_name: isMapReduce
              type: bool
              optional: true
              stability: stable
              description: When specified, signals that the aggregation pipeline originated from a
                           mapReduce command.
          userRoles:
               cpp_name: userRoles
               type: array
               optional: true
               description: A value of the $$USER_ROLES variable.
               stability: unstable