(DOCSP-14573): set data type #1079

mohammadhunan-dev · 2021-05-13T06:57:40Z

Pull Request Info

MongoCaleb

Overall comment: I have no idea WHY I would use a set over an array. Perhaps JS developers already know that? Also, there is no section on how to retrieve a value from a set, and I assume that's because you can't -- you have to iterate? Is it worth any additional info about that?

MongoCaleb · 2021-05-14T16:40:51Z

source/sdk/node/data-types/sets.txt

+--------
+A {+service-short+} set is a special object that allows you to store a


"special object" sounds weird and doesn't really tel us anything. Since everyone is familiar with Arrays, perhaps a start like this?

A {+service-short+} set is an object that stores a collection of values. A Set is similar to an Array, except:

Each value in a Set must be unique,

Arrays are ordered by index, while sets are iterable and unordered (this isn't quite right...)

I'm down for being a bit clearer on the advantages of Set. I do want to keep it a bit more subtle and not necessarily bring up array for the following reasons:

JavaScript developers should probably know the differences between set and array. Explaining the differences between the two would be explaining JS, not explaining how to use Realm with JS. For those that aren't familiar with the differences, I've linked out to the mdn docs on set.

As for showing when to use set, I've added some info in the intro, the new intro reads:

"A Realm Set is a special object that allows you to store a collection of unique values. Realm Sets are based on JavaScript Sets, but can only contain values of a single type and can only be modified within a write transaction. Sets allow you to perform math operations such as finding the union, intersection, or difference between two sets. To learn more about performing these operations, see the MDN docs for Implementing basic set operations."

The JS Set does not currently support the math operations. Its implementation has been kept as close as possible to JS's own set type.

MongoCaleb · 2021-05-14T16:42:01Z

source/sdk/node/data-types/sets.txt

+--------
+A {+service-short+} set is a special object that allows you to store a
+collection of unique values. {+service-short+} sets work similarly to JavaScript


sets work similarly to JavaScript
to
sets are based on JavaScript Sets, but are limited to a single value type and can only be modified...

took this suggestion almost verbatim 👍

MongoCaleb · 2021-05-14T16:42:36Z

source/sdk/node/data-types/sets.txt

+   When using a ``forEach()`` loop or other :mdn:`iteration methods
+   <Web/JavaScript/Reference/Global_Objects/Set#iteration_methods>` to iterate
+   through a loop, {+service-short+} sets may be in a different order than


through a loop,
to
through a set,

Changed the sentence to: "When using a forEach() loop or other iteration method to traverse the set in a loop, the content of the Realm Set may be in a different order than originally written to."

MongoCaleb · 2021-05-14T16:43:51Z

source/sdk/node/data-types/sets.txt

+   originally written to. If you require an ordered version of your set, you
+   must implement that order yourself. You can do this by creating an array of
+   the set's values in the insertion order.


The last sentence here is confusing. Are you saying the user should create an Array that gets updated every time the set is updated, and insert into the array in the order I want?

Essentially, that's it. I've altered it to be a bit clearer:

"You can do this by creating an array from the set, using Array.from(mySet), and updating that array when the set has been modified through a change listener."

MongoCaleb · 2021-05-14T16:45:28Z

source/sdk/node/data-types/sets.txt

+Realm Object Models
+-------------------
+To define a property's values as a {+service-short+} set, specify the data type


Can this be shortened to:

To define a property type as a Set, specify the data type you want in the set, followed by <>

That works, fixed now 👍

MongoCaleb · 2021-05-14T16:48:30Z

source/sdk/node/data-types/sets.txt

+Create an Object With a Set
+---------------------------
+To create an object with a property that value is of the set data type, create a


The wording here is confusing me.
Does this work?

To create an object that has one or more set properties, you must create the object within a write transaction. You then initialize the set-type properties as you would an array, by passing the initial values in brackets ([])

How about a combo of the two phrasings:

"To create an object with a {+service-short+} Set property, you must create the object within a write transaction. When defining your Realm object, initialize the set by passing an empty array or an array with your initial values."

MongoCaleb · 2021-05-14T16:48:55Z

source/sdk/node/data-types/sets.txt

+Check if a Set has Specific Items
+---------------------------------
+To find out if a set has a particular value, pass the value to the ``set.has()`` method. The


consider changing "To find out" to "To determine"

ccho-mongodb

There are some changes I think you should make and some nitpicks, but I'll approve since Caleb is also reviewing this.

ccho-mongodb · 2021-05-14T16:28:08Z

source/sdk/node/data-types/sets.txt

+--------
+A {+service-short+} set is a special object that allows you to store a


I wonder if we should make it conspicuous that "Realm Set" is a term, either through capitalization similar to Javascript "Set" or using a bold format.
After reading the first couple of paragraphs, I'm also curious as to whether you can use Javascript Sets instead, or if I can only use Realm Sets since the title of the page is Sets.

I agree: A Realm Set is not a 1:1 mapping of a JavaScript Set (but heavily inspired by it).

Fair point, I've altered it to be "Realm Set" consistently throughout the doc to indicate it is a term.

As for indicating that it is not a 1:1 mapping, I've included the line: "Realm sets work similarly to JavaScript Sets, except they must be a single type and can only be modified within a write-transaction"

source/sdk/node/data-types/sets.txt

examples/node/Examples/data-types.js

mohammadhunan-dev · 2021-05-18T17:40:27Z

@MongoCaleb per your top level comment: "Overall comment: I have no idea WHY I would use a set over an array. Perhaps JS developers already know that? Also, there is no section on how to retrieve a value from a set, and I assume that's because you can't -- you have to iterate? Is it worth any additional info about that?"

Added some info about the benefits of using a Set, but I'm opposed to directly mentioning Arrays in this doc since I think it may confuse readers. Fundamentally they are two different data types with unique use cases, see more about my reasoning for not directly mentioning Arrays here: (DOCSP-14573): set data type #1079 (comment)
About retrieving a value from a set, you can check if a set has a value (shown in Node.js > Sets # Check if a Set has Specific Items since sets are not retrievable via any index like arrays. Alternatively, you can iterate through the values in a set with a forEach loop, but I don't think we should show a snippet of that since iteration of a set using a forEach loop might confuse readers and imply that a set is similar to an array and since we don't guarantee traversal order.

source/examples/generated/node/data-types.codeblock.remove-all-items-from-set.js

source/examples/generated/node/data-types.codeblock.remove-specific-item-from-set.js

source/sdk/node/data-types/sets.txt

kneth · 2021-05-19T07:48:23Z

source/sdk/node/data-types/sets.txt

+   of your set, you must implement that ordering yourself.If you require an
+   ordered version of your set, you must implement that order yourself. You can
+   do this by creating an array from the set, using :mdn:`Array.from(mySet)


The spread operator (...) will also work.

…-items-from-set.js Co-authored-by: Kenneth Geisshirt <k@zigzak.net>

…cific-item-from-set.js Co-authored-by: Kenneth Geisshirt <k@zigzak.net>

Co-authored-by: Kenneth Geisshirt <k@zigzak.net>

… fix merge conf

* New data types node rn (#1040) * new data types for node * added data types to TOC Co-authored-by: Mohammad Hunan Chughtai <mohammad.hunan@mongodb.com> * fixed refs for node.js data types * update doc * Remove accidental changes * added empty test file * (DOCSP-15613): Added Node.js field types (#1041) * Added node.js field types * fixed wording * fixed typo * fix typo in mdn urls * added additional data types * fix monospace err Co-authored-by: Mohammad Hunan Chughtai <mohammad.hunan@mongodb.com> * (DOCSP-15613): Node.js collections type (#1044) * Add content to Node.js > Data Types > Collections.txt * Removed unneeded spacing * clean up collections page + add headers * Filled out collections page * fix refs * fix typo * Update source/sdk/node/data-types/collections.txt * Update source/sdk/node/data-types/collections.txt * Update source/sdk/node/data-types/collections.txt Co-authored-by: Dachary <dc@dacharycarey.com> * fix rst * fix woridng * added ref * removed unneeded word * removed unneeded word * added period Co-authored-by: Mohammad Hunan Chughtai <mohammad.hunan@mongodb.com> Co-authored-by: Dachary <dc@dacharycarey.com> * (DOCSP-15613): Node.js embedded objects type (#1047) * Added documentation of Node.js embedded objects under data types * clean up relationships and embedded objects * added CRUD examples for embedded obj * added bluehawked examples * fix rst syntax highlight + add description for deletes * Update source/sdk/node/data-types/embedded-objects.txt * Update source/sdk/node/data-types/embedded-objects.txt * Update source/sdk/node/data-types/embedded-objects.txt * Update source/sdk/node/data-types/embedded-objects.txt * Update source/sdk/node/data-types/embedded-objects.txt Co-authored-by: Mohammad Hunan Chughtai <mohammad.hunan@mongodb.com> * Docsp 14569 mixed data type (#1064) * attempt to add bluehawked mixed example snippets * fixed wording * Update source/examples/generated/node/data-types.codeblock.query-objects-with-mixed-values.js * Update examples/node/Examples/data-types.js Co-authored-by: Mohammad Hunan Chughtai <mohammad.hunan@mongodb.com> * (DOCSP-14565): Dictionary data type (#1058) * (DOCSP-14565): Dictionary Data Type - Node.js * added unit tested + bluehawked dictionary examples * Update examples/node/package.json * removed unneeded file * Added new examples for dictionaries * update dictionary examples * fix capitalization * moved addlistener down * fix comment * update wording to be clearer on type usage in dict * fix wording * fix wording Co-authored-by: Mohammad Hunan Chughtai <mohammad.hunan@mongodb.com> * (DOCSP-14577): UUID (#1067) * bump realmjs to 10.5.0-beta-1 * removed uuid as it's own page and added a subsection on it * added uuid bluehawked snippet + readded uuid to toc * added uuid examples * removed uuid from field types as a paragraph * update wording * update wording * fix passive voice * add specific uuid example * removed innacurate collections are homogenous (per mixed) * (DOCSP-14573): set data type (#1079) * added set examples + bluehawked * literal included set exampkes * added delete one set item example * fix typo * added descriptions to set * fix grammar * changed link + hunter to generic names * added capitalization to clearly define Realm Set as a term * fix wording + formatting" * clarified wording * fix literalincldue indentation * fix typo * more wording fixes * clean up realm object model for set wording * fix character names for examples * clarified traversal order wording * rst typo in <set> * changed set to mySet * fix overview wording * updated overview to be more clear on differences between array * updated create wording * Update source/examples/generated/node/data-types.codeblock.remove-all-items-from-set.js Co-authored-by: Kenneth Geisshirt <k@zigzak.net> * Update source/examples/generated/node/data-types.codeblock.remove-specific-item-from-set.js Co-authored-by: Kenneth Geisshirt <k@zigzak.net> * Update source/sdk/node/data-types/sets.txt Co-authored-by: Kenneth Geisshirt <k@zigzak.net> * fix grammar + wording + changed Set to Realm.Set in js snippets * Fix woridng Co-authored-by: Kenneth Geisshirt <k@zigzak.net> * fill out field types * add react native data types as a copy of node data types * add data types to toc * fix rn mixed links * attempt to add realm-js links * more grammar and woridng fixes * wording fixes * Update source/sdk/node/data-types/uuid.txt Co-authored-by: nate contino <nathan.contino@mongodb.com> * change uuid note on rn to match node * added note about obj id to both rn and node * Update source/sdk/node/data-types/mixed.txt Co-authored-by: nate contino <nathan.contino@mongodb.com> * fix 'mixed' formatting on rn to match node * change monospace to bold * fix spacing errors * fix wording * correct supported types for mixed * wording update Co-authored-by: Mohammad Hunan Chughtai <mohammad.hunan@mongodb.com> Co-authored-by: Dachary <dc@dacharycarey.com> Co-authored-by: Kenneth Geisshirt <k@zigzak.net> Co-authored-by: nate contino <nathan.contino@mongodb.com>

added set examples + bluehawked

e59b6ae

mohammadhunan-dev changed the base branch from master to new-data-types-node-rn May 13, 2021 06:57

Mohammad Hunan Chughtai added 5 commits May 13, 2021 03:07

literal included set exampkes

b8be1d8

added delete one set item example

10ef9db

fix typo

ad8f25e

added descriptions to set

b5322f9

fix grammar

5ddbb5f

mohammadhunan-dev changed the title ~~WIP - (DOCSP-14573): set data type~~ (DOCSP-14573): set data type May 13, 2021

mohammadhunan-dev requested review from kneth and fronck May 13, 2021 13:38

MongoCaleb requested changes May 14, 2021

View reviewed changes

ccho-mongodb approved these changes May 14, 2021

View reviewed changes

Mohammad Hunan Chughtai added 15 commits May 17, 2021 16:13

changed link + hunter to generic names

62dae49

added capitalization to clearly define Realm Set as a term

3030419

fix wording + formatting"

179fdfc

clarified wording

e5baab5

fix literalincldue indentation

1c4a3a3

fix typo

4a469f3

more wording fixes

15fbdb8

clean up realm object model for set wording

81c94ad

fix character names for examples

55f6e4f

clarified traversal order wording

dc7d071

rst typo in <set>

c5561b7

changed set to mySet

5312d69

fix overview wording

ac8a4ec

updated overview to be more clear on differences between array

cad7aec

updated create wording

545a3c0

mohammadhunan-dev requested a review from MongoCaleb May 18, 2021 16:34

kneth approved these changes May 19, 2021

View reviewed changes

Mohammad Hunan Chughtai and others added 6 commits May 19, 2021 08:47

Update source/examples/generated/node/data-types.codeblock.remove-all…

a2e8387

…-items-from-set.js Co-authored-by: Kenneth Geisshirt <k@zigzak.net>

Update source/examples/generated/node/data-types.codeblock.remove-spe…

2e37543

…cific-item-from-set.js Co-authored-by: Kenneth Geisshirt <k@zigzak.net>

Update source/sdk/node/data-types/sets.txt

d6f993d

Co-authored-by: Kenneth Geisshirt <k@zigzak.net>

clarified that you can use spread operator to create array from set +…

0114373

… fix merge conf

fix grammar + wording + changed Set to Realm.Set in js snippets

5d8338d

Fix woridng

b5edd4b

mohammadhunan-dev merged commit c003974 into mongodb:new-data-types-node-rn May 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(DOCSP-14573): set data type #1079

(DOCSP-14573): set data type #1079

mohammadhunan-dev commented May 13, 2021 •

edited

MongoCaleb left a comment

MongoCaleb May 14, 2021

mohammadhunan-dev May 18, 2021 •

edited

fronck Jun 4, 2021

MongoCaleb May 14, 2021

mohammadhunan-dev May 18, 2021 •

edited

MongoCaleb May 14, 2021

mohammadhunan-dev May 18, 2021

MongoCaleb May 14, 2021

mohammadhunan-dev May 18, 2021

MongoCaleb May 14, 2021

mohammadhunan-dev May 17, 2021

MongoCaleb May 14, 2021

mohammadhunan-dev May 18, 2021

MongoCaleb May 14, 2021

mohammadhunan-dev May 17, 2021

ccho-mongodb left a comment

ccho-mongodb May 14, 2021

kneth May 17, 2021

mohammadhunan-dev May 17, 2021

mohammadhunan-dev commented May 18, 2021 •

edited

kneth May 19, 2021

mohammadhunan-dev May 19, 2021

		--------
		A {+service-short+} set is a special object that allows you to store a

(DOCSP-14573): set data type #1079

(DOCSP-14573): set data type #1079

Conversation

mohammadhunan-dev commented May 13, 2021 • edited

Pull Request Info

Jira

Staged Changes (Requires MongoDB Corp SSO)

Review Guidelines

MongoCaleb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohammadhunan-dev May 18, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohammadhunan-dev May 18, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccho-mongodb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohammadhunan-dev commented May 18, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohammadhunan-dev commented May 13, 2021 •

edited

mohammadhunan-dev May 18, 2021 •

edited

mohammadhunan-dev May 18, 2021 •

edited

mohammadhunan-dev commented May 18, 2021 •

edited