cursor.collation()

Definition定义

cursor.collation(<collation document>)

Important重要

mongosh Method

This is a mongosh method. This is not the documentation for Node.js or other programming language specific driver methods.

In most cases, mongosh methods work the same way as the legacy mongo shell methods. However, some legacy methods are unavailable in mongosh.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

• mongo shell v4.4
• mongo shell v4.2
• mongo shell v4.0

For MongoDB API drivers, refer to the language specific MongoDB driver documentation.

Specifies the collation for the cursor returned by the db.collection.find(). 指定db.collection.find()返回的游标的排序规则。To use, append to the db.collection.find().要使用，请将附加到db.collection.find()。

The cursor.collation() accepts the following collation document:cursor.collation()接受以下排序规则文档：

{
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

When specifying collation, the locale field is mandatory; all other collation fields are optional. 指定排序规则时，locale字段是必需的；所有其他排序字段都是可选的。For descriptions of the fields, see Collation Document.有关字段的描述，请参阅排序规则文档。

Field字段	Type类型	Description描述
locale	string	The ICU locale. ICU地区。See Supported Languages and Locales for a list of supported locales.有关支持的区域设置列表，请参阅支持的语言和区域设置。 To specify simple binary comparison, specify locale value of "simple".要指定简单的二进制比较，请将locale值指定为"simple"。
strength	integer	Optional. 可选。The level of comparison to perform. 要执行的比较级别。Corresponds to ICU Comparison Levels. 对应ICU比较级别。Possible values are:可能的值为： Value值 Description描述 1 Primary level of comparison. 初级比较。Collation performs comparisons of the base characters only, ignoring other differences such as diacritics and case.排序规则只对基本字符进行比较，而忽略其他差异，如音调符号和大小写。 2 Secondary level of comparison. 二级比较。Collation performs comparisons up to secondary differences, such as diacritics. 排序规则执行到次要差异的比较，例如音调符号。That is, collation performs comparisons of base characters (primary differences) and diacritics (secondary differences). 也就是说，排序规则执行基本字符（主要差异）和音调符号（次要差异）的比较。Differences between base characters takes precedence over secondary differences.基本字符之间的差异优先于次要差异。 3 Tertiary level of comparison. 第三级比较。Collation performs comparisons up to tertiary differences, such as case and letter variants. 排序规则执行到三级差异的比较，例如大小写和字母变体。That is, collation performs comparisons of base characters (primary differences), diacritics (secondary differences), and case and variants (tertiary differences). 也就是说，排序执行基本字符（主要差异）、变音符号（次要差异）以及大小写和变体（三级差异）的比较。Differences between base characters takes precedence over secondary differences, which takes precedence over tertiary differences.基本字符之间的差异优先于次差异，次差异优先于三级差异。 This is the default level.这是默认级别。 4 Quaternary Level. 第四纪水平。Limited for specific use case to consider punctuation when levels 1-3 ignore punctuation or for processing Japanese text.在1-3级忽略标点符号或处理日语文本时，仅限于考虑标点符号的特定用例。 5 Identical Level. 相同级别。Limited for specific use case of tie breaker.仅限于断路器的特定使用情况。 See ICU Collation: Comparison Levels for details.有关详细信息，请参阅ICU排序：比较级别。
caseLevel	boolean	Optional. 可选。Flag that determines whether to include case comparison at strength level 1 or 2.用于确定是在strength级别1还是2包含事例比较的标志。 If true, include case comparison; i.e.如果为true，请包括案例比较；即。 When used with strength:1, collation compares base characters and case.与strength:1一起使用时，排序规则会比较基本字符和大小写。 When used with strength:2, collation compares base characters, diacritics (and possible other secondary differences) and case.与strength:2一起使用时，排序规则会比较基本字符、音调符号（以及其他可能的次要差异）和大小写。 If false, do not include case comparison at level 1 or 2. 如果为false，则不包括级别1或2的案例比较。The default is false.默认值为false。 For more information, see ICU Collation: Case Level.有关更多信息，请参阅ICU排序：大小写级别。
caseFirst	string	Optional. 可选。A field that determines sort order of case differences during tertiary level comparisons.在三级比较期间确定大小写差异排序顺序的字段。 Possible values are:可能的值为： Value值 Description描述 "upper" Uppercase sorts before lowercase.在小写之前进行大写排序。 "lower" Lowercase sorts before uppercase.在大写之前进行小写排序。 "off" Default value. 默认值。Similar to "lower" with slight differences. 类似于"lower"，但略有不同。See http://userguide.icu-project.org/collation/customization for details of differences. 参阅http://userguide.icu-project.org/collation/customization了解差异的详细信息。
numericOrdering	boolean	Optional. 可选。Flag that determines whether to compare numeric strings as numbers or as strings.用于确定将数字字符串作为数字还是字符串进行比较的标志。 If true, compare as numbers; i.e. "10" is greater than "2".如果为true，则作为数字进行比较；即"10"大于"2"。 If false, compare as strings; i.e. "10" is less than "2".如果为false，则作为字符串进行比较；即"10"小于"2"。 Default is false.默认值为false。
alternate	string	Optional. 可选。Field that determines whether collation should consider whitespace and punctuation as base characters for purposes of comparison.字段，用于确定排序规则是否应将空格和标点符号作为比较的基本字符。 Possible values are:可能的值为： Value值 Description描述 "non-ignorable" Whitespace and punctuation are considered base characters.空格和标点符号被视为基本字符。 "shifted" Whitespace and punctuation are not considered base characters and are only distinguished at strength levels greater than 3. 空格和标点符号不被视为基本字符，仅在大于3的强度级别上区分。 See ICU Collation: Comparison Levels for more information.更多信息请参见ICU排序：比较级别 Default is "non-ignorable".默认值为“不可忽略”。
maxVariable	string	Optional. 可选。Field that determines up to which characters are considered ignorable when alternate: "shifted". 字段，用于确定在alternate: "shifted"时最多可忽略哪些字符。Has no effect if alternate: "non-ignorable"如果alternate: "non-ignorable"则无效 Possible values are:可能的值为： Value值 Description描述 "punct" Both whitespaces and punctuation are "ignorable", i.e. not considered base characters. 空格和标点符号都是“可忽略的”，即不被视为基本字符。 "space" Whitespace are "ignorable", i.e. not considered base characters. 空白是“可忽略的”，即不被视为基本字符。
backwards	boolean	Optional. 可选。Flag that determines whether strings with diacritics sort from back of the string, such as with some French dictionary ordering.用于确定带音调符号的字符串是否从字符串的后面排序的标志，例如使用一些法语词典排序。 If true, compare from back to front.如果是true，从后面到前面进行比较。 If false, compare from front to back.如果false，请从前面到后面进行比较。 The default value is false.默认值为false。
normalization	boolean	Optional. 可选。Flag that determines whether to check if text require normalization and to perform normalization. 确定是否检查文本是否需要规范化并执行规范化的标志。Generally, majority of text does not require this normalization processing.通常，大多数文本不需要这种规范化处理。 If true, check if fully normalized and perform normalization to compare text.如果为true，请检查是否完全规范化，并执行规范化以比较文本。 If false, does not check.如果为false，则不检查。 The default value is false.默认值为false。 See http://userguide.icu-project.org/collation/concepts#TOC-Normalization for details.请参阅http://userguide.icu-project.org/collation/concepts#TOC-Normalization。

Examples示例

Consider a collection foo with the following documents:考虑一个foo集合包含以下文档：

{ "_id" : 1, "x" : "a" }
{ "_id" : 2, "x" : "A" }
{ "_id" : 3, "x" : "á" }

The following operation specifies a query filter of x: "a". 以下操作指定x: "a"的查询筛选器。The operation also includes a collation option with locale: "en_US"(US English locale) and strength: 1 (compare base characters only; i.e. ignore case and diacritics):该操作还包括一个排序选项，locale: "en_US"（美国英语区域设置），strength: 1（仅比较基本字符；即忽略大小写和音调符号）：

db.foo.find( { x: "a" } ).collation( { locale: "en_US", strength: 1 } )

The operation returns the following documents:该操作返回以下文档：

{ "_id" : 1, "x" : "a" }
{ "_id" : 2, "x" : "A" }
{ "_id" : 3, "x" : "á" }

If you do not specify the collation, i.e. db.collection.find( { x: "a" } ), the query would only match the following document:如果未指定排序规则，即db.collection.find( { x: "a" } )，则查询将只匹配以下文档：

db.foo.find( { x: "a" } )

You can chain other cursor methods, such as cursor.sort() and cursor.count(), to cursor.collation():您可以将其他游标方法（如cursor.sort()和cursor.count()）链接到cursor.collation()：

db.collection.find({...}).collation({...}).sort({...});
db.collection.find({...}).collation({...}).count();