[DOCS-6106] Document "indexOptionDefaults" option to createCollection() Created: 27/Aug/15  Updated: 30/Oct/23  Resolved: 09/Dec/15

Status: Closed
Project: Documentation
Component/s: Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Task Priority: Major - P3
Reporter: Max Hirschhorn Assignee: Kyle Suarez
Resolution: Done Votes: 0
Labels: docs-3.2
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-18879 Add "indexOptionDefaults" to createCo... Closed
Participants:
Days since reply: 7 years, 29 weeks ago

 Description   

Update the documentation for the create command and the createCollection() shell helper to say that they take a new optional parameter called indexOptionDefaults. The only supported subkey is "storageEngine", which should be documented identically to how the "storageEngine" option is documented for the createIndex() shell helper. Perhaps something along the lines of the following.


Optional. Allows users to specify a default configuration to the storage engine for indexes created on a collection. The value of the storageEngine option should take the following form:

{ <storage-engine-name>: <options> }

Storage engine configuration specified when creating indexes are validated and logged to the oplog during replication to support replica sets with members that use different storage engines.

New in version 3.2.



 Comments   
Comment by Emily Hall [ 27/Jul/16 ]

Closed for housekeeping on 7/27/2016 by Emily Hall.
If you require additional support, please open a new ticket for prioritization.
Thanks,
Emily

Comment by Githook User [ 09/Dec/15 ]

Author:

{u'username': u'ksuarz', u'name': u'Kyle Suarez', u'email': u'kyle.suarez@mongodb.com'}

Message: DOCS-6106 document indexOptionDefaults

This adds documentation for the `indexOptionDefaults` option for the `create`
command and its shell helper, `db.createCommand()`.

Signed-off-by: kay <kay.kim@10gen.com>
Branch: master
https://github.com/mongodb/docs/commit/ad3d6872d4ae1622a3141858ccbb9c3e8538bec2

Generated at Thu Feb 08 07:51:38 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.