クラス: Mongoid::Criteria::Queryable::Options

継承:
Smash
  • オブジェクト
すべて表示
定義:
lib/mongoid/criteria/queryable/options.rb

Overview

オプションは、スキップ、制限、ソート条件など、MongoDB クエリに渡されるオプションのハッシュ表現です。

インスタンス属性の概要

Smashから継承された属性

#allased_asし、 、 #エイリアス、 #エイリアス エイリアス。 、 の関連付け、の関連付け、 #serializer 、 #serializer シリアライザー。

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

Smashから継承されたメソッド

#[] 、# initialize

コンストラクターの詳細

このクラスは、 Mongoid::Criteria::Queryable::Smashからコンストラクターを継承します。

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

#__deep_copy__ ⇒ Options

オプションの詳細なコピーを実行します。

例:

ディープ コピー を実行します。

options.__deep_copy__

次の値を返します。



87
88
89
90
91
92
93
 
# ファイル 'lib/mongoid/criteria/queryable/options.rb' は、 87行を

デフォルト __deep_ copy__
  自己.クラス.新着情報(aliases, シリアライザー, 関連付け, alased_ associateds) 行う |copy|
    each_pair 行う |キー, 価値|
      copy.mergeします。(キー => 価値.__deep_ copy__)
    end
  end
end

フィールド=ハッシュ

フィールド オプションを取得するための便利なメソッド。

例:

フィールド オプションを取得します。

options.fields

次の値を返します。

  • （ハッシュ） —

    フィールド オプション。



18
19
20
 
# ファイル 'lib/mongoid/criteria/queryable/options.rb' は、 18行を

デフォルト フィールド
  自己[:fields]
end

#limit ⇒ Integer

制限オプションを取得するための便利なメソッドです。

例:

制限オプションを取得します。

options.limit

次の値を返します。

  • (整数) —

    制限オプション。



28
29
30
 
# ファイル 'lib/mongoid/criteria/queryable/options.rb' は、 28行を

デフォルト limit
  自己[:limit]
end

#skip ⇒ Integer

スキップ オプションを取得するための便利なメソッドです。

例:

skip オプションを取得します。

options.skip

次の値を返します。

  • (整数) —

    スキップ オプション。



38
39
40
 
# ファイル 'lib/mongoid/criteria/queryable/options.rb' は、 38行を

デフォルト スキップ
  自己[:skip]
end

#sort ⇒ Hash

ソートオプションを取得するための便利なメソッドです。

例:

ソートオプションを取得します。

options.sort

次の値を返します。

  • （ハッシュ） —

    並べ替えオプション。



48
49
50
 
# ファイル 'lib/mongoid/criteria/queryable/options.rb' は、 48行を

デフォルト sort
  自己[:sort]
end

#store （ キー、値、localize =true）=true）==true=true=true ===========================================================================================

指定されたキーのオプションに値を保存します。 このステップでは、オプションは必要な直列化とローカライズをすべて処理します。

例:

オプションに値を保存します。

options.store(:key, "testing")

パラメーター:

  • キー ( string | Symbol ) —

    属性の名前。

  • 価値 （オブジェクト） —

    追加する値。

次の値を返します。

  • （オブジェクト） —

    保存されたオブジェクト。



62
63
64
 
# ファイル 'lib/mongoid/criteria/queryable/options.rb' は、 62行を

デフォルト store(キー, 価値, localize = true)
  スーパー(キー, 量用(価値, localize))
end

#to_pipeline ⇒ Array<Hash>

オプションを 集計パイプラインに適したオプション に変換します。

例:

オプションをパイプラインに変換する。

options.to_pipeline

次の値を返します。

  • （ <Hash>配列 ） —

    パイプライン形式のオプション。



73
74
75
76
77
78
79
 
# ファイル 'lib/mongoid/criteria/queryable/options.rb' は、 73行を

デフォルト to_ pipeline
  パイプライン = []
  パイプライン.プッシュ({ " $skip " => スキップ }) 場合 スキップ
  パイプライン.プッシュ({ " $limit " => limit }) 場合 limit
  パイプライン.プッシュ({ " $sort " => sort }) 場合 sort
  パイプライン
end