Tipos de Campos

Campos sin tipo

Si no especifica un tipo para un campo, Mongoid lo interpreta como el tipo predeterminado Object. Un campo sin tipo puede almacenar valores de cualquier tipo que se puedan serializar directamente en BSON. Puede dejar un campo sin tipo si este puede contener diferentes tipos de datos o si se desconoce el tipo de su valor.

El siguiente ejemplo define una clase Product con un campo sin tipo:

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

El tipo del campo properties es Object, pero varía según el tipo de datos almacenados en él. El siguiente ejemplo guarda datos en el campo properties de dos maneras diferentes:

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"}

Dado que Mongoid no realiza conversiones de tipo en campos sin tipo al leer de la base de datos, es posible que los valores que requieren un manejo especial no se recuperen correctamente como valor de un campo sin tipo. No almacene los siguientes tipos de datos BSON en campos sin tipo:

• Date: Devuelve como Time en campos sin tipo

• DateTime: Devuelve como Time en campos sin tipo

• Range: Devuelve como Hash en campos sin tipo

Picadillo

Puede almacenar Hash datos en un campo usando el Hash tipo. Al especificar un campo Hash como, asegúrese de seguir las restricciones de nomenclatura de MongoDB para garantizar que los valores se almacenen correctamente en la base de datos.

El siguiente ejemplo crea una clase Person y especifica el campo url como Hash.

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

Tiempo

Puede almacenar valores como Time instancias BSON utilizando el Time valor delTime campo. Los campos se almacenan en la zona horaria configurada para su aplicación. Para obtener más información sobre la configuración de zonas horarias, consulte la sección "Configuración de zona horaria" de la guía de configuración de la aplicación.

El siguiente ejemplo crea una clase Voter y especifica que el valor del campo registered_at es de tipo Time:

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

fecha

Puede almacenar los siguientes tipos de valores en un campo especificado como Date:

• Date:Almacena el valor tal como se proporciona.

• Time:Almacena la parte de fecha del valor en la zona horaria del valor.

• DateTime:Almacena la parte de fecha del valor en la zona horaria del valor.

• ActiveSupport::TimeWithZone:Almacena la parte de fecha del valor en la zona horaria del valor.

• String: Almacena la fecha especificada en la string.

• IntegerToma el valor como si fuera una marca de tiempo UTC y lo convierte a la zona horaria configurada de la aplicación. Mongoid almacena la fecha obtenida de esa marca de tiempo.

• FloatToma el valor como si fuera una marca de tiempo UTC y lo convierte a la zona horaria configurada de la aplicación. Mongoid almacena la fecha obtenida de esa marca de tiempo.

Dado que al convertir un Time o DateTime se descarta la parte de tiempo, recomendamos convertir explícitamente los objetos String, Time y DateTime a Date antes de asignarlos al campo.

Fecha y hora

Cuando asignes un valor a un campo definido como DateTime o realices una query en estos campos, Mongoid convierte el valor a un valor UTC Time antes de enviarlo al servidor MongoDB. Mongoid guarda el valor con la zona horaria incrustada en el objeto DateTime. Cuando recuperas el valor, Mongoid convierte la hora UTC a la zona horaria configurada para tu aplicación.

El siguiente ejemplo crea una clase Ticket y especifica el campo purchased_at como un campo DateTime:

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

Si guarda un valor entero o flotante en un campo DateTime, este se considera una marca de tiempo Unix en UTC. El siguiente ejemplo guarda un valor entero en el campo purchased_at:

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

Si se guarda un valor de string en un campo DateTime, Mongoid guarda el ticket con la zona horaria especificada. Si no se especifica una zona horaria, Mongoid guarda el valor usando la zona horaria configurada como por defecto para la aplicación:

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

Para obtener más información sobre cómo configurar zonas horarias, consulte la sección Configuración de zona horaria de la guía de configuración de la aplicación.

Marcas de tiempo

Puedes incluir campos de marca de tiempo en una clase incluyendo el módulo Mongoid::Timestamps al crearla. Al incluir Mongoid::Timestamps, Mongoid crea los siguientes campos en tu clase:

