Skip to content

Commit 9f3727d

Browse files
committed
docs: codify sql review example
1 parent 85b6ae0 commit 9f3727d

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

content/docs/api/sql-review.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: SQL Review API
33
---
44

55
<TutorialBlock url="/docs/tutorials/sql-review" title="Master SQL Review with GUI, GitOps and API" />
6+
<TutorialBlock url="/docs/tutorials/api-sql-review/" title="Codify SQL Review Policies with Bytebase API" />
67

78
| | |
89
| -------- | -------------------------------------------------------------------------------- |

content/docs/tutorials/api-sql-review.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Configure SQL Review Policies with Bytebase API
2+
title: Codify SQL Review Policies with Bytebase API
33
author: Ningjing
44
updated_at: 2024/11/12 18:00
55
tags: Tutorial

content/docs/tutorials/sql-review.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ This tutorial will walk you through using SQL Review in Bytebase to improve your
1818
## Prerequisites
1919

2020
1. Make sure you have [Docker](https://www.docker.com/) installed, and if you don’t have important existing Bytebase data locally, you can start over from scratch by `rm -rf ~/.bytebase/data`.
21-
22-
## Preparation: Configure SQL Reviews in Bytebase
23-
2421
1. Copy and paste the commands to start one Bytebase via Docker.
2522

2623
<IncludeBlock url="/docs/get-started/install/terminal-docker-run-volume"></IncludeBlock>
2724

25+
## Configure SQL Review Policies
26+
27+
### UI
28+
2829
1. Register an admin account and it will be granted the `workspace admin` role automatically.
2930

3031
1. Click **Security & Policy > SQL Review** on the left side menu. You can find there is already one default SQL Review policy named `Default SQL Review Policy`.
@@ -43,6 +44,10 @@ This tutorial will walk you through using SQL Review in Bytebase to improve your
4344

4445
![bb-sql-review-default-value](/content/docs/tutorials/sql-review/bb-sql-review-default-value.webp)
4546

47+
### GitOps
48+
49+
<TutorialBlock url="/docs/tutorials/api-sql-review/" title="Codify SQL Review Policies with Bytebase API" />
50+
4651
## Case 1: Trigger SQL Review in Bytebase GUI
4752

4853
1. Go to `Sample Project`, since the default SQL Review policy is attached to the `Prod` environment, we'll create a new table on it. Click Database > Databases on the left side menu, select `hr_prod` and click **Edit Schema**.

0 commit comments

Comments
 (0)