You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/get-started/step-by-step/add-an-instance.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Add an Instance
3
3
---
4
4
5
-
`Database Instance` or simply `Instance` models after a single database server which is usually accessed via a host:port address. A typical database instance could be your on-premises MySQL instance, an AWS RDS instance etc. Each `Database Instance` belongs to an `Environment`.
5
+
**Database Instance** or simply **Instance** models after a single database server accessed via a host:port address or a primary/replica cluster. A typical database instance could be your on-premises MySQL instance, a PostgreSQL cluster, an AWS RDS instance etc. Each **Database Instance** belongs to an **Environment**.
6
6
7
7
## Prerequisites
8
8
@@ -20,7 +20,7 @@ Go to **Instances** and **Add Instance**.
20
20
21
21
For **Host or socket**, the screenshot assumes you run Bytebase inside Docker and try to connect to a database instance on the same host, thus it uses `host.docker.internal`. Check out [Instance Connection Configuration](/docs/get-started/instance) for the detailed guide.
22
22
23
-
## Sync instance
23
+
## Sync instance schema
24
24
25
25
After instance is added, click **Sync Now** to synchronize the instance schema such as its containing databases to Bytebase.
Copy file name to clipboardExpand all lines: content/docs/get-started/step-by-step/change-schema.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,14 @@
2
2
title: Make a Database Schema Change
3
3
---
4
4
5
-
**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.
5
+
**Issue** drives the database change workflow such as `Schema Change (DDL)`, `Data Change (DML)`, and `Database Creation`. It's similar to the issue concept in other issue management tools.
6
6
7
-
## Create an issue
7
+
## Create issue
8
8
9
9
Go to your project page, choose one or several databases to **Edit Schema**.
Bytebase supports 2 change workflow, **UI** and **GitOps**. Check [Database Change Workflow](/docs/change-database/change-workflow/) for further details.
48
+
Check [Database Change Workflow](/docs/change-database/change-workflow/) for further details.
Copy file name to clipboardExpand all lines: content/docs/get-started/step-by-step/create-a-project.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,16 +16,26 @@ Go to **Projects** and click **New Project**.
16
16
17
17
## Transfer a database into the project
18
18
19
-
To make changes to a database, you need to place it in a project first. Once a project is created, you need to fill it with some Databases.
19
+
<HintBlocktype="info">
20
20
21
-
Go to the project page where you can **create a new database** or **transfer an existing database into the project**.
21
+
To make changes to a database, you need to place it in a project first.
22
+
23
+
</HintBlock>
24
+
25
+
Once a project is created, you need to fill it with some Databases. Go to the project page where you can **create a new database** or **transfer an existing database into the project**.
To manage fine-grained database access, check out [Database Permission](/docs/security/database-permission/overview/).
36
+
37
+
</HintBlock>
38
+
29
39
A project is only visible to its related **users**. The project creator assumes `Project Owner`role and can manage project members.
30
40
31
41
Go to the project page. Click **Manage** > **Members** on the left sidebar. **Grant Access** to add new project members from workspace level accounts. You can assign project-level roles to the members.
Copy file name to clipboardExpand all lines: content/docs/get-started/step-by-step/query-data.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Query Data
3
3
---
4
4
5
-
Bytebase also provides a web-based SQL Editor for querying data. Unlike traditional client-side SQL clients, this server-side SQL Editor allows you to enable data access control, data masking, audit logging, etc.
5
+
Bytebase also provides a web-based SQL Editor for querying data. Unlike traditional client-side SQL clients, this server-side SQL Editor can enforce fine-grained data access control, data masking, audit logging, etc.
6
6
7
7
## Access SQL Editor
8
8
@@ -14,9 +14,12 @@ SQL Editor can be acccess from the top bar or from the database.
0 commit comments