mysql_bak_request.toml Configuration Manual

mysql_bak_request.toml is the request configuration file for the peppykeep backup mysql-db-list command, used to define the specific parameters of a bulk MySQL backup task.

File Role

• Describe which databases to back up this time
• Define table filter rules per database (include/exclude)
• Specify control parameters for backup behavior (whether to upload, clean, etc.)

Profile Description

This document describes the meaning and setting methods of each parameter in the PeppyKeep backup service configuration file `mysql_bak_request.toml’.

Document Creation Instructions

📝 Important: This profile needs to be created by the user themselves

mysql_bak_request.toml is not automatically generated by the peppykeep tool and needs to be created manually by the user according to the actual backup needs.

Create steps:

1. Create the file under a configuration directory such as/path/to/user/.peppykeep/conf/
2. Refer to the configuration examples in this document and fill in the relevant parameters as needed
3. It is recommended that files be included in version control (Git) for easy tracking of changes

File naming suggestions:

mysql_bak_request.toml          # 默认配置
mysql_bak_request.daily.toml    # 日常备份配置
mysql_bak_request.weekly.toml   # 每周备份配置
mysql_bak_request.prod.toml     # 生产环境配置

Full configuration example

# ============================================================
# Backup job identity
# ============================================================

# Instance id for this project/instance
# Align with prj_key in prj.toml when possible
instance_name = "test_717_file"

# Upload to object storage when true; local-only when false
# Final behavior also depends on bak_location_type in bak.toml
upload_to_oss = true

# Prune local old backups per history_bak_num when true
remove_older_files = true

# Prune remote old backups per remote.retain when true
remove_older_oss_files = true

# ============================================================
# Job metadata
# ============================================================

[base]
# Job UUID; auto-generated when empty
uuid = ""

# Job name for logs and UI
name = "test_mysql_bak"

# Job description
desc = "backup test_717_file databases"

# ============================================================
# Docker container (optional)
# ============================================================

# [container]
# Container name for Docker MySQL; empty uses local mysqldump
# docker_container_name = ""

# Path to docker binary for container backups
# docker_cmd_path = "/usr/local/bin/docker"

# ============================================================
# Database list (core)
# ============================================================

# Database 1: full backup
[[db_config_list]]
# Database to back up
db_name = "ldbak_test"
# Included tables; empty means all
include_table_list = []
# Excluded tables; empty means none
exclude_table_list = []

# Database 2: full backup
[[db_config_list]]
db_name = "test_db_2"
include_table_list = []
exclude_table_list = []