필드 정의

유형이 지정되지 않은 필드

필드의 유형을 지정하지 않는 것은 Object 유형을 지정하는 것과 동일합니다. 이러한 필드는 유형이 지정되지 않습니다.

class Product
  include Mongoid::Document
  field :properties
  # Equivalent to:
  field :properties, type: Object
end

유형이 지정되지 않은 필드는 BSON에 직접 직렬화할 수 있는 모든 유형의 값을 저장할 수 있습니다. 이는 필드에 서로 다른 유형의 값이 포함되어 있거나(예: 변형 유형 필드) 값 유형을 미리 알 수 없는 경우에 유용합니다.

product = Product.new(properties: "color=white,size=large")
product.properties
# => "color=white,size=large"
product = Product.new(properties: {color: "white", size: "large"})
product.properties
# => {:color=>"white", :size=>"large"}

필드에 값이 할당되면 Mongoid는 여전히 mongoization을 수행하지만 mongoization 로직을 위해 필드 유형이 아닌 값의 클래스를 사용합니다.

product = Product.new(properties: 0..10)
product.properties
# The range 0..10, mongoized:
# => {"min"=>0, "max"=>10}

데이터베이스에서 데이터를 읽을 때 Mongoid는 유형이 지정되지 않은 필드에서 유형 변환을 수행하지 않습니다. 이러한 이유로 BSON 직렬화 가능 값을 유형이 지정되지 않은 필드에 쓸 수는 있지만 데이터베이스 읽기 측에서 특별한 처리가 필요한 값은 일반적으로 유형이 지정되지 않은 필드에서 올바르게 작동하지 않습니다. Mongoid에서 지원하는 필드 유형 중 다음 유형의 값은 유형이 지정되지 않은 필드에 저장해서는 안 됩니다.

• Date (값은 Time 로 반환됨)

• DateTime (값은 Time 로 반환됨)

• Range (값은 Hash 로 반환됨)

필드 유형: 문자열화된 기호

StringifiedSymbol 필드 유형은 Ruby 애플리케이션에 기호로 노출되어야 하는 값을 저장하는 데 권장되는 필드 유형입니다. Symbol 필드 유형을 사용할 때 Mongoid는 기본적으로 값을 BSON 기호로 저장합니다. BSON 기호 유형에 대한 자세한 내용은 여기 를 참조하세요. 그러나 BSON 기호 유형은 더 이상 사용되지 않으며 네이티브 기호 유형이 없는 프로그래밍 언어에서는 작업하기 어렵기 때문에 StringifiedSymbol 유형을 사용하면 다른 드라이버와의 상호 운용성을 보장하면서 기호를 사용할 수 있습니다. StringifiedSymbol 유형은 데이터베이스 의 모든 데이터를 문자열로 저장하고 값은 애플리케이션 에 기호로 노출합니다.

사용 예는 아래와 같습니다:

class Post
  include Mongoid::Document
  field :status, type: StringifiedSymbol
end
post = Post.new(status: :hello)
# status is stored as "hello" on the database, but returned as a Symbol
post.status
# => :hello
# String values can be assigned also:
post = Post.new(status: "hello")
# status is stored as "hello" on the database, but returned as a Symbol
post.status
# => :hello

문자열이 아닌 모든 값은 ( to_s 을 통해) 데이터베이스로 전송될 때 문자열화되며 모든 값은 애플리케이션에 반환될 때 기호로 변환됩니다. 정수 및 배열과 같이 기호로 직접 변환할 수 없는 값은 먼저 문자열로 변환한 다음 애플리케이션에 반환되기 전에 기호로 변환합니다.

예를 들어 정수를 status(으)로 설정하면 다음과 같습니다.

post = Post.new(status: 42)
post.status
# => :"42"

BSON 기호가 포함된 필드에 StringifiedSymbol 유형이 적용되면 다음 번에 값을 저장할 때 BSON 기호 대신 문자열로 저장됩니다. 이렇게 하면 현재 데이터베이스에 문자열 또는 BSON 기호를 저장하는 필드에서 StringifiedSymbol 필드 유형으로 투명하게 지연 마이그레이션할 수 있습니다.

필드 유형: 기호

