MongoChangetypeAttributes

By default, it will be named MongoChangetypeAttributes1. You can accept the default by pressing Enter or enter a custom name.

This determines the exit code when the check is triggered. Choose one:

• INFO (0)

• MINOR (1)

• MAJOR (2)

• CRITICAL (3)

• BLOCKER (4)

You’ll be prompted with:

Set 'MONGO_CHANGE_TYPE' (options: INSERT_MANY, INSERT_ONE, CREATE_INDEX, CREATE_COLLECTION, MONGO_FILE, DROP_INDEX):

• Only one change type is allowed per check

• Input is case-insenesitive

• Don't include commas or multiple values. Only input one valid name

These are based on the change type you chose. You can modify these examples to fit your own use case. CREATE_COLLECTION — Used to create new MongoDB collections. See db.createCollection() to view all available 'OPTIONS'. This example uses the capped option to require that collections are created as capped collections. When the collections reach the maximum size, older documents are removed to make space for new documents. Be sure to replace your_collection_name if you use the sample code.

Set 'COLLECTION_NAME' (requires string name of the collection): your_collection_name Set 'OPTIONS' (requires string attributes specific to the change type): { "capped": true, "size": 5242880 }

CREATE_INDEX — Used to create indexes on collections. You can enforce rules on the collection name, index structure, or index options. See db.createIndexes() to view all available 'OPTIONS'. This example sets the unique option to true, which ensures that no two documents in the collection can have the same combination of name and type values. The name option assigns a custom name to the index. Be sure to replace your_collection_name and your_index_name if you use the sample code.

Set 'COLLECTION_NAME' (requires string name of the collection): your_collection_name Set 'KEYS' (requires a document that defines the index's basic contents and structure): { name: 1, type: 1 }. Set 'OPTIONS' (requires string attributes specific to the change type): { "unique": true, "name": "your_index_name" }

DROP_INDEX — Used to drop indexes from collections. See db.dropIndex() to view all available 'OPTIONS'. This example allows only the removal of an index on the collectionName collection where the index is defined on the fields name and type in ascending order. Be sure to replace your_collection_name if you use the sample code.

Set 'COLLECTION_NAME' (requires string name of the collection): your_collection_name Set 'KEYS' (requires a document that defines the index's basic contents and structure): { name: 1, type: 1 }.

INSERT_MANY — Used to insert multiple documents into a collection. See collection.insertMany() to view all available 'OPTIONS'.

This example shows multiple documents being inserted, and ensures that MongoDB inserts documents in the order they appear in your DOCUMENTS field, stopping on the first error if one occurs. Be sure to replace your_collection_name and change the DOCUMENT to reflect documents you would like to add.

Set 'COLLECTION_NAME' (requires string name of the collection): your_collection_name Set 'DOCUMENTS' (requires JSON that defines the objects to insert): [{ "name": "New York", "population": 222000000 }, { "name": "California", "population": 522000000 }] Set 'OPTIONS' (requires string attributes specific to the change type): { "ordered": true }

INSERT_ONE — Used to insert a single document into a collection. See collection.insertOne() to view all available 'OPTIONS'.

This example shows inserting a document . It also includes a comment in the 'OPTIONS' field, which serves as metadata attached to the insert operation. This comment is not stored in the document itself but can be viewed in MongoDB logs, the profiler, or monitoring tools to help trace or audit operations. Be sure to replace your_collection_name and change the DOCUMENT to reflect document you would like to add.

Set 'COLLECTION_NAME' (requires string name of the collection): your_collection_name Set 'DOCUMENT' (requires JSON that defines the object to insert): { "name": "New York", "population": 222000000 } Set 'OPTIONS' (requires string attributes specific to the change type): { "comment": added a document }.

MONGO_FILE — Used to load MongoDB commands from an external file. You can enforce rules on the file path or metadata related to the file.

This example shows how to require that the file path be located within a specific directory and be relative to the changelog file. The 'RELATIVE_TO_CHANGELOG' field determines whether the file path is interpreted as relative to the changelog file or as an absolute path.. Be sure to replace /your-directory with the actual path to the file that contains the MongoDB commands you want to load.

Set 'DBMS' (options: DYNAMODB, MONGODB) [MONGODB]: MONGODB Set 'PATH' (requires string for the file path of the Mongo commands to load): /your-directory Set 'RELATIVE_TO_CHANGELOG' (options: true, false) [false]: true