[DOCS-16165] [Server] add more details for per collection creation options (such as compression type) Created: 26/May/23 Updated: 06/Feb/24 |
|
| Status: | External Review |
| Project: | Documentation |
| Component/s: | manual, Server |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Critical - P2 |
| Reporter: | Thomas Luckenbach | Assignee: | Sarah Simpers |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | backlog, request, storage-engines, top250 | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| URL(s): | https://www.mongodb.com/docs/manual/reference/method/db.createCollection/
|
| Participants: | |
| Days since reply: | 2 days ago |
| Story Points: | 2 |
| Description |
Problem Statement/Rationalelooking here https://www.mongodb.com/docs/manual/reference/method/db.createCollection/#specify-storage-engine-options
This operation creates a new collection named users with a specific configuration string that MongoDB will pass to the wiredTiger storage engine. See the WiredTiger documentation of collection level options for specific wiredTiger options.
this link goes to a page for Session options and it is not obvious where to find the collection options. also the options used here^ are not formatted/named the same as say for the mongod.conf or daemon starup . clicking the link to the wiredtiger docs was not clear. for example.. i would have thought blockCompressor to be then name but its ‘block_compressor=zstd’
add more info to the docs to provide an example... |
| Comments |
| Comment by Keith Smith [ 05/Feb/24 ] |
|
The draft (and previous versions of documentation for db.createCollection() point users directly at the WiredTiger documentation for a list of the supported configuration options. Many of these options are not supported we MongoDB, and other options could easily have negative effects on performance (or even stability). I think it would be better to just list the options that we think it is reasonable for a user to update without specific guidance from the support organization. I'll see if I can round up a list of suggestions from the WiredTiger team. |
| Comment by Sarah Simpers [ 02/Feb/24 ] |
|
Scoping notes: update the link to point here to be clearer where the options are documented: https://source.wiredtiger.com/mongodb-5.0/struct_w_t___s_e_s_s_i_o_n.html#:~:text=Data%20Sources.-,config,-configuration%20string%2C%20see
Also, give examples of most frequently-used options as shown here: https://www.oreilly.com/library/view/mastering-mongodb-3x/9781783982608/d63dec39-4731-42ff-9b49-7ead230793fb.xhtml |