クラス: Mongo::Operation::Aggregate::Result

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

Overview

集計コンテキストで結果のカスタム動作を定義します。

以来

  • 2.0.0

定数の概要の削減

EXPLAIN =

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

集計説明情報のフィールド名。

以来

  • 2.0.5

'ステージ'.freeze
EXPLAIN_LEGACY =

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

集計説明情報のレガシーフィールド名。

以来

  • 2.0.5

' serverパイプライン'.freeze

結果から継承される定数

結果::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 、 #namespace 、 #ok? 、 #operation_time 、# reply 、#returned_count 、 #snapshot_timestamp 、#成功し たかどうか 、 トポロジー_バージョン 、検証し ます。 、 #write_concern_error 、 #Written_count

コンストラクターの詳細

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

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

#cursor_id ⇒ Integer

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

注：

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

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

例:

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

result.cursor_id

次の値を返します。

  • (整数) —

    カーソル ID。

以来

  • 2.0.0



54
55
56
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/operation/aggregate/result.rb', 行54

デフォルト cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : 0
end

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

集計結果のドキュメントを取得します。 これは、最初のドキュメントの「結果」フィールドであるか、カーソル オプションが選択されている場合は、返された最初のドキュメントの「カーソル」フィールドの「firstBatch」フィールドです。 それ以外の場合は、explain ドキュメントです。

例:

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

result.documents

次の値を返します。

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

    ドキュメント。

以来

  • 2.0.0



79
80
81
82
83
84
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/operation/aggregate/result.rb', 行79

デフォルト ドキュメント
  docs = 応答.ドキュメント[0][結果]
  docs ||= cursor_document[最初の_バッチ] 場合 cursor_document
  docs ||= explain_document
  docs
end

# post_batch_resume_token 詳しくは、 BSON ::Document | nil

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

結果のバッチ書込み再開トークンを取得する

次の値を返します。

  • (BSON::Document | nil) —

    書き込みバッチ再開トークン

以来

  • 2.0.0



63
64
65
 
ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/operation/aggregate/result.rb', 行63

デフォルト post_batch_resume_token
  cursor_document ? cursor_document['postBatchResumeToken'] : nil
end