새 애플리케이션은 StringifiedSymbol 필드 유형 을 사용하여 데이터베이스에 Ruby 기호를 저장해야 합니다. StringifiedSymbol 필드 유형은 다른 애플리케이션 및 프로그래밍 언어와의 최대 호환성을 제공하며 모든 상황에서 동일한 동작을 갖습니다.

Mongoid는 또한 Ruby 기호를 BSON 기호로 직렬화하기 위해 더 이상 사용되지 않는 Symbol 필드 유형을 제공합니다. BSON 사양에서는 BSON 기호 유형이 더 이상 사용되지 않기 때문에 bson gem은 독립적으로 사용될 때 Ruby 기호를 BSON 문자열로 직렬화합니다. 그러나 이전 데이터셋과의 호환성을 유지하기 위해 mongo gem은 이 행동을 재정의하여 Ruby 기호를 BSON 기호로 직렬화합니다. 이는 BSON 기호를 필드로 포함하는 문서에 대한 쿼리를 지정하는 데 필요합니다.

기본값 행동을 재정의하고 기호 값을 문자열로 인코딩하도록 mongo gem(및 Mongoid)을 구성하려면 프로젝트에 다음 코드 스니펫을 포함하세요:

class Symbol
  def bson_type
    BSON::String::BSON_TYPE
  end
end

필드 유형: 해시

해시 유형의 필드를 사용할 때 mongoDB의 올바른 키 이름을 준수하지 않으면 값이 제대로 저장되지 않습니다.

class Person
  include Mongoid::Document
  field :first_name
  field :url, type: Hash
  # will update the fields properly and save the values
  def set_vals
    self.first_name = 'Daniel'
    self.url = {'home_page' => 'http://www.homepage.com'}
    save
  end
  # all data will fail to save due to the illegal hash key
  def set_vals_fail
    self.first_name = 'Daniel'
    self.url = {'home.page' => 'http://www.homepage.com'}
    save
  end
end

필드 유형: 시간

Time 필드는 구성된 구역에 Time 인스턴스로 값을 저장 합니다.

Date 인스턴스가 Time 필드에 할당되면 DateTime 인스턴스가 Time 인스턴스로 변환됩니다:

class Voter
  include Mongoid::Document
  field :registered_at, type: Time
end
Voter.new(registered_at: Date.today)
# => #<Voter _id: 5fdd80392c97a618f07ba344, registered_at: 2020-12-18 05:00:00 UTC>

위 예에서는 애플리케이션이 UTC 시간을 사용하도록 구성되지 않았으므로 값은 현지 시간으로 오늘로 시작하는 것으로 해석되었습니다.

필드 유형: 날짜

Mongoid를 사용하면 여러 유형의 값을 Date 필드에 할당할 수 있으며 다음과 같습니다.

• Date - 로 설정하면 제공된 데이터가 그대로 저장됩니다.

• Time, DateTime, ActiveSupport::TimeWithZone - 인 경우 값의 날짜 구성 요소는 값의 표준 시간대에서 가져옵니다.

• String - 로 설정하면 문자열에 지정된 날짜가 사용됩니다.

• Integer, Float 의 경우, 값은 UTC 타임스탬프로 간주되여 설정된 시간대로 변환됩니다 (Mongoid.use_utc 은 이 변환에 영향을 주지 않음). 그 후, 결과 시간으로부터 날짜가 추출됩니다.

즉, 값에 날짜가 지정된 경우, 값을 구성된 시간대로 먼저 변환하지 않은 채 해당 날짜 그대로 사용됩니다.

날짜 및 시간을 날짜로 변환하는 것은 손실이 발생하는 과정입니다 (시간 구성 요소가 삭제됨). 특히 애플리케이션에서 다른 시간대의 시간들로 동작하는 경우, Date 유형의 필드에 값을 할당하기 전에 String, Time 및 DateTime 객체를 Date 객체로 명시적으로 변환하는 것이 좋습니다.

필드 유형: 날짜/시간

MongoDB는 모든 시간을 UTC 타임스탬프로 저장합니다. DateTime 필드에 값을 할당하거나 DateTime 필드를 쿼리 할 때 Mongoid는 전달된 값을 MongoDB Server로 보내기 전에 UTC Time 로 변환합니다.

