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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
# Copyright (C) 2014-2017 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Mongo
module ServerSelector
# Encapsulates specifications for selecting servers, with
# secondaries preferred, given a list of candidates.
#
# @since 2.0.0
class SecondaryPreferred
include Selectable
# Name of the this read preference in the server's format.
#
# @since 2.5.0
SERVER_FORMATTED_NAME = 'secondaryPreferred'.freeze
# Get the name of the server mode type.
#
# @example Get the name of the server mode for this preference.
# preference.name
#
# @return [ Symbol ] :secondary_preferred
#
# @since 2.0.0
def name
:secondary_preferred
end
# Whether the slaveOk bit should be set on wire protocol messages.
# I.e. whether the operation can be performed on a secondary server.
#
# @return [ true ] true
#
# @since 2.0.0
def slave_ok?
true
end
# Whether tag sets are allowed to be defined for this server preference.
#
# @return [ true ] true
#
# @since 2.0.0
def tags_allowed?
true
end
# Convert this server preference definition into a format appropriate
# for a mongos server.
# Note that the server preference is not sent to mongos as part of the query
# selector if there are no tag sets, for maximum backwards compatibility.
#
# @example Convert this server preference definition into a format
# for mongos.
# preference = Mongo::ServerSelector::SecondaryPreferred.new
# preference.to_mongos
#
# @return [ Hash ] The server preference formatted for a mongos server.
#
# @since 2.0.0
def to_mongos
return nil if tag_sets.empty? && max_staleness.nil?
to_doc
end
# Convert this server preference definition into a format appropriate
# for a server.
#
# @example Convert this server preference definition into a format
# for a server.
# preference = Mongo::ServerSelector::SecondaryPreferred.new
# preference.to_doc
#
# @return [ Hash ] The server preference formatted for a server.
#
# @since 2.5.0
def to_doc
@doc ||= (preference = { mode: SERVER_FORMATTED_NAME }
preference.merge!({ tags: tag_sets }) unless tag_sets.empty?
preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
preference)
end
private
# Select servers taking into account any defined tag sets and
# local threshold, with secondaries.
#
# @example Select servers given a list of candidates,
# with secondaries preferred.
# preference = Mongo::ServerSelector::SecondaryPreferred.new
# preference.select([candidate_1, candidate_2])
#
# @return [ Array ] A list of servers matching tag sets and acceptable
# latency with secondaries preferred.
#
# @since 2.0.0
def select(candidates)
near_servers(secondaries(candidates)) + primary(candidates)
end
def max_staleness_allowed?
true
end
end
end
end
|
