https://github.com/pilotpirxie/database-backup-worker

💾 Dump MySQL, PostgreSQL or ClickHouse database and upload to S3
https://github.com/pilotpirxie/database-backup-worker

aws-s3 backup backup-tool backup-utility clickhouse clickhouse-database database mysql mysql-database node nodejs postgres postgresql s3 s3-bucket s3-storage sql worker

Last synced: 8 days ago
JSON representation

💾 Dump MySQL, PostgreSQL or ClickHouse database and upload to S3

• Host: GitHub
• URL: https://github.com/pilotpirxie/database-backup-worker
• Owner: pilotpirxie
• License: mit
• Created: 2022-05-28T11:37:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-31T14:45:13.000Z (20 days ago)
• Last Synced: 2024-10-31T15:34:17.227Z (20 days ago)
• Topics: aws-s3, backup, backup-tool, backup-utility, clickhouse, clickhouse-database, database, mysql, mysql-database, node, nodejs, postgres, postgresql, s3, s3-bucket, s3-storage, sql, worker
• Language: TypeScript
• Homepage:
• Size: 133 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# database-backup-worker

Backend worker to periodically dump full **MySQL**, **PostgreSQL** or **ClickHouse** database and upload to S3. You can setup multiple databases on a single instance.

### Getting started

```shell

git clone https://github.com/pilotpirxie/database-backup-worker.git

cd database-backup-worker

yarn

yarn build

yarn start

```

### Setup

Config in `.env` file should look like following:

```shell

# Number of databases to backup

# For each database setup environment variables prefixed with DB_

# Index for database config is 0-based

DB_NUMBER=1

# Whether to run backup on start without

# waiting for the cron time

RUN_ON_START=false

# Cron time pattern, use https://crontab.guru/

# e.g. "0 */6 * * *" means "At minute 0 past every 6th hour."

# leave it default if you don't know what you are doing.

DB_CRON_PATTERN_="0 */6 * * *"

# Database type "mysql", "clickhouse" or "postgresql"

DB_TYPE_=

# Database host

# For MySQL use just host

# For ClickHouse prefix with https:// or http:// protocol

DB_HOST_=

# Database port

DB_PORT_=

# Database name

DB_NAME_=

# Database user name

DB_USER_=

# Database user password

DB_PASS_=

# Skip tables, comma separated

# e.g. "table1,table2"

DB_SKIP_TABLES_=

# S3 compatible bucket name

S3_BUCKET=

# S3 access key

S3_ACCESS_KEY=

# S3 secret key

S3_SECRET_KEY=

# Endpoint of the service without protocol

S3_ENDPOINT=

# Use secure connection, recommended

S3_SSL=true

# Use path-style addressing https://s3.amazonaws.com/BUCKET/KEY

S3_FORCE_PATH_STYLE=true

```

### License

```

MIT

```