クラス: Mongo::Operation::Indexes::Result

継承:
結果
  • オブジェクト
すべて表示
定義:
build/ruby-Driver-v 2.19 /lib/mongo/operation/indexs/result.rb

Overview

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

以来

  • 2.0.0

定数の概要

結果から継承される定数

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

インスタンス属性の概要

結果から継承される属性

# connection_description 、 # connection_ global_id 、 # replays

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

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

認証済み 、#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 フィールドがありますが、 listIndexes コマンドを使用する場合は常に 0 であり、カーソル ドキュメント自体から取得する必要があります。

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

例:

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

result.cursor_id

次の値を返します。

  • (整数) —

    カーソル ID。

以来

  • 2.0.0



43
44
45
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/operation/indexs/result.rb', 行43

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

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

listIndexes 結果のドキュメントを取得します。 これは、返された最初のドキュメントの「cursor」フィールドの「firstBatch」フィールドです。

例:

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

result.documents

次の値を返します。

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

    ドキュメント。

以来

  • 2.0.0



70
71
72
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/operation/indexs/result.rb', 行70

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

#名前空間= string

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

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

例:

名前空間を取得します。

result.namespace

次の値を返します。

  • ( string ) —

    名前空間。

以来

  • 2.0.0



56
57
58
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/operation/indexs/result.rb', 行56

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

#validate! ⇒ Result

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

結果を検証します。 データベースまたはコレクションがサーバー上に存在しない場合は、エラーが発生します。エラーが発生した場合は、あいまいな例外を発生させるよりも、意味のある例外を発生させる方が良いです。

例:

結果を検証します。

result.validate!

次の値を返します。

  • （結果） —

    成功した場合はセルフ。

次の値が発生します。

  • (NoNamespace) —

    ns が存在しない場合。

以来

  • 2.0.0



88
89
90
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/operation/indexs/result.rb', 行88

デフォルト validate!
  !成功した場合 ? resume_operation_failure : 自己
end