Time, ActiveSupport::TimeWithZone 및 DateTime 객체에는 시간대 정보를 포함하고 있으며, 저장되는 값은 UTC로 지정된 시간입니다. 값이 검색될 때, 반환되는 시간대는 구성된 표준 시간대 설정에 의해 정의됩니다.

class Ticket
  include Mongoid::Document
  field :opened_at, type: DateTime
end
Time.zone = 'Berlin'
ticket = Ticket.create!(opened_at: '2018-02-18 07:00:08 -0500')
 ticket.opened_at
 # => Sun, 18 Feb 2018 13:00:08 +0100
 ticket
 # => #<Ticket _id: 5c13d4b9026d7c4e7870bb2f, opened_at: 2018-02-18 12:00:08 UTC>
 Time.zone = 'America/New_York'
 ticket.opened_at
 # => Sun, 18 Feb 2018 07:00:08 -0500
 Mongoid.use_utc = true
 ticket.opened_at
 # => Sun, 18 Feb 2018 12:00:08 +0000

Mongoid는 정수와 부동 소수점을 DateTime으로 캐스팅하는 기능도 지원합니다. 이 때 정수/부동 소수점은 Unix 타임스탬프(UTC)로 간주됩니다:

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

문자열이 DateTime 필드 값으로 사용될 경우, 그 동작은 문자열이 시간대를 포함하는지 여부에 따라 달라집니다. 시간대를 지정하지 않으면 기본값 Mongoid 시간대가 사용됩니다.

Time.zone = 'America/New_York'
ticket.opened_at = 'Mar 4, 2018 10:00:00'
ticket.opened_at
# => Sun, 04 Mar 2018 15:00:00 +0000

시간대를 지정하면 다음과 같이 적용됩니다.

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

필드 유형: 정규식

MongoDB 는 문서에 정규 표현식을 저장하고 정규 표현식을 사용한 쿼리를 지원합니다. MongoDB 는 Perl 호환 정규 표현식(PCRE) 을 사용합니다. Ruby 는 Onigmo 를 사용합니다. 은 Oniguruma 정규 표현식 엔진 의 포크입니다. . 두 정규 표현식 구현은 일반적으로 동일한 기능을 제공하지만 몇 가지 중요한 구문 차이점이 있습니다.

필드가 Regexp 유형으로 선언되면 Mongoid는 Ruby 정규 표현식을 BSON 정규 표현식으로 변환하고 결과를 MongoDB에 저장합니다. 데이터베이스에서 필드를 검색하면 BSON::Regexp::Raw 인스턴스가 생성됩니다.

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

Ruby 정규 표현식으로 되돌리려면 BSON::Regexp::Raw 에서 #compile 메소드를 사용하세요.

token.pattern.compile
# => /hello.world/m

정규 표현식이 원래 Ruby 표현식이 아닌 경우 #compile을(를) 호출하면 다른 정규 표현식이 생성될 수 있다는 점에 유의하세요. 예를 들어 다음은 'hello'로 끝나는 문자열과 일치하는 PCRE입니다.

BSON::Regexp::Raw.new('hello$', 's')
# => #<BSON::Regexp::Raw:0x0000555f51441640 @pattern="hello$", @options="s">

이 정규 표현식을 컴파일하면 "hello" 다음에 개행 문자가 있는 문자열, 그리고 "hello"로 끝나는 문자열을 매치하는 Ruby 정규 표현식이 생성됩니다.

BSON::Regexp::Raw.new('hello$', 's').compile =~ "hello\nworld"
# => 0

이는 PCRE와 Ruby 정규 표현식 간에 $ 의 의미가 다르기 때문입니다.

BigDecimal 필드

BigDecimal 필드 유형은 향상된 정밀도로 숫자를 저장하는 데 사용됩니다.

BigDecimal 필드 유형은 Mongoid.map_big_decimal_to_decimal128 글로벌 구성 옵션의 값에 따라 데이터베이스에 두 가지 방식으로 값을 저장합니다. 이 플래그를 false로 설정된 경우 (기본값), BigDecimal 필드는 문자열로 저장되고, 그렇지 않으면 BSON::Decimal128 필드로 저장됩니다.

BigDecimal 필드 유형은 BSON::Decimal128 형식으로 변환할 때 몇 가지 제한 사항이 있습니다.

