Skip to content

Commit

Permalink
docs: update tuts and docs for data masking export (#247)
Browse files Browse the repository at this point in the history
  • Loading branch information
adela-bytebase authored Dec 4, 2023
1 parent e44b711 commit 9e81aff
Show file tree
Hide file tree
Showing 10 changed files with 43 additions and 2 deletions.
2 changes: 2 additions & 0 deletions content/docs/_layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ expand_section_list: ['Self-host', 'Get Started']

### [Access Unmasked Data](/security/data-masking/access-unmasked-data)

### [Export Masked Data](/security/data-masking/export-masked-data)

## [Batch Change](/change-database/batch-change)

## [Branching](/branching)
Expand Down
2 changes: 1 addition & 1 deletion content/docs/security/data-masking/access-unmasked-data.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Access Unmasked data
title: Access Unmasked Data
feature_name: DATA_MASKING
---

Expand Down
17 changes: 17 additions & 0 deletions content/docs/security/data-masking/export-masked-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Export Masked Data
feature_name: DATA_MASKING
---

Data masking is applied not only to the results of queries but also to exported data.

1. After querying the masked data, click **Export**.
![bb-sql-editor-export](/content/docs/security/data-masking/bb-sql-editor-export.webp)

2. Fill in the export rows number, choose the format and click **Confirm**. The file will start downloading.

![bb-sql-editor-export-data](/content/docs/security/data-masking/bb-sql-editor-export-data.webp)

3. Open the downloaded file, you'll see the data is masked.

![bb-sql-editor-exported-data](/content/docs/security/data-masking/bb-sql-editor-exported-data.webp)
24 changes: 23 additions & 1 deletion content/docs/tutorials/data-masking.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ It helps organizations to **protect sensitive data** from being exposed to unaut

This tutorial will teach you how to set up and try out data masking in Bytebase within 30 mins.

### Preparation
## Prerequisites

Before starting, make sure you have installed [Docker](https://www.docker.com/).

## Preparation

1. Make sure your Docker is running, and start the Bytebase Docker container with following command:

Expand Down Expand Up @@ -54,6 +58,23 @@ You may want to batch apply masking settings, for example, you want to mask all
![bb-sql-editor-query-employee-prod-masked](/content/docs/tutorials/step-by-step-guide-to-data-masking/bb-sql-editor-query-employee-prod-masked.webp)
![bb-sql-editor-query-employee-test-masked](/content/docs/tutorials/step-by-step-guide-to-data-masking/bb-sql-editor-query-employee-test-masked.webp)


### Export data with masked columns
Exported data is masked in the same way as query results.

1. Stay on the SQL Editor after querying, and click **Export**.

![bb-sql-editor-export](/content/docs/tutorials/step-by-step-guide-to-data-masking/bb-sql-editor-export.webp)

2. Fill in the export rows number, choose the format and click **Confirm**. The file will start downloading.

![bb-sql-editor-export-data](/content/docs/tutorials/step-by-step-guide-to-data-masking/bb-sql-editor-export-data.webp)

3. Open the downloaded file, you'll see the `birth_date` is masked.

![bb-sql-editor-exported-data](/content/docs/tutorials/step-by-step-guide-to-data-masking/bb-sql-editor-exported-data.webp)


### Column Masking Rule

If you want to mask a specific column in a specific table, you can use **Column Masking Rule**.
Expand Down Expand Up @@ -84,6 +105,7 @@ What if you want to reveal the masked data to a specific user? You can grant unm

![bb-sql-editor-query-salary-prod-not-masked](/content/docs/tutorials/step-by-step-guide-to-data-masking/bb-sql-editor-query-salary-prod-not-masked.webp)


## Summary

You can now mask data in Bytebase using two methods: use **Global Masking Rule** to batch apply masking settings, and use **Column Masking Rule** to mask a specific column in a specific table. You can also grant access to a specific user to reveal the masked data.
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

1 comment on commit 9e81aff

@vercel
Copy link

@vercel vercel bot commented on 9e81aff Dec 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.