Live Demo •
Install •
Help •
Development •
Design Doc
Bytebase is a web-based, zero-config, dependency-free database schema change and version control management tool for DBAs and developers.
For DBA - 10x operational efficiency
A collaborative web-console to allow DBAs to manage database tasks and handle developer tickets much more efficiently than traditonal tools.
For Tech Lead - Improve team velocity and reduce risk
Teams using Bytebase will naturally adopt industry best practice for managing database schema changes. Tech leads will see an improved development velocity and reduced outages caused by database changes.
For Developer - Holistic view of database schema changes
Regardless of working as an IC in a team or managing your own side project, developers using Bytebase will have a holistic view of all the related database info, the ongoing database schema change tasks and the past database migration history.
Features
- Web-based schema change and management workspace for teams
- Version control based schema migration (Database-as-Code)
- Classic UI based schema migraiton (SQL Review)
- Built-in SQL Editor
- Detailed migration history
- Multi-tenancy (rollout change to homogeneous databases belonged to different tenants)
- Backup and restore
- Anomaly center
- Environment policy
- Approval policy
- Backup schedule enforcement
- Schema drift detection
- Backward compatibility schema change check
- Role-based access control (RBAC)
- MySQL support
- PostgreSQL support
- TiDB support
- Snowflake support
- ClickHouse support
- GitLab CE/EE support
- Webhook integration for Slack, Discord, MS Teams, DingTalk(钉钉), Feishu(飞书), WeCom(企业微信)
- GitLab.com support
- GitHub support
Fig.1 - Dashboard
Fig.2 - SQL review issue pipeline
Fig.3 - GitLab based schema migration (Database-as-code)
Fig.4 - Built-in SQL Editor
Installation
Detailed installation guide
Run on localhost:8080
docker run --init --name bytebase --restart always --publish 8080:8080 --volume ~/.bytebase/data:/var/opt/bytebase bytebase/bytebase:1.0.0 --data /var/opt/bytebase --host http://localhost --port 8080
Run on https://bytebase.example.com
docker run --init --name bytebase --restart always --publish 80:80 --volume ~/.bytebase/data:/var/opt/bytebase bytebase/bytebase:1.0.0 --data /var/opt/bytebase --host https://bytebase.example.com --port 80
📕 Docs
In particular, get familar with various product concept such as data model, roles and permissions and etc.
Design doc
https://github.com/bytebase/bytebase/tree/main/docs/design
🕊 Interested in contributing?
-
Checkout issues tagged with good first issue.
-
We are maintaining an online database glossary list, you can add/improve content there.
Note: We are quite disciplined on tech stack. If you consider bringing a new programming language, framework and any non-trivial external dependency, please open a discussion first.
🏗 Development
Bytebase is built with a curated tech stack. It is optimized for developer experience and is very easy to start
working on the code:
- It has no external dependency.
- It requires zero config.
- 1 command to start backend and 1 command to start frontend, both with live reload support.
Tech Stack
Data Model
Prerequisites
- Go (1.16 or later)
- Yarn
- Air (For backend live reload)
Steps
-
Install Air.
-
Pull source.
git clone https://github.com/bytebase/bytebase
-
Set up pre-commit hooks.
cd bytebase
pre-commit install
pre-commit install --hook-type commit-msg
-
Start backend using air (with live reload).
air -c scripts/.air.toml
Change the open file limit if you encounter "error: too many open files".
ulimit -n 10240
-
Start frontend (with live reload).
cd frontend && yarn && yarn dev
Bytebase should now be running at https://localhost:3000 and change either frontend or backend code would trigger live reload.
Coding guideline
Here
Notice
Bytebase is in public alpha and we may make breaking schema changes between versions. We plan to stabilize the schema by the end of Mar 2022. In the mean time, if you are eager to try Bytebase for your business and encounter
issue when upgrading to the new version. Please contact support@bytebase.com and we will help you manually upgrade the schema.
Star History
We are hiring
We are looking for engineers and developer advocates, interns are also welcomed. Check out our jobs page.