Add user documentation about unique index creation #2856
Conversation
rumyantseva
added
the
documentation
rumyantseva
requested review from
a team,
w84thesun,
chilagrow,
noisersup and
Fashander
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #2856 +/- ##
=======================================
Coverage 63.77% 63.77%
=======================================
Files 448 448
Lines 22890 22890
=======================================
Hits 14598 14598
Misses 7334 7334
Partials 958 958
Flags with carried forward coverage won't be shown. Click here to find out more. |
rumyantseva
changed the title
website/docs/indexes.md
Outdated
| ```js | ||
| db.products.createIndex({ category: 1, name: 1 }, { unique: true }) | ||
| ``` | ||
|
|
||
| :::note |
There was a problem hiding this comment.
That note does not really belong to that section.
Please update the documentation, not just insert your own bit
There was a problem hiding this comment.
This note doesn't belong to compound indexes either. It's rather for the whole index creation section. Do you have a suggestion where it should be moved?
There was a problem hiding this comment.
No, but I know that it should not be there. It was wrong too and is wrong now after insertion
There was a problem hiding this comment.
Does it look better now (as a separate section)?
| db.products.createIndex({ category: 1, name: 1 }, { unique: true }) | ||
| ``` | ||
|
|
||
| ### Index creation details |
There was a problem hiding this comment.
@rumyantseva A separate section may be quite confusing since we have one on how to create indexes. Let's add this to the section above on how to create indexes.
There was a problem hiding this comment.
It can be a subsection there too or just as extra details after this sentence You can create single field indexes or compound indexes.
There was a problem hiding this comment.
"Index creation details" is a subsection of "How to create indexes", not a top-level section
There was a problem hiding this comment.
@Fashander Please send a new PR to improve that page if needed
Description
Closes #2045.
Readiness checklist
task all, and it passed.@FerretDB/core), Labels, Project and project's Sprint fields.