Documentation

PLEASE NOTE: This document applies to latest version and not to the latest stable release v2.21

Documentation for other releases can be found by using the version selector in the top right of any doc page.

mongodb_collection

Manage MongoDB collections.

check_mode:
  support: full

Parameter	Required	Type	Values	Description
name	true	string		Name of the collection to manage.
database	true	string		Name of the database containing the collection.
state		string	present absent	The collection state. [default: `"present"`]
indexes		array		List of indexes to create on the collection.
validator		object		Collection validator document.
validation_level		string	off strict moderate	Validation level (off/strict/moderate).
validation_action		string	error warn	Validation action (error/warn).
collation		object		Collation settings for the collection.
replica_set		string		Replica set name (for replica set connections).
login_host		string		Database host to connect to. [default: `"localhost"`]
login_user		string		Database user to connect with.
login_password		string		Database password to use.
login_port		integer		Database port to connect to. [default: `27017`]
connection_options		string		Connection options string.
auth_database		string		Authentication database. [default: `"admin"`]

```yaml

name: Create a collection mongodb_collection: name: users database: myapp state: present
name: Create collection with indexes mongodb_collection: name: users database: myapp state: present indexes: - key: { email: 1 } unique: true - key: { created_at: -1 /// name: idx_created_at /// /// - name: Create collection with validator /// mongodb_collection: /// name: users /// database: myapp /// state: present /// validator: /// $jsonSchema: /// required: [“email”] /// properties: /// email: /// bsonType: “string” /// validation_level: strict /// validation_action: error /// /// - name: Create collection with collation /// mongodb_collection: /// name: users /// database: myapp /// state: present /// collation: /// locale: en /// strength: 2 /// /// - name: Drop a collection /// mongodb_collection: /// name: logs /// database: myapp /// state: absent /// ```}