community.mongodb.mongodb_schema модуль — Управляет валидаторами схемы документов MongoDB.

Примечание

Этот модуль является частью коллекции community.mongodb (версия 1.7.7).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.mongodb. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.mongodb.mongodb_schema.

Новое в community.mongodb 1.3.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управляет валидаторами схемы документов MongoDB.
Создание, обновление и удаление валидаторов для коллекции.
Поддерживает весь набор ключевых слов jsonSchema.
Подробности см. в [ключевые слова jsonSchema](https://docs.mongodb.com/manual/reference/operator/query/jsonSchema/#available-keywords).

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

pymongo

Параметры

Параметр	Комментарии
действие строка	Действие валидации для MongoDB при обработке недопустимых документов. Варианты: `"error"` ← (по умолчанию) `"warn"`
atlas_auth логическое	Путь авторизации, предназначенный для экземпляров MongoDB Atlas. Варианты: `false` ← (по умолчанию) `true`
auth_mechanism строка	Тип аутентификации. Варианты: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
коллекция строка / обязательно	Коллекция для работы.
connection_options список / элементы=любое	Дополнительные параметры подключения. Указывайте в виде списка словарей или строк, содержащих пары ключ-значение, разделенные ‘=’.
база данных строка / обязательно	База данных для работы.
отладка логическое	Включить вывод дополнительной отладочной информации. Варианты: `false` ← (по умолчанию) `true`
уровень строка	Уровень валидации, который MongoDB должен применять при обновлении существующих документов. Варианты: `"strict"` ← (по умолчанию) `"moderate"`
база_данных_входа строка	База данных, в которой хранятся учетные данные входа. По умолчанию: `"admin"`
хост_входа строка	Хост, на котором запущен экземпляр MongoDB для входа. По умолчанию: `"localhost"`
пароль_входа строка	Пароль, используемый для аутентификации. Требуется, когда указан login_user.
порт_входа целое число	Порт сервера MongoDB для входа. По умолчанию: `27017`
пользователь_входа строка	Пользователь MongoDB для входа. Требуется, когда указан login_password.
свойства словарь	Индивидуальные настройки свойств. По умолчанию: `{}`
replica_set строка	Имя репликации.
обязательные список / элементы=строка	Список полей, которые обязательны.
ssl алиасы: tls логическое	Использовать ли SSL-соединение при подключении к базе данных. Варианты: `false` ← (по умолчанию) `true`
ssl_ca_certs алиасы: tlsCAFile строка	Параметр ssl_ca_certs принимает путь к файлу CA.
ssl_cert_reqs алиасы: tlsAllowInvalidCertificates строка	Указывает, требуется ли сертификат с другой стороны соединения и будет ли он проверен, если предоставлен. Варианты: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (по умолчанию)

ssl_certfile aliases: tlsCertificateKeyFile строка	Укажите сертификат клиента с помощью параметра ssl_certfile.
ssl_crlfile строка	Параметр ssl_crlfile принимает путь к файлу CRL.
ssl_keyfile строка	Приватный ключ для сертификата клиента.
ssl_pem_passphrase aliases: tlsCertificateKeyFilePassword строка	Фраза доступа для расшифровки зашифрованных приватных ключей.
state строка	Состояние валидатора. Варианты: `"present"` ← (по умолчанию) `"absent"`
strict_compatibility логическое	Требовать строгие требования к версиям pymongo и MongoDB программного обеспечения. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Требуется пакет pymongo Python на удалённом хосте, версия 4+.

Примеры

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

- name: Remove a schema rule
  community.mongodb.mongodb_schema:
    collection: contacts
    db: rhys
    state: absent


- name: More advanced example using properties
  community.mongodb.mongodb_schema:
    collection: contacts
    db: rhys
    properties:
      email:
        maxLength: 150
        minLength: 5
      options:
        bsonType: array
        maxItems: 10
        minItems: 5
        uniqueItems: true
      status:
        bsonType: string
        description: "can only be ACTIVE or DISABLED"
        enum:
          - ACTIVE
          - DISABLED
      year:
        bsonType: int
        description: "must be an integer from 2021 to 3020"
        exclusiveMaximum: false
        maximum: 3020
        minimum: 2021
    required:
      - email
      - first_name
      - last_name

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
changed логическое	Если модуль произвел изменения. Возвращается: при успехе
module_config словарь	Документ валидатора, как указано в вызове модуля. Возвращается: когда debug равен true
msg строка	Сообщение состояния. Возвращается: всегда
validator словарь	Документ валидатора, прочитанный из экземпляра. Возвращается: когда debug равен true

Авторы

Rhys Campbell (@rhysmeister)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/mongodb/mongodb_schema_module.html