Overview

Bytebase Docs

Why Bytebase

Supported Databases

Use Cases

POC Checklist

Onboarding Guide

Core Concepts

Self-host

Upgrade

Configure External PostgreSQL

Configure External URL

Cloud

Step 1: Deploy with Docker

Step 2: Register Account

Step 3: Configure Environments

Step 4: Add an Instance

Step 5: Create a Project

Step 6: Change Schema 

Step 7: Query Data

Connect Your Database

Troubleshoot

Query

Admin Mode

Data Masking

Manage SQL Scripts

AI Assistant

Grant Access

Request a Role

Role Expiration Reminder

One-Time Export

Semantic Types

Masking Algorithm

Global Masking Rule

Data Classification

Column Masking

Masking Exemption

Roles and Permissions

User Groups

Custom Roles

Audit Log

SCIM

Two-factor Authentication

Password Restriction

Sign-in Restriction

Watermark

Manage License

Production Setup

Back up Data

Database Change Mode

Database Instance

Environment Policy

Customize Logo

Set an Announcement

Server Startup Options

Error Code for Bytebase Core

Error Code for SQL Review

Schema Definition Language

Authentication

SQL Review API

SQL Editor

Release

Plan

Rollout

Issue

Permission

Terraform

Slack

Jira

Supabase

Render

Neon

First Schema Change in 5 Minutes

Deploy Schema Change with Rollout Policy

Data Change with 1-Click Rollback

This tutorial shows you how to configure risk rules in Bytebase to manage changes effectively.

Risk Center Best Practice

Batch Change with Database Group

SQL Review with Bytebase GUI

Learn to move schema change from test to prod.

How to Move Schema Change from Test to Prod

How to Synchronize Database Schemas

Database Change with Risk-Based Approval Flow

Database GitOps with GitHub Actions

Database GitOps with Azure DevOps Pipeline

Database GitOps with GitLab CI

Database GitOps with Bitbucket Pipelines

How to Configure Dynamic Data Masking

Assign a manager role who can only roll out issue but not query or change database.

How to Manage Roles

Just-in-Time Database Access via GUI

Just-in-Time Database Access via Slack

Learn how to automate semantic type and global masking rule using GitHub Actions and Bytebase API

Data Masking with GitHub Actions Part 1 - Semantic Type and Global Masking Rule

Data Masking with GitHub Actions Part 2 - Column Masking and Masking Exemption

Data Masking with GitHub Actions Part 3 - Data Classification

In this tutorial, we will demonstrate how to set up Just-in-Time (JIT) access using the Bytebase GUI connecting to Amazon Aurora.

Just-in-time Database Access to Amazon Aurora

Data Masking with Classification Levels

Manage Databases with Terraform

SQL Review with Bytebase API

In this tutorial, we will demonstrate how to use One API to help deploy Llama3 to Bytebase SQL editor

Self-host Llama3 for Bytebase AI Assistant

Codify SQL Review Policies with Bytebase API

Embed SQL Editor in Your Internal Web Portal

Automate database changes using Jira and Bytebase.

Automate Database Change with Jira

Manual Database Change with Jira

Audit Database Activities with Bytebase API

Learn how to use the Bytebase API to inspect user and database permissions.

User and Database Permissions with Bytebase API

Create Issue with Bytebase API

Get v1* iampolicies:batchget

Get v1projects

Post v1projects

GetProject retrieves a project by name.
 Users with "bb.projects.get" permission on the workspace or the project owner can access this method.

Get v1projects 1

Delete v1projects

Patch v1projects

Post v1projects webhooks :removewebhook

Post v1projects webhooks :updatewebhook

Post v1projects :addwebhook

Get v1projects :getiampolicy

Post v1projects :setiampolicy

Post v1projects :testwebhook

Post v1projects :undelete

Post v1projects:search

Delete v1actuatorcache

Get v1actuatorinfo

Patch v1actuatorinfo

Get v1actuatorresources

Post v1actuator:setupsample

Post v1auditlogs:export

Post v1auditlogs:search

Post v1projects auditlogs:export

Post v1projects auditlogs:search

Post v1authlogin

Post v1authlogout

Post v1celbatchdeparse

Post v1celbatchparse

Get v1environments policies

Post v1environments policies

Get v1environments policies 1

Delete v1environments policies

Patch v1environments policies

Get v1instances databases policies

Post v1instances databases policies

Get v1instances databases policies 1

Delete v1instances databases policies

Patch v1instances databases policies

Get v1instances policies

Post v1instances policies

Get v1instances policies 1

Delete v1instances policies

Patch v1instances policies

Get v1policies

Post v1policies

Get v1policies 1

Delete v1policies

Patch v1policies

Get v1projects policies

Post v1projects policies

Get v1projects policies 1

Delete v1projects policies

Patch v1projects policies

Get v1groups

Post v1groups

Get v1groups 1

Delete v1groups

UpdateGroup updates the group.
 Users with "bb.groups.update" permission on the workspace or the group owner can access this method.

Database CI/CD

SQL Editor

Database Permission

Dynamic Data Masking