Skip to content

Commit 04203c7

Browse files
authored
docs(NODE-4755): clarify deprecation docs for autoIndexId (#3470)
1 parent 1a5e619 commit 04203c7

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/operations/create_collection.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,27 +58,27 @@ export interface CreateCollectionOptions extends CommandOperationOptions {
5858
strict?: boolean;
5959
/** Create a capped collection */
6060
capped?: boolean;
61-
/** @deprecated Create an index on the _id field of the document, True by default on MongoDB 2.6 - 3.0 */
61+
/** @deprecated Create an index on the _id field of the document. This option is deprecated in MongoDB 3.2+ and will be removed once no longer supported by the server. */
6262
autoIndexId?: boolean;
6363
/** The size of the capped collection in bytes */
6464
size?: number;
6565
/** The maximum number of documents in the capped collection */
6666
max?: number;
6767
/** Available for the MMAPv1 storage engine only to set the usePowerOf2Sizes and the noPadding flag */
6868
flags?: number;
69-
/** Allows users to specify configuration to the storage engine on a per-collection basis when creating a collection on MongoDB 3.0 or higher */
69+
/** Allows users to specify configuration to the storage engine on a per-collection basis when creating a collection */
7070
storageEngine?: Document;
71-
/** Allows users to specify validation rules or expressions for the collection. For more information, see Document Validation on MongoDB 3.2 or higher */
71+
/** Allows users to specify validation rules or expressions for the collection. For more information, see Document Validation */
7272
validator?: Document;
73-
/** Determines how strictly MongoDB applies the validation rules to existing documents during an update on MongoDB 3.2 or higher */
73+
/** Determines how strictly MongoDB applies the validation rules to existing documents during an update */
7474
validationLevel?: string;
75-
/** Determines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted on MongoDB 3.2 or higher */
75+
/** Determines whether to error on invalid documents or just warn about the violations but allow invalid documents to be inserted */
7676
validationAction?: string;
77-
/** Allows users to specify a default configuration for indexes when creating a collection on MongoDB 3.2 or higher */
77+
/** Allows users to specify a default configuration for indexes when creating a collection */
7878
indexOptionDefaults?: Document;
79-
/** The name of the source collection or view from which to create the view. The name is not the full namespace of the collection or view; i.e. does not include the database name and implies the same database as the view to create on MongoDB 3.4 or higher */
79+
/** The name of the source collection or view from which to create the view. The name is not the full namespace of the collection or view (i.e., does not include the database name and implies the same database as the view to create) */
8080
viewOn?: string;
81-
/** An array that consists of the aggregation pipeline stage. Creates the view by applying the specified pipeline to the viewOn collection or view on MongoDB 3.4 or higher */
81+
/** An array that consists of the aggregation pipeline stage. Creates the view by applying the specified pipeline to the viewOn collection or view */
8282
pipeline?: Document[];
8383
/** A primary key factory function for generation of custom _id keys. */
8484
pkFactory?: PkFactory;

0 commit comments

Comments
 (0)