Skip to content

Commit 7438748

Browse files
committed
docs: data retain policy
1 parent c9e7431 commit 7438748

File tree

2 files changed

+30
-8
lines changed

2 files changed

+30
-8
lines changed

content/docs/change-database/rollback-data-changes.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ feature_name: 'ROLLBACK_DATA_CHANGES'
77

88
Bytebase allows taking **Prior Backup** before a data change is made. Bytebase stores the pre-snapshot of the affected rows, which allows you to revert that data change if needed.
99

10-
## Support Matrix
10+
<HintBlock type="info">
11+
12+
The backup data is stored in your own database instance. Bytebase does not purge the backup data automatically.
13+
You can manually delete the data in `bbdataarchive` database/schema.
14+
15+
</HintBlock>
1116

1217
Prior backup is only feasible when meeting **any** of the following conditions:
1318

@@ -50,7 +55,7 @@ If the DML change contains more than 5 statements, then all statements will be b
5055

5156
![bb-prior-bk-single-table](/content/docs/change-database/rollback-data-changes/bb-prior-bk-single-table.webp)
5257

53-
## Project Backup Settings
58+
## Project backup settings
5459

5560
<PricingPlanBlock feature_name='ISSUE_SETTING' />
5661

content/docs/faq.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,29 @@ If you use Docker to deploy Bytebase, please use Docker version >= [20.10.24](ht
4343

4444
SQL Editor autocomplete requires [enabling WebSocket](/docs/get-started/self-host/#enable-websocket-for-sql-editor) in your gateway if present.
4545

46+
## Does Bytebase retain your data
47+
48+
Bytebase does not retain any database row data.
49+
50+
### Database credentials
51+
52+
In order to perform database operations on users' behalf, Bytebase needs users to provide the database credentials.
53+
By default, Bytebase stores the supplied credentials in the obfuscated format. For the Enterprise plan, you can
54+
instruct Bytebase to [use the external secret manager](/docs/get-started/instance/#use-secret-manager).
55+
56+
### Database schema (metadata)
57+
58+
Bytebase syncs and stores the database schema information. If you enable [AI Assistant](/docs/ai-assistant/),
59+
Bytebase will also send the schema info to OpenAI or the configured endpoint.
60+
61+
### Database data (row data)
62+
63+
When you query the database via Bytebase, Bytebase does not store the result data. [Audit log](/docs/security/audit-log/)
64+
only records the query.
65+
66+
If you enable [Data Rollback](/docs/change-database/rollback-data-changes/), Bytebase will store the backup data in your
67+
own database instance.
68+
4669
## Production Setup
4770

4871
See [Production Setup](/docs/administration/production-setup/).
@@ -55,12 +78,6 @@ See [Supported Databases](/docs/introduction/supported-databases).
5578

5679
See [Git Provider](/docs/vcs-integration/add-git-provider).
5780

58-
## How Bytebase stores the database credentials
59-
60-
In order to perform database operations on users' behalf, Bytebase needs users to provide the database credentials.
61-
By default, Bytebase stored the supplied credentials in the obfuscated format. For the Enterprise plan, you can
62-
instruct Bytebase to [use the external secret manager](/docs/get-started/instance/#use-secret-manager).
63-
6481
## How to enable https
6582

6683
You can use [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) or [Nginx](https://www.nginx.com/).

0 commit comments

Comments
 (0)