struct Mongo::Collation

• Mongo::Collation
• Struct
• Value
• Object

Overview

Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

See: the official documentation

Included Modules

• BSON::Serializable

Defined in:

Constructors

• .new(bson : BSON)

  Allocate an instance and copies data from a BSON struct.

• .new(locale : String, case_level : Bool | Nil = nil, case_first : Nil | String = nil, strength : Int32 | Nil = nil, numeric_ordering = nil, alternate = nil, max_variable = nil, backwards = nil, normalization = nil)

  Create a new Collation instance.

Class Method Summary

• .from_bson(bson : BSON)

  NOTE See self.new.

Instance Method Summary

• #alternate : String | Nil

  Field that determines whether collation should consider whitespace and punctuation as base characters for purposes of comparison.

• #alternate=(alternate : String | Nil)

  Field that determines whether collation should consider whitespace and punctuation as base characters for purposes of comparison.

• #backwards : Bool | Nil

  Flag that determines whether strings with diacritics sort from back of the string, such as with some French dictionary ordering.

• #backwards=(backwards : Bool | Nil)

  Flag that determines whether strings with diacritics sort from back of the string, such as with some French dictionary ordering.

• #case_first : String | Nil

  A field that determines sort order of case differences during tertiary level comparisons.

• #case_first=(case_first : String | Nil)

  A field that determines sort order of case differences during tertiary level comparisons.

• #case_level : Bool | Nil

  Flag that determines whether to include case comparison at strength level 1 or 2.

• #case_level=(case_level : Bool | Nil)

  Flag that determines whether to include case comparison at strength level 1 or 2.

• #locale : String

  The ICU locale.

• #locale=(locale : String)

  The ICU locale.

• #max_variable : String | Nil

  Field that determines up to which characters are considered ignorable when alternate: "shifted".

• #max_variable=(max_variable : String | Nil)

  Field that determines up to which characters are considered ignorable when alternate: "shifted".

• #normalization : Bool | Nil

  Flag that determines whether to check if text require normalization and to perform normalization.

• #normalization=(normalization : Bool | Nil)

  Flag that determines whether to check if text require normalization and to perform normalization.

• #numeric_ordering : Bool | Nil

  Flag that determines whether to compare numeric strings as numbers or as strings.

• #numeric_ordering=(numeric_ordering : Bool | Nil)

  Flag that determines whether to compare numeric strings as numbers or as strings.

• #strength : Int32 | Nil

  The level of comparison to perform.

• #strength=(strength : Int32 | Nil)

  The level of comparison to perform.

• #to_bson(bson = BSON.new)

  Converts to a BSON representation.

Constructor Detail

class User
  include BSON::Serializable
  property name : String
end

data = BSON.new
data["name"] = "John"
User.new(data)

collation = Mongo::Collation.new(locale: "fr")

Class Method Detail

Instance Method Detail

user = User.new name: "John"
bson = user.to_bson