community.mongodb.mongodb lookup — получение данных из MongoDB

Примечание

Этот плагин поиска входит в коллекцию community.mongodb (версия 1.7.12).

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

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

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

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

Краткое описание
Требования
Параметры-ключевые слова
Примечания
Примеры
Возвращаемое значение

Краткое описание

Поиск ``MongoDB`` выполняет команду *find()* для указанной *коллекции* на указанном сервере *MongoDB*.
Результат представляет собой список JSON-объектов, поэтому он немного отличается от результата, возвращаемого PyMongo. В частности, *временные метки* преобразуются в целые числа эпохи.

Требования

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

pymongo >= 2.4 (библиотека Python)

Параметры-ключевые слова

Здесь описаны параметры-ключевые слова поиска. В следующих примерах это значения key1=value1, key2=value2 и т. д.: lookup('community.mongodb.mongodb', key1=value1, key2=value2, ...) и query('community.mongodb.mongodb', key1=value1, key2=value2, ...)

Параметр	Комментарии
collection string / обязательный	Имя коллекции, для которой будет выполнен запрос
connect_string string	Любая допустимая строка подключения MongoDB с поддержкой аутентификации, наборов реплик и т. д. Подробнее: https://docs.mongodb.org/manual/reference/connection-string/ По умолчанию: `"mongodb://localhost/"`
database string / обязательный	Имя базы данных, для которой будет выполнен запрос
extra_connection_parameters dictionary	Дополнительные параметры подключения, передаваемые в pymongo.MongoClient В примере показано, как подключиться к Mongo с помощью SSL-сертификата. Полный список параметров: https://pymongo.readthedocs.io/en/stable/api/pymongo/mongo_client.html#pymongo.mongo_client.MongoClient По умолчанию: `{}`
filter dictionary	Критерии отбора результатов По умолчанию: `{}`
limit integer	Количество отображаемых результатов
projection dictionary	Поля, которые нужно вернуть По умолчанию: `{}`
skip integer	Количество пропускаемых результатов
sort list / элементы=list	Правила сортировки. Для указания порядка используйте строки `ASCENDING` и `DESCENDING`. Дополнительные сведения см. в примере. По умолчанию: `[]`

Примечания

Примечание

Дополнительные сведения см. в документации: https://pymongo.readthedocs.io/en/stable/api/pymongo/collection.html#pymongo.collection.Collection.find.

Примеры

- hosts: localhost
  gather_facts: false
  vars:
    mongodb_parameters:
      #mandatory parameters
      database: 'local'
      collection: "startup_log"
      #optional
      connection_string: "mongodb://localhost/"
      # connection_string: "mongodb://username:password@my.server.com:27017/"
      # extra_connection_parameters: { "ssl" : True , "ssl_certfile": /etc/self_signed_certificate.pem" }
      #optional query  parameters, we accept any parameter from the normal mongodb query.
      # filter:  { "hostname": "u18" }
      projection: { "pid": True    , "_id" : False , "hostname" : True }
      skip: 0
      limit: 1
      sort:  [ [ "startTime" , "ASCENDING" ] , [ "age", "DESCENDING" ] ]
  tasks:
    - debug: msg="The PID from MongoDB is {{ lookup('mongodb', mongodb_parameters ).pid }}"

    - debug: msg="The HostName from the MongoDB server is {{ lookup('mongodb', mongodb_parameters ).hostname }}"

    - debug: msg="Mongo DB is stored at {{ lookup('mongodb', mongodb_parameters_inline )}}"
      vars:
        mongodb_parameters_inline:
          database: 'local'
          collection: "startup_log"
          connection_string: "mongodb://localhost/"
          limit: 1
          projection: { "cmdline.storage": True }

      # lookup syntax, does the same as below
    - debug: msg="The hostname is {{ item.hostname }} and the pid is {{ item.pid }}"
      loop: "{{ lookup('mongodb', mongodb_parameters, wantlist=True) }}"

      # query syntax, does the same as above
    - debug: msg="The hostname is {{ item.hostname }} and the pid is {{ item.pid }}"
      loop: "{{ query('mongodb', mongodb_parameters) }}"

    - name: "Raw output from the mongodb lookup (a json with pid and hostname )"
      debug: msg="{{ lookup('mongodb', mongodb_parameters) }}"

    - name: "Yet another mongodb query, now with the parameters on the task itself"
      debug: msg="pid={{item.pid}} hostname={{item.hostname}} version={{ item.buildinfo.version }}"
      with_mongodb:
        - database: 'local'
          collection: "startup_log"
          connection_string: "mongodb://localhost/"
          limit: 1
          projection: { "pid": True    , "hostname": True , "buildinfo.version": True }

    # Please notice this specific query may result more than one result. This is expected
    - name: "Shows the whole output from mongodb"
      debug: msg="{{ item }}"
      with_mongodb:
        - database: 'local'
          collection: "startup_log"
          connection_string: "mongodb://localhost/"

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

Ключ	Описание
Возвращаемое значение list / элементы=string	Список JSON-объектов с результатами запроса MongoDB. Возвращается: при успешном выполнении

Авторы

Marcos Diez (@marcosdiez)

Ссылки на коллекцию

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