|
| 1 | +import type { BSONSerializeOptions, Document, Long } from '../bson'; |
| 2 | +import type { Db } from '../db'; |
| 3 | +import { MongoAPIError, MongoUnexpectedServerResponseError } from '../error'; |
| 4 | +import { executeOperation, ExecutionResult } from '../operations/execute_operation'; |
| 5 | +import { GetMoreOperation } from '../operations/get_more'; |
| 6 | +import { RunCommandOperation } from '../operations/run_command'; |
| 7 | +import type { ReadConcernLike } from '../read_concern'; |
| 8 | +import type { ReadPreferenceLike } from '../read_preference'; |
| 9 | +import type { ClientSession } from '../sessions'; |
| 10 | +import { Callback, ns } from '../utils'; |
| 11 | +import { AbstractCursor } from './abstract_cursor'; |
| 12 | + |
| 13 | +/** @public */ |
| 14 | +export type RunCommandCursorOptions = { |
| 15 | + readPreference?: ReadPreferenceLike; |
| 16 | + session?: ClientSession; |
| 17 | +} & BSONSerializeOptions; |
| 18 | + |
| 19 | +/** @internal */ |
| 20 | +type RunCursorCommandResponse = { |
| 21 | + cursor: { id: bigint | Long | number; ns: string; firstBatch: Document[] }; |
| 22 | + ok: 1; |
| 23 | +}; |
| 24 | + |
| 25 | +/** @public */ |
| 26 | +export class RunCommandCursor extends AbstractCursor { |
| 27 | + public readonly command: Readonly<Record<string, any>>; |
| 28 | + public readonly getMoreOptions: { |
| 29 | + comment?: any; |
| 30 | + maxAwaitTimeMS?: number; |
| 31 | + batchSize?: number; |
| 32 | + } = {}; |
| 33 | + |
| 34 | + /** |
| 35 | + * Controls the `getMore.comment` field |
| 36 | + * @param comment - any BSON value |
| 37 | + */ |
| 38 | + public setComment(comment: any): this { |
| 39 | + this.getMoreOptions.comment = comment; |
| 40 | + return this; |
| 41 | + } |
| 42 | + |
| 43 | + /** |
| 44 | + * Controls the `getMore.maxTimeMS` field. Only valid when cursor is tailable await |
| 45 | + * @param maxTimeMS - the number of milliseconds to wait for new data |
| 46 | + */ |
| 47 | + public setMaxTimeMS(maxTimeMS: number): this { |
| 48 | + this.getMoreOptions.maxAwaitTimeMS = maxTimeMS; |
| 49 | + return this; |
| 50 | + } |
| 51 | + |
| 52 | + /** |
| 53 | + * Controls the `getMore.batchSize` field |
| 54 | + * @param maxTimeMS - the number documents to return in the `nextBatch` |
| 55 | + */ |
| 56 | + public setBatchSize(batchSize: number): this { |
| 57 | + this.getMoreOptions.batchSize = batchSize; |
| 58 | + return this; |
| 59 | + } |
| 60 | + |
| 61 | + public clone(): never { |
| 62 | + throw new MongoAPIError('RunCommandCursor cannot be cloned'); |
| 63 | + } |
| 64 | + |
| 65 | + public override withReadConcern(_: ReadConcernLike): never { |
| 66 | + throw new MongoAPIError( |
| 67 | + 'RunCommandCursor does not support readConcern it must be attached to the command being run' |
| 68 | + ); |
| 69 | + } |
| 70 | + |
| 71 | + public override addCursorFlag(_: string, __: boolean): never { |
| 72 | + throw new MongoAPIError( |
| 73 | + 'RunCommandCursor does not support cursor flags, they must be attached to the command being run' |
| 74 | + ); |
| 75 | + } |
| 76 | + |
| 77 | + public override maxTimeMS(_: number): never { |
| 78 | + throw new MongoAPIError( |
| 79 | + 'RunCommandCursor does not support maxTimeMS, it must be attached to the command being run' |
| 80 | + ); |
| 81 | + } |
| 82 | + |
| 83 | + public override batchSize(_: number): never { |
| 84 | + throw new MongoAPIError( |
| 85 | + 'RunCommandCursor does not support batchSize, it must be attached to the command being run' |
| 86 | + ); |
| 87 | + } |
| 88 | + |
| 89 | + /** @internal */ |
| 90 | + private db: Db | undefined; |
| 91 | + |
| 92 | + /** @internal */ |
| 93 | + constructor(db: Db, command: Document, options: RunCommandCursorOptions = {}) { |
| 94 | + super(db.s.client, ns(db.namespace), options); |
| 95 | + this.db = db; |
| 96 | + this.command = Object.freeze({ ...command }); |
| 97 | + } |
| 98 | + |
| 99 | + /** @internal */ |
| 100 | + protected _initialize(session: ClientSession, callback: Callback<ExecutionResult>) { |
| 101 | + const operation = new RunCommandOperation<RunCursorCommandResponse>(this.db, this.command, { |
| 102 | + ...this.cursorOptions, |
| 103 | + session: session, |
| 104 | + readPreference: this.cursorOptions.readPreference |
| 105 | + }); |
| 106 | + executeOperation(this.client, operation).then( |
| 107 | + response => { |
| 108 | + if (!response.cursor) { |
| 109 | + callback( |
| 110 | + new MongoUnexpectedServerResponseError('Expected server to respond with cursor') |
| 111 | + ); |
| 112 | + return; |
| 113 | + } |
| 114 | + callback(undefined, { |
| 115 | + server: operation.server, |
| 116 | + session, |
| 117 | + response |
| 118 | + }); |
| 119 | + }, |
| 120 | + err => callback(err) |
| 121 | + ); |
| 122 | + } |
| 123 | + |
| 124 | + /** @internal */ |
| 125 | + override _getMore(_batchSize: number, callback: Callback<Document>) { |
| 126 | + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion |
| 127 | + const getMoreOperation = new GetMoreOperation(this.namespace, this.id!, this.server!, { |
| 128 | + ...this.cursorOptions, |
| 129 | + session: this.session, |
| 130 | + ...this.getMoreOptions |
| 131 | + }); |
| 132 | + |
| 133 | + executeOperation(this.client, getMoreOperation, callback); |
| 134 | + } |
| 135 | +} |
0 commit comments