Skip to content

Commit c786875

Browse files
committed
docs: update concepts
1 parent d83edc9 commit c786875

File tree

2 files changed

+32
-8
lines changed

2 files changed

+32
-8
lines changed

content/docs/change-database/change-workflow.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,34 @@ For a typical change workflow, a developer first submits the SQL statement for D
88

99
There are 2 typical workflows employed by the team to deal with database schema changes (DDL) and data changes (DML). [UI workflow](#ui-workflow) and [GitOps workflow (GitOps)](#gitops-workflow).
1010

11+
## Core Concepts
12+
13+
### Release
14+
15+
<HintBlock type="info">
16+
17+
Release is only used in [Custom GitOps workflow](/docs/vcs-integration/custom/overview/).
18+
19+
</HintBlock>
20+
21+
A `release` is a deployable unit that encapsulates a set of SQL statements. You can think of a `release` as a collection of SQL statements layered on top of a scratch Docker image.
22+
23+
### Rollout
24+
25+
To roll out the changes, Bytebase creates a multi-stage rollout pipeline from you project deployment config setting. The changes are pushed to databases stage by stage.
26+
27+
### Issue
28+
29+
`Issue` adds the collaboration such as approval, comment, and notification to the database change process. An issue is often created via the UI workflow. On the other hand, an issue may not be created via the GitOps workflow since the GitOps workflow may only need the [rollout](/docs/change-database/change-workflow/#rollout) without further human intervention.
30+
31+
### Revision
32+
33+
`Revision` records the versioned changes applied to a database. You can get a database from version A to version B by replaying the revisions between A and B. When applying a [release](/docs/change-database/change-workflow/#release) to a database, the changes with a version present in the revision are skipped so that the same changes are not applied twice.
34+
35+
### Changelog
36+
37+
`Changelog` records all changes applied to a database, whether they are versioned or not, successfully applied or not. This includes change database [issues](/docs/change-database/change-workflow/#issue) created on Bytebase UI or [rollout](/docs/change-database/change-workflow/#rollout) via Bytebase APIs, but NOT changes from Bytebase SQL Editor or other external database tools. Changelog offers you insights into the database schema evolution.
38+
1139
## UI workflow
1240

1341
Classic SQL Review workflow where the developer submits a SQL review ticket directly from Bytebase and waits for the assigned DBA or peer developer to review. Bytebase applies the SQL change after review approved.

content/docs/concepts/data-model.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,16 +67,12 @@ A list of databases usually having the same schema structure. Examples like per-
6767

6868
Most of the time, `Developers` work with the `Project`.
6969

70-
## Issue
71-
72-
`Issue` drives the database change workflow such as `Database Creation`, `DDL` and `DML`. It's similar to the issue concept in other issue management tools.
73-
74-
In Bytebase, `Issue` is optimized for **database domain**. An `Issue` always belongs to a `Project`. A single `Issue` is only dealing with a particular `Database Instance` (e.g. creating a database on a database instance). Except for creating database issue, most other issues are also associated with an existing `Database` (e.g. altering a table on a database).
75-
76-
Internally, the issue progression is represented by a `Pipeline`. A `Pipeline` contains multiple `Stages`, each usually corresponds to an `Environment`. A `Stage` contains multiple `Tasks` dealing with a specific database operation such as altering table. A single `Task` can run multiple times (e.g. failed first and then retry). Each run is represented by a `Task Run`.
77-
7870
## Sheet
7971

8072
`Sheet` is the entity where users store, run and share the SQL scripts. A paritcular sheet belongs
8173
to a project and may or may not attach a database context. Users interacts with the Sheet from
8274
[SQL Editor](/docs/sql-editor/manage-sql-scripts).
75+
76+
## CI/CD
77+
78+
See [CI/CD Core Concepts](/docs/change-database/change-workflow/#core-concepts).

0 commit comments

Comments
 (0)