docs(populate): add a little more info on why we recommend using ObjectId for _id
#13474
Conversation
…ctId for `_id` Fix #13400
vkarpov15
requested review from
Uzlopak,
hasezoey,
AbdelrahmanHafez and
IslandRhythms
| You can set the `ref` option on `ObjectId`, `Number`, `String`, and `Buffer` paths. | ||
| `populate()` works with ObjectIds, numbers, strings, and buffers. | ||
| However, we recommend using ObjectIds as `_id` properties (and thus ObjectIds for `ref` properties) unless you have a good reason not to. | ||
| That is because MongoDB will set `_id` to an ObjectId if you create a new document without an `_id` property, so if you make your `_id` property a Number, you need to be extra careful not to insert a document without a numeric `_id`. |
There was a problem hiding this comment.
maybe mention that mongoose can help with that via validators, like using required: true and for non-default types to have to use default: () => newType to generate a new id (via a function instead of statically)
|
@vkarpov15 I just had a question about this PR. Should we be saying we are using the mongodb ObjectId type defn rather than our own b/c I found that we have defined in our type defns to use the mongoose specific one that extends the mongodb one but that isn't the case in reality (from testing). See my issue here: #13473 |
|
@BioSurienDG I'm not sure what your question has to do with this PR? I'd generally recommend using |
Ya no worries. I had thought it was a documentation issue that could be resolved in this but was actually a bug - pls disregard my comment on the PR 🙂 |
Fix #13400
Summary
Re: #13400, populate docs don't really explain why we recommend using ObjectId for
_idandref. Added a note about that, and moved the note to the "Saving Refs" section.Examples