クラス: Mongo::Operation:ListCollections::Result

継承:
結果
  • オブジェクト
すべて表示
定義:
lib/mongo/操作/list_collections/result.rb

Overview

listCollections コマンドを使用する際の結果のカスタム動作を定義します。

以来

  • 2.0.0

定数の概要

結果から継承される定数

結果::CURSOR 、結果::CURSOR_ID 、結果::FIRST_BATCH 、結果::N 、結果::NAMESPACE 、結果::Next_BATCH 、結果:: OK 、結果::RESULT

インスタンス属性の概要

結果から継承される属性

接続 、 接続_説明 、 接続_グローバル_id 、 コンテキスト 、 応答

インスタンス メソッドの概要を折りたたむ

結果から継承されるメソッド

認証済み 、#cluster_time 、 各 、# error 、# has_cursor_id ? 、 #initiate 、 #inspect 、 # labels 、 #ok? 、 #operation_time 、# reply 、#returned_count 、 #snapshot_timestamp 、#成功し たかどうか 、トポロジー_バージョン 、書込み _concern_error ? 、 #Written_count

コンストラクターの詳細

このクラスは、 Mongo::Operation::Resultから コンストラクターを継承します。

インスタンス メソッドの詳細

#cursor_id ⇒ Integer

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

注：

ワイヤプロトコルには、タイプ応答のすべてのメッセージに cursor_id フィールドがありますが、 listCollections コマンドを使用する場合は常に 0 であり、カーソル ドキュメント自体から取得する必要があります。

結果のカーソル ID を取得します。

例:

カーソル ID を取得します。

result.cursor_id

次の値を返します。

  • (整数) —

    カーソル ID。

以来

  • 2.0.0



43
44
45
 
# ファイル 'lib/mongo/操作/list_collections/result.rb' は、43 行

デフォルト cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : スーパー
end

ドキュメント 数 : 配列[BSON::Document]<BSON::Document>

listCollections の結果のドキュメントを取得します。 これは 'firstBatch'

field in the 'cursor' field of the first document returned.

例:

ドキュメントを取得します。

result.documents

次の値を返します。

  • （配列<BSON::Document> ） —

    ドキュメント。

以来

  • 2.0.0



70
71
72
 
# ファイル 'lib/mongo/操作/list_collections/result.rb' は、70 行

デフォルト ドキュメント
  cursor_document[最初の_バッチ]
end

#名前空間= string

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

カーソルの名前空間を取得します。

例:

名前空間を取得します。

result.namespace

次の値を返します。

  • ( string ) —

    名前空間。

以来

  • 2.0.0



56
57
58
 
# ファイル 'lib/mongo/操作/list_collections/result.rb' は、56 行

デフォルト namespace
  cursor_document ? cursor_document[名前空間] : スーパー
end

#validate! ⇒ Result

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

結果を検証します。 権限のないクライアントが コマンドを実行しようとした場合は、適切なエラーを生成する必要があります。

例:

結果を検証します。

result.validate!

次の値を返します。

  • （結果） —

    成功した場合はセルフ。

以来

  • 2.0.0



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# ファイル 'lib/mongo/操作/list_collections/result.rb' は、84 行

デフォルト validate!
  場合 成功した場合
    自己
  else
    発生 operation_failure_Class.新着情報(
      parser.メッセージ,
      自己,
      コード: parser.コード,
      Code_name: parser.Code_name,
      labels parser.labels,
      wtimeout: parser.wtimeout,
      ドキュメント: parser.ドキュメント,
      server_message: parser.server_message,
    )
  end
end