モジュール: Mongo::Collection::View::Aggregation::動作

次による拡張機能。

転送可能

次のことが含まれます。

列挙可能、説明可能、不変、反復可能 、ログ可能、再試行可能

次のドキュメントに含まれます。

Mongo::Collection::View::Aggregation 、 ChangeStream

定義:

lib/mongo/ コレクション/view/ 集計/behavior.rb

Overview

View::Aggreator や View::changeStream など、集計クラスに一般的な動作を廃止します。

以来

• 2.0.0

定数の概要

Loggableに含まれる定数

ログ可能::PRFIX

Explainableに含まれる定数

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

インスタンス属性の概要を

• #view ⇒ View readOnly

  コレクション ビューを表示します。

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

#cursor, #timeout_mode

不変に含まれる属性

#options

インスタンス メソッドの概要を

• # allow_disk_use (value = nil) ==nil)=true, ...

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

• # explain = ハッシュ

  集計の説明プランを取得します。

• #timeout_ms ⇒ Integer | nil private

  このオブジェクトにオプションとして渡された、または ビューから継承された timeout_ms 値。

• #書込み? = ブール値 private

  この集計がその結果をデータベース コレクションに書き込むかどうか。

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

#read_worker 、 #select_server 、 #write_worker

Loggableに含まれるメソッド

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

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

#close_query 、各

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

#validate_timeout_mode!

インスタンス属性の詳細

#表示=表示(readonly)

コレクション ビューのビューを返します。

次の値を返します。

• （ビュー） —

  view コレクションビュー。

以来

• 2.0.0

# ファイル 'lib/mongo/ コレクション/view/ 集計/behavior.rb' は、19 行を

デフォルト 表示
  @view
end

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

# allow_disk_use (value = nil) = true , ...

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

例:

Set disk usage flag.

aggregation.allow_disk_use(true)

パラメーター:

• 価値 （ true 、 false ） （デフォルトはnil ） —

  フラグの値。

次の値を返します。

• （ true 、 false 、集計） —

  値が設定されている場合は 集計 、または getter として使用されている場合は 値。

以来

• 2.0.0

# ファイル 'lib/mongo/ コレクション/view/ 集計/behavior.rb' は、38 行を

デフォルト allow_disk_use(価値 = nil)
  構成する(:allow_disk_use, 価値)
end

# explain =ハッシュ

集計の説明プランを取得します。

例:

集計の説明プランを取得します。

aggregation.explain

次の値を返します。

• （ハッシュ） —

  説明プラン。

以来

• 2.0.0

# ファイル 'lib/mongo/ コレクション/view/ 集計/behavior.rb' は、50 行を

デフォルト explain
  自己.クラス.新着情報(表示, パイプライン, options.merge(explain: true)).最初に
end

#timeout_ms ⇒ Integer | nil

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

このオブジェクトにオプションとして渡された、または ビューから継承された timeout_ms 値を返します。

次の値を返します。

• (Integer | nil) —

  このオブジェクトにオプションとして渡された timeout_ms 値 、または ビューから継承された timeout_ms 値 。

以来

• 2.0.0

# ファイル 'lib/mongo/ コレクション/view/ 集計/behavior.rb' は、68 行を

デフォルト timeout_ms
  @timeout_ms || 表示.timeout_ms
end

#書込み? =ブール値

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

この集計がその結果をデータベース コレクションに書き込むかどうか。

次の値を返します。

• （ブール値） —

  集計が結果をコレクションに書き込むかどうか。

以来

• 2.0.0

# ファイル 'lib/mongo/ コレクション/view/ 集計/behavior.rb' は、60 行を

デフォルト 書込み (write)?
  パイプライン.any? { |op| op.key?(' $out ') || op.key?(:$out) || op.key?(' $merge ') || op.key?(:$merge) }
end