Skip to content

Commit ed9d6bc

Browse files
mongoKartmongoKart
committed
rm review
1 parent 169591e commit ed9d6bc

File tree

1 file changed

+57
-50
lines changed

1 file changed

+57
-50
lines changed

‎source/includes/collation.rst

Lines changed: 57 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -24,87 +24,94 @@ setting's value.
2424
| **Data Type**: {+string-data-type+}
2525
- ``Locale``
2626

27-
* - ``alternate``
28-
- | Optional. Specifies whether the driver considers whitespace and punctuation as base
29-
characters for purposes of comparison.
27+
* - ``caseLevel``
28+
- | *(Optional)* Specifies whether to include case comparison.
3029
|
31-
| **Data Type**: `CollationAlternate <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationAlternate.html>`__
32-
| **Default**: ``CollationAlternate.NonIgnorable`` (spaces and punctuation are
33-
considered base characters)
34-
- ``Alternate``
35-
36-
* - ``backwards``
37-
- | Optional. Specifies whether strings containing diacritics sort from the back of the string
38-
to the front.
30+
| When this argument is ``true``, the driver's behavior depends on the value of
31+
the ``strength`` argument:
32+
|
33+
| - If ``strength`` is ``CollationStrength.Primary``, the driver compares base
34+
characters and case.
35+
| - If ``strength`` is ``CollationStrength.Secondary``, the driver compares base
36+
characters, diacritics, other secondary differences, and case.
37+
| - If ``strength`` is any other value, this argument is ignored.
38+
|
39+
| When this argument is ``false``, the driver doesn't include case comparison at
40+
strength level ``Primary`` or ``Secondary``.
3941
|
4042
| **Data Type**: {+bool-data-type+}
4143
| **Default**: ``false``
42-
- ``Backwards``
44+
- ``CaseLevel``
4345

4446
* - ``caseFirst``
45-
- | Optional. Specifies the sort order of case differences during tertiary level comparisons.
47+
- | *(Optional)* Specifies the sort order of case differences during tertiary level comparisons.
4648
|
4749
| **Data Type**: `CollationCaseFirst <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationCaseFirst.html>`__
4850
| **Default**: ``CollationCaseFirst.Off``
4951
- ``CaseFirst``
5052

51-
* - ``caseLevel``
52-
- | Optional. Specifies whether to include case comparison at strength level ``Primary`` or
53-
``Secondary``.
54-
|
55-
| When this argument is ``true``:
53+
* - ``strength``
54+
- | *(Optional)* Specifies the level of comparison to perform, as defined in the
55+
`ICU documentation <https://unicode-org.github.io/icu/userguide/collation/concepts.html#comparison-levels>`__.
5656
|
57-
| - If the strength is ``Primary``, the driver compares base
58-
characters and case.
59-
| - If the strength is ``Secondary``, the driver compares base
60-
characters, diacritics, other secondary differences, and case.
57+
| **Data Type**: `CollationStrength <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationStrength.html>`__
58+
| **Default**: ``CollationStrength.Tertiary``
59+
- ``Strength``
60+
61+
* - ``numericOrdering``
62+
- | *(Optional)* Specifies whether the driver compares numeric strings as numbers.
63+
|
64+
| If this argument is ``true``, the driver compares numeric strings as numbers.
65+
For example, when comparing the strings "10" and "2", the driver treats the values
66+
as 10 and 2, and finds 10 to be greater.
67+
|
68+
| If this argument is ``false`` or excluded, the driver compares numeric strings
69+
as strings. For example, when comparing the strings "10" and "2", the driver
70+
compares one character at a time. Because "1" is less than "2", the driver finds
71+
"10" to be less than "2".
6172
|
62-
| When this argument is ``false``, the driver doesn't include case comparison at
63-
strength level ``Primary`` or ``Secondary``.
73+
| For more information, see :manual:`Collation Restrictions </reference/collation/#restrictions>`
74+
in the {+mdb-server+} manual.
6475
|
65-
| **Data Type**: {+bool-data-type+}
76+
| **Data Type**: {+bool-data-type+}
6677
| **Default**: ``false``
67-
- ``CaseLevel``
78+
- ``NumericOrdering``
79+
80+
* - ``alternate``
81+
- | *(Optional)* Specifies whether the driver considers whitespace and punctuation as base
82+
characters for purposes of comparison.
83+
|
84+
| **Data Type**: `CollationAlternate <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationAlternate.html>`__
85+
| **Default**: ``CollationAlternate.NonIgnorable`` (spaces and punctuation are
86+
considered base characters)
87+
- ``Alternate``
6888

6989
* - ``maxVariable``
70-
- | Optional. Specifies which characters the driver considers ignorable when
71-
``Alternate`` is ``CollationAlternate.Shifted``.
90+
- | *(Optional)* Specifies which characters the driver considers ignorable when
91+
the ``alternate`` argument is ``CollationAlternate.Shifted``.
7292
|
7393
| **Data Type**: `CollationMaxVariable <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationMaxVariable.html>`__
7494
| **Default**: ``CollationMaxVariable.Punctuation`` (the driver ignores punctuation
7595
and spaces)
7696
- ``MaxVariable``
7797

7898
* - ``normalization``
79-
- | Optional. Specifies whether the driver normalizes text as needed.
99+
- | *(Optional)* Specifies whether the driver normalizes text as needed.
80100
|
81-
| Most text doesn't require normalization.
101+
| Most text doesn't require normalization. For more information about
102+
normalization, see the `ICU documentation <https://unicode-org.github.io/icu/userguide/collation/concepts.html#normalization>`__.
82103
|
83104
| **Data Type**: {+bool-data-type+}
84105
| **Default**: ``false``
85106
- ``Normalization``
86107

87-
* - ``numericOrdering``
88-
- | Optional. Specifies whether the driver compares numeric strings as numbers.
89-
|
90-
| If this argument is ``true``, the driver compares numeric strings as numbers.
91-
For example, "10" is greater than "2". If this argument is ``false`` or excluded,
92-
the driver compares numeric strings as strings. For example, "10" is less than "2".
93-
|
94-
| For more information, see :manual:`Collation Restrictions </reference/collation/#restrictions>`
95-
in the {+mdb-server+} manual.
108+
* - ``backwards``
109+
- | *(Optional)* Specifies whether strings containing diacritics sort from the back of the string
110+
to the front.
96111
|
97-
| **Data Type**: {+bool-data-type+}
112+
| **Data Type**: {+bool-data-type+}
98113
| **Default**: ``false``
99-
- ``NumericOrdering``
100-
101-
* - ``strength``
102-
- | Optional. Specifies the level of comparison to perform, as defined in the
103-
`ICU documentation <https://unicode-org.github.io/icu/userguide/collation/concepts.html#comparison-levels>`__.
104-
|
105-
| **Data Type**: `CollationStrength <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.CollationStrength.html>`__
106-
| **Default**: ``CollationStrength.Tertiary``
107-
- ``Strength``
114+
- ``Backwards``
108115

109-
For more information about collation, see the :manual:`Collation <reference/collation>`
116+
For more information about collation, see the :manual:`Collation </reference/collation>`
110117
page in the {+mdb-server+} manual.

0 commit comments

Comments
 (0)