Utilice tipos de campos BSON

Campos sin tipado

Si no se especifica un tipo para un campo, Mongoid lo interpreta como el tipo Object por defecto. Un campo sin tipo puede almacenar valores de cualquier tipo que sea directamente serializable a BSON. Se puede dejar un campo sin tipo si el campo puede contener diferentes tipos de datos o si no se conoce el tipo del valor del campo.

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 dependiendo del tipo de datos almacenados en ese campo. El siguiente ejemplo guarda los 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:

• DateDevuelve como Time en campos no tipados

• DateTimeDevuelve como Time en campos no tipados

• RangeDevuelve como Hash en campos no tipados

Picadillo

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

El siguiente ejemplo crea una clase Person y especifica el campo url como un 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 instancias BSON Time utilizando el valor del campo Time. Time los campos se almacenan en la zona horaria configurada para su aplicación. Para obtener más información sobre cómo configurar zonas horarias, consulta la sección Configuración de zona horaria de la guía Configuración de 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

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

• Date:Almacena el valor tal como se proporciona.

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

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

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

• 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 convertir un Time o un DateTime descarta la porción 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 guardas un valor entero o flotante en un campo DateTime, el valor se trata como 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 las zonas horarias, consulta la sección Configuración de la 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 cuando crees tu clase. Cuando incluyes el 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

Puedes acortar los nombres de los campos de marcas 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

Puedes almacenar expresiones regulares en un campo usando el tipo Regexp.

Mientras MongoDB implementa expresiones regulares compatibles con Perl (PCRE), Mongoid utiliza la librería Onigmo de Ruby. PCRE y Onigmo ofrecen funcionalidades globalmente similares, pero hay varias diferencias de sintaxis. Por ejemplo, Onigmo utiliza \A y \z para hacer coincidir el principio y el final de una string, mientras que PCRE utiliza ^ y $.

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

La 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 establecer 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 almacenas valores que están fuera de estos límites, recomendamos almacenarlos como cadenas de texto en su lugar.

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

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

SímboloSerializado

Use el tipo de campo StringifiedSymbol para almacenar valores que deben exponerse como símbolos para las aplicaciones Ruby. StringifiedSymbol te permite usar símbolos mientras garantiza la interoperabilidad con otros drivers. Este tipo almacena todos los datos en la base de datos como cadenas y convierte las cadenas en símbolos cuando son leídas por la aplicación. Los valores que no pueden convertirse directamente en símbolos, como enteros o arreglos, 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 Phantom

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!