• created_at:Almacena la hora en que se creó el documento.

• updated_at:Almacena la hora en que se actualizó el documento por última vez.

En el siguiente ejemplo se crea una clase Post con campos de marca de tiempo:

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

También puede optar por incluir solo los campos created_at o updated_at incluyendo solo los módulos Created o Updated. El siguiente ejemplo crea una clase Post con solo el campo created_at y una clase Post con solo el campo updated_at:

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

Puede acortar los nombres de los campos de marca de tiempo a c_at y u_at configurando la opción ::Short al incluir el módulo:

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

Puede deshabilitar la creación del campo de marca de tiempo para operaciones específicas llamando al método timeless en la llamada al método. El siguiente ejemplo deshabilita las marcas de tiempo para la operación save:

post.timeless.save

Regexp

Puede almacenar expresiones regulares en un campo utilizando el tipo Regexp.

Mientras MongoDB implementa expresiones regulares compatibles con Perl (PCRE)Mongoid usa la biblioteca Onigmo de Ruby. PCRE y Onigmo ofrecen una funcionalidad similar, pero presentan varias diferencias sintácticas. Por ejemplo, Onigmo usa \A y \z para encontrar el principio y el final de una cadena, mientras que PCRE usa ^ y.$

Al declarar un campo como Regexp, Mongoid convierte las expresiones regulares de Ruby en expresiones regulares BSON al almacenar el resultado en la base de datos. La base de datos devuelve el campo como una instancia Bson::Regexp::Raw. Puede usar el método compile en instancias BSON::Regexp::Raw para convertir los datos de nuevo a una expresión regular de Ruby.

El siguiente ejemplo crea una clase Token y especifica el campo pattern como 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">

Gran decimal

Puede usar el tipo BigDecimal para almacenar números con mayor precisión. Mongoid almacena valores BigDecimal de dos maneras diferentes, según el valor que configure para la propiedad de configuración Mongoid.map_big_decimal_to_decimal128:

• Si se establece en true (predeterminado), Mongoid almacena valores BigDecimal como valores BSON Decimal128.

• Si se establece en false, Mongoid almacena BigDecimal valores como cadenas.

Tenga en cuenta las siguientes limitaciones al configurar la opción Mongoid.map_big_decimal_to_decimal128 en true:

• Decimal128 Tiene un rango y una precisión limitados. Decimal128 tiene un valor máximo de aproximadamente 10^6145 y un mínimo de aproximadamente -10^6145, con un máximo de 34 bits de precisión. Si almacena valores que exceden estos límites, le recomendamos almacenarlos como cadenas.

• Decimal128 Acepta valores con signo NaN, pero BigDecimal no. Recuperar valores con signo NaN Decimal128 de la base de datos como BigDecimal devuelve el valor sin signo.

• Decimal128 Mantiene los ceros finales, pero BigDecimal no. Por ello, recuperar valores Decimal128 de la base de datos como BigDecimal podría resultar en una pérdida de precisión.

Símbolo de cadena

Utilice el tipo de campo StringifiedSymbol para almacenar valores que deben exponerse como símbolos a las aplicaciones Ruby. StringifiedSymbol permite usar símbolos, garantizando la interoperabilidad con otros controladores. Este tipo almacena todos los datos de la base de datos como cadenas y las convierte en símbolos cuando la aplicación los lee. Los valores que no se pueden convertir directamente a símbolos, como enteros y matrices, se convierten en cadenas y luego en símbolos.

El siguiente ejemplo define el campo status como StringifiedSymbol y demuestra cómo se almacena y se devuelve el campo:

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

Tipos de campos personalizados fantasma

Puede crear un tipo de campo personalizado que guarde en la base de datos un valor distinto al asignado en la aplicación. Esto puede ser útil para tener valores descriptivos en la aplicación y almacenar valores más compactos en la base de datos.

El siguiente ejemplo crea un tipo ColorMapping que utiliza el nombre del color en la aplicación, pero almacena el color como un entero en la base de datos:

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!