Node and React Native Data Types #1065

mohammadhunan-dev · 2021-05-11T15:57:47Z

Note to the reviewer

This PR only needs a sanity check review, as the pages of this PR have already been copy and technical reviewed in other PRs.

Pull Request Info

Jira

https://jira.mongodb.org/browse/DOCSP-16176

Staged Changes (Requires MongoDB Corp SSO)

Review Guidelines

REVIEWING.md

* new data types for node * added data types to TOC Co-authored-by: Mohammad Hunan Chughtai <mohammad.hunan@mongodb.com>

* 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>

* 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>

* 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>

* 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 - 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>

* 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)

* 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>

nathan-contino-mongo

LGTM with some nitpicks and suggestions on the Node docs. All of my comments apply twofold: once to the Node page I commented on, but also to the React Native equivalent of the page that just has different anchor link names.

nathan-contino-mongo · 2021-05-19T14:19:05Z

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

+- ``objectId`` maps to BSON :manual:`ObjectId </reference/method/ObjectId/>` type.
+- ``data`` maps to the JavaScript :mdn:`ArrayBuffer <Web/JavaScript/Reference/Global_Objects/ArrayBuffer>` type.
+- ``date`` maps to the JavaScript :mdn:`Date <Web/JavaScript/Reference/Global_Objects/Date>` type.
+- ``list`` maps to the JavaScript :mdn:`Array <Web/JavaScript/Reference/Global_Objects/Array>` type. You can also specify that a field contains a list of a primitive value type by appending ``[]`` to the type name.


Suggested change

- ``list`` maps to the JavaScript :mdn:`Array <Web/JavaScript/Reference/Global_Objects/Array>` type. You can also specify that a field contains a list of a primitive value type by appending ``[]`` to the type name.

- ``list`` maps to the JavaScript :mdn:`Array <Web/JavaScript/Reference/Global_Objects/Array>` type. You can also specify that a field contains a list of a primitive value types by appending ``[]`` to the type name.

Fixed locally 👍 , ignoring the commit suggestion. Changed it to "...contains a list of primitive value types by appending []"

nathan-contino-mongo · 2021-05-19T14:25:15Z

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

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


It looks like the SDK actually uses the term Realm.Set (with a period in the middle) to refer to this type. Since "Realm Set" (with a space, no period) isn't actually a type in the SDK, I would suggest either:

removing the monospace formatting from the term (reserved for literal type names)

switching the space to a period so we're using the literal name of the type in the SDK.

If the SDK uses the name "Realm Set" with a space in the middle, then you can safely ignore this. But since most languages don't support type names containing spaces, I think we ought to change this.

The SDK term is Realm.Set, but I've defined it as "Realm Set" to indicate that it the term is a proper noun and to avoid confusion with the JavaScript set term.

OK, but you shouldn't monospace the term if it isn't a literal code term. You can bold it if you want to highlight it as a key term, but monospace is reserved for code references.

I see, didn't realize monospace was reserved for code references. Changing it to bold now.

nathan-contino-mongo · 2021-05-19T14:26:24Z

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

+- bool
+- int 
+- float 
+- double 
+- string
+- Date 
+- Data
+- UUID
+- Set
+- null


Since these are all literal type names, can we monospace format these?

nathan-contino-mongo · 2021-05-19T14:27:10Z

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

+-------------------
+To :ref:`set a property of your object model
+<node-define-a-realm-object-schema>` as mixed, set the property's type to
+``"mixed"``.


nitpick: can we move the quotes here outside of the monospace formatting, since it's not part of the literal type name?

nathan-contino-mongo · 2021-05-19T14:28:33Z

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

+
+   The mixed data type is indexable, but you can't use it as a primary key.
+   Because null is a permitted value, you can't declare a Mixed property as
+   optional.


This sentence is a bit confusing to me -- the second bit doesn't really follow from the first. If a Mixed property can have the value null, wouldn't it essentially always be optional? Perhaps a second clarifying sentence to explain this could be helpful.

Optional means that it can or cannot contain a value, and null is technically a value. Going to avoid changing this for now, since this sentence has already been copy + tech reviewed, but will add the suggestion to a list of iterative updates.

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

nathan-contino-mongo · 2021-05-19T14:31:13Z

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

+   In general, you can use ``UUID`` in any field that you need a unique
+   identifier. Using ``UUID`` might be particularly useful if you are migrating
+   data not stored in MongoDB since it is likely that your object's unique
+   identifiers are already of a ``UUID`` type.


No callout here to the fact that you should use ObjectId for collections of data that already exist in MongoDB? That feels like a significant omission since without that statement we basically never talk about when you would actually use ObjectId.

Fair point, I've added the sentence "Alternatively, using ObjectId might be useful for a collection of data that already exists in MongoDB."

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

nathan-contino-mongo · 2021-05-19T14:35:30Z

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

+your :ref:`object model <node-object-schemas>`. Create a {+service-short+}
+object within a write transaction. To set any unique identifier properties of


Suggested change

your :ref:`object model <node-object-schemas>`. Create a {+service-short+}

object within a write transaction. To set any unique identifier properties of

your :ref:`object model <node-object-schemas>`. To set any unique identifier properties of

