Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 2.72 KB

CHANGELOG.md

File metadata and controls

80 lines (60 loc) · 2.72 KB

BSON Changelog

2.0.0

Backwards Incompatible Changes

  • BSON::DEFAULT_MAX_BSON_SIZE has been removed, as the BSON specification does not provide an upper limit on how large BSON documents can be.

  • BSON.serialize is no longer the entry point to serialize a BSON document into its raw bytes.

    For Ruby runtimes that support ordered hashes, you may simply call `to_bson` on
the hash instance (Alternatively a `BSON::Document` is also a hash:

  { key: "value" }.to_bson
  BSON::Document[:key, "value"].to_bson

For Ruby runtimes that do not support ordered hashes, then you must instantiate
an instance of a `BSON::Document` (which is a subclass of hash) and call `to_bson`
on that, since the BSON specification guarantees order of the fields:

  BSON::Document[:key, "value"].to_bson

  • BSON.deserialize is no longer the entry point for raw byte deserialization into a document.

    For Ruby runtimes that support ordered hashes, you may simply call `from_bson` on
the `Hash` class if you want a `Hash` instance, or on `BSON::Document` if you
want an instance of that. The input must be a `StringIO` object:

  Hash.from_bson(stringio)
  BSON::Document.from_bson(stringio)

For Ruby runtimes that do not support ordered hashes, then `from_bson` must be
called on `BSON::Document` in order to guarantee order:

  BSON::Document.from_bson(stringio)

  • Calling to_json on custom BSON objects now outputs different results from before, and conforms the BSON specification:

    • BSON::Binary: { "$binary" : "\x01", "$type" : "md5" }
    • BSON::Code: { "$code" : "this.v = 5 }
    • BSON::CodeWithScope: { "$code" : "this.v = value", "$scope" : { v => 5 }}
    • BSON::MaxKey: { "$maxKey" : 1 }
    • BSON::MinKey: { "$minKey" : 1 }
    • BSON::ObjectId: { "$oid" : "4e4d66343b39b68407000001" }
    • BSON::Timestamp: { "t" : 5, "i" : 30 }
    • Regexp: { "$regex" : "[abc]", "$options" : "i" }

New Features

  • All Ruby objects that have a corresponding object defined in the BSON specification can now have to_bson called on them to get the raw BSON bytes. These objects include:

    • Array
    • FalseClass
    • Float
    • Hash
    • Integer
    • NilClass
    • Regexp
    • String
    • Symbol (deprecated)
    • Time
    • TrueClass

  • Custom types specific to the BSON specification that have Ruby objects defined for them may also have to_bson called on them to get the raw bytes. These types are:

    • BSON::Binary
    • BSON::Code
    • BSON::CodeWithScope
    • BSON::MaxKey
    • BSON::MinKey
    • BSON::ObjectId
    • BSON::Timestamp
    • BSON::Undefined