community.mongodb.mongodb_schema – Manages MongoDB Document Schema Validators.

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Manages MongoDB Document Schema Validators.
• Create, update and remove Validators on a collection.
• Supports the entire range of jsonSchema keywords.
• See [jsonSchema Available Keywords](https://docs.mongodb.com/manual/reference/operator/query/jsonSchema/#available-keywords) for details.

Requirements

The below requirements are needed on the host that executes this module.

• pymongo

Parameters

Notes

Examples

- name: Require that an email address field is in every document
  community.mongodb.mongodb_schema:
    db: "rhys"
    collection: "contacts"
    required:
      - "email"

- name: More advanced example using properties
  community.mongodb.mongodb_schema:
    db: "rhys"
    collection: "contacts"
    state: "absent"
  - name: Test with debuging option - Without check mode
    community.mongodb.mongodb_schema:
      <<: *mongo_parameters
      db: "rhys"
      collection: "contacts"
      required:
        - "email"
        - "first_name"
        - "last_name"
      properties:
        status:
          bsonType: "string"
          enum: ["ACTIVE", "DISABLED"]
          description: "can only be ACTIVE or DISABLED"
        year:
          bsonType: "int"
          minimum: 2021
          maximum: 3020
          exclusiveMaximum: false
          description: "must be an integer from 2021 to 3020"
        options:
          bsonType: "array"
          maxItems: 10
          minItems: 5
          uniqueItems: yes
        email:
          maxLength: 150
          minLength: 5

Return Values

Common return values are documented here, the following are the fields unique to this module:

Authors

• Rhys Campbell (@rhysmeister)