Skip to content

Commit 1165683

Browse files
tianzhoutianzhou
committed
docs: update to SQL Editor user
1 parent 59c86f0 commit 1165683

File tree

10 files changed

+20
-20
lines changed

10 files changed

+20
-20
lines changed

‎content/docs/concepts/roles-and-permissions.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Users can also be granted `Workspace Admin`, `Workspace DBA`. These 2 roles shou
1818

1919
**Project Roles**
2020

21-
- Built-in roles: `Project Owner`, `Project Developer`, `Project Releaser`, `Project Querier`, `Project Exporter`, `Project Viewer`.
21+
- Built-in roles: `Project Owner`, `Project Developer`, `Project Releaser`, `SQL Editor User` (previously called `Project Querier`), `Project Exporter`, `Project Viewer`.
2222
- [Custom roles](/docs/administration/custom-roles/).
2323

2424
In addition to the inherent `Workspace Member` role, most users will be granted project roles. These roles
@@ -89,7 +89,7 @@ By default, the first registered user is granted the `Admin` role, all following
8989
Any user can create project. By default, the project creator is granted the `Project Owner` role.
9090
`Workspace DBA` and `Workspace Admin` assume the `Project Owner` role for all projects.
9191

92-
| Project Permission | Project Querier | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
92+
| Project Permission | SQL Editor User | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
9393
| ---------------------------- | --------------- | ---------------- | ----------------- | ------------- | ------------- | --------------- |
9494
| Sync sheet from VCS | | | ✔️ | ✔️ | ✔️ | ✔️ |
9595
| Change project role | | | | ✔️ | ✔️ | ✔️ |
@@ -101,7 +101,7 @@ Any user can create project. By default, the project creator is granted the `Pro
101101

102102
Bytebase does not define database specific roles. Whether a user can perform certain action to the database is based on the user's Workspace role and the role of the project owning the database.
103103

104-
| Database Permission | Project Querier | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
104+
| Database Permission | SQL Editor User | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
105105
| ------------------- | --------------- | ---------------- | ----------------- | ------------- | ------------- | --------------- |
106106
| Query | ✔️ | | | ✔️ | ✔️ | ✔️ |
107107
| Export | | ✔️ | | ✔️ | ✔️ | ✔️ |
@@ -120,7 +120,7 @@ User can save sheets from [SQL Editor](/docs/sql-editor/overview). A sheet alway
120120

121121
### Private Sheet
122122

123-
| Permission | Creator | Project Querier | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
123+
| Permission | Creator | SQL Editor User | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
124124
| ---------- | ------- | --------------- | ---------------- | ----------------- | ------------- | ------------- | --------------- |
125125
| Star | ✔️ | | | | | | |
126126
| Read | ✔️ | | | | | | |
@@ -129,7 +129,7 @@ User can save sheets from [SQL Editor](/docs/sql-editor/overview). A sheet alway
129129

130130
### Project Sheet
131131

132-
| Permission | Creator | Project Querier | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
132+
| Permission | Creator | SQL Editor User | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
133133
| ---------- | ------- | --------------- | ---------------- | ----------------- | ------------- | ------------- | --------------- |
134134
| Star | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
135135
| Read | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
@@ -138,7 +138,7 @@ User can save sheets from [SQL Editor](/docs/sql-editor/overview). A sheet alway
138138

139139
### Public Sheet
140140

141-
| Permission | Creator | Project Querier | Project Exporter | Project Developer | Project Owner | Others |
141+
| Permission | Creator | SQL Editor User | Project Exporter | Project Developer | Project Owner | Others |
142142
| ---------- | ------- | --------------- | ---------------- | ----------------- | ------------- | ------ |
143143
| Star | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
144144
| Read | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
@@ -147,7 +147,7 @@ User can save sheets from [SQL Editor](/docs/sql-editor/overview). A sheet alway
147147

148148
## Issue permissions
149149

150-
| Issue Permission | Assignee | Creator | Project Querier | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
150+
| Issue Permission | Assignee | Creator | SQL Editor User | Project Exporter | Project Developer | Project Owner | Workspace DBA | Workspace Admin |
151151
| ------------------------- | -------- | ------- | --------------- | ---------------- | ----------------- | ------------- | ------------- | --------------- |
152152
| Create issue | N/A | N/A | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
153153
| Re-assign issue | ✔️ | ✔️ | | | | | ✔️ | ✔️ |

‎content/docs/security/database-permission/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Database permission controls individual users' or groups' actions within the dat
1919
| Workspace DBA | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
2020
| Project Owner | ✅ | ✅ | ✅ | ✅ | ✅ | |
2121
| Project Developer | | | | \* | \* | |
22-
| Project Querier | ✅ | ✅ | | ✅ | ✅ | |
22+
| SQL Editor User | ✅ | ✅ | | ✅ | ✅ | |
2323
| Project Exporter | | | ✅ | | | |
2424
| Project Releaser | | | | | | |
2525
| Project Viewer | | | | | | |

‎content/docs/security/database-permission/query.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,37 @@ title: Data Query
44

55
Bytebase users query data from [SQL Editor](/docs/sql-editor/run-queries/). Bytebase can enforce query access control for a particular user at the database, schema or table level.
66

7-
## Assign Project Querier Role
7+
## Assign SQL Editor User Role
88

9-
`Workspace Admin`, `Workspace DBA` or `Project Owner` can manually grant `Project Querier` role to users/groups.
9+
`Workspace Admin`, `Workspace DBA` or `Project Owner` can manually grant `SQL Editor User` role to users/groups.
1010

1111
### Assign at Project level
1212

1313
**Select Project** and go to **Manage > Members**. Then **Grant Access**.
1414

1515
![project-members-grant](/content/docs/security/database-permission/query/project-members-grant.webp)
1616

17-
Select Users or Groups, assign `Project Querier` role, choose the database object, Expiration and click **Confirm**.
17+
Select Users or Groups, assign `SQL Editor User` role, choose the database object, Expiration and click **Confirm**.
1818

1919
You can choose the entire database, a particular schema, or a particular table.
2020

2121
![project-members-querier](/content/docs/security/database-permission/query/project-members-querier.webp)
2222

2323
### Assign at Workspace level
2424

25-
`Workspace Admin` can assign `Project Querier` role at the workspace level. This will grant query permission to _all databases_ within _all projects_.
25+
`Workspace Admin` can assign `SQL Editor User` role at the workspace level. This will grant query permission to _all databases_ within _all projects_.
2626

27-
From the workspace page, go to **IAM & Admin > Members**, **Grant Access** to Select users/groups and assign `Project Querier` to them.
27+
From the workspace page, go to **IAM & Admin > Members**, **Grant Access** to Select users/groups and assign `SQL Editor User` to them.
2828

2929
![assign-workspace](/content/docs/security/database-permission/query/assign-workspace.webp)
3030

31-
## Request Project Querier Role
31+
## Request SQL Editor User Role
3232

3333
<PricingPlanBlock feature_name='QUERY_EXPORT_APPROVAL_WORKFLOW' />
3434

3535
<TutorialBlock url="/docs/tutorials/just-in-time-part1/" title="Just-in-Time Database Access" />
3636

37-
Users can also apply for `Project Querier` role by submitting an issue. Approval flow matches the `Request Querier Role` in [custom approval](/docs/administration/custom-approval/) if configured.
37+
Users can also apply for `SQL Editor User` role by submitting an issue. Approval flow matches the `Request Querier Role` in [custom approval](/docs/administration/custom-approval/) if configured.
3838

3939
### Request at Project level
4040

‎content/docs/tutorials/api-user-database-permission.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,18 +118,18 @@ Let's dig into the code:
118118

119119
```json
120120
{
121-
"role": "roles/projectQuerier",
121+
"role": "roles/sqlEditorUser",
122122
"members": ["user:[email protected]", "user:[email protected]"],
123123
"condition": {
124124
"expression": "(resource.database in [\"instances/test-sample-instance/databases/hr_test\"])",
125-
"title": "project querier hr_prod",
125+
"title": "SQL Editor User hr_prod",
126126
"description": "",
127127
"location": ""
128128
}
129129
}
130130
```
131131

132-
This grants the `projectQuerier` role only for the `hr_test` database in `test-sample-instance`.
132+
This grants the `SQL Editor User` role only for the `hr_test` database in `test-sample-instance`.
133133

134134
1. When processing IAM policies, handle [CEL (Common Expression Language)](https://cel.dev/) format conditions carefully. In this demo, we parse these conditions using a custom `parseCelExpression` function:
135135

‎content/docs/tutorials/how-to-manage-data-access-for-developers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Log in as `Developer`, and you can see `Sample Project`. Enter **SQL Editor** on
6969

7070
### Admin grants data query access directly
7171

72-
1. Log in as `Admin`, and go to `Sample Project`. Click **Members** and then **Grant Access**. Choose `Developer` and assign the role `Project Querier`, `All` for **Databases**. Click **Confirm**.
72+
1. Log in as `Admin`, and go to `Sample Project`. Click **Members** and then **Grant Access**. Choose `Developer` and assign the role `SQL Editor User`, `All` for **Databases**. Click **Confirm**.
7373

7474
1. Log in as `Developer`, and go to SQL Editor. You can see all databases under `Test` and `Prod` environment. Select `hr_prod`, input `SELECT * FROM employee;` and run, you can see the result. Change `employee` to any other tables and run, you can see data as well.
7575

‎content/docs/tutorials/how-to-manage-roles.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A typical requirement is to create a `Manager` role in Bytebase who can only rol
2323

2424
- **Project Owner**: All permissions within the project
2525
- **Project Developer**: All viewer permissions, plus permissions for requesting database changes.
26-
- **Project Querier**: Permissions for querying database data.
26+
- **SQL Editor User**: Permissions for querying database data.
2727
- **Project Exporter**: Permissions for exporting database data.
2828
- **Project Releaser**: All viewer permissions, plus permission for reviewing database change requests for release purposes.
2929
- **Project Viewer**: Read-only permissions for viewing basic project information, accessing databases, and initiating privilege requests.

‎public/content/docs/security/database-permission/query/assign-workspace.webp‎

-40.2 KB
Loading

‎public/content/docs/security/database-permission/query/project-members-grant.webp‎

-80.8 KB
Loading

‎public/content/docs/security/database-permission/query/project-members-querier.webp‎

-104 KB
Loading

‎public/content/docs/tutorials/how-to-manage-roles/bb-system-roles.webp‎

-50.5 KB
Loading

0 commit comments

Comments
 (0)