Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vielhuber/syncdb
🔥 Sync databases between two servers. 🔥
https://github.com/vielhuber/syncdb
database mysql sql sync-database
Last synced: 19 days ago
JSON representation
🔥 Sync databases between two servers. 🔥
- Host: GitHub
- URL: https://github.com/vielhuber/syncdb
- Owner: vielhuber
- Created: 2016-06-19T18:40:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-24T09:42:22.000Z (over 1 year ago)
- Last Synced: 2024-04-02T21:22:41.830Z (9 months ago)
- Topics: database, mysql, sql, sync-database
- Language: PHP
- Homepage:
- Size: 247 KB
- Stars: 7
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔥 syncdb 🔥
syncdb syncs databases between two servers.
## Features
- Most common use case: Sync your production database to your local environment
- You also can sync between any servers, even from remote to remote (without local)
- Works with direct database connections or via ssh tunnels
- Currently supports mysql, postgresql support will be added soon
- Has also a fast mode where the sql file is zipped (you also can choose the compression level)
- Does include a search/replace mechanism called [magicreplace](https://github.com/vielhuber/magicreplace)
- (Remote) commands like mysqldump, mysql, zip, e.g. can be overwritten manually to fit any environment
- Works on Linux, Mac and Windows (with WSL)
- Supports parallel execution of multiple syncs
- Uses optimization techniques for a faster restore
- Also supports ssh connections to servers without the support for public keys
- Shows live restore progress
## Requirements
#### Mac
Install [Homebrew](https://brew.sh) and then [coreutils](https://formulae.brew.sh/formula/coreutils):
```
brew install coreutils
```
#### Windows
Choose one of the two following options:
- Install [WSL2](https://docs.microsoft.com/de-de/windows/wsl/install-win10)
- Install [Cygwin](https://cygwin.com/install.html):
- Install all default packages + `unzip`
- Add `C:\cygwin64\bin` to your environment PATH (high priority, but below php)
## Installation
### Mac / Windows (WSL2) / Linux
```bash
mkdir ~/.syncdb
cd ~/.syncdb
composer require vielhuber/syncdb
chmod +x vendor/vielhuber/syncdb/src/syncdb
```
Now add `~/.syncdb/vendor/vielhuber/syncdb/src/` to your path environment.
### Windows (CMD)
```bash
mkdir "%USERPROFILE%/.syncdb"
cd "%USERPROFILE%/.syncdb"
composer require vielhuber/syncdb
```
Now add `C:\Users\xxx\.syncdb\vendor\vielhuber\syncdb\src\` to your path environment.
## Update
### Mac / Windows (WSL2) / Linux
```bash
cd ~/.syncdb
composer update
chmod +x vendor/vielhuber/syncdb/src/syncdb
```
### Windows (CMD)
```bash
cd "%USERPROFILE%/.syncdb"
composer update
```
## Usage
```bash
syncdb profile-name
```
## Configuration
Simply put your desired configuration files in ~/.syncdb/profiles/profile-name.json:
```bash
mkdir ~/.syncdb/profiles
cd ~/.syncdb/profiles
nano example.json
```
```json
{
"engine": "mysql",
"source": {
"host": "200.10.10.10",
"port": "3307",
"database": "EXAMPLE",
"username": "EXAMPLE",
"password": "EXAMPLE",
"cmd": "mysqldump",
"ssh": false
},
"target": {
"host": "localhost",
"port": "3306",
"database": "EXAMPLE",
"username": "EXAMPLE",
"password": "EXAMPLE",
"cmd": "mysql",
"ssh": false
},
"replace": {
"https://www.example.com": "http://www.example.local",
"www.example.com": "www.example.local"
}
}
```
You can find more examples in the profiles folder in this git repo.
## Excluding table data
Sometimes it is useful to exclude certain table data (e.g. `logs`, `cache`, ...), while preserving the structure.
Database engines don't provide a good way to do this.
Therefore you can use the `ignore_table_data`-directive in your `json`-config:
```json
{
"ignore_table_data": ["table1", "table2", "table3"]
}
```
## Privileges
Since MySQL 5.7 and MySQL 8.0.21 accessing the INFORMATION_SCHEMA.FILES table now requires the PROCESS privilege. Most providers don't have this option available. This results in the error message:
`Error: 'Access denied; you need (at least one of) the PROCESS privilege(s) for this operation' when trying to dump tablespaces`
`syncdb` automatically adds `--no-tablespaces` to your mysqldump-commands. You can turn off this behaviour by adding `"tablespaces": true` to your configuration.