Модуль community.general.django_dumpdata — оболочка для django-admin dumpdata

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

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

Добавлено в community.general 11.3.0

Краткое описание
Параметры
Атрибуты
Примечания
См. также
Примеры
Возвращаемые значения

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

Этот модуль служит оболочкой для выполнения django-admin dumpdata.

Параметры

Параметр	Комментарии
all boolean	Выгрузить все записи, включая те, которые в противном случае могли бы быть отфильтрованы или изменены пользовательским менеджером. Варианты: `false` `true`
apps_models list / elements=string	Выгрузить только перечисленные в дампе приложения и модели. Формат должен быть `app_label` или `app_label.ModelName`. Если значение не указано, выгружаются все приложения и модели.
database string	Указать используемую базу данных. По умолчанию: `"default"`
excludes list / elements=string	Приложения или модели, которые нужно исключить. Формат должен быть `app_label` или `app_label.ModelName`.
fixture псевдонимы: output path / обязательный	Путь к выходному файлу. Имя файла фикстуры может оканчиваться на `.bz2`, `.gz`, `.lzma` или `.xz`; в этом случае используется соответствующий формат сжатия. Соответствует параметру `--output` команды `django-admin dumpdata`.
format string	Формат сериализации выходных данных. Варианты: `"xml"` `"json"` ← (по умолчанию) `"jsonl"` `"yaml"`
indent integer	Размер отступа в выходных данных. По умолчанию отступы не добавляются, поэтому данные выводятся одной строкой.
natural_foreign boolean	Использовать естественные ключи при сериализации внешних ключей. Варианты: `false` `true`
natural_primary boolean	Не включать первичные ключи при сериализации. Варианты: `false` `true`
primary_keys псевдонимы: pks list / elements=string	Список первичных ключей, которые нужно включить в дамп. Доступно только при выгрузке одной модели.
pythonpath path	Добавляет указанный путь в файловой системе к пути поиска импортируемых модулей Python. Значение без изменений передаётся аргументу `--pythonpath` в `django-admin`.
settings string / обязательный	Указывает модуль настроек, который нужно использовать. Значение без изменений передаётся аргументу `--settings` в `django-admin`.
skip_checks boolean	Пропускает системные проверки перед выполнением команды. Варианты: `false` `true`
traceback boolean	Выводит полную трассировку стека, если возникает `CommandError`. Варианты: `false` `true`
venv path	Использовать интерпретатор Python из этой виртуальной среды. Укажите путь к корневому каталогу virtualenv, а не к каталогу `bin/` и не к исполняемому файлу `python`.
verbosity integer	Указывает уровень подробности уведомлений и отладочной информации в выводе `django-admin`. Варианты: `0` `1` `2` `3`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или изменениях, которые, возможно, требуется внести в `check_mode`).

Примечания

Примечание

Команда django-admin всегда выполняется с локалью C, а параметр --no-color передаётся всегда.
В текущем виде модуль не является идемпотентным. Обеспечить идемпотентность в этом случае может быть непросто: для этого пришлось бы заранее проверять, что все данные из файла фикстур уже присутствуют в базе данных, а это нетривиальная задача. К сожалению, ни django loaddata, ни django dumpdata не имеют параметра --dry-run, поэтому единственный способ определить, произошли ли изменения, — фактически загрузить или выгрузить данные.

См. также

django-admin и manage.py в официальной документации Django: Обратитесь к этой документации за сведениями о встроенных командах и параметрах django-admin. Обязательно выберите нужную версию Django в списке выбора версии на этой странице.

Примеры

- name: Dump all data
  community.general.django_dumpdata:
    settings: myproject.settings
    fixture: /tmp/mydata.json

- name: Dump data excluding certain apps, into a compressed JSON file
  community.general.django_dumpdata:
    settings: myproject.settings
    database: myotherdb
    excludes:
      - auth
      - contenttypes
    fixture: /tmp/mydata.json.gz

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

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

Ключ	Описание
run_info dictionary	Сведения о выполнении команды. Возвращается: при успешном выполнении и если `verbosity` >= 3
version string	Версия Django. Возвращается: всегда Пример: `"5.1.2"`

Авторы

Alexei Znamensky (@russoz)

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

© 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/general/django_dumpdata_module.html