• BSON::Decimal128 범위와 정밀도에서 제한이 있으나 BigDecimal 는 범위와 정밀도 측면에서 제한이 없습니다. BSON::Decimal128 의 최대값은 약 10^6145 이고 최소값은 약 -10^6145 이며 최대 정밀도는 34비트입니다. BSON::Decimal128 에 맞지 않는 값을 저장하려고 하는 경우, 해당 값을 BSON::Decimal128 대신 문자열로 저장하는 것이 좋습니다. Mongoid.map_big_decimal_to_decimal128 를 false 로 설정하면 됩니다. BSON::Decimal128 에 맞지 않는 값을 저장하려고 하면 오류가 발생합니다.

• BSON::Decimal128 기호가 있는 NaN 값을 받아들일 수 있는 반면, BigDecimal 은 허용하지 않습니다. BigDecimal 필드 유형을 사용하여 데이터베이스에서 기호가 있는 NaN 값을 검색할 때 NaN 은 기호 없는 상태로 반환됩니다.

• BSON::Decimal128 데이터베이스에 저장될 때 후행 0을 유지합니다. 그러나 BigDecimal은 후행 0을 유지하지 않으므로 BigDecimal 필드 유형을 사용하여 BSON::Decimal128 값을 검색하면 정밀도가 손실될 수 있습니다.

유형이 없는 필드(즉, 동적으로 입력되는 필드)에 BigDecimal를 저장하고 Mongoid.map_big_decimal_to_decimal128가 false인 경우 추가 주의 사항이 있습니다. 이 경우 BigDecimal는 문자열로 저장되고 동적 필드가 사용 중이므로 BigDecimal으로 해당 필드를 쿼리하면 쿼리가 BigDecimal를 찾기 때문에 해당 BigDecimal의 문자열을 찾을 수 없습니다. 해당 문자열을 쿼리하려면 먼저 BigDecimal을 to_s 사용하여 문자열로 변환해야 합니다. 필드의 유형이 BigDecimal인 경우에는 문제가 되지 않습니다.

BigDecimal을(를) 모두 사용하지 않으려면 필드 유형을 BSON::Decimal128(으)로 설정하면 됩니다. 이렇게 하면 후행 0과 부호가 있는 NaN 값을 추적할 수 있습니다.

클래스 대신 기호 또는 문자열 사용

Mongoid에서는 클래스 대신 기호나 문자열을 사용하여 필드 유형을 지정할 수 있습니다. 예를 들면 다음과 같습니다.

class Order
  include Mongoid::Document
  field :state, type: :integer
  # Equivalent to:
  field :state, type: "integer"
  # Equivalent to:
  field :state, type: Integer
end

아래 나열된 표준 필드 유형만 이 방식으로 기호나 문자열을 사용하여 지정할 수 있습니다. Mongoid는 다음과 같은 확장을 인식합니다.

• :array => Array

• :big_decimal => BigDecimal

• :binary => BSON::Binary

• :boolean => Mongoid::Boolean

• :date => Date

• :date_time => DateTime

• :float => Float

• :hash => Hash

• :integer => Integer

• :object_id => BSON::ObjectId

• :range => Range

• :regexp => Regexp

• :set => Set

• :string => String

• :stringified_symbol => StringifiedSymbol

• :symbol => Symbol

• :time => Time

필드 기본값 지정

필드는 기본값을 갖도록 구성할 수 있습니다. 기본값은 다음 예시와 같이 고정할 수 있습니다.

class Order
  include Mongoid::Document
  field :state, type: String, default: 'created'
end

기본값은 Proc으로 지정할 수도 있습니다.

class Order
  include Mongoid::Document
  field :fulfill_by, type: Time, default: ->{ Time.now + 3.days }
end

field :submitted_at, type: Time, default: Time.now
field :submitted_at, type: Time, default: ->{ Time.now }

문서 상태에 따라 달라지는 기본값을 설정하려면 작업 중인 문서 인스턴스로 평가되는 Proc 인스턴스 내에서 self를 사용하세요.

field :fulfill_by, type: Time, default: ->{
  # Order should be fulfilled in 2 business hours.
  if (7..8).include?(self.submitted_at.hour)
    self.submitted_at + 4.hours
  elsif (9..3).include?(self.submitted_at.hour)
    self.submitted_at + 2.hours
  else
    (self.submitted_at + 1.day).change(hour: 11)
  end
}

