# Bytebase Docs ## Docs - [Two-factor Authentication](https://docs.bytebase.com/administration/2fa.md) - [Announcement Banner](https://docs.bytebase.com/administration/announcement.md) - [Archive](https://docs.bytebase.com/administration/archive.md) - [Customize Logo](https://docs.bytebase.com/administration/customize-logo.md) - [Database Group](https://docs.bytebase.com/administration/database-group.md) - [Manage License](https://docs.bytebase.com/administration/license.md) - [Database Change Mode](https://docs.bytebase.com/administration/mode.md) - [Password Restriction](https://docs.bytebase.com/administration/password.md) - [Risk Center](https://docs.bytebase.com/administration/risks.md) - [Roles and Permissions](https://docs.bytebase.com/administration/roles.md) - [Entra ID](https://docs.bytebase.com/administration/scim/entra-id.md) - [Okta](https://docs.bytebase.com/administration/scim/okta.md) - [Overview](https://docs.bytebase.com/administration/scim/overview.md) - [Service Account](https://docs.bytebase.com/administration/service-account.md) - [Sign-in Restriction](https://docs.bytebase.com/administration/sign-in-restriction.md) - [IdP-Initiated Flow](https://docs.bytebase.com/administration/sso/idp-initiated.md) - [LDAP](https://docs.bytebase.com/administration/sso/ldap.md) - [OAuth 2.0](https://docs.bytebase.com/administration/sso/oauth2.md) - [OpenID Connect (OIDC)](https://docs.bytebase.com/administration/sso/oidc.md) - [OIDC with Microsoft Entra ID](https://docs.bytebase.com/administration/sso/oidc-entra-id.md) - [Overview](https://docs.bytebase.com/administration/sso/overview.md) - [Users & Groups](https://docs.bytebase.com/administration/user-groups/overview.md) - [Workload Identity for GitHub Actions](https://docs.bytebase.com/administration/workload-identity/github-actions.md) - [Workload Identity for GitLab CI/CD](https://docs.bytebase.com/administration/workload-identity/gitlab-ci.md) - [Overview](https://docs.bytebase.com/administration/workload-identity/overview.md) - [AI Assistant](https://docs.bytebase.com/ai-assistant.md) - [Custom Approval](https://docs.bytebase.com/change-database/approval.md) - [Batch Change](https://docs.bytebase.com/change-database/batch-change.md) - [Change History](https://docs.bytebase.com/change-database/change-history.md) - [Overview](https://docs.bytebase.com/change-database/change-workflow.md) - [Environment Policy](https://docs.bytebase.com/change-database/environment-policy/overview.md) - [Rollout Permissions](https://docs.bytebase.com/change-database/environment-policy/rollout-policy.md) - [Online Schema Migration for MySQL](https://docs.bytebase.com/change-database/online-schema-migration-for-mysql.md) - [Plan](https://docs.bytebase.com/change-database/plan.md) - [Review](https://docs.bytebase.com/change-database/review.md) - [Data Rollback](https://docs.bytebase.com/change-database/rollback-data-changes.md) - [Schema Rollback](https://docs.bytebase.com/change-database/rollback-schema-changes.md) - [Scheduled Rollout](https://docs.bytebase.com/change-database/scheduled-rollout.md) - [Schema Editor](https://docs.bytebase.com/change-database/schema-editor.md) - [Settings](https://docs.bytebase.com/change-database/settings.md) - [Schema Synchronization](https://docs.bytebase.com/change-database/synchronize-schema.md) - [Transaction Mode](https://docs.bytebase.com/change-database/transaction-mode.md) - [Webhook](https://docs.bytebase.com/change-database/webhook.md) - [Bytebase 3.0.0 - Oct 24, 2024](https://docs.bytebase.com/changelog/bytebase-3-0-0.md): AI Assistant for SQL Editor - [Bytebase 3.0.1 - Nov 07, 2024](https://docs.bytebase.com/changelog/bytebase-3-0-1.md): Configurable DDL/DML Execution in SQL Editor - [Bytebase 3.1.0 - Nov 21, 2024](https://docs.bytebase.com/changelog/bytebase-3-1-0.md): Google/GitHub SSO available in Pro Plan - [Bytebase 3.1.1 - Dec 05, 2024](https://docs.bytebase.com/changelog/bytebase-3-1-1.md): Customizable homepage with shortcut list - [Bytebase 3.1.2 - Dec 19, 2024](https://docs.bytebase.com/changelog/bytebase-3-1-2.md): Tooltips for tables, columns, and PostgreSQL view comments in SQL Editor - [Bytebase 3.10.0 - Sep 11, 2025](https://docs.bytebase.com/changelog/bytebase-3-10-0.md): Cassandra data masking - [Bytebase 3.10.1 - Sep 25, 2025](https://docs.bytebase.com/changelog/bytebase-3-10-1.md): Support key–value project labels - [Bytebase 3.11.0 - Oct 10, 2025](https://docs.bytebase.com/changelog/bytebase-3-11-0.md): Environment rollout policy update - [Bytebase 3.11.1 - Oct 23, 2025](https://docs.bytebase.com/changelog/bytebase-3-11-1.md): Apache Doris - Support system views and functions - [Bytebase 3.12.0 - Nov 6, 2025](https://docs.bytebase.com/changelog/bytebase-3-12-0.md): PostgreSQL - State-based GitOps workflow - [Bytebase 3.12.1 - Nov 20, 2025](https://docs.bytebase.com/changelog/bytebase-3-12-1.md): Audit logging to stdout - [Bytebase 3.12.2 - Dec 4, 2025](https://docs.bytebase.com/changelog/bytebase-3-12-2.md): Improvements and Bug Fixes - [Bytebase 3.13.0 - Dec 18, 2025](https://docs.bytebase.com/changelog/bytebase-3-13-0.md): Support MCP integration and simplified approval flow configuration - [Bytebase 3.13.1 - Dec 30, 2025](https://docs.bytebase.com/changelog/bytebase-3-13-1.md): Improvements and Bug Fixes - [Bytebase 3.14.0 - Jan 15, 2026](https://docs.bytebase.com/changelog/bytebase-3-14-0.md): Separate CI and CD phases and Redefine Webhook Events - [Bytebase 3.14.1 - Jan 29, 2026](https://docs.bytebase.com/changelog/bytebase-3-14-1.md): Improvements and Bug Fixes - [Bytebase 3.15.0 - Feb 12, 2026](https://docs.bytebase.com/changelog/bytebase-3-15-0.md): Project-level Service Accounts & Workload Identities - [Bytebase 3.15.1 - Feb 26, 2026](https://docs.bytebase.com/changelog/bytebase-3-15-1.md): Improvements and Bug Fixes - [Bytebase 3.16.0 - Mar 12, 2026](https://docs.bytebase.com/changelog/bytebase-3-16-0.md): Just-In-Time (JIT) Data Access - [Bytebase 3.16.1 - Mar 26, 2026](https://docs.bytebase.com/changelog/bytebase-3-16-1.md): Improvements and Bug Fixes - [Bytebase 3.17.0 - Apr 9, 2026](https://docs.bytebase.com/changelog/bytebase-3-17-0.md): Unified Plan Lifecycle View & High Availability - [Bytebase 3.17.1 - Apr 23, 2026](https://docs.bytebase.com/changelog/bytebase-3-17-1.md): Improvements and Bug Fixes - [Bytebase 3.2.0 - Jan 02, 2025](https://docs.bytebase.com/changelog/bytebase-3-2-0.md): Selectively sync databases from an instance - [Bytebase 3.3.0 - Jan 16, 2025](https://docs.bytebase.com/changelog/bytebase-3-3-0.md): SOC 2 - [Bytebase 3.3.1 - Jan 30, 2025](https://docs.bytebase.com/changelog/bytebase-3-3-1.md): Support 1-click DML rollback for Oracle - [Bytebase 3.4.0 - Feb 13, 2025](https://docs.bytebase.com/changelog/bytebase-3-4-0.md): More features moved to community plan - [Bytebase 3.4.1 - Feb 27, 2025](https://docs.bytebase.com/changelog/bytebase-3-4-1.md): Terraform provider manages more resources - [Bytebase 3.5.0 - Mar 13, 2025](https://docs.bytebase.com/changelog/bytebase-3-5-0.md): Azure IAM Auth for Cosmos DB & Azure SQL - [Bytebase 3.5.1 - Mar 27, 2025](https://docs.bytebase.com/changelog/bytebase-3-5-1.md): Added Cosmos DB SQL filtering and projection support in SQL Editor - [Bytebase 3.5.2 - Apr 10, 2025](https://docs.bytebase.com/changelog/bytebase-3-5-2.md): Support Cassandra in SQL Editor - [Bytebase 3.6.0 - Apr 24, 2025](https://docs.bytebase.com/changelog/bytebase-3-6-0.md): SOC 2 Type 2 - [Bytebase 3.6.1 - May 08, 2025](https://docs.bytebase.com/changelog/bytebase-3-6-1.md): DML rollback supports unique indexes for major databases - [Bytebase 3.6.2 - May 23, 2025](https://docs.bytebase.com/changelog/bytebase-3-6-2.md): Enhance SQL Editor Experience - [Bytebase 3.7.0 - Jun 05, 2025](https://docs.bytebase.com/changelog/bytebase-3-7-0.md): Support Batch Export - [Bytebase 3.7.1 - Jun 19, 2025](https://docs.bytebase.com/changelog/bytebase-3-7-1.md): All database change features are now FREE in Community Plan - [Bytebase 3.8.0 - Jul 03, 2025](https://docs.bytebase.com/changelog/bytebase-3-8-0.md): Greatly improve schema sync/rollback for multiple DB engines - [Bytebase 3.8.1 - Jul 17, 2025](https://docs.bytebase.com/changelog/bytebase-3-8-1.md): New Database CI/CD Experience Preview - [Bytebase 3.9.0 - Jul 31, 2025](https://docs.bytebase.com/changelog/bytebase-3-9-0.md): New database CI/CD experience - [Bytebase 3.9.1 - Aug 14, 2025](https://docs.bytebase.com/changelog/bytebase-3-9-1.md): Support importing database revisions from releases or local files - [Bytebase 3.9.2 - Aug 28, 2025](https://docs.bytebase.com/changelog/bytebase-3-9-2.md): Support hard-delete for projects and instances - [FAQ](https://docs.bytebase.com/faq.md) - [Cloud](https://docs.bytebase.com/get-started/cloud.md) - [AWS Database Connections](https://docs.bytebase.com/get-started/connect/aws.md) - [Azure Database Connections](https://docs.bytebase.com/get-started/connect/azure.md) - [GCP Database Connections](https://docs.bytebase.com/get-started/connect/gcp.md) - [Overview](https://docs.bytebase.com/get-started/connect/overview.md) - [Self-Host vs Cloud](https://docs.bytebase.com/get-started/self-host-vs-cloud.md) - [Deploy with Docker](https://docs.bytebase.com/get-started/self-host/deploy-with-docker.md) - [Deploy with Kubernetes](https://docs.bytebase.com/get-started/self-host/deploy-with-kubernetes.md) - [External Access Configuration](https://docs.bytebase.com/get-started/self-host/external-access.md) - [Configure External PostgreSQL](https://docs.bytebase.com/get-started/self-host/external-postgres.md) - [Configure External URL](https://docs.bytebase.com/get-started/self-host/external-url.md) - [High Availability](https://docs.bytebase.com/get-started/self-host/high-availability.md) - [Network Architecture and External Access](https://docs.bytebase.com/get-started/self-host/network-architecture.md) - [Production Setup](https://docs.bytebase.com/get-started/self-host/production-setup.md) - [Upgrade](https://docs.bytebase.com/get-started/self-host/upgrade.md) - [Step 4: Add an Instance](https://docs.bytebase.com/get-started/step-by-step/add-an-instance.md) - [Step 6: Change Schema](https://docs.bytebase.com/get-started/step-by-step/change-schema.md) - [Step 5: Create a Project](https://docs.bytebase.com/get-started/step-by-step/create-a-project.md) - [Step 1: Deploy with Docker](https://docs.bytebase.com/get-started/step-by-step/deploy-with-docker.md) - [Step 7: Query Data](https://docs.bytebase.com/get-started/step-by-step/query-data.md) - [Step 2: Register Account](https://docs.bytebase.com/get-started/step-by-step/register-accounts.md) - [Step 3: Configure Environments](https://docs.bytebase.com/get-started/step-by-step/set-up-environments.md) - [File Organization](https://docs.bytebase.com/gitops/best-practices/file-organization.md) - [Git and CI/CD](https://docs.bytebase.com/gitops/best-practices/git-and-cicd.md) - [Migration Guidelines](https://docs.bytebase.com/gitops/best-practices/migration-guidelines.md) - [Overview](https://docs.bytebase.com/gitops/best-practices/overview.md) - [Performance Optimization](https://docs.bytebase.com/gitops/best-practices/performance.md) - [SQL Review and Security](https://docs.bytebase.com/gitops/best-practices/sql-review-and-security.md) - [Installation](https://docs.bytebase.com/gitops/installation.md) - [Develop](https://docs.bytebase.com/gitops/migration-based-workflow/develop.md) - [Limitations](https://docs.bytebase.com/gitops/migration-based-workflow/limitations.md) - [Overview](https://docs.bytebase.com/gitops/migration-based-workflow/overview.md) - [Release](https://docs.bytebase.com/gitops/migration-based-workflow/release.md) - [SQL Review CI](https://docs.bytebase.com/gitops/migration-based-workflow/sql-review-ci.md) - [Overview](https://docs.bytebase.com/gitops/overview.md) - [Develop](https://docs.bytebase.com/gitops/state-based-workflow/develop.md) - [Limitations](https://docs.bytebase.com/gitops/state-based-workflow/limitations.md) - [Overview](https://docs.bytebase.com/gitops/state-based-workflow/overview.md) - [Release](https://docs.bytebase.com/gitops/state-based-workflow/release.md) - [SQL Review CI](https://docs.bytebase.com/gitops/state-based-workflow/sql-review-ci.md) - [CI/CD Issues](https://docs.bytebase.com/gitops/troubleshooting/cicd-issues.md) - [Overview](https://docs.bytebase.com/gitops/troubleshooting/overview.md) - [Release and Plan Issues](https://docs.bytebase.com/gitops/troubleshooting/release-and-plan.md) - [Rollout Issues](https://docs.bytebase.com/gitops/troubleshooting/rollout.md) - [SDL Issues](https://docs.bytebase.com/gitops/troubleshooting/sdl-issues.md) - [Model Context Protocol (MCP)](https://docs.bytebase.com/integrations/mcp.md) - [Terraform Provider](https://docs.bytebase.com/integrations/terraform/overview.md) - [Supported Databases](https://docs.bytebase.com/introduction/supported-databases.md) - [Use Cases](https://docs.bytebase.com/introduction/use-cases.md) - [What's Bytebase](https://docs.bytebase.com/introduction/what-is-bytebase.md) - [Organize Resources](https://docs.bytebase.com/onboarding/organize-resources.md) - [Onboarding Plan](https://docs.bytebase.com/onboarding/plan.md) - [POC Checklist](https://docs.bytebase.com/onboarding/poc.md) - [SQL Editor Data Access Control](https://docs.bytebase.com/onboarding/sql-editor-data-access-control.md) - [Page Agent](https://docs.bytebase.com/page-agent.md) - [Audit Log](https://docs.bytebase.com/security/audit-log.md) - [Masking Exemption](https://docs.bytebase.com/security/data-masking/access-unmasked-data.md) - [Column Masking](https://docs.bytebase.com/security/data-masking/column-masking.md) - [Data Classification](https://docs.bytebase.com/security/data-masking/data-classification.md) - [Global Masking Rule](https://docs.bytebase.com/security/data-masking/global-masking-rule.md) - [Masking Algorithm](https://docs.bytebase.com/security/data-masking/masking-algorithm.md) - [Overview](https://docs.bytebase.com/security/data-masking/overview.md) - [Semantic Types](https://docs.bytebase.com/security/data-masking/semantic-types.md) - [Role Expiration Reminder](https://docs.bytebase.com/security/database-permission/expiration.md) - [Export Data](https://docs.bytebase.com/security/database-permission/export.md) - [Grant Access](https://docs.bytebase.com/security/database-permission/grant.md) - [Overview](https://docs.bytebase.com/security/database-permission/overview.md) - [Request a Role](https://docs.bytebase.com/security/database-permission/request.md) - [Watermark](https://docs.bytebase.com/security/watermark.md) - [Admin Mode](https://docs.bytebase.com/sql-editor/admin-mode.md) - [AI Assistant](https://docs.bytebase.com/sql-editor/ai-assistant.md) - [Manage SQL Scripts](https://docs.bytebase.com/sql-editor/manage-sql-scripts.md) - [Data Masking](https://docs.bytebase.com/sql-editor/mask-data.md) - [Overview](https://docs.bytebase.com/sql-editor/overview.md) - [Query](https://docs.bytebase.com/sql-editor/run-queries.md) - [Schema Diagram](https://docs.bytebase.com/sql-editor/schema-diagram.md) - [Data Source Restriction](https://docs.bytebase.com/sql-editor/settings/data-source-restriction.md) - [SQL Editor Limits](https://docs.bytebase.com/sql-editor/settings/limit.md) - [Error Codes](https://docs.bytebase.com/sql-review/error-codes.md) - [SQL Review Policy](https://docs.bytebase.com/sql-review/review-policy.md) - [Review Rules](https://docs.bytebase.com/sql-review/review-rules.md) - [Audit Database Activities with Bytebase API](https://docs.bytebase.com/tutorials/api-audit-log.md) - [Create Issue with Bytebase API](https://docs.bytebase.com/tutorials/api-issue.md) - [Codify SQL Review Policies with Bytebase API](https://docs.bytebase.com/tutorials/api-sql-review-policy.md) - [User and Database Permissions with Bytebase API](https://docs.bytebase.com/tutorials/api-user-database-permission.md): Learn how to use the Bytebase API to inspect user and database permissions. - [Batch Change with Database Group](https://docs.bytebase.com/tutorials/batch-change-with-database-group.md) - [Data Masking with Classification Levels](https://docs.bytebase.com/tutorials/data-classification.md) - [How to Configure Dynamic Data Masking](https://docs.bytebase.com/tutorials/data-masking.md) - [Data Change with 1-Click Rollback](https://docs.bytebase.com/tutorials/data-rollback.md) - [Automate Database Change with Jira](https://docs.bytebase.com/tutorials/database-change-management-with-jira-automated.md): Automate database changes using Jira and Bytebase. - [Manual Database Change with Jira](https://docs.bytebase.com/tutorials/database-change-management-with-jira-manual.md) - [Database Change with Custom Approval Flow](https://docs.bytebase.com/tutorials/database-change-management-with-risk-adjusted-approval-flow.md) - [Deploy Schema Change with Rollout Policy](https://docs.bytebase.com/tutorials/deploy-schema-migration.md) - [Embed SQL Editor in Your Internal Web Portal](https://docs.bytebase.com/tutorials/embed-sql-editor.md) - [First Schema Change in 5 Minutes](https://docs.bytebase.com/tutorials/first-schema-change.md) - [Data Masking with GitHub Actions Part 1 - Semantic Type and Global Masking Rule](https://docs.bytebase.com/tutorials/github-action-data-masking-part1.md): Learn how to automate semantic type and global masking rule using GitHub Actions and Bytebase API - [Data Masking with GitHub Actions Part 2 - Column Masking and Masking Exemption](https://docs.bytebase.com/tutorials/github-action-data-masking-part2.md) - [Data Masking with GitHub Actions Part 3 - Data Classification](https://docs.bytebase.com/tutorials/github-action-data-masking-part3.md) - [Database GitOps with Azure DevOps Pipeline](https://docs.bytebase.com/tutorials/gitops-azure-devops-workflow.md) - [Database GitOps with Bitbucket Pipelines](https://docs.bytebase.com/tutorials/gitops-bitbucket-workflow.md) - [Database GitOps with GitHub Actions](https://docs.bytebase.com/tutorials/gitops-github-workflow.md) - [Database GitOps with GitLab CI](https://docs.bytebase.com/tutorials/gitops-gitlab-workflow.md) - [How to Manage Roles](https://docs.bytebase.com/tutorials/how-to-manage-roles.md): Assign a manager role who can only deploy issue but not query or change database. - [How to Move Schema Change from Test to Prod](https://docs.bytebase.com/tutorials/how-to-move-schema-change-from-test-to-prod.md): Learn to move schema change from test to prod. - [How to Synchronize Database Schemas](https://docs.bytebase.com/tutorials/how-to-synchronize-database-schemas.md) - [Just-in-time Database Access to Amazon Aurora](https://docs.bytebase.com/tutorials/just-in-time-database-access-amazon-aurora.md): 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 via GUI](https://docs.bytebase.com/tutorials/just-in-time-database-access-part1.md) - [Just-in-Time Database Access via Slack](https://docs.bytebase.com/tutorials/just-in-time-database-access-part2.md) - [Manage Data Masking with Terraform](https://docs.bytebase.com/tutorials/manage-data-masking-with-terraform.md) - [Manage Database Access Control with Terraform](https://docs.bytebase.com/tutorials/manage-database-access-control-with-terraform.md) - [Manage Databases with Terraform](https://docs.bytebase.com/tutorials/manage-databases-with-terraform.md) - [Manage Environments with Terraform](https://docs.bytebase.com/tutorials/manage-environments-with-terraform.md) - [Manage General Settings with Terraform](https://docs.bytebase.com/tutorials/manage-general-settings-with-terraform.md) - [Manage Projects with Terraform](https://docs.bytebase.com/tutorials/manage-projects-with-terraform.md) - [Manage SQL Review Rules with Terraform](https://docs.bytebase.com/tutorials/manage-sql-review-rules-with-terraform.md) - [Manage Users and Groups with Terraform](https://docs.bytebase.com/tutorials/manage-users-and-groups-with-terraform.md) - [Risks Best Practice](https://docs.bytebase.com/tutorials/risks-best-practice.md): This tutorial shows you how to configure risk rules in Bytebase to manage changes effectively. - [Self-host Llama3 for Bytebase AI Assistant](https://docs.bytebase.com/tutorials/self-host-llama.md): In this tutorial, we will demonstrate how to use One API to help deploy Llama3 to Bytebase SQL editor - [SQL Review with Bytebase API](https://docs.bytebase.com/tutorials/sql-review-api.md) - [SQL Review with Bytebase GUI](https://docs.bytebase.com/tutorials/sql-review-gui.md) - [State-based Schema Management with GitHub Actions and AI Review](https://docs.bytebase.com/tutorials/state-based-schema-management-github.md) ## Optional - [API Reference](https://api.bytebase.com)