Class: Mongo::Cursor Private

 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

# File 'lib/mongo/cursor.rb', line 305 def close(opts = {}) return if closed? ctx = context ? context.refresh(timeout_ms: opts[:timeout_ms]) : fresh_context(opts) unregister read_with_one_retry do spec = { coll_name: collection_name, db_name: database.name, cursor_ids: [id], } op = Operation::KillCursors.new(spec) execute_operation(op, context: ctx) end nil rescue Error::OperationFailure::Family, Error::SocketError, Error::SocketTimeoutError, Error::ServerNotUsable # Errors are swallowed since there is noting can be done by handling them. ensure end_session @cursor_id = 0 @lock.synchronize do @explicitly_closed = true end check_in_connection end

 296 297 298 299

# File 'lib/mongo/cursor.rb', line 296 def closed? # @cursor_id should in principle never be nil  @cursor_id.nil? || @cursor_id == 0 end

 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356

# File 'lib/mongo/cursor.rb', line 341 def collection_name # In most cases, this will be equivalent to the name of the collection  # object in the driver. However, in some cases (e.g. when connected  # to an Atlas Data Lake), the namespace returned by the find command  # may be different, which is why we want to use the collection name based  # on the namespace in the command result.  if @namespace # Often, the namespace will be in the format "database.collection".  # However, sometimes the collection name will contain periods, which  # is why this method joins all the namespace components after the first.  ns_components = @namespace.split('.') ns_components[1...ns_components.length].join('.') else collection.name end end

 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

# File 'lib/mongo/cursor.rb', line 163 def each # If we already iterated past the first batch (i.e., called get_more  # at least once), the cursor on the server side has advanced past  # the first batch and restarting iteration from the beginning by  # returning initial result would miss documents in the second batch  # and subsequent batches up to wherever the cursor is. Detect this  # condition and abort the iteration.  #  # In a future driver version, each would either continue from the  # end of previous iteration or would always restart from the  # beginning.  if @get_more_called raise Error::InvalidCursorOperation, 'Cannot restart iteration of a cursor which issued a getMore' end # To maintain compatibility with pre-2.10 driver versions, reset  # the documents array each time a new iteration is started.  @documents = nil if block_given? # StopIteration raised by try_next ends this loop.  loop do document = try_next if explicitly_closed? raise Error::InvalidCursorOperation, 'Cursor was explicitly closed' end yield document if document end self else documents = [] # StopIteration raised by try_next ends this loop.  loop do document = try_next if explicitly_closed? raise Error::InvalidCursorOperation, 'Cursor was explicitly closed' end documents << document if document end documents end end

 416 417 418

# File 'lib/mongo/cursor.rb', line 416 def fully_iterated? !!@fully_iterated end

 391 392 393 394 395 396 397 398 399 400

# File 'lib/mongo/cursor.rb', line 391 def get_more @get_more_called = true # Modern retryable reads specification prohibits retrying getMores.  # Legacy retryable read logic used to retry getMores, but since  # doing so may result in silent data loss, the driver no longer retries  # getMore operations in any circumstance.  # https://github.com/mongodb/specifications/blob/master/source/retryable-reads/retryable-reads.md#qa  process(execute_operation(get_more_operation)) end

 368 369 370

# File 'lib/mongo/cursor.rb', line 368 def id @cursor_id end

 145 146 147

# File 'lib/mongo/cursor.rb', line 145 def inspect "#<Mongo::Cursor:0x#{object_id} @view=#{@view.inspect}>" end

 403 404 405 406 407 408 409 410 411 412 413

# File 'lib/mongo/cursor.rb', line 403 def kill_spec(connection_global_id) KillSpec.new( cursor_id: id, coll_name: collection_name, db_name: database.name, connection_global_id: connection_global_id, server_address: server.address, session: @session, connection: @connection ) end

 381 382 383

# File 'lib/mongo/cursor.rb', line 381 def to_return use_limit? ? @remaining : (batch_size || 0) end

 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 264 265 266 267 268 269

# File 'lib/mongo/cursor.rb', line 223 def try_next if @documents.nil? # Since published versions of Mongoid have a copy of old driver cursor  # code, our dup call in #process isn't invoked when Mongoid query  # cache is active. Work around that by also calling dup here on  # the result of #process which might come out of Mongoid's code.  @documents = process(@initial_result).dup # the documents here can be an empty array, hence  # we may end up issuing a getMore in the first try_next call  end if @documents.empty? # On empty batches, we cache the batch resume token  cache_batch_resume_token unless closed? if exhausted? close @fully_iterated = true raise StopIteration end @documents = get_more else @fully_iterated = true raise StopIteration end else # cursor is closed here  # keep documents as an empty array  end # If there is at least one document, cache its _id  if @documents[0] cache_resume_token(@documents[0]) end # Cache the batch resume token if we are iterating  # over the last document, or if the batch is empty  if @documents.size <= 1 cache_batch_resume_token if closed? @fully_iterated = true end end return @documents.shift end