기본값을 Proc으로 정의하면 Mongoid는 다른 모든 속성이 설정되고 연결이 초기화된 후에 기본값을 적용합니다. 다른 속성이 설정되기 전에 기본값을 적용하려면 pre_processed: true 필드 옵션을 사용하십시오.

field :fulfill_by, type: Time, default: ->{ Time.now + 3.days },
  pre_processed: true

pre_processed: true 옵션은 _id 필드에 대해 Proc을 통해 맞춤 기본값을 지정할 때에도 필요하며, 연결을 통해 _id가 올바르게 설정되도록 해야 합니다.

field :_id, type: String, default: -> { 'hello' }, pre_processed: true

저장 필드 이름 지정

스키마 없는 데이터베이스의 단점 중 하나는 MongoDB가 모든 문서와 함께 모든 필드 정보를 저장해야 한다는 것입니다. 즉, RAM과 디스크에서 많은 저장 공간을 차지합니다. 이를 제한하는 일반적인 패턴은 애플리케이션의 도메인 표현력을 유지하면서 필드 별칭을 적은 수의 문자로 지정하는 것입니다. Mongoid를 사용하면 변환을 수행하는 동안 이 작업을 수행하고 게터, 세터 및 기준의 긴 이름을 통해 도메인의 필드를 참조할 수 있습니다.

class Band
  include Mongoid::Document
  field :n, as: :name, type: String
end
band = Band.new(name: "Placebo")
band.attributes # { "n" => "Placebo" }
criteria = Band.where(name: "Placebo")
criteria.selector # { "n" => "Placebo" }

필드 별칭

필드 별칭을 정의할 수 있습니다. 값은 대상 필드에 저장되지만 대상 필드 또는 별칭이 지정된 필드에서 액세스할 수 있습니다.

class Band
  include Mongoid::Document
  field :name, type: String
  alias_attribute :n, :name
end
band = Band.new(n: 'Astral Projection')
# => #<Band _id: 5fc1c1ee2c97a64accbeb5e1, name: "Astral Projection">
band.attributes
# => {"_id"=>BSON::ObjectId('5fc1c1ee2c97a64accbeb5e1'), "name"=>"Astral Projection"}
band.n
# => "Astral Projection"

별칭은 unalias_attribute 메서드를 사용하여 모델 클래스에서 제거할 수 있습니다.

class Band
  unalias_attribute :n
end

class Band
  include Mongoid::Document
  unalias_attribute :id
  field :id, type: String
end
Band.new(id: '42')
# => #<Band _id: 5fc1c3f42c97a6590684046c, id: "42">

예약어

Mongoid에서 예약된 메서드 이름과 충돌하는 문서에 필드를 정의하려고 하면 오류가 발생합니다. 예약된 이름 목록은 Mongoid.destructive_fields 메서드를 호출하여 얻을 수 있습니다.

필드 재정의

기본적으로 Mongoid에서는 모델의 필드를 재정의할 수 있습니다. 필드가 재정의될 때 오류를 발생시키려면 duplicate_fields_exception 구성 옵션을 true으로 설정합니다.

옵션을 true로 설정하면 다음 예에서는 오류가 발생합니다.

class Person
  include Mongoid::Document
  field :name
  field :name, type: String
end

그래도 필드를 정의하려면 overwrite: true 옵션을 사용합니다.

class Person
  include Mongoid::Document
  field :name
  field :name, type: String, overwrite: true
end

사용자 지정 ID

기본적으로 Mongoid는 Mongoid에 의해 자동으로 생성되는 BSON::ObjectId 값을 포함하도록 문서의 _id 필드를 정의합니다.

_id 필드 정의를 대체하여 _id 값의 유형을 변경하거나 다른 기본값을 가질 수 있습니다.

class Band
  include Mongoid::Document
  field :name, type: String
  field :_id, type: String, default: ->{ name }
end

기본값을 완전히 생략할 수도 있습니다.

class Band
  include Mongoid::Document
  field :_id, type: String
end

_id의 기본값이 생략되고 애플리케이션에서 _id 값을 제공하지 않으면 Mongoid는 _id 값 없이 문서를 유지합니다. 이 경우 문서가 최상위 문서인 경우 서버에서 _id 값을 할당하고, 문서가 내장된 문서인 경우 _id 값을 할당하지 않습니다. Mongoid는 문서가 유지될 때 이 값을 할당한 경우 자동으로 검색하지 않습니다. 다른 방법을 사용하여 지속된 값(및 전체 지속된 문서)을 가져와야 합니다.

