클래스: Mongo::Database::CursorCommandView Private

상속:
객체
  • 객체
모두 표시
다음에 정의됨:
lib/mongo/database/cursor_command_view.rb

개요

이 클래스는 비공개 API의 일부입니다. 이 클래스는 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

컬렉션 쿼리가 아닌 임의 명령 응답으로 부터 빌드되는 경우 커서가 필요로 하는 최소 뷰입니다.

getMore 특정 옵션(batchSize, maxTimeMS, comment)과 커서 유형 및 타임아웃 모드를 지원하며, 커서가 보기에서 읽는 몇 가지 메서드에 대해 답변합니다.

이후:

  • 2.0.0

인스턴스 속성 요약 접기

인스턴스 메서드 요약 접기

생성자 세부 정보

#initialize(database, options = {}) ⇒ CursorCommandView

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

CursorCommandView의 새 인스턴스를 반환합니다.

매개변수:

  • database (Mongo::Database) —

    명령이 실행된 데이터베이스입니다.

  • 옵션 (해시) (기본값: {}) —

    getMore 및 시간 초과 옵션입니다.

옵션 해시(options):

  • :batch_size (정수) —

    getMore의 batchSize입니다.

  • :max_time_ms (정수) —

    getMore의 maxTimeMS.

  • :comment (객체) —

    getMores에 대한 주석입니다.

  • :cursor_type (기호) —

    :tailable 또는 :tailable_await.

  • :timeout_mode (기호) —

    :cursor_lifetime 또는 :iteration.

이후:

  • 2.0.0



36
37
38
39
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 36

def 초기화(database, 옵션 = {})
  @database = database
  @options = 옵션
end

인스턴스 속성 세부 정보

#database ⇒ Mongo::Database (읽기 전용)

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

반환 명령이 실행된 데이터베이스입니다.

반환합니다:

이후:

  • 2.0.0



42
43
44
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 42

def database
  @database
end

#options ⇒ 해시 (읽기 전용)

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

반환값 보기 옵션. 커서가 getMore 주석을 읽는 데 사용됩니다.

반환합니다:

  • (해시) —

    보기 옵션. 커서가 getMore 주석을 읽는 데 사용됩니다.

이후:

  • 2.0.0



46
47
48
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 46

def 옵션
  @options
end

인스턴스 메서드 세부 정보

#batch_size ⇒ Integer | nil

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

getMore 명령에 전송된 batchSize를 반환합니다.

반환합니다:

  • (정수 | nil) —

    getMore 명령에 전송된 batchSize입니다.

이후:

  • 2.0.0



63
64
65
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 63

def batch_size
  옵션[:batch_size]
end

#클라이언트 ⇒ Mongo::Client

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

반환값 클라이언트.

반환합니다:

이후:

  • 2.0.0



49
50
51
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 49

def 고객
  database.고객
end

#컬렉션 ⇒ Mongo::Collection

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

커서가 클라이언트와 데이터베이스에 도달할 수 있도록만 사용되는 자리 표시자 컬렉션입니다. getMore 및 killCursors의 실제 네임스페이스는 이 컬렉션에서 가져오는 것이 아니라 명령 응답에서 가져오는 것입니다.

반환합니다:

이후:

  • 2.0.0



58
59
60
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 58

def 컬렉션
  @collection ||= 컬렉션.신규(database, '$cmd')
end

#cursor_type ⇒ Symbol | nil

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

커서 유형을 반환합니다.

반환합니다:

  • (Symbol | nil) —

    커서 유형입니다.

이후:

  • 2.0.0



73
74
75
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 73

def cursor_type
  옵션[:cursor_type]
end

#limit ⇒ Object

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

커서는 명령 응답에서 빌드되었을 때 제한을 지원하지 않습니다.

이후:

  • 2.0.0



90
91
92
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 90

def limit
  nil
end

#max_time_ms_for_get_more ⇒ Integer | nil

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

getMore 명령에 전송된 maxTimeMS를 반환합니다.

반환합니다:

  • (정수 | nil) —

    getMore 명령에 전송된 maxTimeMS.

이후:

  • 2.0.0



68
69
70
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 68

def max_time_ms_for_get_more
  옵션[:max_time_ms]
end

#operation_timeouts(opts = {}) ⇒ 해시

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

작업 컨텍스트에 대한 타임아웃 값을 반환합니다.

반환합니다:

  • (해시) —

    작업 컨텍스트에 대한 타임아웃 값입니다.

이후:

  • 2.0.0



83
84
85
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 83

def operation_timeout(opts = {})
  database.operation_timeout(opts)
end

#timeout_mode ⇒ Symbol | nil

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

반환 시간 초과 모드.

반환합니다:

  • (Symbol | nil) —

    타임아웃 모드.

이후:

  • 2.0.0



78
79
80
 
# 파일 'lib/ Mongo/ 데이터베이스/cursor_command_view.rb', 줄 78

def timeout_mode
  옵션[:timeout_mode]
end