Repository

bytebase/bytebase

Database CI/CD for DevOps teams. https://www.bytebase.com
4746 307 58 140
Standard Operating Procedure (SOP) Standardize the database schema and data change process across different database systems, small or large tables and different tenants.SQL Review100+ lint rules to detect SQL anti-patterns and enforce consistent SQL style in the organization.GitOpsPoint-and-click GitHub and GitLab integration to enable GitOps workflow for changing database.
All-in-one SQL EditorWeb-based IDE specifically for performing SQL specific tasks.Data AnonymizationState-of-the-art column level anonymization engine to cover complex situations like subquery, CTE.Database Access ControlOrganization level policy to centralize the database access control.
Manage Database Resources A single place to manage environments, database instances, database users for application development, with optional Terraform integration. Policy EnforcementEnforce organization wide SQL Review policy, backup policy and data access policy.SQL Editor Admin modeCLI like experience without setting up bastion.
Centralize Change, Query and Admin TasksA single place to perform different tasks on different databases, thus enforce policy and monitor activity accordingly. RBACTwo-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.

๐Ÿ–– 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:

  • Bytebase Console: A web-based GUI for developers and DBAs to manage the database development lifecycle.
  • Bytebase CLI (bb): The CLI to help developers integrate database changes into the existing CI/CD workflow.
  • Bytebase GitHub App and SQL Review GitHub Action: The GitHub App and GitHub Action to detect SQL anti-patterns and enforce a consistent SQL style guide during Pull Request.
  • Terraform Bytebase Provider: The Terraform provider enables team to manage Bytebase resources via Terraform. A typical setup involves teams using Terraform to provision database instances from Cloud vendors, followed by using Bytebase provider to prepare those instances ready for application use.
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.

๐Ÿ‘ฉโ€๐Ÿซ Tutorials

Manage database from cloud database vendors

๐Ÿ’Ž Design Principles

๐Ÿชถ Dependency Free Start with a single command ./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.

๐Ÿงฉ Data Model

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:

  • Workspace roles: Owner, DBA, Developer. The workspace role maps to the role in an engineering organization.
  • Project roles: Owner, Developer. 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:

    1. It has no external dependency.
    2. It requires zero config.
    3. 1 command to start backend and 1 command to start frontend, both with live reload support.
  • Interactive code walkthrough

  • Follow Life of a Feature.

Dev Environemnt Setup

Prerequisites

  • Go (1.19 or later)
  • pnpm
  • Air (our forked repo @87187cc with the proper signal handling). This is for backend live reload.
    go install github.com/bytebase/[email protected]
    
    

Steps

  1. Pull source.

    git clone https://github.com/bytebase/bytebase
    
  2. 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
    

    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
    
  3. 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.

๐Ÿคบ Bytebase vs Alternatives

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 tooliing 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.

Star History Chart

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.

Star History Chart

๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Community

Hang out on Discord

Follow us on Twitter

๐Ÿค” Frequently Asked Questions (FAQs)

Check out our FAQ.

๐Ÿ™‹ Contact Us

  • Interested in joining us? Check out our jobs page for openings.
  • Want to solve your schema change and database management headache? Book a 30min demo with one of our product experts.