フィールド型

型なしフィールド

フィールドの型を指定しない場合、Mongoid はそれをデフォルトのObject 型として解釈します。 型指定されていないフィールドには、 BSONに直接シリアル化可能な任意の型の値を保存できます。 フィールドにさまざまなタイプのデータが含まれる可能性がある場合、またはフィールドの値のタイプが不明な場合は、フィールドを型なしで残すことができます。

次の例では、型指定されていないフィールドを持つ Productクラスを定義します。

class Product
  include Mongoid::Document
  field :name, type: String
  field :properties
end

propertiesフィールドのタイプは Object ですが、そのフィールドに保存されているデータのタイプによって異なります。 次の例では、 2 つの異なる方法で propertiesフィールドにデータを保存します。

product = Product.new(properties: "color=white,size=large")
# properties field saved as String: "color=white,size=large"
product = Product.new(properties: {color: "white", size: "large"})
# properties field saved as Object: {:color=>"white", :size=>"large"}

Mongoid はデータベースから読み取るときに型のないフィールドで型の変換を実行しないため、特別な処理を必要とする値は、型なしフィールドの値として では正しく検索されない可能性があります。 次のBSONデータ型は、型なしフィールドに保存しないでください。

• Date: 型なしフィールドで Time として返します

• DateTime: 型なしフィールドで Time として返します

• Range: 型なしフィールドで Hash として返します

ハッシュ

Hash 型を使用して、フィールドに Hash データを保存できます。 フィールドをHash として指定する場合は、値がデータベースに正しく保存されるようにMongoDB の命名制限 に従っていることを確認してください。

次の例では、 Personクラスを作成し、urlフィールドをHash として指定します。

class Person
  include Mongoid::Document
  field :first_name
  field :url, type: Hash
end
person = Person.new(url: {'home_page' => 'http://www.homepage.com'})

時間

Timeフィールド値を使用して、 BSON Time インスタンスとして値を保存できます。 Time フィールドは、アプリケーションに構成されたタイムゾーンに保存されます。 タイム ゾーンの設定の詳細については、 アプリケーション構成ガイドの「 タイム ゾーン構成 」セクションを参照してください。

次の例では、 Voterクラスを作成し、registered_atフィールドの値が Time 型であることを指定します。

class Voter
  include Mongoid::Document
  
  field :registered_at, type: Time
end
  
Voter.new(registered_at: Date.today)

日付

Date として指定されたフィールドには次の値の型を保存できます。

• Date: 指定された値を保存します。

• Time: 値の日付部分を値の タイムゾーンに保存します。

• DateTime: 値の日付部分を値の タイムゾーンに保存します。

• ActiveSupport::TimeWithZone: 値の日付部分を値の タイムゾーンに保存します。

• String: string で指定された日付を保存します。

• Integer: UTC タイムスタンプであるかのように値を受け取り、アプリケーションの設定された タイムゾーンに変換します。 次に、Mongoid はそのタイムスタンプから取得された日付を保存します。

• Float: UTC タイムスタンプであるかのように値を受け取り、アプリケーションの設定された タイムゾーンに変換します。 次に、Mongoid はそのタイムスタンプから取得された日付を保存します。

Time または DateTime を変換すると時間部分が破棄されるため、フィールドに割り当てる前に、String、Time、DateTime オブジェクトを Date に明示的に変換することをお勧めします。

日時

これらのフィールドに対して DateTime または クエリとして定義されたフィールドに値を割り当てると、Mongoid は値を UTC Time 値に変換してからMongoDBサーバーに送信します。 Mongoid は、DateTimeオブジェクトに埋め込まれたタイムゾーンを含む値を保存します。 値を取得すると、Mongoid は UTC 時間をアプリケーションに構成されたタイムゾーンに変換します。

次の例では、 Ticketクラスを作成し、purchased_atフィールドをDateTimeフィールドとして指定します。

class Ticket
  include Mongoid::Document
  field :purchased_at, type: DateTime
end

整数値または浮動小数数値を DateTimeフィールドに保存すると、その値は UTC の Unix タイムスタンプとして扱われます。 次の例では、 purchased_atフィールドに整数値を保存しています。

ticket.purchased_at = 1544803974
ticket.purchased_at
# Outputs: Fri, 14 Dec 2018 16:12:54 +0000

string の値を DateTimeフィールドに保存すると、Mongoid は指定されたタイムゾーンのチケットを保存します。 タイムゾーンが指定されていない場合、Mongoid はアプリケーションのデフォルトとして構成されたタイムゾーン を使用して 値を保存します。

ticket.purchased_at = 'Mar 4, 2018 10:00:00 +01:00'
ticket.purchased_at
# Outputs: Sun, 04 Mar 2018 09:00:00 +0000

タイム ゾーンの設定の詳細については、 アプリケーション構成ガイドの「 タイム ゾーン構成 」セクションを参照してください。

タイムスタンプ

クラスを作成する ときに、Mongoid::Timestamps モジュールを含めることで、クラスにタイムスタンプ フィールドを含めることができます。 Mongoid::Timestamps を含めると、Mongoid はクラスに次のフィールドを作成します。

• created_at:ドキュメントが作成された時刻を保存します。

• updated_at:ドキュメントが最後にアップデートされた時刻を保存します。

次の例では、タイムスタンプ フィールドを持つ Postクラスを作成しています。

class Post
  include Mongoid::Document
  include Mongoid::Timestamps
end

