Skip to content

Commit adddc60

Browse files
d-bytebaseclaude
andauthored
refactor: reorganize change database settings and navigation (#860)
* refactor: reorganize change database settings and navigation - Moved Settings group from UI-Driven Workflow to top-level "General" group - Combined issue.mdx and transaction-mode.mdx into single settings.mdx file - Moved schema-template to Change group under UI-Driven Workflow - Simplified and clarified content in settings page - Removed unnecessary screenshots This improves navigation structure and makes settings more discoverable. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * fix: update broken links to new settings page - Update link in custom-approval.mdx from /change-database/issue/#self-approval to /change-database/settings#self-approval - Update links in troubleshoot.mdx from /change-database/issue/#postgres-database-tenant-mode to /change-database/settings#postgres-tenant-mode 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent 6cc4fdc commit adddc60

File tree

6 files changed

+48
-54
lines changed

6 files changed

+48
-54
lines changed

mintlify/administration/custom-approval.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Custom Approval allows you to create multi-stage approval workflows based on cha
1616
<Tip>
1717
**Best Practices:**
1818
- Custom Approval works best with [UI workflow](/change-database/change-workflow/#ui-workflow). For [GitOps workflow](/change-database/change-workflow/#gitops-workflow), configure approvals in your PR/MR process instead.
19-
- By default, users cannot self-approve their own issues. You can [change this setting](/change-database/issue/#self-approval) in project settings if needed.
19+
- By default, users cannot self-approve their own issues. You can [change this setting](/change-database/settings#self-approval) in project settings if needed.
2020
</Tip>
2121

2222
## How It Works

mintlify/change-database/issue.mdx

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Settings
3+
---
4+
5+
Customize how database changes work in your projects. Navigate to **Project****Settings** to access these options.
6+
7+
## Transaction Mode
8+
9+
<Note>
10+
Supported databases: MySQL, PostgreSQL, Oracle, SQL Server, TiDB, Redshift
11+
</Note>
12+
13+
By default, Bytebase wraps SQL statements in a transaction for safety - if something goes wrong, changes can be rolled back.
14+
15+
Some DDL statements can't run inside transactions. To disable transaction wrapping, add this comment before your SQL:
16+
17+
```sql
18+
-- txn-mode=off
19+
ALTER TABLE t ALTER COLUMN a TYPE VARCHAR(255);
20+
```
21+
22+
## Postgres Tenant Mode
23+
24+
Perfect for multi-tenant PostgreSQL setups where each database has its own owner.
25+
26+
When enabled, Bytebase automatically switches to the database's OWNER role before executing changes, ensuring proper permissions.
27+
28+
**Location:** Project → Settings → Issue Related
29+
30+
## Self Approval
31+
32+
By default, issue creators can't approve their own changes.
33+
34+
To allow self-approval, enable **Allow self approval** in your project settings.
35+
36+
**Location:** Project → Settings → Issue Related

mintlify/change-database/transaction-mode.mdx

Lines changed: 0 additions & 18 deletions
This file was deleted.

mintlify/change-database/troubleshoot.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Following permission errors are likely to happen if either conditions meet:
2626

2727
### ERROR: permission denied to set role xxx (SQLSTATE 42501)
2828

29-
This could happen if you turn on [Postgres database tenant mode](/change-database/issue/#postgres-database-tenant-mode).
29+
This could happen if you turn on [Postgres database tenant mode](/change-database/settings#postgres-tenant-mode).
3030

3131
You need to grant the database owner permission to the Bytebase user configured in your PostgreSQL instance.
3232

@@ -44,7 +44,7 @@ If you use AlloyDB, the database owner must NOT be created via [Cloud IAM](https
4444

4545
### ERROR: must be owner of table xxx (SQLSTATE 42501)
4646

47-
This could happen if you turn on [Postgres database tenant mode](/change-database/issue/#postgres-database-tenant-mode).
47+
This could happen if you turn on [Postgres database tenant mode](/change-database/settings#postgres-tenant-mode).
4848

4949
For some sophisticated setup where database owner and table owner are different, this causes problem.
5050
Because only table owner can alter that table schema, and if the database owner is not a member of

mintlify/docs.json

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@
9797
"change-database/synchronize-schema",
9898
"change-database/stored-procedure",
9999
"change-database/schema-editor",
100+
"change-database/schema-template",
100101
"change-database/online-schema-migration-for-mysql"
101102
]
102103
},
@@ -133,16 +134,6 @@
133134
"group": "Monitor",
134135
"pages": ["change-database/drift-detection"]
135136
},
136-
{
137-
"group": "Settings",
138-
"pages": [
139-
"change-database/webhook",
140-
"change-database/risk-center",
141-
"change-database/issue",
142-
"change-database/transaction-mode",
143-
"change-database/schema-template"
144-
]
145-
},
146137
"change-database/troubleshoot"
147138
]
148139
},
@@ -152,6 +143,14 @@
152143
"gitops/overview",
153144
"gitops/release"
154145
]
146+
},
147+
{
148+
"group": "General",
149+
"pages": [
150+
"change-database/webhook",
151+
"change-database/risk-center",
152+
"change-database/settings"
153+
]
155154
}
156155
]
157156
},

0 commit comments

Comments
 (0)