Модуль community.mongodb.mongodb_index – Создает или удаляет индексы в коллекциях MongoDB.

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.mongodb.mongodb_index.

Добавлен в community.mongodb 1.0.0

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

Обзор

Создает или удаляет индексы в коллекциях MongoDB.
Поддерживает несколько вариантов индексов, т.е. уникальные, разреженные и частичные.
Проверяет существование индексов только по имени.

Требования

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

pymongo

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
atlas_auth boolean	Путь аутентификации для экземпляров MongoDB Atlas Варианты: `false` ← (default) `true`
auth_mechanism string	Тип аутентификации. Варианты: `"SCRAM-SHA-256"` `"SCRAM-SHA-1"` `"MONGODB-X509"` `"GSSAPI"` `"PLAIN"`
connection_options list / elements=any	Дополнительные параметры подключения. Укажите в виде списка словарей или строк, содержащих пары ключ-значение, разделенные символом ‘=’.
indexes list / elements=any / required	Список индексов для создания или удаления
login_database string	База данных, где хранятся учетные данные для входа. По умолчанию: `"admin"`
login_host string	Хост, на котором запущен экземпляр MongoDB для входа. По умолчанию: `"localhost"`
login_password string	Пароль, используемый для аутентификации. Обязательно, если указан login_user.
login_port integer	Порт сервера MongoDB для входа. По умолчанию: `27017`
login_user string	Пользователь MongoDB для входа. Обязательно, если указан login_password.
replica_set string	Репликационный набор для подключения (автоматически подключается к основному для записи).
ssl aliases: tls boolean	Использовать ли SSL-соединение при подключении к базе данных. Варианты: `false` ← (default) `true`
ssl_ca_certs aliases: tlsCAFile string	Параметр ssl_ca_certs принимает путь к файлу CA.
ssl_cert_reqs aliases: tlsAllowInvalidCertificates string	Указывает, требуется ли сертификат от другой стороны соединения и будет ли он проверен, если предоставлен. Варианты: `"CERT_NONE"` `"CERT_OPTIONAL"` `"CERT_REQUIRED"` ← (default)
ssl_certfile aliases: tlsCertificateKeyFile string	Представить клиентский сертификат, используя параметр ssl_certfile.
ssl_crlfile string	Параметр ssl_crlfile принимает путь к файлу CRL.
ssl_keyfile string	Закрытый ключ для клиентского сертификата.
ssl_pem_passphrase aliases: tlsCertificateKeyFilePassword string	Пароль для расшифровки зашифрованных закрытых ключей.
strict_compatibility boolean	Применять строгие требования к версиям pymongo и MongoDB Варианты: `false` `true` ← (default)

Примечания

Примечание

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

Примеры

- name: Create a single index on a collection
  community.mongodb.mongodb_index:
    login_user: admin
    login_password: secret
    indexes:
      - database: mydb
        collection: test
        keys:
          - username: 1
            last_login: -1
        options:
          name: myindex
        state: present

- name: Drop an index on a collection
  community.mongodb.mongodb_index:
    login_user: admin
    login_password: secret
    indexes:
      - database: mydb
        collection: test
        options:
          name: myindex
        state: absent

- name: Create multiple indexes
  community.mongodb.mongodb_index:
    login_user: admin
    login_password: secret
    indexes:
      - database: mydb
        collection: test
        keys:
          - username: 1
            last_login: -1
        options:
          name: myindex
        state: present
      - database: mydb
        collection: test
        keys:
          - email: 1
            last_login: -1
        options:
          name: myindex2
        state: present

- name: Add a unique index
  community.mongodb.mongodb_index:
    login_port: 27017
    login_user: admin
    login_password: secret
    login_database: "admin"
    indexes:
      - database: "test"
        collection: "rhys"
        keys:
          username: 1
        options:
          name: myuniqueindex
          unique: true
        state: present

- name: Add a ttl index
  community.mongodb.mongodb_index:
    login_port: 27017
    login_user: admin
    login_password: secret
    login_database: "admin"
    indexes:
      - database: "test"
        collection: "rhys"
        keys:
          created: 1
        options:
          name: myttlindex
          expireAfterSeconds: 3600
        state: present

- name: Add a sparse index
  community.mongodb.mongodb_index:
    login_port: 27017
    login_user: admin
    login_password: secret
    login_database: "admin"
    indexes:
      - database: "test"
        collection: "rhys"
        keys:
          last_login: -1
        options:
          name: mysparseindex
          sparse: true
        state: present

- name: Add a partial index
  community.mongodb.mongodb_index:
    login_port: 27017
    login_user: admin
    login_password: secret
    login_database: "admin"
    indexes:
      - database: "test"
        collection: "rhys"
        keys:
          last_login: -1
        options:
          name: mypartialindex
          partialFilterExpression:
            rating:
              $gt: 5
        state: present

- name: Add a index in the background (background option is deprecated from 4.2+)
  community.mongodb.mongodb_index:
    login_port: 27017
    login_user: admin
    login_password: secret
    login_database: "admin"
    indexes:
      - database: "test"
        collection: "rhys"
        options:
          name: idxbackground
        keys:
          username: -1
        backgroud: true
        state: present

- name: Check creating 5 index all with multiple options specified
  community.mongodb.mongodb_index:
    login_port: 27017
    login_user: admin
    login_password: secret
    login_database: "admin"
    indexes:
      - database: "test"
        collection: "indextest"
        options:
          name: "idx_unq_username"
          unique: true
        keys:
          username: -1
        state: present
      - database: "test"
        collection: "indextest"
        options:
          name: "idx_last_login"
          sparse: true
        keys:
          last_login: -1
        state: present
      - database: "test"
        collection: "indextest"
        options:
          name: "myindex"
        keys:
          first_name: 1
          last_name: -1
          city: 1
        state: present
      - database: "test"
        collection: partialtest
        options:
          name: "idx_partialtest"
          partialFilterExpression:
            rating:
              $gt: 5
        keys:
          rating: -1
          title: 1
        state: present
      - database: "test"
        collection: "wideindex"
        options:
          name: "mywideindex"
        keys:
          email: -1
          username: 1
          first_name: 1
          last_name: 1
          dob: -1
          city: 1
          last_login: -1
          review_count: 1
          rating_count: 1
          last_post: -1
        state: present

Значения возврата

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

Ключ	Описание
changed boolean	Указывает, что модуль что-то изменил. Возвращаемое значение: когда модуль изменил что-либо.
failed boolean	Указывает, что модуль завершился с ошибкой. Возвращаемое значение: при возникновении ошибки в модуле.
indexes_created list / elements=string	Список созданных индексов. Возвращаемое значение: всегда Пример: `["myindex", "myindex2"]`
indexes_dropped list / elements=string	Список удалённых индексов. Возвращаемое значение: всегда Пример: `["myindex", "myindex2"]`

Авторы

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_index_module.html