Skip to content

Commit 83b313a

Browse files
d-bytebaseclaudeCopilot
authored
docs: consolidate instance management into connection overview (#845)
* docs: consolidate instance management into connection overview Merged instance.mdx content into connect/overview.mdx to provide a more unified documentation experience. Added Instance Management section covering sync intervals and maximum connections configuration with improved clarity on best practices and trade-offs. - Removed standalone instance.mdx file - Added Instance Management section to connection overview - Removed unnecessary screenshot images - Clarified sync behavior for internal vs external changes - Added warnings about configuration impacts 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Update mintlify/get-started/connect/overview.mdx Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Claude <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent 6983769 commit 83b313a

File tree

4 files changed

+25
-35
lines changed

4 files changed

+25
-35
lines changed

mintlify/administration/instance.mdx

Lines changed: 0 additions & 35 deletions
This file was deleted.
-14.5 KB
Binary file not shown.
-6.04 KB
Binary file not shown.

mintlify/get-started/connect/overview.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,31 @@ Requires Vault KV v2 engine
143143
}
144144
```
145145

146+
## Instance Management
147+
148+
Configure instance-level settings to optimize how Bytebase interacts with your databases.
149+
150+
### Sync Interval
151+
152+
<Tip>
153+
Manually trigger schema metadata sync at any time:
154+
- **Database level**: Sync an individual database's schema metadata
155+
- **Instance level**: Sync all databases and detect newly added or removed databases
156+
</Tip>
157+
158+
Bytebase automatically syncs schema metadata when changes are made through Bytebase. For external changes, set an automatic sync interval to keep metadata current for SQL review, data masking, and drift detection. We recommend 24 hours for most use cases—shorter intervals can overload your database server and Bytebase service.
159+
160+
### Maximum Connections
161+
162+
Control the number of concurrent connections Bytebase can establish to your database. Finding the right balance is important:
163+
- **Too high**: May overwhelm your database server
164+
- **Too low**: May cause task queuing and execution delays
165+
166+
Consider these factors when setting the limit:
167+
- Team size and concurrent SQL Editor usage
168+
- Available database connection capacity
169+
- Parallel operations (migrations, backups, syncs)
170+
146171
## Database-Specific Guides
147172

148173
Configure connection settings for specific database types:

0 commit comments

Comments
 (0)