band = Band.create!
=> #<Band _id: , >
band.id
=> nil
band.reload
# raises Mongoid::Errors::DocumentNotFound
Band.last
=> #<Band _id: 5fc681c22c97a6791f324b99, >

_id 필드를 생략하는 것은 내장된 문서에서 더 일반적입니다.

Mongoid는 또한 _id 에 별칭이 지정된 id 필드 를 정의합니다. 원하는 id 경우 별칭을 제거할 수 있습니다 (예:id 필드 를 사용하여 이외의 값을 저장 하는 시스템과 통합하려는 _id 경우).

캐스팅 불가 값

Mongoid 8에서 Mongoid는 "캐스팅할 수 없는" 값의 할당 및 읽기 처리를 표준화했습니다. 값은 해당 필드의 형식으로 강제 변환할 수 없는 경우 "캐스팅할 수 없는" 것으로 간주됩니다. 예를 들어 배열은 정수 필드에 대해 "캐스팅할 수 없는" 값입니다.

class User
  include Mongoid::Document
  field :name, type: Integer
end
User.new(name: [ "hello" ])

user = User.new(name: [ "Mike", "Trout" ])
# => #<User _id: 62b222d43282a47bf73e3264, name: nil>

user.attributes_before_type_cast["name"]
# => ["Mike", "Trout"]

class User
  include Mongoid::Document
  field :name, type: Integer
end

{ _id: ..., name: [ "Mike", "Trout" ] }

User.first.name
# => nil

user.attributes_before_type_cast["name"]
# => ["Mike", "Trout"]

사용자 정의 게터 및 세터

필드에 대한 getter 및 setter를 재정의하여 값에 액세스하거나 기록할 때 값을 수정할 수 있습니다. getter 및 setter는 필드와 동일한 이름을 사용합니다. 원시 속성 값에 대해 작업을 수행하려면 getter 및 setter 내에서 read_attribute 및 write_attribute 메서드를 사용합니다.

예를 들어, Mongoid는 필드에 기본값을 쓸 수 있는 :default 필드 옵션을 제공합니다. 애플리케이션에 필드 기본값을 갖고 싶지만 이를 유지하고 싶지 않은 경우 다음과 같이 게터를 재정의할 수 있습니다.

class DistanceMeasurement
  include Mongoid::Document
  field :value, type: Float
  field :unit, type: String
  def unit
    read_attribute(:unit) || "m"
  end
  def to_s
    "#{value} #{unit}"
  end
end
measurement = DistanceMeasurement.new(value: 2)
measurement.to_s
# => "2.0 m"
measurement.attributes
# => {"_id"=>BSON::ObjectId('613fa0b0a15d5d61502f3447'), "value"=>2.0}

또 다른 예를 들자면, 빈 문자열을 nil 값으로 변환하는 필드는 다음과 같이 구현될 수 있습니다.

class DistanceMeasurement
  include Mongoid::Document
  field :value, type: Float
  field :unit, type: String
  def unit=(value)
    if value.blank?
      value = nil
    end
    write_attribute(:unit, value)
  end
end
measurement = DistanceMeasurement.new(value: 2, unit: "")
measurement.attributes
# => {"_id"=>BSON::ObjectId('613fa15aa15d5d617216104c'), "value"=>2.0, "unit"=>nil}

사용자 정의 필드 유형

Mongoid에서 사용자 정의 유형을 정의하고 직렬화 및 역직렬화 방법을 결정할 수 있습니다. 이 예에서는 다음과 같이 모델 클래스에서 사용할 수 있는 새 필드 유형 Point을 정의합니다.

class Profile
  include Mongoid::Document
  field :location, type: Point
end

그런 다음 유형을 나타내는 Ruby 클래스를 만듭니다. 이 클래스는 MongoDB 직렬화 및 역직렬화에 사용되는 메서드를 다음과 같이 정의해야 합니다.

