モジュール: Mongo::Collection::View::Readable

次のドキュメントに含まれます。: Mongo::Collection::View

定義:: build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb

Overview

コレクションビューの読み取り関連の動作を定義します。

以来

2.0.0

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

#集計（パイプライン、オプション = {}） = 集計

コレクションビューで集計を実行します。
# allow_disk_use = を表示

サーバーが検索操作を実行中に一時データをディスクに書き込むことを許可します。
# allow_Partial_results = を表示

一部のシャードがダウンした場合にクエリで部分的な結果を得ることができます。
#await_data = を表示

クエリのカーソルを開いたままデータを待つように指示します。
# batch_size (batch_size = nil) = 整数、ビュー

MongoDB からの結果の各バッチで返されたドキュメントの数。
#コメント（コメント=nil）=string, ビュー

クエリにコメントを関連付けます。
カウント（opts = {{}) = 整数非推奨
非推奨。
代わりに、#count_documents または #estimated_document_count_count を使用してください。ただし、#count_documents に切り替えるときに次の演算子を置き換える必要があることに注意してください。
```
* $where should be replaced with $expr (only works on 3.6+)
* $near should be replaced with $geoWithin with $center
* $nearSphere should be replaced with $geoWithin with $centerSphere
```
count_documents (opts = {}) = 整数

コレクション内の一致するドキュメントの数を取得します。
# cursor_type （type =nil）=:tailable, ...