I'm not sure if the command/instruction to "create a Realm object within a write transaction" actually fits here. Readers already know that you're talking about a theoretical object model that contains a UUID field, so personally I'd say that the instructions to set properties with new UUID() should suffice to explain how to generate new UUID instances and put them in such an object.

Decided to ignore this one, as it doesn't hurt to re-explain that it needs to be within a write transaction. Personally, I've made the mistake of not writing in a write transaction, and then realized once I got the error, so I think a short reminder sentence might be helpful.

Fair enough, but just note that we don't tell users to modify fields in write transactions in the very same paragraph, even though you need to use a write transaction for all modifications.

Perhaps you've missed the point of my comment, though, which was that instructing users to create an instance of the object is probably redundant since they'll know that they need an instance to modify a property.

'in the very same paragraph' as in the last sentence of that paragraph?: 'Alternatively, set a string to new UUID() to set the unique identifier property to a specific value.'? That sentence is meant to show a specific usage of the new UUID constructor, rather than how to use UUIDs as a whole within the realm and within a write object (which the previous sentences teach).

Even if it's a bit redundant, I think that sentence still works and could be helpful to readers who may not know or who forget that you need a write transaction and an instance of an object to set or modify a uuid property.

Let me know if I'm misunderstanding your concern/suggestion though.

Co-authored-by: nate contino <nathan.contino@mongodb.com>

Mohammad Hunan Chughtai and others added 9 commits May 5, 2021 20:55

New data types node rn (#1040)

849b626

* 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

d9d42cd

update doc

765c511

Remove accidental changes

bbc7817

added empty test file

9054308

(DOCSP-15613): Added Node.js field types (#1041)

c894f77

* 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>

mohammadhunan-dev added the DO NOT MERGE label May 11, 2021

Mohammad Hunan Chughtai and others added 3 commits May 13, 2021 01:50

mohammadhunan-dev removed the DO NOT MERGE label May 19, 2021

Mohammad Hunan Chughtai added 6 commits May 19, 2021 09:30

fill out field types

2202f42

add react native data types as a copy of node data types

43e9e37

add data types to toc

6b5aaef

fix rn mixed links

63a342e

attempt to add realm-js links

33d63be

more grammar and woridng fixes

b2587f1

mohammadhunan-dev changed the title ~~WIP - Node Data Types~~ Node Data Types May 19, 2021

mohammadhunan-dev changed the title ~~Node Data Types~~ Node and React Native Data Types May 19, 2021

nathan-contino-mongo approved these changes May 19, 2021

View reviewed changes

Mohammad Hunan Chughtai and others added 7 commits May 19, 2021 11:21

wording fixes

d7dbb9e

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

96870ba

Co-authored-by: nate contino <nathan.contino@mongodb.com>

change uuid note on rn to match node

efb91b9

added note about obj id to both rn and node

375093f

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

f2035ae

Co-authored-by: nate contino <nathan.contino@mongodb.com>

fix 'mixed' formatting on rn to match node

897704a

change monospace to bold

c44908b

Mohammad Hunan Chughtai added 4 commits May 19, 2021 11:38

fix spacing errors

e0ea0fc

fix wording

97a5350

correct supported types for mixed

99078cc

wording update

e0cc203

mohammadhunan-dev merged commit f43ae61 into master May 19, 2021

mohammadhunan-dev deleted the new-data-types-node-rn branch May 19, 2021 20:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Node and React Native Data Types #1065

Node and React Native Data Types #1065

mohammadhunan-dev commented May 11, 2021 •

edited

Loading

nathan-contino-mongo left a comment

nathan-contino-mongo May 19, 2021

mohammadhunan-dev May 19, 2021

nathan-contino-mongo May 19, 2021

mohammadhunan-dev May 19, 2021

nathan-contino-mongo May 19, 2021

mohammadhunan-dev May 19, 2021

nathan-contino-mongo May 19, 2021

mohammadhunan-dev May 19, 2021

nathan-contino-mongo May 19, 2021

mohammadhunan-dev May 19, 2021

nathan-contino-mongo May 19, 2021

mohammadhunan-dev May 19, 2021

nathan-contino-mongo May 19, 2021

mohammadhunan-dev May 19, 2021

nathan-contino-mongo May 19, 2021

mohammadhunan-dev May 19, 2021

nathan-contino-mongo May 19, 2021

mohammadhunan-dev May 19, 2021

	- ``list`` maps to the JavaScript :mdn:`Array <Web/JavaScript/Reference/Global_Objects/Array>` type. You can also specify that a field contains a list of a primitive value type by appending ``[]`` to the type name.
	- ``list`` maps to the JavaScript :mdn:`Array <Web/JavaScript/Reference/Global_Objects/Array>` type. You can also specify that a field contains a list of a primitive value types by appending ``[]`` to the type name.

		your :ref:`object model <node-object-schemas>`. Create a {+service-short+}
		object within a write transaction. To set any unique identifier properties of

Node and React Native Data Types #1065

Node and React Native Data Types #1065

Conversation

mohammadhunan-dev commented May 11, 2021 • edited Loading

Note to the reviewer

Pull Request Info

Jira

Staged Changes (Requires MongoDB Corp SSO)

Review Guidelines

nathan-contino-mongo 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

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

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 11, 2021 •

edited

Loading