Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 | 503x 503x 503x 503x 503x 503x 503x 503x 503x 503x 503x 503x 503x 509112x 92x 509020x 4x 4x 509016x 12x 509008x 509008x 509008x 509008x 509008x 509008x 509008x 306x 8x 298x 298x 509000x 415996x 4x 415992x 12x 415980x 8x 50x 88558x 6425368x 6326647x 6326647x 6326647x 2559999x 3766648x 3783x 3762865x 412114x 412114x 412114x 3350751x 69x 3350751x 4150149x 4150149x 3641037x 4065143x 4065143x 27932x 291085x 291085x 291085x 291085x 291085x | import type { Document } from './bson';
import { MongoInvalidArgumentError } from './error';
import type { TagSet } from './sdam/server_description';
import type { ClientSession } from './sessions';
/** @public */
export type ReadPreferenceLike = ReadPreference | ReadPreferenceMode;
/** @public */
export const ReadPreferenceMode = Object.freeze({
primary: 'primary',
primaryPreferred: 'primaryPreferred',
secondary: 'secondary',
secondaryPreferred: 'secondaryPreferred',
nearest: 'nearest'
} as const);
/** @public */
export type ReadPreferenceMode = (typeof ReadPreferenceMode)[keyof typeof ReadPreferenceMode];
/** @public */
export interface HedgeOptions {
/** Explicitly enable or disable hedged reads. */
enabled?: boolean;
}
/** @public */
export interface ReadPreferenceOptions {
/** Max secondary read staleness in seconds, Minimum value is 90 seconds.*/
maxStalenessSeconds?: number;
/** Server mode in which the same query is dispatched in parallel to multiple replica set members. */
hedge?: HedgeOptions;
}
/** @public */
export interface ReadPreferenceLikeOptions extends ReadPreferenceOptions {
readPreference?:
| ReadPreferenceLike
| {
mode?: ReadPreferenceMode;
preference?: ReadPreferenceMode;
tags?: TagSet[];
maxStalenessSeconds?: number;
};
}
/** @public */
export interface ReadPreferenceFromOptions extends ReadPreferenceLikeOptions {
session?: ClientSession;
readPreferenceTags?: TagSet[];
hedge?: HedgeOptions;
}
/**
* The **ReadPreference** class is a class that represents a MongoDB ReadPreference and is
* used to construct connections.
* @public
*
* @see https://www.mongodb.com/docs/manual/core/read-preference/
*/
export class ReadPreference {
mode: ReadPreferenceMode;
tags?: TagSet[];
hedge?: HedgeOptions;
maxStalenessSeconds?: number;
minWireVersion?: number;
public static PRIMARY = ReadPreferenceMode.primary;
public static PRIMARY_PREFERRED = ReadPreferenceMode.primaryPreferred;
public static SECONDARY = ReadPreferenceMode.secondary;
public static SECONDARY_PREFERRED = ReadPreferenceMode.secondaryPreferred;
public static NEAREST = ReadPreferenceMode.nearest;
public static primary = new ReadPreference(ReadPreferenceMode.primary);
public static primaryPreferred = new ReadPreference(ReadPreferenceMode.primaryPreferred);
public static secondary = new ReadPreference(ReadPreferenceMode.secondary);
public static secondaryPreferred = new ReadPreference(ReadPreferenceMode.secondaryPreferred);
public static nearest = new ReadPreference(ReadPreferenceMode.nearest);
/**
* @param mode - A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)
* @param tags - A tag set used to target reads to members with the specified tag(s). tagSet is not available if using read preference mode primary.
* @param options - Additional read preference options
*/
constructor(mode: ReadPreferenceMode, tags?: TagSet[], options?: ReadPreferenceOptions) {
if (!ReadPreference.isValid(mode)) {
throw new MongoInvalidArgumentError(`Invalid read preference mode ${JSON.stringify(mode)}`);
}
if (options == null && typeof tags === 'object' && !Array.isArray(tags)) {
options = tags;
tags = undefined;
} else if (tags && !Array.isArray(tags)) {
throw new MongoInvalidArgumentError('ReadPreference tags must be an array');
}
this.mode = mode;
this.tags = tags;
this.hedge = options?.hedge;
this.maxStalenessSeconds = undefined;
this.minWireVersion = undefined;
options = options ?? {};
if (options.maxStalenessSeconds != null) {
if (options.maxStalenessSeconds <= 0) {
throw new MongoInvalidArgumentError('maxStalenessSeconds must be a positive integer');
}
this.maxStalenessSeconds = options.maxStalenessSeconds;
// NOTE: The minimum required wire version is 5 for this read preference. If the existing
// topology has a lower value then a MongoError will be thrown during server selection.
this.minWireVersion = 5;
}
if (this.mode === ReadPreference.PRIMARY) {
if (this.tags && Array.isArray(this.tags) && this.tags.length > 0) {
throw new MongoInvalidArgumentError('Primary read preference cannot be combined with tags');
}
if (this.maxStalenessSeconds) {
throw new MongoInvalidArgumentError(
'Primary read preference cannot be combined with maxStalenessSeconds'
);
}
if (this.hedge) {
throw new MongoInvalidArgumentError(
'Primary read preference cannot be combined with hedge'
);
}
}
}
// Support the deprecated `preference` property introduced in the porcelain layer
get preference(): ReadPreferenceMode {
return this.mode;
}
static fromString(mode: string): ReadPreference {
return new ReadPreference(mode as ReadPreferenceMode);
}
/**
* Construct a ReadPreference given an options object.
*
* @param options - The options object from which to extract the read preference.
*/
static fromOptions(options?: ReadPreferenceFromOptions): ReadPreference | undefined {
if (!options) return;
const readPreference =
options.readPreference ?? options.session?.transaction.options.readPreference;
const readPreferenceTags = options.readPreferenceTags;
if (readPreference == null) {
return;
}
if (typeof readPreference === 'string') {
return new ReadPreference(readPreference, readPreferenceTags, {
maxStalenessSeconds: options.maxStalenessSeconds,
hedge: options.hedge
});
} else if (!(readPreference instanceof ReadPreference) && typeof readPreference === 'object') {
const mode = readPreference.mode || readPreference.preference;
Eif (mode && typeof mode === 'string') {
return new ReadPreference(mode, readPreference.tags ?? readPreferenceTags, {
maxStalenessSeconds: readPreference.maxStalenessSeconds,
hedge: options.hedge
});
}
}
if (readPreferenceTags) {
readPreference.tags = readPreferenceTags;
}
return readPreference as ReadPreference;
}
/**
* Replaces options.readPreference with a ReadPreference instance
*/
static translate(options: ReadPreferenceLikeOptions): ReadPreferenceLikeOptions {
if (options.readPreference == null) return options;
const r = options.readPreference;
if (typeof r === 'string') {
options.readPreference = new ReadPreference(r);
} else if (r && !(r instanceof ReadPreference) && typeof r === 'object') {
const mode = r.mode || r.preference;
if (mode && typeof mode === 'string') {
options.readPreference = new ReadPreference(mode, r.tags, {
maxStalenessSeconds: r.maxStalenessSeconds
});
}
} else if (!(r instanceof ReadPreference)) {
throw new MongoInvalidArgumentError(`Invalid read preference: ${r}`);
}
return options;
}
/**
* Validate if a mode is legal
*
* @param mode - The string representing the read preference mode.
*/
static isValid(mode: string): boolean {
const VALID_MODES = new Set([
ReadPreference.PRIMARY,
ReadPreference.PRIMARY_PREFERRED,
ReadPreference.SECONDARY,
ReadPreference.SECONDARY_PREFERRED,
ReadPreference.NEAREST,
null
]);
return VALID_MODES.has(mode as ReadPreferenceMode);
}
/**
* Validate if a mode is legal
*
* @param mode - The string representing the read preference mode.
*/
isValid(mode?: string): boolean {
return ReadPreference.isValid(typeof mode === 'string' ? mode : this.mode);
}
/**
* Indicates that this readPreference needs the "SecondaryOk" bit when sent over the wire
* @see https://www.mongodb.com/docs/manual/reference/mongodb-wire-protocol/#op-query
*/
secondaryOk(): boolean {
const NEEDS_SECONDARYOK = new Set<string>([
ReadPreference.PRIMARY_PREFERRED,
ReadPreference.SECONDARY,
ReadPreference.SECONDARY_PREFERRED,
ReadPreference.NEAREST
]);
return NEEDS_SECONDARYOK.has(this.mode);
}
/**
* Check if the two ReadPreferences are equivalent
*
* @param readPreference - The read preference with which to check equality
*/
equals(readPreference: ReadPreference): boolean {
return readPreference.mode === this.mode;
}
/** Return JSON representation */
toJSON(): Document {
const readPreference = { mode: this.mode } as Document;
if (Array.isArray(this.tags)) readPreference.tags = this.tags;
if (this.maxStalenessSeconds) readPreference.maxStalenessSeconds = this.maxStalenessSeconds;
if (this.hedge) readPreference.hedge = this.hedge;
return readPreference;
}
}
|