Skip to content

Commit c66ae08

Browse files
author
Chris Cho
authored
DOCSP-32718: add CodeWhisperer comments to collation code snippets (#763)
* DOCSP-32718: add CodeWhisperer comments to collation code snippets
1 parent 11461c3 commit c66ae08

14 files changed

+126
-61
lines changed

‎source/code-snippets/collation/aggregation-collation.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1+
/*
2+
Retrieve the total number of matching names, grouped by the first_name
3+
field and sorted by using the German phonebook collation.
4+
*/
5+
// start aggregation collation
16
myColl.aggregate(
27
[
38
{ $group: { "_id": "$first_name", "nameCount": { "$sum": 1 } } },
49
{ $sort: { "_id": 1 } },
510
],
611
{ collation: { locale: "de@collation=phonebook" } },
712
);
13+
// end aggregation collation

‎source/code-snippets/collation/collection-auto-collation.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// Retrieve documents that match "photograph" in the "type" field
2+
// start auto collation
3+
myColl.find({type: "photograph"});
4+
// end auto collation

‎source/code-snippets/collation/collection-collation.js‎

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,6 @@
1-
// start create collection with collation
2-
// Create the collection with a collation
1+
// Create the "souvenirs" collection and specify the French Canadian collation
2+
// start collection collation
33
db.createCollection("souvenirs", {
44
collation: { locale: "fr_CA" },
55
});
6-
// end create collection with collation
7-
8-
// start collection query without collation
9-
myColl.find({type: "photograph"});
10-
// end collection query without collation
11-
12-
// start collection query with collation
13-
myColl.find({type: "photograph"},
14-
{ collation: { locale: "is", caseFirst: "upper" } }
15-
);
16-
// end collection query with collation
6+
// end collection collation

‎source/code-snippets/collation/collection-specify-collation.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/*
2+
Retrieve documents that match "photograph" in the "type" field,
3+
sorted by the Iceland collation and uppercase precedence.
4+
*/
5+
// start specified collation
6+
myColl.find({type: "photograph"},
7+
{ collation: { locale: "is", caseFirst: "upper" } }
8+
);
9+
// end specified collation

‎source/code-snippets/collation/find-sort-collation.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1+
/*
2+
Retrieve documents that match "New York" in the "city" field,
3+
sorted by the "name" field by using the German collation.
4+
*/
5+
// start find sort collation
16
myColl.find({ city: "New York" }, { collation: { locale: "de" } })
27
.sort({ name: 1 });
8+
// end find sort collation

‎source/code-snippets/collation/findOneAndDelete-collation.js‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
// start findOneAndDelete example without collation
2-
await myColl.findOneAndDelete({ a: { $gt: "100" } });
3-
// end findOneAndDelete example without collation
4-
5-
// start findOneAndDelete example with collation
1+
/*
2+
Delete the first document that contains a value greater
3+
than 100 in the "a" field when ordered by using the
4+
English numeric collation order.
5+
*/
6+
// start findOneAndDelete collation
67
myColl.findOneAndDelete(
78
{ a: { $gt: "100" } },
89
{ collation: { locale: "en", numericOrdering: true } },
910
);
10-
// end findOneAndDelete example with collation
11+
// end findOneAndDelete collation

‎source/code-snippets/collation/findOneAndDelete-no-collation.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/*
2+
Delete the first document that contains a value greater
3+
than 100 in the "a" field when ordered by using the default
4+
binary collation order.
5+
*/
6+
// start findOneAndDelete no collation
7+
await myColl.findOneAndDelete({ a: { $gt: "100" } });
8+
// end findOneAndDelete no collation

‎source/code-snippets/collation/findOneAndUpdate-collation.js‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
// start findOneAndUpdate without collation
2-
myColl.findOneAndUpdate(
3-
{ first_name : { $lt: "Gunter" } },
4-
{ $set: { verified: true } }
5-
);
6-
// end findOneAndUpdate without collation
7-
8-
// start findOneAndUpdate with collation
1+
/*
2+
Update the "verified" field to "true" for the first document
3+
that precedes "Gunter" when ordered by using the
4+
German phonebook collation order.
5+
*/
6+
// start findOneAndUpdate collation
97
myColl.findOneAndUpdate(
108
{ first_name: { $lt: "Gunter" } },
119
{ $set: { verified: true } },
1210
{ collation: { locale: "de@collation=phonebook" } },
1311
);
14-
// end findOneAndUpdate with collation
12+
// end findOneAndUpdate collation

‎source/code-snippets/collation/findOneAndUpdate-default-order-collation.js‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/*
2+
Update the "verified" field to "true" for the first document
3+
that precedes "Gunter" when ordered by using the
4+
default binary collation order.
5+
*/
6+
// start findOneAndUpdate default order collation
7+
myColl.findOneAndUpdate(
8+
{ first_name : { $lt: "Gunter" } },
9+
{ $set: { verified: true } }
10+
);
11+
// end findOneAndUpdate default order collation

‎source/code-snippets/collation/index-collation.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
/*
2+
Create an index on the "title" field with the "en_US"
3+
locale collation, specifying ascending ordering of the
4+
"title" field.
5+
*/
6+
// start create index collation
17
myColl.createIndex(
28
{ 'title' : 1 },
39
{ 'collation' : { 'locale' : 'en_US' } });
10+
// end create index collation

0 commit comments

Comments
 (0)