クラス: Mongo::Collection::View::Aggregation

継承:
オブジェクト
  • オブジェクト
すべて表示
次のことが含まれます。
動作
定義:
lib/mongo/コレクション/view/集計.rb
、lib/mongo/コレクション/view/集計/behavior.rb

Overview

コレクション ビューで 集計パイプライン の動作を提供します。

以来

  • 2.0.0

既知のサブクラスを直接確認

ChangeStream

名前空間で定義済み

Modules: 動作

定数の概要

Loggableに含まれる定数

ログ可能::PRFIX

Explainableに含まれる定数

説明可能::ALL_PLANS_EXECUTION説明可能:EXECUTION_STATS説明可能::QUERY_PLANNER

インスタンス属性の概要を折りたたむ

動作に含まれる属性

#view

Mongo::CursorHost から含まれる属性

#cursor, #timeout_mode

不変に含まれる属性

#options

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

動作に含まれるメソッド

#allow_disk_use 、#explain 、#timeout_ms 、#write?

再試行可能な に含まれるメソッド

#read_worker#select_server#write_worker

Loggableに含まれるメソッド

#log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger

Explainableに含まれるメソッド

#explain

イテラブルに含まれるメソッド

#close_query

Mongo::CursorHost に含まれるメソッド

#validate_timeout_mode!

コンストラクターの詳細

#初期化(ビュー、パイプライン、オプション = {}) =集計

指定されたコレクション ビュー、パイプライン、オプションの集計を初期化します。

例:

新しい集計ビューを作成します。

Aggregation.view.new(view, pipeline)

パラメーター:

  • 表示 コレクション::View

    コレクションビュー。

  • パイプライン <Hash>配列 )

    の操作パイプライン。

  • options ハッシュ (デフォルトは{}です)

    集計オプション。

オプション ハッシュ( options ):

  • :allow_disk_use truefalse

    集計中にディスクの使用が許可されている場合は、 を true に設定します。

  • :batch_size 整数

    バッチするごとに返すドキュメントの数。

  • :bypass_document_validation truefalse

    ドキュメント レベルの検証をスキップするかどうか。

  • :collation ハッシュ

    使用する照合。

  • :comment オブジェクト

    このコマンドに添付するユーザー指定のコメント。

  • :hint string

    集計に使用するインデックス。

  • :let ハッシュ

    パイプラインで使用する変数のマッピング。 詳細については、 サーバーのドキュメントを 参照してください。

  • :max_time_ms 整数

    集計の実行を許可する最大時間(ミリ秒単位)。 このオプションは非推奨です。代わりに :timeout_ms を使用してください。

  • :session セッション

    使用するセッション。

  • :timeout_mode :cursor_Lifetime | :iteration

    :timeout_ms の解釈方法(カーソルの有効期間、または反復ごとに適用されるかどうか)。

  • :timeout_ms 整数

    操作のタイムアウト(ミリ秒単位)。 負でない整数である必要があります。 0 の明示的な値は無限を意味します。 デフォルト値が設定されていない場合は、コレクション、データベース、またはクライアントから値が継承されることを意味します。

以来

  • 2.0.0



68
69
70
71
72
73
74
75
# ファイル 'lib/mongo/ コレクション/view/ 集計.rb' は、68 行

デフォルト 初期化(表示, パイプライン, options = {})
  performance_setup(表示, options) 行う
    @ pipeline = パイプライン.dup
    ただし、 mongo.break_view_aggregate || 表示.フィルター.空の場合
      @ pipeline.unshift(:$match => 表示.フィルター)
    end
  end
end

インスタンス属性の詳細

#パイプライン= Array<Hash> (読み取り専用)

パイプライン 集計パイプラインを返します。

次の値を返します。

  • <Hash>配列 )

    pipeline 集計パイプライン。

以来

  • 2.0.0



31
32
33
# ファイル 'lib/mongo/ コレクション/view/ 集計.rb' は、31 行

デフォルト パイプライン
  @ pipeline
end