また、Created または Updated モジュールのみを含めることで、created_at フィールドまたは updated_at フィールドのみを含めることもできます。 次の例では、 created_atフィールドのみを含む Postクラスと、updated_atフィールドのみを含む Postクラスを作成します。

class Post
  include Mongoid::Document
  include Mongoid::Timestamps::Created
end
class Post
  include Mongoid::Document
  include Mongoid::Timestamps::Updated
end

モジュールを含めるときに ::Short オプションを設定することで、タイムスタンプフィールド名を c_at と u_at に短縮できます。

class Post
  include Mongoid::Document
  include Mongoid::Timestamps::Short # For c_at and u_at.
end
class Post
  include Mongoid::Document
  include Mongoid::Timestamps::Created::Short # For c_at only.
end
class Post
  include Mongoid::Document
  include Mongoid::Timestamps::Updated::Short # For u_at only.
end

メソッド呼び出しで timeless メソッドを呼び出すと、特定の操作のタイムスタンプフィールドの作成を無効にできます。 次の例ではsave操作のタイムスタンプを無効にします。

post.timeless.save

Regexp

Regexp 型を使用して、フィールドに正規表現を保存できます。

MongoDB はPerl互換正規表現（PCRE） を実装しますが、Mongoid は Ruby の Onigmo ライブラリを使用します。PCRE と Onigmo は通常同じ機能を提供しますが、構文の違いがいくつかあります。 例、Onigmo では string の先頭と末尾を一致させるために \A と \z が使用され、PCRE では ^ と $ が使用されます。

フィールドをRegexp として宣言すると、Mongoid は結果をデータベースに保存 するときにRuby正規表現をBSON正規表現に変換します。 データベースはフィールドをBson::Regexp::Rawインスタンスとして返します。 BSON::Regexp::Raw インスタンスで compile メソッドを使用して、データをRuby正規式に変換できます。

次の例では、 Tokenクラスを作成し、patternフィールドをRegexp として指定します。

class Token
  include Mongoid::Document
  
  field :pattern, type: Regexp
end
  
token = Token.create!(pattern: /hello.world/m)
token.pattern
# Outputs: /hello.world/m
# Reload the token from the database
token.reload
token.pattern
# Outputs: #<BSON::Regexp::Raw:0x0000555f505e4a20 @pattern="hello.world", @options="ms">

BillAtlas

より精度の高い数値を保存するには、 BigDecimal 型を使用します。 Mongoid は、Mongoid.map_big_decimal_to_decimal128 構成プロパティに設定した値に応じて、BigDecimal 値を 2 つの異なる方法で保存します。

• true に設定すると、Mongoid は BigDecimal 値をBSON Decimal128 値として保存します。

• false（デフォルト）に設定されている場合、Mongoid は BigDecimal 値を string として保存します。

Mongoid.map_big_decimal_to_decimal128 オプションを true に設定する場合は、次の制限を考慮してください。

• Decimal128 は、範囲と精度が制限されています。 Decimal128 の最大値は約 10^6145、最小値は約 -10^6145 で、精度は最大 34 ビットです。 これらの制限外の値を保存する場合は、代わりに string として保存することをお勧めします。

• Decimal128 は符号付き NaN 値を受け入れますが、BigDecimal は一致しません。 符号付き NaN Decimal128 値を BigDecimal としてデータベースから取得すると、符号なしの値が返されます。

• Decimal128 は後続のゼロを保持しますが、BigDecimal は後続のゼロを保持しません。 このため、データベースから Decimal128 の値を BigDecimal として検索すると、精度が失われる可能性があります。

StringedSymbol

Rubyアプリケーションにシンボルとして公開する値を保存するには、StringifiedSymbolフィールド型を使用します。 StringifiedSymbol を使用すると、他のドライバーとの相互運用性を確保しながら、 シンボルを使用できます。 このタイプは、データベース上のすべてのデータを string として保存し、アプリケーションによって読み取られるときに string をシンボルに変換します。 整数や配列など、記号に直接変換できない値は、string に変換され、その後記号に変換されます。

次の例では、 statusフィールドをStringifiedSymbol として定義し、このフィールドの保存方法と返却方法を示しています。

class Post
  include Mongoid::Document
  
  field :status, type: StringifiedSymbol
end
  
# Save status as a symbol
post = Post.new(status: :hello)
# status is stored as "hello" on the database, but returned as a Symbol
post.status
# Outputs: :hello
# Save status as a string
post = Post.new(status: "hello")
# status is stored as "hello" in the database, but returned as a Symbol
post.status
# Outputs: :hello

仮想カスタムフィールドタイプ

アプリケーションに割り当てられた値とは異なる値をデータベースに保存するカスタムフィールドタイプを作成できます。 これは、データベースにより圧縮された値を保存しながら、アプリケーションに記述的な値を設定するのに便利です。

次の例では、アプリケーション内の色の名前を使用する ColorMapping 型を作成しますが、データベースには整数として色を保存します。

class ColorMapping
  MAPPING = {
    'black' => 0,
    'white' => 1,
  }.freeze
  INVERSE_MAPPING = MAPPING.invert.freeze
  class << self
    def mongoize(object)
      MAPPING[object]
    end
    def demongoize(object)
      INVERSE_MAPPING[object]
    end
    def evolve(object)
      MAPPING.fetch(object, object)
    end
  end
end
class Profile
  include Mongoid::Document
  field :color, type: ColorMapping
end
profile = Profile.new(color: 'white')
profile.color
# Outputs: "white"
# Sets "color" field to 0 in MongoDB
profile.save!