MCPcopy Index your code
hub / github.com/bytebase/bytebase

github.com/bytebase/bytebase @3.20.0 sqlite

repository ↗ · DeepWiki ↗ · release 3.20.0 ↗
29,129 symbols 91,653 edges 3,215 files 7,213 documented · 25% 107 cross-repo links
README

Bytebase

Database CI/CD for DevOps teams

Manage database schema changes with confidence

⚙️ Install📚 Docs💬 Discord🙋‍♀️ Book Demo

go report Artifact Hub Github Stars


What is Bytebase?

Bytebase is an open-source database DevOps tool, it's the only database CI/CD project included by the CNCF Landscape and Platform Engineering.

It offers a web-based collaboration workspace to help DBAs and Developers manage the lifecycle of application database schemas.

Bytebase

Key Features

🔄 Database CI/CD

  • GitOps Integration: Native GitHub/GitLab integration for database-as-code workflows
  • Migration Management: Automated schema migration with rollback support
  • SQL Review: 200+ lint rules to enforce SQL standards and best practices

🔒 Security & Compliance

  • Data Masking: Advanced column-level masking for sensitive data protection
  • Access Control: Fine-grained RBAC with project and workspace-level permissions
  • Audit Logging: Complete audit trail of all database activities

🎯 Developer Experience

  • Web SQL Editor: Feature-rich IDE for database development
  • Batch Changes: Apply changes across multiple databases and tenants
  • API & Terraform: Full API access and Terraform provider for automation

📊 Operations

  • Multi-Database Support: PostgreSQL, MySQL, MongoDB, Redis, Snowflake, and more
  • Drift Detection: Automatic detection of schema drift across environments
  • Admin Mode: CLI-like experience without bastion setup

Quick Start

Docker

docker run --init \
  --name bytebase \
  --publish 8080:8080 \
  --volume ~/.bytebase/data:/var/opt/bytebase \
  bytebase/bytebase:latest

Kubernetes

helm install bytebase bytebase/bytebase

Visit http://localhost:8080 and follow the setup wizard.

Documentation

The Bytebase Family

Use Cases

For Development Teams

  • Implement database schema version control
  • Automate database deployments through CI/CD pipelines
  • Collaborate on database changes with review workflows

For DBAs

  • Centralize database management across all environments
  • Enforce organization-wide SQL standards and policies
  • Monitor and audit all database activities

For Security Teams

  • Control data access with column-level permissions
  • Implement data masking for sensitive information
  • Maintain compliance with audit trails

Supported Databases

PostgreSQL, MySQL, MariaDB, TiDB, Snowflake, ClickHouse, MongoDB, Redis, Oracle, SQL Server, Spanner, and more.

Community & Support

Contributing

We welcome contributions!

# Setup a postgres database with user bbdev and database bbdev
export PG_URL=postgresql://bbdev@localhost/bbdev

# Start backend
alias r='go build -ldflags "-w -s" -p=16 -o ./bytebase-build/bytebase ./backend/bin/server/main.go && ./bytebase-build/bytebase --port 8080 --data . --debug'

# Start frontend
alias y="pnpm --dir frontend i && pnpm --dir frontend dev"

Comparisons

Star History Chart

Extension points exported contracts — how you extend this code

AST (Interface)
AST is the interface that all parser AST types must implement. Each parser package defines its own concrete AST type wit [19 …
backend/plugin/parser/base/ast.go
Masker (Interface)
Masker is the interface that masks the data. [6 implementers]
backend/component/masker/masker.go
Executor (Interface)
Executor is the task executor.
backend/runner/taskrun/executor.go
GoMigrationFunc (FuncType)
GoMigrationFunc is a function that performs data migration in Go code. It receives a context and database connection, an
backend/migrator/migrator.go
ComponentCustomProperties (Interface)
(no doc)
frontend/src/shims-vue-globals.d.ts
ApiClientOptions (Interface)
(no doc)
frontend/tests/e2e/framework/api-client.ts
Advisor (Interface)
Advisor is the interface for advisor. [250 implementers]
backend/plugin/advisor/advisor.go
Writer (FuncType)
Writer is a function type that writes query results to a writer.
backend/component/export/export.go

Core symbols most depended-on inside this repo

Errorf
called by 3847
backend/component/ghost/logger.go
t
called by 1707
frontend/src/react/components/sql-editor/SchemaPane/schemaTree.ts
String
called by 1674
backend/plugin/parser/tsql/batch/batch.go
Equal
called by 1412
backend/component/masker/masker.go
Equal
called by 1238
backend/plugin/schema/function_comparer.go
Join
called by 803
backend/common/qb/qb.go
Close
called by 645
backend/plugin/db/driver.go
Run
called by 583
backend/server/server.go

Shape

Method 13,258
Function 12,131
Struct 2,533
Interface 780
TypeAlias 214
Enum 94
Class 80
FuncType 39

Languages

Go81%
TypeScript19%

Modules by API surface

backend/generated-go/v1/database_service.pb.go731 symbols
backend/generated-go/store/database.pb.go612 symbols
backend/generated-go/v1/setting_service.pb.go495 symbols
backend/generated-go/v1/rollout_service.pb.go471 symbols
backend/generated-go/store/setting.pb.go407 symbols
backend/generated-go/v1/instance_service.pb.go399 symbols
backend/generated-go/v1/sql_service.pb.go394 symbols
backend/generated-go/v1/issue_service.pb.go288 symbols
backend/generated-go/store/instance.pb.go263 symbols
backend/generated-go/v1/plan_service.pb.go230 symbols
backend/generated-go/v1/subscription_service.pb.go209 symbols
backend/generated-go/v1/project_service.pb.go208 symbols

Dependencies from manifests, versioned

buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/gov1.36.11-20260415201 · 1×
buf.build/go/protovalidatev1.0.1 · 1×
cel.dev/exprv0.25.1 · 1×
cloud.google.com/gov0.123.0 · 1×
cloud.google.com/go/auth/oauth2adaptv0.2.8 · 1×
cloud.google.com/go/bigqueryv1.77.0 · 1×
cloud.google.com/go/cloudsqlconnv1.21.0 · 1×
cloud.google.com/go/compute/metadatav0.9.0 · 1×
cloud.google.com/go/longrunningv0.12.0 · 1×
cloud.google.com/go/monitoringv1.28.0 · 1×

Datastores touched

bbdevDatabase · 1 repos
bytebaseDatabase · 1 repos
(mongodb)Database · 1 repos
sampleDBDatabase · 1 repos
dbDatabase · 1 repos
postgresDatabase · 1 repos

For agents

$ claude mcp add bytebase \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact