diff --git a/mintlify/administration/instance.mdx b/mintlify/administration/instance.mdx deleted file mode 100644 index 9f41451b4..000000000 --- a/mintlify/administration/instance.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Database Instance ---- - -## Instance connection - -Check [Connect Your Database](/get-started/instance/). - -## Scan interval - - - -You can always sync the database schema manually. - - - -Bytebase needs to fetch the databases' schema information: - -- [SQL review](/sql-review/overview/), [Dynamic Data Masking](/security/data-masking/overview/), and etc all require an up-to-date schema info. -- [SQL Editor](/sql-editor/overview/), [Schema Editor](/change-database/schema-editor/) also require - schema info. -- [Schema Drift Detection](/change-database/drift-detection/) needs to compare with the schema in the live database. - -On the other hand, fetching schemas too frequently will impact the database operations. We allow users to -configure a sync interval. - -![scan-interval](/content/docs/administration/instance/scan-interval.webp) - -## Maximum connections - -Bytebase may open multiple connections to a particular instance if there are concurrent ongoing database -operations. To avoid overwhelming the instance, you can configure the maximum connections that Bytebase -can open. - -![max-connections](/content/docs/administration/instance/max-connections.webp) diff --git a/mintlify/content/docs/administration/instance/max-connections.webp b/mintlify/content/docs/administration/instance/max-connections.webp deleted file mode 100644 index 82eb620fc..000000000 Binary files a/mintlify/content/docs/administration/instance/max-connections.webp and /dev/null differ diff --git a/mintlify/content/docs/administration/instance/scan-interval.webp b/mintlify/content/docs/administration/instance/scan-interval.webp deleted file mode 100644 index 1954353f6..000000000 Binary files a/mintlify/content/docs/administration/instance/scan-interval.webp and /dev/null differ diff --git a/mintlify/get-started/connect/overview.mdx b/mintlify/get-started/connect/overview.mdx index b365228f1..60bbfb2fe 100644 --- a/mintlify/get-started/connect/overview.mdx +++ b/mintlify/get-started/connect/overview.mdx @@ -143,6 +143,31 @@ Requires Vault KV v2 engine } ``` +## Instance Management + +Configure instance-level settings to optimize how Bytebase interacts with your databases. + +### Sync Interval + + +Manually trigger schema metadata sync at any time: +- **Database level**: Sync an individual database's schema metadata +- **Instance level**: Sync all databases and detect newly added or removed databases + + +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. + +### Maximum Connections + +Control the number of concurrent connections Bytebase can establish to your database. Finding the right balance is important: +- **Too high**: May overwhelm your database server +- **Too low**: May cause task queuing and execution delays + +Consider these factors when setting the limit: +- Team size and concurrent SQL Editor usage +- Available database connection capacity +- Parallel operations (migrations, backups, syncs) + ## Database-Specific Guides Configure connection settings for specific database types: