summaryrefslogtreecommitdiff
path: root/src/mongo/client/read_preference.idl
blob: d3e5580c692bd8f580c577af52318b527fddd180 (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
# Copyright (C) 2020-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"

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

enums:
  ReadPreference:
      description: Enumeration representing Read Preference Modes
      type: string
      values:
          # Read from primary only. All operations produce an error (throw an exception where
          # applicable) if primary is unavailable. Cannot be combined with tags.
          PrimaryOnly: "primary"
          #
          # Read from primary if available, otherwise a secondary. Tags will only be applied in the
          # event that the primary is unavailable and a secondary is read from. In this event only
          # secondaries matching the tags provided would be read from.
          PrimaryPreferred: "primaryPreferred"
          #
          # Read from secondary if available, otherwise error.
          SecondaryOnly: "secondary"
          #
          # Read from a secondary if available, otherwise read from the primary.
          SecondaryPreferred: "secondaryPreferred"
          #
          # Read from any member.
          Nearest: "nearest"