Глава 20. Опции mysqlbackup

Следующие разделы описывают параметры командной строки для различных режимов работы mysqlbackup.

Таблица ниже приводит все возможности команды для mysqlbackup. Используйте гиперссылки в именах, чтобы перейти к подробным описаниям.

Варианты команды могут также быть определены в конфигурационных файлах, посмотрите объяснения в главе 21. mysqlbackup следует общепринятой практике MySQL для обработки дубликатов опций. Варианты обрабатываются сначала из конфигурационных файлов, затем из командной строки. Если выбор определяется несколько раз, последний случай имеет приоритет.

Таблица 20.1. Список опций

ИмяОписание ВведенаУстарела Удалена
--backup-dir Каталог, чтобы сохранить данные резервного копирования.
--backup-image Определяет путь образа резервной копии.
--backup_innodb_data_file_path Определяет системный путь файлов табличного пространства Innodb и размер в резервной копии.
--backup_innodb_data_home_dir Резервный основной каталог для всех файлов данных InnoDB в системном табличном пространстве.
--backup_innodb_log_group_home_dir Резервный каталог для файлов журнала InnoDB.
--backup_innodb_undo_directory Относительный или абсолютный путь к каталогу, где InnoDB создает отдельные табличные пространства для журнала отмены.
--character-sets-dir Каталог для файлов набора символов.
--cloud-access-key Ключ доступа для облака.8.0.23
--cloud-access-key-id Ключ доступа AWS ID для регистрации на Amazon S3.
--cloud-aws-region Регион для Amazon Web Services, к которому mysqlbackup обращается в S3.
--cloud-basicauth-url URL для HTTP Basic Authentication для доступа Swift.
--cloud-bucket Место хранения для образа резервной копии.
--cloud-buffer-size Размер буфера для операций с облаком.
--cloud-ca-info Абсолютный путь к CA-файлам для идентификации хоста для связей SSL.
--cloud-ca-path Каталог сертификата CA в дополнение к каталогу системы по умолчанию.
--cloud-chunk-size Размер куска в мегабайтах, если передача кусками позволена. 8.0.23
--cloud-chunked-transfer Используйте передачу кусками с обслуживанием облачного хранилища.
--cloud-container Контейнер Swift для образа резервной копии.
--cloud-host Имя хоста для обслуживания хранения. 8.0.22
--cloud-identity-url URL обслуживания идентификации Keystone.
--cloud-object Объект хранения для образа резервной копии.
--cloud-object-key Ключ объекта Amazon S3 для образа резервной копии.
--cloud-par-url Предварительно заверенный запрос URL для хранения объектов OCI 8.0.22
--cloud-password Пароль для пользователя, определенного --cloud-user-id.
--cloud-proxy Адрес прокси и номер порта для перекрытия параметров настройки окружающей среды по умолчанию для доступа к облачному сервису.
--cloud-region Регион Keystone для пользователя, определенного --cloud-user-id.
--cloud-secret-access-key Ключ доступа AWS.
--cloud-secret-key Секретный ключ для облака.8.0.23
--cloud-service Облачный сервис для резервного копирования данных или восстановления.
--cloud-tempauth-url URL сервиса идентификации для подтверждения пользователя с системой аутентификации Swift's TempAuth.
--cloud-tenant Арендатор Keystone для пользователя, определенного --cloud-user-id.
--cloud-trace Напечатать трассировочную информацию для операций по облаку.
--cloud-user-id User ID для доступа к Swift.
--comments Определяет последовательность комментариев.
--comments-file Определяет путь к файлу комментариев.
--compress Создать резервную копию в сжатом формате.
--compress-level Определяет уровень сжатия.
--compress-method Определяет алгоритм сжатия.
--compression-algorithms Разрешенные алгоритмы сжатия для связей с сервером 8.0.18
--connect_timeout Тайм-аут связи в секундах.
--datadir Путь к каталогу данных mysql.
--debug Напечатать отладочную информацию.
--decrypt Расшифровать образ резервной копии, написанный в MEB Secure File.
--default-character-set Установить набор символов по умолчанию.
--defaults-extra-file Прочитать этот файл после того, как глобальные файлы будут прочитаны.
--defaults-file Прочитать опции по умолчанию только от данного файла.
--defaults-group-suffix Также прочитать группы опций с обычными именами и суффиксом str.
--disable-manifest Не создавать файлы декларации для операции резервного копирования.
--dst-entry Используется с однофайловым резервным копированием файлов, чтобы извлечь единственный файл или каталог к определенному пользователями пути.
--enable-cleartext-plugin Позволяет плагин идентификации открытого текста. 8.0.22
--encrypt Зашифровать образ резервной копии и записать в MEB Secure File.
--encrypt-password Заданный пользователем пароль, которым mysqlbackup шифрует ключи шифрования для зашифрованных табличных пространств InnoDB.
--error-code Код выхода, для которого команда печатает соответствующее выходное сообщение.
--exclude-tables Исключите в резервной копии или восстановлении таблицы, имена которых соответствуют регулярному выражению REGEXP.
--exec-when-locked Выполните указанную утилиту в фазе блокировки около конца операции резервного копирования.
--force Принудительно переписать данные, журнал или файл образа в зависимости от операции.
--free-os-buffers Освободить кэш файловой системы, синхронизируя буфера
--help Отобразить справочное сообщение.
--host Имя хоста, чтобы соединиться.
--include [Устаревшая] Резервная копия только тех файлов данных innodb, которые соответствуют регулярному выражению REGEXP. 8.0.20
--include-tables Включить в резервной копии или восстановлении таблицы, имена которых соответствуют регулярному выражению REGEXP.
--incremental Определяет, что связанная операция backup или backup-to-image возрастающая.
--incremental-backup-dir Определяет местоположение для возрастающей директивной резервной копии.
--incremental-base Спецификация основной резервной копии для --incremental.
--incremental-with-redo-log-only Определяет инкрементное резервное копирование таблиц InnoDB, основанное на копировании журнала отката к резервной копии, без включения любых файлов данных InnoDB в резервной копии.
--innodb_data_home_dir Определяет основной каталог для всех файлов данных InnoDB в общем системном табличном пространстве.
--innodb_log_group_home_dir Путь к каталогу к файлам журнала InnoDB.
--innodb_undo_directory Путь к каталогу табличных пространств отмены InnoDB.
--key Симметричный ключ используется для шифрования и декодирования.
--key-file Путь к файлу, который содержит симметричный ключ, используемый для шифрования и декодирования.
--limit-memory Память в MB, доступном для операции MEB.
--lock-wait-timeout Определите тайм-аут в секундах для FLUSH TABLES WITH READ LOCK во время заключительного этапа резервной копии. 8.0.16
--log-bin Определите местоположение для двоичной регистрации, которая будет восстановлена.
--log-bin-index Определяет абсолютный путь индексного файла, который перечисляет все двоичные файлы журнала.
--login-path Прочитайте опции из названного пути логина в файле .mylogin.cnf.
--messages-logdir Определяет путь существующего каталога для хранения регистрации сообщений.
--no-defaults Не читать опции по умолчанию ни от какого заданного файла.
--no-history-logging Отключить сохранение истории, даже если связь доступна.
--no-locking Отключить все табличные блокировки во время резервных копий.
--no-redo-log-archive Пропустить архивирование журнала отката во время резервных копий. 8.0.17
--number-of-buffers Определяет точное количество буферов памяти, которые будут использоваться для операции резервного копирования.
--on-disk-full Определяет поведение, когда процесс резервного копирования сталкивается с полным дискоом.
--only-innodb Поддержать только файлы данных InnoDB и файлы журнала.
--only-known-file-types Включает только файлы списка известных типов в резервной копии.
--optimistic-busy-tables Выполнить оптимистическую резервную копию, используя регулярное выражение, определенное опцией для выбора таблиц, которые будут пропущены в первой фазе оптимистической резервной копии.
--optimistic-time Выполнить оптимистическую резервную копию со значением, определенным как оптимистическое время, то есть время, после которого таблицы, которые не были изменены, считаются неактивными.
--page-reread-count Максимальное количество страницы для перечитывания.
--page-reread-time Время ожидания перед перепрочтением страницы.
--password Пароль для связи.
--pipe Псевдоним для --protocol=pipe.
--plugin-dir Определяет каталог для клиентских плагинов. 8.0.22
--port Номер порта TCP, чтобы соединиться.
--print-defaults Напечатать список значений опций, поставляемых файлами по умолчанию.
--process-threads Определяет количество потоков процесса для операции резервного копирования.
--progress-interval Интервал между отчетами о выполнении работ в секундах.
--protocol Протокол для связи.
--read-threads Определяет количество потоков чтения для операции резервного копирования.
--relay-log Определяет местоположение для журнала реле, который будет восстановлен на сервере точной копии.
--relay-log-index Определяет абсолютный путь индексного файла, который перечисляет все файлы журнала реле.
--rename Переименовать единственную таблицу, когда она будет выбрана опцией --include-tables для восстановления
--safe-slave-backup-timeout Поддерживая сервер точной копии, значение тайм-аута для ожидания потока SQL репликации, чтобы удалить его временные таблицы.
--sbt-database-name Используется в качестве подсказки Media Management Software (MMS) для выбора носителя и политики для резервного копирования на магнитную ленту.
--sbt-environment Список разделенных запятой значений назначений переменной окружения, которые будут переданы библиотеке SBT.
--sbt-lib-path Путь к библиотеке SBT, использовавшейся программным обеспечением, которое справляется с резервными копированиями на магнитную ленту.
--shared-memory-base-name Это называет имя общей памяти, используемой сервером Windows, чтобы разрешить клиентам соединяться с использованием общей памяти (только Windows).
--show-progress Периодически производить короткие отчеты о выполнении работ, известные как индикаторы хода выполнения.
--skip-binlog Не включать двоичные файлы журнала во время резервной копии или не восстанавливать их во время восстановления.
--skip-final-rescan Пропустить заключительный перепросмотр для таблиц InnoDB, которые изменяются операциями DDL.
--skip-messages-logdir Отключить регистрацию в файл teelog.
--skip-relaylog Не включать файлы журнала реле во время резервной копии или восстановления.
--skip-unused-pages Пропустить неиспользованные страницы в табличных пространствах, поддерживая таблицы InnoDB.
--slave-info Информация, чтобы настроить идентичный сервер точной копии.
--sleep Время, которое спать в миллисекундах после копирования каждого 1 МБ данных.
--socket Файл сокета, чтобы использовать, чтобы соединиться.
--src-entry Определяет файл или каталог, чтобы извлечь из однофайлового резервного копирования.
--ssl-ca Файл CA в формате PEM (подразумевает --ssl).
--ssl-capath Каталог CA (см. документацию OpenSSL, подразумевает --ssl).
--ssl-cert Сертификат X509 в формате PEM (подразумевает --ssl).
--ssl-cipher SSL-шифр (подразумевает --ssl).
--ssl-fips-mode Работает ли MEB в режиме FIPS. 8.0.14
--ssl-key Ключ X509 в формате PEM (подразумевает --ssl).
--ssl-mode Состояние защиты связи с сервером.
--start-lsn Определяет самое высокое значение LSN, включенное в предыдущую резервную копию.
--suspend-at-end Делает паузу mysqlbackup, когда процедура резервного копирования близка к окончанию.
--trace Уровень сообщений отладки mysqlbackup.
--uncompress Распаковать резервную копию во время операции.
--use-tts Позволить выборочную резервную копию таблиц InnoDB, используя транспортабельные табличные пространства (TTS).
--user Имя пользователя базы данных, чтобы соединиться.
--verbose Напечатать больше информации.
--version Покажите информацию о версии.
--with-timestamp Создайте подкаталог под резервным каталогом с именем, сформированным из метки времени операции резервного копирования.
--write-threads Определяет количество потоков записи для операции резервного копирования.
--zstd-compression-level Уровень сжатия для связей с сервером с использованием сжатия ZSTD 8.0.18