class Point
  attr_reader :x, :y
  def initialize(x, y)
    @x, @y = x, y
  end
  # Converts an object of this instance into a database friendly value.
  # In this example, we store the values in the database as array.
  def mongoize
    [ x, y ]
  end
  class << self
    # Takes any possible object and converts it to how it would be
    # stored in the database.
    def mongoize(object)
      case object
      when Point then object.mongoize
      when Hash then Point.new(object[:x], object[:y]).mongoize
      else object
      end
    end
    # Get the object as it was stored in the database, and instantiate
    # this custom class from it.
    def demongoize(object)
      Point.new(object[0], object[1])
    end
    # Converts the object that was supplied to a criteria and converts it
    # into a query-friendly form.
    def evolve(object)
      case object
      when Point then object.mongoize
      else object
      end
    end
  end
end

인스턴스 메서드 mongoize 는 사용자 지정 유형 객체의 인스턴스를 가져와서 이를 데이터베이스에 저장하는 방법, 즉 MongoDB Ruby 드라이버에 전달하는 방법에 대한 표현으로 변환합니다. 위의 예에서는 Point 객체를 [ x, y ] 형식의 Array 로 저장하려고 합니다.

클래스 메서드 mongoize는 인스턴스 메서드와 비슷하지만 가능한 모든 유형의 객체를 입력으로 처리해야 합니다. mongoize 메서드는 사용자 지정 유형의 필드에 대해 세터 메서드를 호출할 때 사용됩니다.

point = Point.new(12, 24)
venue = Venue.new(location: point) # This uses the Point#mongoize instance method.
venue = Venue.new(location: [ 12, 24 ]) # This uses the Point.mongoize class method.

클래스 메서드 demongoize는 mongoize의 반대 작업을 수행합니다. MongoDB Ruby 드라이버에서 원시 객체를 가져와 사용자 지정 유형의 인스턴스로 변환합니다. 이 경우 데이터베이스 드라이버는 Array를 반환하고 이로부터 Point를 인스턴스화합니다. demongoize 메서드는 사용자 정의 유형에 대한 필드의 게터를 호출할 때 사용됩니다. 참고로 위 예시에서는 demongoize 명령이 Point.new를 호출하므로 게터를 호출할 때마다 Point의 새 인스턴스가 생성됩니다.

Mongoid는 데이터베이스에서 검색된 값에 대해 항상 demongoize 메서드를 호출하지만 이론적으로 애플리케이션은 임의 입력으로 demongoize를 호출할 수 있습니다. 애플리케이션은 demongoize 메서드에 임의 입력에 대한 처리를 추가하는 것이 좋습니다. 다음과 같이 Point의 demongoize 메서드를 다시 작성할 수 있습니다.

def demongoize(object)
  if object.is_a?(Array) && object.length == 2
    Point.new(object[0], object[1])
  end
end

demongoize 은 길이가 2 인 배열이 주어질 경우에만 새 Point 를 생성하고, 그렇지 않으면 nil 을 반환한다는 점에 유의하세요. mongoize 및 demongoize 메서드는 모두 임의의 입력을 받을 수 있도록 준비되어야 하며 사용자 지정 유형으로 변환할 수 없는 값에 대해 nil 를 반환해야 합니다. 자세한 내용은 캐스트할 수 없는 값 섹션을 참조하세요.

마지막으로 클래스 메서드 evolve는 mongoize와 비슷하지만 Mongoid 쿼리 기준에 사용할 객체를 변환할 때 사용됩니다.

point = Point.new(12, 24)
Venue.where(location: point) # This uses Point.evolve

evolve 메서드도 임의의 입력을 받을 수 있도록 준비해야 하지만 mongoize 및 demongoize 메서드와 달리 사용자 지정 유형으로 변환할 수 없는 값에 입력된 값을 반환해야 합니다. 자세한 내용은 캐스트할 수 없는 값 섹션을 참조하세요.

class ColorMapping
  MAPPING = {
    'black' => 0,
    'white' => 1,
  }.freeze
  INVERSE_MAPPING = MAPPING.invert.freeze
  class << self
    # Takes application-scope value and converts it to how it would be
    # stored in the database. Converts invalid values to nil.
    def mongoize(object)
      MAPPING[object]
    end
    # Get the value as it was stored in the database, and convert to
    # application-scope value. Converts invalid values to nil.
    def demongoize(object)
      INVERSE_MAPPING[object]
    end
    # Converts the object that was supplied to a criteria and converts it
    # into a query-friendly form. Returns invalid values as is.
    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
