Reliable Database CI/CD for Developers and DBAs
๐ฅ Live Demo โข โ๏ธ Install โข ๐ Docs โข ๐ฌ Discord โข ๐โโ๏ธ Book Demo
Different database development tasks
Multiple database systems
Unified process
Single tool
๐ช
Change
Want to formalize the database change process but don't know how?
Standard Operating Procedure (SOP)
Standardize the database schema and data change process across different database systems, small or large tables and different tenants.
SQL Review
100+ lint rules to detect SQL anti-patterns and enforce consistent SQL style in the organization.
GitOps
Point-and-click GitHub and GitLab integration to enable GitOps workflow for changing database.
๐ฎ
Query
Want to control the data access but don't know how?
All-in-one SQL Editor
Web-based IDE specifically for performing SQL specific tasks.
Data Masking
State-of-the-art column level masking engine to cover complex situations like subquery, CTE.
Data Access Control
Organization level policy to centralize the data access control.
๐
Secure
Want to avoid data leakage, change outage and detect malicious behavior but don't know how?
Centralize Change, Query and Admin Tasks
A single place to perform different tasks on different databases, thus enforce policy and monitor activity accordingly.
RBAC
Two-level RBAC model mapping to the organization wide privileges and application team privileges respectively.
Anomaly Center and Audit Logging
Capture all database anomalies, user actions and system events and present them in a holistic view.
๐ฉโ๐ผ
Govern
Want to enforce organization policy but don't know how?
Manage Database Resources
A single place to manage environments, database instances, database users for application development, with optional Terraform integration.
Policy Enforcement
Enforce organization wide SQL Review policy, backup policy and data access policy.
SQL Editor Admin mode
CLI like experience without setting up bastion.
๐ Intro
Bytebase is a Database CI/CD solution for the Developers and DBAs. It's the only database CI/CD project included by the CNCF Landscape. The Bytebase family consists of these tools:
Topic
๐๏ธ Installation
๐ฎ Demo
๐ฉโ๐ซ Tutorials
๐ Design Principles
๐งฉ Data Model
๐ญ Roles
๐ Developing and Contributing
๐คบ Bytebase vs Alternatives
๐๏ธ Installation
One liner
# One-liner installation script from latest release /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/bytebase/install/main/install.sh)"
๐ฎ Demo
Live demo at https://demo.bytebase.com
You can also book a 30min product walkthrough with one of our product experts.
Product tutorials are available at https://www.bytebase.com/tutorial.
Integrations./bytebase
without any external dependency. External PostgreSQL data store and others are optional.
๐
Integration First
Solely focus on database management and leave the rest to others. We have native VCS integration with GitHub/GitLab, Terraform Provider, webhook, and etc.
๐โโ๏ธ
Engineering Disciplined
Disciplined bi-weekly release and engineering practice.
More details in Data Model Doc.
๐ญ Roles
More details in Roles and Permissions Doc.
Bytebase employs RBAC (role based access control) and provides two role sets at the workspace and project level:
Admin
, DBA
, Member
. The workspace role maps to the role in an organization.Owner
, Developer
, Releaser
, Querier
, Exporter
, Viewer
. The project level role maps to the role in a specific team or project.Every user is assigned a workspace role, and if a particular user is involved in a particular project, then she will also be assigned a project role accordingly.
Below diagram describes a typical mapping between an engineering org and the corresponding roles in the Bytebase workspace
๐ Developing and Contributing
Bytebase is built with a curated tech stack. It is optimized for developer experience and is very easy to start working on the code:
Interactive code walkthrough
Follow Life of a Feature.
go install github.com/bytebase/air@87187cc
Steps
Pull source.
git clone https://github.com/bytebase/bytebase
Create an external Postgres database on localhost.
CREATE USER bbdev SUPERUSER; CREATE DATABASE bbdev;
Start backend using air (with live reload).
PG_URL=postgresql://bbdev@localhost/bbdev air -c scripts/.air.toml
Change the open file limit if you encounter "error: too many open files".
ulimit -n 10240
If you need additional runtime parameters such as --backup-bucket, please add them like this:
air -c scripts/.air.toml -- --backup-region us-east-1 --backup-bucket s3:\\/\\/example-bucket --backup-credential ~/.aws/credentials
Start frontend (with live reload).
cd frontend && pnpm i && pnpm dev
Bytebase should now be running at http://localhost:3000 and change either frontend or backend code would trigger live reload.
Tips
Option + Shift
on Mac or Alt + Shift
on Windows
Bytebase vs Flyway, Liquibase
Either Flyway or Liquibase is a library and CLI focusing on schema change. While Bytebase is an one-stop solution covering the entire database development lifecycle for Developers and DBAs to collaborate.
Another key difference is Bytebase doesn't support Oracle and SQL Server. This is a conscious decision we make so that we can focus on supporting other databases without good tooling support. In particular, many of our users tell us Bytebase is by far the best (and sometimes the only) database tool that can support their PostgreSQL and ClickHouse use cases.
Bytebase vs Yearning, Archery
Either Yearning or Archery provides a DBA operation portal. While Bytebase provides a collaboration
workspace for DBAs and Developers, and brings DevOps practice to the Database Change Management (DCM).
Bytebase has the similar Project
concept seen in GitLab/GitHub and provides native GitOps integration
with GitLab/GitHub.
Another key difference is Yearning, Archery are open source projects maintained by the individuals part-time. While Bytebase is open-sourced, it adopts an open-core model and is a commercialized product, supported by a fully staffed team releasing new version every 2 weeks.
๐จโ๐ฉโ๐งโ๐ฆ Community
๐ค Frequently Asked Questions (FAQs)
Check out our FAQ.
๐ Contact Us
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.