20.1. Общие опции

Это опции общего характера или опции, которые не классифицированы ни под какой другой определенной группой:

20.2. Опции связи

Когда mysqlbackup создает резервную копию, он посылает команды SQL в сервер MySQL, используя соединение с базой данных. Способ создать связь подобен тому, что описан в Connecting to the MySQL Server Using Command Options MySQL 8.0 Reference Manual.

Как часть вызова mysqlbackup определите соответствующие --user, --password, --port и другие опции соединения с сервером MySQL. Можно определить определенные для связи опции клиента MySQL, упомянутые ниже в разделах [mysqlbackup] или [client] конфигурационного файла MySQL, или через параметры командной строки mysqlbackup:

Большинство других параметров связи, используемых командой mysql, признаны, но тихо проигнорированы. Неизвестные параметры связи заставляют mysqlbackup бросать ошибку и завершаться.

20.3. Варианты хранилища сервера

Эти варианты хранилища определяют различные параметры, связанные с сервером базы данных, на который восстанавливается резервная копия.

Эти варианты используются только с операциями восстановления то есть, copy-back и copy-back-and-apply-log. Описания ниже объясняют, как эти опции используются с mysqlbackup, для получения информации о том, как они используются с сервером MySQL, щелкните по имени, чтобы увидеть описание в документации MySQL.

  • innodb_undo_directory= PATH

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

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

    Для восстановления:

    Его значение получено следующим образом:

    Используя эту опцию удостоверьтесь, что местоположение не изменяется между последовательными восстановлениями полной и возрастающих резервных копий или двух возрастающих резервных копий. Иначе восстановление потерпит неудачу.

  • 20.4. Варианты резервного репозитория

    Эти опции определяют различные параметры, связанные с образом резервной копии или каталогом, или с тем, как резервная копия будет восстановлена. Как правило, --backup-image и --backup-dir единственные опции из группы, которые необходимо определить, используя mysqlbackup.

    Варианты резервного репозитория используются со следующими операциями:

    Варианты резервного репозитория разделены на две группы: первая определяет структуру резервной копии, вторая предоставляет информацию об оригинальной структуре данных по поддержанному серверу для будущих операций на резервной копии.

    Следующие варианты определяют структуру резервной копии:

    20.5. Варианты метаданных

    Эти варианты управляют созданием метаданных о резервных копиях. Некоторые метаданные сохранены в резервном каталоге, другие метаданные сохранены в таблицах базы данных mysql.

    20.6. Варианты сжатия

    Для обзора сжатия посмотрите раздел 4.3.4.

    20.7. Варианты инкрементного резервного копирования

    Для обзора возрастающих резервных копий и примеров использования для этих вариантов посмотрите разделы 4.3.3 и 5.1.3.

    Чтобы взять инкрементное резервное копирование, определите --incremental или --incremental-with-redo-log-only наряду с --backup-dir. В зависимости от того, использована --incremental или --incremental-with-redo-log-only, другие опции требуются или рекомендуются. Все данные InnoDB, измененные после определенного LSN (определен прямо или косвенно примененными опциями) копируются в инкрементное резервное копирование. MySQL Enterprise Backup 8.0.20 и ранее: чтобы восстановить инкрементное резервное копирование, определите --incremental (опция больше не требуется для MySQL Enterprise Backup 8.0.21 и позже).

    20.8. Частичная резервная копия и восстановление

    Чтобы выбрать определенные данные, которые будут поддержаны или восстановлены, используйте частичную резервную копию и опции, описанные в этой секции.

    Для обзора частичной резервной копии, а также примеров использования посмотрите разделы 4.3.5 и 5.1.4.

    Старые опции частичных резервных копий

    Информация в этом подразделе только для использования устаревшей опции --include. Для создания частичных резервных копий используйте --include-tables и --exclude-tables .

    Кроме --include некоторые другие опции также обсуждены ниже, но информация только для использования опций вместе с --include.

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

    20.9. Варианты однофайлового резервного копирования

    Эти варианты связаны с однофайловым резервным копированием. Вы используете их в сочетании с командами backup-to-image , image-to-backup-dir, backup-dir-to-image, copy-back-and-apply-log, list-image и extract (не все варианты применимы ко всем этим командам). Для примеров использования посмотрите раздел 4.3.1.

    20.10. Опции масштабируемости и производительности

    Эти варианты ограничивают ресурсы, используемые процессом резервного копирования, чтобы минимизировать издержки резервной копии для занятых или огромных баз данных или определить поведение процесса, сталкиваясь с проблемами ресурса.

    20.11. Опции журналирования сообщений

    mysqlbackup пишет важную информацию о прогрессе и ошибках в stderr. Информация часто очень ценна для того, чтобы разыскать проблемы, которые происходят во время операции. Начиная с MySQL Enterprise Backup 3.9, вывод stderr также сохранен в файле журнала по умолчанию (для большинства действий mysqlbackup), чтобы к информации об ошибке можно было легко получить доступ в любом процессе отладки.

    Сообщение, регистрирующее работы, например, tee обрабатывает на подобной Unix системе, в которой вывод программы разделяется, чтобы быть показанным и сохраненным в файл. Файл журнала называют в следующем формате: MEB_timestamp _operation.log, где operation действие mysqlbackup (например, backup, apply-log и т.д.), timestamp это дата и время, в которое выполнено действие. Вот некоторые примеры названий файлов журнала:

    MEB_2013-06-24.16-32-43_backup.log
    MEB_2013-06-28.11-07-18_apply_log.log
    MEB_2013-06-29.10-08-06_list_image.log
    

    Следующие опции управляют сообщением, регистрирующим функцию:

    Следующее это некоторые примеры, показывающие, как регистрацией сообщения управляют.

    Это создает файл журнала для операции backup в каталоге /home/backup_dir/meta из-за настроек по умолчанию:

    mysqlbackup -uroot --port=3306 --backup-dir=/home/backup_dir backup
    

    Это пропускает сообщение для действия backup:

    mysqlbackup -uroot --port=3306 --backup-dir=/home/backup_dir \
                --skip-messages-logdir backup
    

    Это создает файл журнала для действия apply-log в существующем каталоге /home/teelog_dir вместо местоположения по умолчанию:

    mysqlbackup -uroot --port=3306 --backup-dir=/home/backup_dir \
                --messages-logdir=/home/teelog_dir apply-log
    

    Это создает файл журнала для операции list-image в существующем каталоге /home/teelog_dir:

    mysqlbackup -uroot --port=3306 --backup-image=/backup/my.mbi \
                --messages-logdir=/home/teelog_dir list-image
    

    20.12. Опции отчета о выполнении работ

    Есть две возможности для управления функцией сообщения прогресса mysqlbackup: --show-progress и --progress-interval:

    20.13. Опции шифрования

    Эти опции для создания зашифрованного однофайлового резервного копирования и для расшифровки их. Дополнительную информацию см. в главе 10. Там же есть примеры использования для шифрования и функций декодирования MySQL Enterprise Backup.

    20.14. Возможности для работы с зашифрованными табличными пространствами InnoDB и зашифрованными журналами

    MySQL Enterprise Backup понимает зашифрованные табличные пространства InnoDB и для выпусков 8.0.14 и позже зашифрованные журналы. Для получения дополнительной информации о том, как MySQL Server шифрует и расшифровывает эти объекты, посмотрите InnoDB Data-at-Rest Encryption и Encrypting Binary Log Files and Relay Log Files. См. главу 6 и раздел 8.4 о том, как команды mysqlbackup обращаются с этими зашифрованными объектами.

    20.15. Опции облачного хранилища

    Эти опции для использования облачного хранилища для однофайловых операций. Посмотрите разделы 4.3.1.3 и 5.2 для получения дополнительной информации и инструкции относительно использования облаков с MySQL Enterprise Backup.

    20.16. Возможности для специальных типов резервирования

    Эти опции для поддержки серверов баз данных, которые играют определенные роли в репликации или содержат определенные виды данных, которые требуют специальной обработки.