# => "white"
# Writes 0 to color field
profile.save!

사용자 정의 필드 옵션

모델 클래스가 로드될 때 동작을 확장하는 field 매크로 함수의 사용자 지정 옵션을 정의할 수 있습니다.

예를 들어 필드에 길이 유효성 검사기를 추가하는 :max_length 옵션을 정의합니다. 먼저, 초기화 프로그램에서 새 필드 옵션을 선언하고 해당 핸들러 함수를 차단으로 지정합니다.

# in /config/initializers/mongoid_custom_fields.rb
Mongoid::Fields.option :max_length do |model, field, value|
  model.validates_length_of field.name, maximum: value
end

그런 다음 모델 클래스에 사용하세요.

class Person
  include Mongoid::Document
  field :name, type: String, max_length: 10
end

옵션 값이 false 또는 nil인 경우에도 필드 정의에서 옵션이 사용될 때마다 핸들러 함수가 호출됩니다.

필드 이름의 특수 문자

Mongoid는 동적 필드 이름에 공백과 구두점을 포함하는 것을 허용합니다.

bob = Person.new('hello world' => 'MDB')
bob.send('hello world')
# => "MDB"
bob.write_attribute("hello%world", 'MDB')
bob[:"hello%world"]
# => "MDB"

:present 필드 옵션 현지화

Mongoid는 현지화된 필드를 생성할 때 :present 옵션을 지원합니다.

class Product
  include Mongoid::Document
  field :description, localize: :present
end

이 옵션은 blank 값을 자동으로 제거합니다(예: blank? 메서드에 대해 true 반환). 이는 _translations 해시에서 가져옵니다.

I18n.default_locale = :en
product = Product.new
product.description = "Marvelous!"
I18n.locale = :de
product.description = "Fantastisch!"
product.description_translations
# { "en" => "Marvelous!", "de" => "Fantastisch!" }
product.description = ""
product.description_translations
# { "en" => "Marvelous!" }

:de 국가 및 언어 설정에 대해 빈 문자열이 기록되면 빈 문자열을 쓰는 대신 "de" 키가 _translations 해시에서 제거됩니다.

폴백

Mongoid는 i n18 폴백과 통합됩니다. . 폴백을 사용하려면 해당 기능을 명시적으로 활성화해야 합니다.

Rails 애플리케이션에서 사용자 환경의 config.i18n.fallbacks 구성 설정을 true로 설정하고 대체 언어를 지정하십시오.

config.i18n.fallbacks = true
config.after_initialize do
  I18n.fallbacks[:de] = [ :en, :es ]
end

Rails가 아닌 애플리케이션에서는 사용 중인 I18n 백엔드에 폴백 모듈을 포함하고 폴백 언어를 지정합니다.

require "i18n/backend/fallbacks"
I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
I18n.fallbacks[:de] = [ :en, :es ]

폴백이 활성화된 경우 활성 언어에 번역이 없는 경우 대체 언어로 번역이 검색됩니다.

product = Product.new
I18n.locale = :en
product.description = "Marvelous!"
I18n.locale = :de
product.description # "Marvelous!"

Mongoid는 또한 특정 필드에서 대체 기능을 비활성화하는 데 사용할 수 있는 :fallbacks 옵션을 필드에 정의합니다.

class Product
  include Mongoid::Document
  field :description, type: String, localize: true, fallbacks: false
end
product = Product.new
I18n.locale = :en
product.description = "Marvelous!"
I18n.locale = :de
product.description # nil

이 옵션의 기본값은 true입니다.

쿼리하기

Mongoid의 기준 API를 사용하여 현지화된 필드를 쿼리할 때 Mongoid는 현재 국가 및 언어 설정과 일치하도록 기준을 자동으로 변경합니다.

# Match all products with Marvelous as the description. Locale is en.
Product.where(description: "Marvelous!")
# The resulting MongoDB query filter: { "description.en" : "Marvelous!" }

인덱싱

지역화된 필드에 대해 광범위하게 쿼리할 계획이라면 검색하려는 각 국가 및 언어 설정을 인덱스화해야 합니다.

class Product
  include Mongoid::Document
  field :description, localize: true
  index "description.de" => 1
  index "description.en" => 1
end