使用するカーソルの型。
distinct （field_name, opts = {{}）= Array=========================================<Object>

特定のフィールドの個別の値のリストを取得します。
#estimate_document_count (ops = {}) = 整数

コレクションメタデータを使用して、コレクション内のドキュメント数の推定値を取得します。
#hint(hint = nil) ⇒ Hash, View

MongoDB がクエリに使用するように強制するインデックス。
#limit(limit = nil) ⇒ Integer, View

クエリから返されるDocsの最大数。
# map_reduce （map, reduce, options={{}）= MapReduce

コレクションビューで map-reduce 操作を実行します。
#max_await_time_ms (max = nil) = 整数、ビュー

カーソルに対する操作数を増やすための累積時間制限（ミリ秒単位）。
# max_scan （値 = nil） = 整数、ビュー非推奨 非推奨。

MongoDB サーバーバージョン4.0以降、このオプションは非推奨です。
# max_time_ms (max = nil) = 整数、ビュー

カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。
# max_value (value = nil) = ハッシュ、ビュー

検索する最大値を設定します。
# min_value (value = nil) = ハッシュ、ビュー

検索する最小値を設定します。
#modifiers(doc = nil) ⇒ Hash, View

引数なしまたは nil 引数を指定して呼び出すと、は現在のビューのレガシー（OP_QUERY）サーバー修飾子を返します。
#no_cursor_timeout ⇒ View

サーバーは通常、非アクティブな期間（ 10分）の後にアイドルカーソルをタイムアウトして、過剰なメモリの使用を防ぎます。
#プロジェクション（ドキュメント = nil）= ハッシュ、ビュー

結果セット内の各ドキュメントに含める、または除外するフィールド。
#read (value = nil) = シンボル、ビュー

クエリに使用する読み込み設定（read preference）。
#read_concern =オブジェクト private
# read_preference =オブジェクト private
# return_key (値 = nil) = true, ...

インデックス付きフィールドのみを返すかどうかを設定します。
# show_disk_loc （値 = nil）=true, ... （#show_record_id）

各ドキュメントのディスク場所を表示するかどうかを設定します。
# skip (number = nil) = 整数、ビュー

結果を返す前にスキップするDocsの数。
#スナップショット(値 = nil) = オブジェクト非推奨 非推奨。

MongoDB サーバーバージョン4.0以降、このオプションは非推奨です。
#sort (spec = nil) = ハッシュ、ビュー

結果セットがソートされるキーと方向のペア。

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

#集計（パイプライン、オプション = {}） =`集計`

コレクションビューで集計を実行します。

例:

ドキュメントを集計します。

view.aggregate([
  { "$group" => { "_id" => "$city", "tpop" => { "$sum" => "$pop" }}}
])

パラメーター:

パイプライン（ <Hash>配列） —

集計パイプライン。
options （ハッシュ） （デフォルトは{}です） —

集計オプション。

オプションハッシュ（ options ）:

:allow_disk_use （ true 、 false ） —

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

バッチするごとに返すドキュメントの数。
:bypass_document_validation （ true 、 false ） —

ドキュメントレベルの検証をスキップするかどうか。
:collation （ハッシュ） —

使用する照合。
:comment （オブジェクト） —

このコマンドに添付するユーザー指定のコメント。
:hint （ string ） —

集計に使用するインデックス。
:let （ハッシュ） —

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

集計の実行を許可する最大時間（ミリ秒単位）。
:use_cursor （ true 、 false ） —

コマンドがカーソルを使用してサーバーに結果の提供をリクエストするかどうかを示します。サーバーバージョン3.6以降、集計では常にカーソルを使用して結果が提供され、このオプションは有効ではないことに注意してください。
:session （セッション） —

使用するセッション。

次の値を返します。

（集計） —

集計オブジェクト。

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行60

デフォルト 集計(パイプライン, options = {})
  options = @options.merge(options) ただし、 mongo.broken_view_options
  集計 = 集計.新着情報(自己, パイプライン, options)

  # で、$merge と $out パイプライン ステージはドキュメントを
  # コレクションでは、実行時にキャッシュをクリアする必要があります。
  #
  1 つの名前空間ではなくキャッシュ全体をクリアするオプションは次のとおりです:
  $out ステージと $merge ステージは同じ名前空間に書き込む必要はありません
  集計が実行される#。
  クエリ キャッシュ.クリア 場合 集計.書込み (write)?

  集計
end

# allow_disk_use = を`表示`

サーバーが検索操作を実行中に一時データをディスクに書き込むことを許可します。

次の値を返します。

（ビュー） —

新しいビュー。

以来

2.0.0



79
80
81

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行79

デフォルト allow_disk_use
  構成する(:allow_disk_use, true)
end

# allow_Partial_results = を`表示`

一部のシャードがダウンした場合にクエリで部分的な結果を得ることができます。

例:

部分的な結果を許可します。

view.allow_partial_results

次の値を返します。

（ビュー） —

新しいビュー。

以来

2.0.0



91
92
93

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行91

デフォルト allow_ partial_results
  構成する(:allow_ partial_results, true)
end

#await_data = を`表示`

クエリのカーソルを開いたままデータを待つように指示します。

例:

カーソル上のデータを待機します。

view.await_data

次の値を返します。

（ビュー） —

新しいビュー。

以来

2.0.0



103
104
105

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行103

デフォルト await_data
  構成する(:await_data, true)
end

# batch_size (batch_size = nil) =`整数`、`ビュー`

注：

1または負の数を指定することは、制限を設定することと同様です。

MongoDB からの結果の各バッチで返されたドキュメントの数。

例:

バッチサイズを設定します。

view.batch_size(5)

パラメーター:

batch_size （整数） （デフォルトはnil ） —

結果の各バッチのサイズ。

次の値を返します。

（整数、表示） —

batch_size 値または新しいViewのいずれか。

以来

2.0.0



120
121
122

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行120

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

#コメント（コメント=nil）= `string` 、`ビュー`

注：

profilingLevel を2に設定すると、クエリとともにコメントがプロファイルコレクションに記録されます。

クエリにコメントを関連付けます。

例:

コメントを追加します。

view.comment('slow query')

パラメーター:

comment （オブジェクト） （デフォルトはnil ） —

クエリに関連付けるコメント。

次の値を返します。

（ string 、ビュー） —

コメントまたは新しいViewのいずれか。

以来

2.0.0



138
139
140

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行138

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

カウント（opts = {{}) =`整数`

非推奨。

代わりに、#count_documents または #estimated_document_count_count を使用してください。ただし、#count_documents に切り替えるときに次の演算子を置き換える必要があることに注意してください。

* $where should be replaced with $expr (only works on 3.6+)
* $near should be replaced with $geoWithin with $center
* $nearSphere should be replaced with $geoWithin with $centerSphere

コレクション内の一致するドキュメントの数を取得します。

例:

コレクション内のドキュメントの数を取得します。

collection_view.count

パラメーター:

ops （ハッシュ） （デフォルトは{}です） —

操作のオプション。

オプションハッシュ（ opts ）:

:skip （整数） —

スキップするドキュメントの数。
:hint （ハッシュ） —

デフォルトのインデックス選択を上書きし、MongoDB がクエリに特定のインデックスを使用するように強制します。
:limit （整数） —

カウントするDocsの最大数。
:max_time_ms （整数） —

コマンドの実行を許可する最大時間。
:read （ハッシュ） —

読み込み設定（read preference）オプション。
:collation （ハッシュ） —

使用する照合。
:session （ Mongo::Session ） —

操作に使用するセッション。
:comment （オブジェクト） —

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

次の値を返します。

(整数) —

ドキュメント数。

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行170

デフォルト count(ops = {})
  ops = @options.merge(ops) ただし、 mongo.broken_view_options
  cmd = { :count => コレクション.name, : クエリ => フィルター }
  cmd[:skip] = ops[:skip] 場合 ops[:skip]
  cmd[:hint] = ops[:hint] 場合 ops[:hint]
  cmd[:limit] = ops[:limit] 場合 ops[:limit]
  場合 read_concern
    cmd[:readConcern] = オプション::マッパー.transform_values_to_strings(
      read_concern)
  end
  cmd[:maxTimeMS] = ops[:max_time_ms] 場合 ops[:max_time_ms]
  mongo::Lint.validate_userscore_read_preference(ops[:read])
  read_pref = ops[:read] || read_preference
  セレクター = ServerSelector.得る(read_pref || server_selector)
  with_session(ops) 行う |セッション|
    read_with_retry(セッション, セレクター) 行う |サーバー|
      操作::数.新着情報(
        セレクター: cmd,
        db_name: database.name,
        次のオプションがあります。 {:limit => -1},
        read: read_pref,
        セッション: セッション,
        # 何らかの理由で照合は歴史的に として受け入れられました
        # string キー。 これは有効な使用として文書化されていないことに注意してください。
        collation: ops[:collation] || ops[「照合」] || collation,
        comment: ops[:comment],
      ).実行する(サーバー, context: 操作::Context.新着情報(クライアント: クライアント, セッション: セッション))
    end.n.to_i
  end
end

count_documents (opts = {}) =`整数`

コレクション内の一致するドキュメントの数を取得します。

例:

コレクション内のドキュメントの数を取得します。

collection_view.count

パラメーター:

ops （ハッシュ） （デフォルトは{}です） —

操作のオプション。
ops （ハッシュ） —

カスタマイズ可能なオプションのセット

オプションハッシュ（ opts ）:

:skip （整数） —

スキップするドキュメントの数。
:hint （ハッシュ） —

デフォルトのインデックス選択を上書きし、MongoDB がクエリに特定のインデックスを使用するように強制します。サーバーバージョン3.6 + が必要です。
:limit （整数） —

カウントするDocsの最大数。
:max_time_ms （整数） —

コマンドの実行を許可する最大時間。
:read （ハッシュ） —

読み込み設定（read preference）オプション。
:collation （ハッシュ） —

使用する照合。
:session （ Mongo::Session ） —

操作に使用するセッション。

次の値を返します。

(整数) —

ドキュメント数。

以来

2.6.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行223

デフォルト count_documents(ops = {})
  ops = @options.merge(ops) ただし、 mongo.broken_view_options
  パイプライン = [:'$match' => フィルター]
  パイプライン < { :'$skip' => ops[:skip] } 場合 ops[:skip]
  パイプライン < { :'$limit' => ops[:limit] } 場合 ops[:limit]
  パイプライン < { :'$group' => { _id: 1, n: { :'$sum' => 1 } } }

  ops = ops.スライス(:hint, :max_time_ms, :read, :collation, :session, :comment)
  ops[:collation] ||= collation

  最初に = 集計(パイプライン, ops).最初に
  return 0 ただし、 最初に
  最初に['n'].to_i
end

# cursor_type （type =nil）= `:tailable` 、...

使用するカーソルの型。 :tailable または :tailable_await になります。

例:

カーソルの種類を設定します。

view.cursor_type(:tailable)

パラメーター:

タイプ（ :tailable 、 :tailable_await ） （デフォルトはnil ） —

カーソルの種類。

次の値を返します。

（ :tailable 、 :tailable_await 、ビュー） —

カーソルタイプ設定または新しいView 。

以来

2.3.0



626
627
628

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行626

デフォルト cursor_type(タイプ = nil)
  構成する(: cursor_type, タイプ)
end

distinct （field_name, opts = {{}）= `Array =========================================<Object>`

特定のフィールドの個別の値のリストを取得します。

例:

個別の値を取得します。

collection_view.distinct('name')

パラメーター:

field_name ( string 、 Symbol ) —

フィールドの名前。
ops （ハッシュ） （デフォルトは{}です） —

個別のコマンドのオプション。
options （ハッシュ） —

カスタマイズ可能なオプションのセット

オプションハッシュ（ opts ）:

:max_time_ms （整数） —

コマンドの実行を許可する最大時間。
:read （ハッシュ） —

読み込み設定（read preference）オプション。
:collation （ハッシュ） —

使用する照合。

次の値を返します。

（配列<Object> ） —

個別の値のリスト。

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行317

デフォルト distinct(field_name, ops = {})
  場合 field_name.nil?
    発生 ArgumentError, '個別の操作のフィールド名は nil 以外である必要があります'
  end
  ops = @options.merge(ops) ただし、 mongo.broken_view_options
  cmd = { : distinct => コレクション.name,
          :key => field_name.to_s,
          : クエリ => フィルター, }
  cmd[:maxTimeMS] = ops[:max_time_ms] 場合 ops[:max_time_ms]
  場合 read_concern
    cmd[:readConcern] = オプション::マッパー.transform_values_to_strings(
      read_concern)
  end
  mongo::Lint.validate_userscore_read_preference(ops[:read])
  read_pref = ops[:read] || read_preference
  セレクター = ServerSelector.得る(read_pref || server_selector)
  with_session(ops) 行う |セッション|
    read_with_retry(セッション, セレクター) 行う |サーバー|
      操作::distinct.新着情報(
        セレクター: cmd,
        db_name: database.name,
        次のオプションがあります。 {:limit => -1},
        read: read_pref,
        セッション: セッション,
        comment: ops[:comment],
        # 何らかの理由で照合は歴史的に として受け入れられました
        # string キー。 これは有効な使用として文書化されていないことに注意してください。
        collation: ops[:collation] || ops[「照合」] || collation,
      ).実行する(サーバー, context: 操作::Context.新着情報(クライアント: クライアント, セッション: セッション))
    end.最初に['values']
  end
end

#estimate_document_count (ops = {}) =`整数`

コレクションメタデータを使用して、コレクション内のドキュメント数の推定値を取得します。

例:

コレクション内のドキュメントの数を取得します。

collection_view.estimated_document_count

パラメーター:

ops （ハッシュ） （デフォルトは{}です） —

操作のオプション。

オプションハッシュ（ opts ）:

:max_time_ms （整数） —

コマンドの実行を許可する最大時間。
:read （ハッシュ） —

読み込み設定（read preference）オプション。
:comment （オブジェクト） —

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

次の値を返します。

(整数) —

ドキュメント数。

以来

2.6.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行254

デフォルト Estimated_document_count(ops = {})
  ただし、 表示.フィルター.空の場合
    発生 ArgumentError, "フィルターを使用してクエリを実行すると、estimate_document_count を呼び出せません"
  end

  %i[limit スキップ].各 行う |opt|
    場合 options.key?(opt) || ops.key?(opt)
      発生 ArgumentError, 「 #{ opt } を使用してクエリを実行すると、estimate_document_count を呼び出せません 」
    end
  end

  ops = @options.merge(ops) ただし、 mongo.broken_view_options
  mongo::Lint.validate_userscore_read_preference(ops[:read])
  read_pref = ops[:read] || read_preference
  セレクター = ServerSelector.得る(read_pref || server_selector)
  with_session(ops) 行う |セッション|
    read_with_retry(セッション, セレクター) 行う |サーバー|
      context = 操作::Context.新着情報(クライアント: クライアント, セッション: セッション)
      cmd = { count: コレクション.name }
      cmd[:maxTimeMS] = ops[:max_time_ms] 場合 ops[:max_time_ms]
      場合 read_concern
        cmd[:readConcern] = オプション::マッパー.transform_values_to_strings(read_concern)
      end
      結果 = 操作::数.新着情報(
        セレクター: cmd,
        db_name: database.name,
        read: read_pref,
        セッション: セッション,
        comment: ops[:comment],
      ).実行する(サーバー, context: context)
      結果.n.to_i
    end
  end
ヘルプ エラー::OperationFailure => 除外
  場合 除外.コード == 26
    # NamespaceNotFound
    # これは、集計パイプライン パスでのみ発生します
    #（サーバー4.9 +）。 以前のサーバーでは存在しない場合に対して0が返される必要があります。
    # コレクション。
    0
  else
    発生
  end
end

#hint(hint = nil) ⇒ `Hash`, `View`

MongoDB がクエリに使用するように強制するインデックス。

例:

インデックスヒントを設定します。

view.hint(name: 1)

パラメーター:

hint （ハッシュ） （デフォルトはnil ） —

クエリに使用するインデックス。

次の値を返します。

（ハッシュ、ビュー） —

ヒントまたは新しいViewのいずれか。

以来

2.0.0



360
361
362

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行360

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

#limit(limit = nil) ⇒ `Integer`, `View`

クエリから返されるDocsの最大数。

例:

制限を設定します。

view.limit(5)

パラメーター:

limit （整数） （デフォルトはnil ） —

返されるDocsの数。

次の値を返します。

（整数、表示） —

制限または新しいViewのいずれか。

以来

2.0.0



374
375
376

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行374

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

# map_reduce （map, reduce, options={{}）= `MapReduce`

コレクションビューで map-reduce 操作を実行します。

例:

map-reduce を実行します。

view.map_reduce(map, reduce)

パラメーター:

map ( string ) —

map JavaScript関数。
reduce ( string ) —

reduce JavaScript関数。
options （ハッシュ） （デフォルトは{}です） —

map/reduce オプション。

次の値を返します。

（ MapReduce ） —

map reduce ラッパー。

以来

2.0.0



390
391
392

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行390

デフォルト map_reduce(map, reduce, options = {})
  mapReduce.新着情報(自己, map, reduce, @options.merge(options))
end

#max_await_time_ms (max = nil) =`整数`、`ビュー`

カーソルに対する操作数を増やすための累積時間制限（ミリ秒単位）。

例:

max await time ms 値を設定します。

view.max_await_time_ms(500)

パラメーター:

最大（整数） （デフォルトはnil ） —

ミリ秒単位の最大時間。

次の値を返します。

（整数、表示） —

max await time ミリ秒の値または新しいViewのいずれか。

以来

2.1.0



598
599
600

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行598

デフォルト max_await_time_ms(最大 = nil)
  構成する(:max_await_time_ms, 最大)
end

# max_scan （値 = nil） =`整数`、`ビュー`

非推奨。

MongoDB サーバーバージョン4.0以降、このオプションは非推奨です。

スキャンするドキュメントの最大数を設定します。

例:

最大スキャン値を設定します。

view.max_scan(1000)

パラメーター:

価値（整数） （デフォルトはnil ） —

スキャンする最大数。

次の値を返します。

（整数、表示） —

値または新しいView 。

以来

2.0.0



407
408
409

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行407

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

# max_time_ms (max = nil) =`整数`、`ビュー`

カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。

例:

max 時間ミリ秒の値を設定します。

view.max_time_ms(500)

パラメーター:

最大（整数） （デフォルトはnil ） —

ミリ秒単位の最大時間。

次の値を返します。

（整数、表示） —

max 時間ミリ秒の値または新しいViewのいずれか。

以来

2.1.0



612
613
614

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行612

デフォルト max_time_ms(最大 = nil)
  構成する(:max_time_ms, 最大)
end

# max_value (value = nil) =`ハッシュ`、`ビュー`

検索する最大値を設定します。

例:

最大値を設定します。

view.max_value(_id: 1)

パラメーター:

価値（ハッシュ） （デフォルトはnil ） —

の最大フィールドと値。

次の値を返します。

（ハッシュ、ビュー） —

値または新しいView 。

以来

2.1.0



421
422
423

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行421

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

# min_value (value = nil) =`ハッシュ`、`ビュー`

検索する最小値を設定します。

例:

最小値を設定します。

view.min_value(_id: 1)

パラメーター:

価値（ハッシュ） （デフォルトはnil ） —

最小フィールドと値。

次の値を返します。

（ハッシュ、ビュー） —

値または新しいView 。

以来

2.1.0



435
436
437

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行435

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

#modifiers(doc = nil) ⇒ `Hash`, `View`

引数なしまたは nil 引数を指定して呼び出すと、は現在のビューのレガシー（OP_QUERY）サーバー修飾子を返します。ハッシュまたはサブクラスである必要がある nil 以外の引数で呼び出された場合、は指定された修飾子を現在のビューにマージします。入力ハッシュではstringキーとシンボルキーの両方が許可されます。

例:

Set the modifiers document.

view.modifiers(:$orderby => Mongo::Index::ASCENDING)

パラメーター:

doc （ハッシュ） （デフォルトはnil ） —

The modifiers document.

次の値を返します。

（ハッシュ、ビュー） —

修飾子ドキュメントまたは新しいView 。

以来

2.1.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行579

デフォルト modifiers(doc = nil)
  場合 doc.nil?
    操作::find::ビルダ::Modifiers.map_server_modifiers(options)
  else
    新着情報(options.merge(操作::find::ビルダ::Modifiers.map_Driver_options(BSON::ドキュメント.新着情報(doc))))
  end
end

#no_cursor_timeout ⇒ `View`

サーバーは通常、非アクティブな期間（ 10分）の後にアイドルカーソルをタイムアウトして、過剰なメモリの使用を防ぎます。それを防ぐには、このオプションをに設定します。

例:

カーソルをタイムアウトしないように設定します。

view.no_cursor_timeout

次の値を返します。

（ビュー） —

新しいビュー。

以来

2.0.0



448
449
450

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行448

デフォルト no_cursor_timeout
  構成する(:no_cursor_timeout, true)
end

#プロジェクション（ドキュメント = nil）=`ハッシュ`、`ビュー`

注：

0の値は、ドキュメントからフィールドを除外します。 1の値にはそれが含まれます。値は、 _id 値を除き、すべて0またはすべての1である必要があります。 _id フィールドはデフォルトで含まれます。明示的に除外する必要があります。

結果セット内の各ドキュメントに含める、または除外するフィールド。

例:

含めるフィールドまたは除外するフィールドを設定します。

view.projection(name: 1)

パラメーター:

ドキュメント（ハッシュ） （デフォルトはnil ） —

フィールドと1または0を含めるまたは除外します。

次の値を返します。

（ハッシュ、ビュー） —

フィールドまたは新しいViewのいずれか。

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行466

デフォルト プロジェクション(ドキュメント = nil)
  validate_doc!(ドキュメント) 場合 ドキュメント
  構成する(:プロジェクション, ドキュメント)
end

#read (value = nil) =`シンボル`、`ビュー`

注：

クエリにが指定されていない場合は、コレクションの読み込み設定（read preference）が使用されます。

クエリに使用する読み込み設定（read preference）。

パラメーター:

価値（ハッシュ） （デフォルトはnil ） —

クエリに使用する読み込み設定（read preference）モード

次の値を返します。

（シンボル、ビュー） —

読み込み設定（read preference）または新しいViewのいずれか。

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行482

デフォルト 読み取り(価値 = nil)
  return read_preference 場合 価値.nil?
  構成する(:read, 価値)
end

#read_concern =`オブジェクト`

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

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行631

デフォルト read_concern
  場合 options[:session] & & options[:session].in_transaction?
    options[:session].送信(:txn_read_concern) || コレクション.クライアント.read_concern
  else
    コレクション.read_concern
  end
end

# read_preference =`オブジェクト`

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行640

デフォルト read_preference
  @read_preference ||= begin
    # 操作の読み込み設定（read preference）は常に尊重され、次の要素が含まれます:
    優先順位 。 トランザクション内では、次が必要になります。
    # トランザクションの読み込み設定（read preference）とデフォルトのクライアントを無視する
    コレクションの読み込み設定 (read preference)。 トランザクションにない場合は、
    クライアントにデフォルト設定されている読み込み設定 (read preference) を参照してください。
    rp = 場合 options[:read]
      options[:read]
    elsif options[:session] & & options[:session].in_transaction?
      options[:session].txn_read_preference || コレクション.クライアント.read_preference
    else
      コレクション.read_preference
    end
    Lint.validate_userscore_read_preference(rp)
    rp
  end
end

# return_key (値 = nil) = `true` , ...

インデックス付きフィールドのみを返すかどうかを設定します。

例:

戻り値の設定。

view.return_key(true)

パラメーター:

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

キー値を返します。

次の値を返します。

（ true 、 false 、ビュー） —

値または新しいView 。

以来

2.1.0



497
498
499

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行497

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

# show_disk_loc （値 = nil） = `true` 、... とも呼ばれます: show_record_id

各ドキュメントのディスク場所を表示するかどうかを設定します。

例:

ディスクロケーションの表示オプションを設定します。

view.show_disk_loc(true)

パラメーター:

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

フィールドの値。

次の値を返します。

（ true 、 false 、ビュー） —

値または新しいViewのいずれか。

以来

2.0.0



512
513
514

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行512

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

# skip (number = nil) =`整数`、`ビュー`

結果を返す前にスキップするDocsの数。

例:

スキップする数を設定します。

view.skip(10)

パラメーター:

数値（整数） （デフォルトはnil ） —

スキップするDocsの数。

次の値を返します。

（整数、表示） —

スキップ値または新しいViewのいずれか。

以来

2.0.0



528
529
530

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行528

デフォルト スキップ(数値 = nil)
  構成する(:skip, 数値)
end

#スナップショット(値 = nil) =`オブジェクト`

非推奨。

MongoDB サーバーバージョン4.0以降、このオプションは非推奨です。

注：

true に設定されている場合、はドキュメントを複数回返すことを防止します。

ビューのスナップショット値を設定します。

例:

スナップショット値を設定します。

view.snapshot(true)

パラメーター:

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

スナップショットの値。

以来

2.0.0



546
547
548

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行546

デフォルト スナップショット(価値 = nil)
  構成する(:snapshot, 価値)
end

#sort (spec = nil) =`ハッシュ`、`ビュー`

結果セットがソートされるキーと方向のペア。

例:

並べ替え条件の設定

view.sort(name: -1)

パラメーター:

スペック（ハッシュ） （デフォルトはnil ） —

並べ替える属性と方向。

次の値を返します。

（ハッシュ、ビュー） —

並べ替え設定または新しいViewのいずれか。

以来

2.0.0



561
562
563

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/collection/view/readable.rb', 行561

デフォルト sort(スペック = nil)
  構成する(:sort, スペック)
end

モジュール: Mongo::Collection::View::Readable

Overview

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

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

#集計（パイプライン、オプション = {}） =集計

# allow_disk_use = を表示

# allow_Partial_results = を表示

#await_data = を表示

# batch_size (batch_size = nil) =整数、ビュー

#コメント（コメント=nil）= string 、ビュー

カウント（opts = {{}) =整数

count_documents (opts = {}) =整数

# cursor_type （type =nil）= :tailable 、...

distinct （field_name, opts = {{}）= Array =========================================<Object>

#estimate_document_count (ops = {}) =整数

#hint(hint = nil) ⇒ Hash, View

#limit(limit = nil) ⇒ Integer, View

# map_reduce （map, reduce, options={{}）= MapReduce

#max_await_time_ms (max = nil) =整数、ビュー

# max_scan （値 = nil） =整数、ビュー

# max_time_ms (max = nil) =整数、ビュー

# max_value (value = nil) =ハッシュ、ビュー

# min_value (value = nil) =ハッシュ、ビュー

#modifiers(doc = nil) ⇒ Hash, View

#no_cursor_timeout ⇒ View

#プロジェクション（ドキュメント = nil）=ハッシュ、ビュー

#read (value = nil) =シンボル、ビュー

#read_concern =オブジェクト

# read_preference =オブジェクト

# return_key (値 = nil) = true , ...

# show_disk_loc （値 = nil） = true 、... とも呼ばれます: show_record_id

# skip (number = nil) =整数、ビュー

#スナップショット(値 = nil) =オブジェクト

#sort (spec = nil) =ハッシュ、ビュー

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

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

#集計（パイプライン、オプション = {}） =`集計`

# allow_disk_use = を`表示`

# allow_Partial_results = を`表示`

#await_data = を`表示`

# batch_size (batch_size = nil) =`整数`、`ビュー`

#コメント（コメント=nil）= `string` 、`ビュー`

カウント（opts = {{}) =`整数`

count_documents (opts = {}) =`整数`

# cursor_type （type =nil）= `:tailable` 、...

distinct （field_name, opts = {{}）= `Array =========================================<Object>`

#estimate_document_count (ops = {}) =`整数`

#hint(hint = nil) ⇒ `Hash`, `View`

#limit(limit = nil) ⇒ `Integer`, `View`

# map_reduce （map, reduce, options={{}）= `MapReduce`

#max_await_time_ms (max = nil) =`整数`、`ビュー`

# max_scan （値 = nil） =`整数`、`ビュー`

# max_time_ms (max = nil) =`整数`、`ビュー`

# max_value (value = nil) =`ハッシュ`、`ビュー`

# min_value (value = nil) =`ハッシュ`、`ビュー`

#modifiers(doc = nil) ⇒ `Hash`, `View`

#no_cursor_timeout ⇒ `View`

#プロジェクション（ドキュメント = nil）=`ハッシュ`、`ビュー`

#read (value = nil) =`シンボル`、`ビュー`

#read_concern =`オブジェクト`

# read_preference =`オブジェクト`

# return_key (値 = nil) = `true` , ...

# show_disk_loc （値 = nil） = `true` 、... とも呼ばれます: show_record_id

# skip (number = nil) =`整数`、`ビュー`

#スナップショット(値 = nil) =`オブジェクト`

#sort (spec = nil) =`ハッシュ`、`ビュー`