Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions content/blog/2023-q3-retrospect.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,6 @@ Bytebase keeps up with the bi-weekly release cadence and released 7 versions.
- Oracle: Schema Sync.
- RisingWave: basic support.

### GitOps Integration

- Support [GitHub Enterprise](https://docs.bytebase.com/vcs-integration/github-enterprise/).
- Support [Azure DevOps](https://docs.bytebase.com/vcs-integration/azure-devops/).

### Database Change Management

Expand Down
2 changes: 1 addition & 1 deletion content/blog/all-database-tools-bytebase-replaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ for DBAs and developers to collaborate on database changes.
- [SQL linter](https://docs.bytebase.com/sql-review/overview/) to detect anti-patterns.
![schema-review-table-drop-naming](/content/docs/sql-review/schema-review-table-drop-naming.webp)
- [Streamline the change](https://docs.bytebase.com/change-database/batch-change/) across different environments and allow to batch change many databases consistently.
- [GitOps integration](https://docs.bytebase.com/vcs-integration/overview/) with mainstream VCSs to enable database-as-code workflow.
- [GitOps integration](https://docs.bytebase.com/gitops/overview/) with mainstream VCSs to enable database-as-code workflow.
- [Online schema migration for MySQL](https://docs.bytebase.com/change-database/online-schema-migration-for-mysql/) with gh-ost integration.

## Change Coordination
Expand Down
2 changes: 1 addition & 1 deletion content/blog/bytebase-github-technology-partner.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Once configured, if a SQL statement in your PR violates the review rule, you wil

![sql-review-github](/content/blog/bytebase-github-technology-partner/sql-review-github.webp)

In addition, you can take database management one step further by configuring the [GitOps workflow](https://docs.bytebase.com/vcs-integration/overview), which can be defined as "Database-as-code". This enables an integrated CI/CD process from code changes to database changes. The database change scripts you submit to your GitHub repo will automatically trigger Bytebase's SQL review and deployment pipeline. This enables an integrated CI/CD process from code changes to database changes.
In addition, you can take database management one step further by configuring the [GitOps workflow](https://docs.bytebase.com/gitops/overview), which can be defined as "Database-as-code". This enables an integrated CI/CD process from code changes to database changes. The database change scripts you submit to your GitHub repo will automatically trigger Bytebase's SQL review and deployment pipeline. This enables an integrated CI/CD process from code changes to database changes.

![gitops-bytebase](/content/blog/bytebase-github-technology-partner/gitops-bytebase.webp)

Expand Down
2 changes: 1 addition & 1 deletion content/blog/database-cicd-best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ This process can be divided into three main tasks:

![](/content/blog/database-cicd-best-practice/schema-review.webp)

3. **[Set up GitOps](https://docs.bytebase.com/vcs-integration/overview)**. Configure the GitOps workflow in a given project to monitor changes in the VCS and automatically kick start the review process.
3. **[Set up GitOps](https://docs.bytebase.com/gitops/overview)**. Configure the GitOps workflow in a given project to monitor changes in the VCS and automatically kick start the review process.

![](/content/blog/database-cicd-best-practice/gitops.webp)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ At the same time, we also understand the benefit of state-based approach. That's
1. For every schema migration, Bytebase will record the schema snapshot.
2. If team manage database schema under version control system, they can configure Bytebase to write the schema snapshot back to the repository at a specified path.

With that, it makes Bytebase become a hybrid schema migration system. Team using Bytebase retain all the existing benefits of migration-based approach, meanwhile they now can have a single latest schema file. This file is the single of truth of their database schema, which brings the core merit from state-based approach. Please do checkout out [user guide](https://docs.bytebase.com/vcs-integration/add-gitops-connector#step-3---configure-deploy) on how to configure this.
With that, it makes Bytebase become a hybrid schema migration system. Team using Bytebase retain all the existing benefits of migration-based approach, meanwhile they now can have a single latest schema file. This file is the single of truth of their database schema, which brings the core merit from state-based approach. Please do checkout out [user guide](https://docs.bytebase.com/gitops/overview) on how to configure this.

As a side note, I do hope database engine could innovate in the direction as Kubernetes to pave the way for state-based approach. Actually, Google's own database system Spanner does provide these support and you know what, every team at Google use the state-based approach to manage their database schemas.

Expand Down
2 changes: 1 addition & 1 deletion content/blog/ev-manufacturer-case-study.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Introduce Bytebase, an open-source database DevOps tool, which offers a web-base

### Manage SQL scripts and initiate change requests directly through code repos

SQL [is also code](/blog/database-as-code) and should be orderly and consistent. With Bytebase, they are able to [integrate SQL scripts into their code repository (GitLab)](https://docs.bytebase.com/vcs-integration/overview/): all SQL scripts will automatically trigger issues when merged into the specified branch. Devs can complete all their tasks within their familiar tool, greatly improving efficiency while reducing the chances of careless mistakes caused by copying and pasting back and forth.
SQL [is also code](/blog/database-as-code) and should be orderly and consistent. With Bytebase, they are able to [integrate SQL scripts into their code repository (GitLab)](https://docs.bytebase.com/gitops/overview/): all SQL scripts will automatically trigger issues when merged into the specified branch. Devs can complete all their tasks within their familiar tool, greatly improving efficiency while reducing the chances of careless mistakes caused by copying and pasting back and forth.

### Notification on IM apps

Expand Down
2 changes: 1 addition & 1 deletion content/blog/how-bytebase-tracks-database-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ to a single database as well as changes to hundreds of databases spanning multip
![_](/content/blog/how-bytebase-tracks-database-change/issue-detail-who.webp)

1. Issue Creator
1. Reviewers according to the [Rollout Policy](https://docs.bytebase.com/administration/environment-policy/rollout-policy/)
1. Reviewers according to the [Rollout Policy](https://docs.bytebase.com/change-database/environment-policy/rollout-policy/)
1. Subscribers interested in the progress.
1. Other participants can comment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,6 @@ To tackle this, you should adopt best practices:

<HintBlock type="info">

Bytebase offers [batch change](https://docs.bytebase.com/change-database/batch-change/), [SQL Review](https://docs.bytebase.com/sql-review/overview/), [GitOps](https://docs.bytebase.com/vcs-integration/overview/) to streamline and simplify schema migrations for the **Database per Tenant** model.
Bytebase offers [batch change](https://docs.bytebase.com/change-database/batch-change/), [SQL Review](https://docs.bytebase.com/sql-review/overview/), [GitOps](https://docs.bytebase.com/gitops/overview/) to streamline and simplify schema migrations for the **Database per Tenant** model.

</HintBlock>
2 changes: 1 addition & 1 deletion content/blog/note-case-study.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,6 @@ After implementing Bytebase's database access control, the following issues have

At present, only read queries are utilized; the aim is to enable modifications for both DML and DDL directly on Bytebase.

- [GitOps workflow with GitHub](https://docs.bytebase.com/vcs-integration/overview/)
- [GitOps workflow with GitHub](https://docs.bytebase.com/gitops/overview/)

Given that SQL is currently managed through GitHub Issues in the existing business process, the introduction of GitOps is expected to enhance operational efficiency.
2 changes: 1 addition & 1 deletion content/blog/postgres-create-index-concurrently.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ To prevent developers from running `CREATE INDEX` and accidentally locking the d

<HintBlock type="info">

[Bytebase SQL Review](https://docs.bytebase.com/sql-review/review-rules#create-index-concurrently) provides automated enforcement of the `CREATE INDEX CONCURRENTLY` rule and can be integrated with [CI/CD pipelines](https://docs.bytebase.com/vcs-integration/overview#github-actions) to catch violations before deployment.
[Bytebase SQL Review](https://docs.bytebase.com/sql-review/review-rules#create-index-concurrently) provides automated enforcement of the `CREATE INDEX CONCURRENTLY` rule and can be integrated with [CI/CD pipelines](https://docs.bytebase.com/gitops/overview) to catch violations before deployment.

</HintBlock>

Expand Down
2 changes: 1 addition & 1 deletion content/blog/salla-case-study.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,5 @@ With the entire change process integrated into a single platform, their release

Salla has plans to integrate GitOps and Terraform Bytebase Provider into their workflow.

- Through the [GitOps workflow](https://docs.bytebase.com/vcs-integration/overview/), developers can directly submit change requests through their code repository, further integrating database management with the development workflow.
- Through the [GitOps workflow](https://docs.bytebase.com/gitops/overview/), developers can directly submit change requests through their code repository, further integrating database management with the development workflow.
- With [Terraform Bytebase Provider](https://docs.bytebase.com/tutorials/manage-databases-with-terraform/), all Bytebase configurations can be codified, making it even easier for DBAs to configure batch access permissions.
2 changes: 1 addition & 1 deletion content/blog/stop-using-navicat.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Bytebase is a web-based product with server-side capabilities that can fill the

### Integration with GitLab / GitHub to synchronize SQL scripts

![_](/content/blog/stop-using-navicat/bytebase-vcs-integration.webp)
![_](/content/blog/stop-using-navicat/bytebase-gitops.webp)

### Audit Log

Expand Down
2 changes: 1 addition & 1 deletion content/blog/what-is-database-devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Automation can be applied in several places:

<HintBlock type="info">

Bytebase automates database tasks via [GitOps](https://docs.bytebase.com/vcs-integration/overview/), [SQL Review](https://docs.bytebase.com/sql-review/overview/), [built-in rollback](https://docs.bytebase.com/change-database/rollback-data-changes/), [Webhook Integration](https://docs.bytebase.com/change-database/webhook/), and [API](https://docs.bytebase.com/api/overview/).
Bytebase automates database tasks via [GitOps](https://docs.bytebase.com/gitops/overview/), [SQL Review](https://docs.bytebase.com/sql-review/overview/), [built-in rollback](https://docs.bytebase.com/change-database/rollback-data-changes/), [Webhook Integration](https://docs.bytebase.com/change-database/webhook/), and [API](https://docs.bytebase.com/api/overview/).

</HintBlock>

Expand Down
2 changes: 1 addition & 1 deletion content/blog/what-is-database-devsecops.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ modifications are applied uniformly across environments.

<HintBlock type="info">

Bytebase provides [built-in GitOps integration](https://docs.bytebase.com/vcs-integration/overview/) and [SQL Review](https://docs.bytebase.com/sql-review/overview/) to detect erroneous SQLs automatically.
Bytebase provides [built-in GitOps integration](https://docs.bytebase.com/gitops/overview/) and [SQL Review](https://docs.bytebase.com/sql-review/overview/) to detect erroneous SQLs automatically.

</HintBlock>

Expand Down
2 changes: 1 addition & 1 deletion content/blog/what-is-database-schema-drift.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@ If this interests you, please do check out our [demo](/view-live-demo) or use 1

- [What is Database Change Management?](/blog/what-is-database-change-management)
- [Database-as-Code](/blog/database-as-code)
- [Bytebase Database-as-Code VCS integration](https://docs.bytebase.com/vcs-integration/overview)
- [Bytebase Database-as-Code VCS integration](https://docs.bytebase.com/gitops/overview)
- [Database Version Control, State-based or Migration-based?](/blog/database-version-control-state-based-vs-migration-based)
2 changes: 1 addition & 1 deletion content/blog/what-is-ddl-and-dml-in-sql-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ Data Manipulation Language (DML) consists of SQL commands that manipulate the da
| **Privilege Level** | Higher (admin-level) | Lower (user-level) |
| **Impact** | Structural changes | Data changes |

Effective database change management requires proper control over both DDL and DML operations. Tools like Bytebase provide features such as [SQL review policies](https://docs.bytebase.com/sql-review), [version control for schema changes](https://docs.bytebase.com/vcs-integration), [approval workflows](https://docs.bytebase.com/change-workflow), [automatic backups](https://docs.bytebase.com/backup-restore), and [audit capabilities](https://docs.bytebase.com/audit-logging) to ensure safe and efficient database changes.
Effective database change management requires proper control over both DDL and DML operations. Tools like Bytebase provide features such as [SQL review policies](https://docs.bytebase.com/sql-review), [version control for schema changes](https://docs.bytebase.com/gitops), [approval workflows](https://docs.bytebase.com/change-workflow), [automatic backups](https://docs.bytebase.com/backup-restore), and [audit capabilities](https://docs.bytebase.com/audit-logging) to ensure safe and efficient database changes.
4 changes: 2 additions & 2 deletions mintlify/administration/custom-approval.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ An approval flow consists of one or more **approval nodes** arranged in sequence
- All nodes must be approved before the issue proceeds to rollout

<Note>
After approval, the actual deployment may still require manual action depending on your [rollout policy](/administration/environment-policy/rollout-policy/) configuration.
After approval, the actual deployment may still require manual action depending on your [rollout policy](/change-database/environment-policy/rollout-policy/) configuration.
</Note>

![Approval Flow](/content/docs/administration/custom-approval/edit-approval-flow.webp)
Expand All @@ -46,7 +46,7 @@ After approval, the actual deployment may still require manual action depending
### Step 2: Assign Flows to Risk Levels

1. Click the **Rules** tab
2. Select an approval flow for each [risk level](/administration/risk-center)
2. Select an approval flow for each risk level
3. Choose "Skip manual approval" if no approval is needed for a specific risk level

## Working with Custom Roles
Expand Down
2 changes: 1 addition & 1 deletion mintlify/administration/roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -195,4 +195,4 @@ User can save sheets from [SQL Editor](/sql-editor/overview). A sheet always bel
| Subscribe/Unsubscribe | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| Add comment | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |

\* `Project Owner` can change issue status when the current active [Environment Rollout Policy](/administration/environment-policy/rollout-policy) is set to **Require manual rolling out**.
\* `Project Owner` can change issue status when the current active [Environment Rollout Policy](/change-database/environment-policy/rollout-policy) is set to **Require manual rolling out**.
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ title: Environment Policy

Even if you have `sql.dml` and `sql.ddl` [database permissions](/security/database-permission/overview/), you can only run read-only statements such as `SELECT` in SQL Editor by default. If you attempt to run mutation DML or DDL, it will prompt you to submit an issue.

![prompt-issue](/content/docs/administration/environment-policy/prompt-issue.webp)
![prompt-issue](/content/docs/change-database/environment-policy/prompt-issue.webp)

If you want to run those statements directly in SQL Editor, you need to turn on the **statement execution** setting.

![statement-execution](/content/docs/administration/environment-policy/statement-execution.webp)
![statement-execution](/content/docs/change-database/environment-policy/statement-execution.webp)

## Environment tier

Expand All @@ -20,14 +20,14 @@ If you want to run those statements directly in SQL Editor, you need to turn on

You can configure any color for an environment either by inputting in **HEX** tab or choosing one in the palette.

![env-color](/content/docs/administration/environment-policy/env-color.webp)
![env-color](/content/docs/change-database/environment-policy/env-color.webp)

SQL Editor then displays the configured color tab.

![env-color-sql-editor](/content/docs/administration/environment-policy/env-color-sql-editor.webp)
![env-color-sql-editor](/content/docs/change-database/environment-policy/env-color-sql-editor.webp)

### Production indicator

Once you mark an environment as a production environment, Bytebase will attach a shield icon 🛡️ besides the environment name.

![tier-envs](/content/docs/administration/environment-policy/tier-envs.webp)
![tier-envs](/content/docs/change-database/environment-policy/tier-envs.webp)
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ the issue is approved by the others, you **can** deploy your own issue if qualif

`Workspace Admin` or `DBA` can configure the **Rollout policy** for a particular environment from the **Environment** detail page:

![environment-rollout](/content/docs/administration/environment-policy/bb-env-rollout.webp)
![environment-rollout](/content/docs/change-database/environment-policy/bb-env-rollout.webp)

This setting will affect projects using either [UI workflow or GitOps workflow](/change-database/change-workflow). The rollout policy determines who will rollout the database changes.

Expand Down
2 changes: 0 additions & 2 deletions mintlify/changelog/bytebase-0-5-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ import InstallUpgrade from '/snippets/install/install-upgrade.mdx';

### Version Control Workflow enhancement

- Allow user to specify the migration file path template. [Detailed guide](https://docs.bytebase.com/use-bytebase/vcs-integration/organize-repository-files#file-path-template)
- Allow user to specify the schema path template. **This is useful to let repository always keep a complete schema of the corresponding database.**[Detailed guide](https://docs.bytebase.com/use-bytebase/vcs-integration/organize-repository-files#schema-path-template)
- Record schema snapshot in every migration history record

### A dedicated page for individual migration history
Expand Down
2 changes: 1 addition & 1 deletion mintlify/changelog/bytebase-1-12-1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ description: '- Support OAuth 2.0 for Single Sign-On (SSO). - Support change and
- Start a 14-day trial of the Enterprise Plan by default.
- Improved Schema Editor's UX.
- Improved Schema Diagram: filtering, navigation, focusing and export PNG files. [/change-database/schema-diagram](/sql-editor/schema-diagram)
- Rename "Protected environment" to "Production environment". [/administration/environment-policy/tier](/administration/environment-policy/tier)
- Rename "Protected environment" to "Production environment". [/change-database/environment-policy/tier](/change-database/environment-policy/tier)
- Improved schema viewing and editing experience in SQL Editor.
- Add an icon to identify sensitive data columns in the query result of SQL Editor.

Expand Down
2 changes: 1 addition & 1 deletion mintlify/changelog/bytebase-1-13-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import InstallUpgrade from '/snippets/install/install-upgrade.mdx';

- Generate SQL statements to rollback DML for MySQL. [/change-database/rollback-data-changes](/change-database/rollback-data-changes)
- Support Single Sign-On (SSO) with OIDC. [/administration/sso/oidc](/administration/sso/oidc)
- GitOps workflow now supports GitLab.com as a VCS provider. Now Bytebase supports GitLab.com, GitHub.com and GitLab self-hosted. [/vcs-integration/overview#gitlab-ci](/vcs-integration/overview#gitlab-ci)
- GitOps workflow now supports GitLab.com as a VCS provider. Now Bytebase supports GitLab.com, GitHub.com and GitLab self-hosted. [/gitops/overview](/gitops/overview)

## 🎄 Enhancements

Expand Down
2 changes: 1 addition & 1 deletion mintlify/changelog/bytebase-1-15-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import InstallUpgrade from '/snippets/install/install-upgrade.mdx';

- Bytebase now offers a Cloud version [https://hub.bytebase.com/](https://hub.bytebase.com/).

- GitOps supports Bitbucket Cloud ([bitbucket.org](https://bitbucket.org)) as the Git provider. [/vcs-integration/overview#bitbucket-pipelines](/vcs-integration/overview#bitbucket-pipelines)
- GitOps supports Bitbucket Cloud ([bitbucket.org](https://bitbucket.org)) as the Git provider. [/gitops/overview](/gitops/overview)

## 🎄 Enhancements

Expand Down
Loading