OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Developer Center

V4.2.0

  • Overview
    • What is ODC?
    • Features
    • Architecture
    • Limitations
    • User interface
  • Quick Start
    • Client ODC
      • Overview
      • Install Client ODC
      • Use Client ODC
    • Web ODC
      • Overview
      • Deploy Web ODC
      • Use Web ODC
  • Data Source Management
    • Create a data source
    • Data source and project collaboration
    • Database O&M
      • Session management
      • Global variable management
      • Recycle bin management
  • SQL Development
    • Edit and execute SQL statements
    • Compile and debug PL objects
    • Command-line window
    • Edit and export results
    • Analyze SQL statements
    • Data mocking
    • 700.database-objects
      • Table objects
        • Overview
        • Create a table
        • Table list
        • Manage table attributes
        • Manage table data
      • View objects
        • Overview
        • Create a view
        • Manage views
      • Function objects
        • Overview
        • Create a function
        • Manage functions
      • Stored procedure objects
        • Overview
        • Create a stored procedure
        • Manage stored procedures
      • Sequence objects
        • Overview
        • Create a sequence
        • Manage sequences
      • Package objects
        • Overview
        • Create a program package
        • Manage program packages
      • Trigger objects
        • Overview
        • Create a trigger
        • Manage triggers
      • Type objects
        • Overview
        • Create a type
        • Manage types
      • Synonym objects
        • Overview
        • Create a synonym
        • Manage synonyms
  • Import and Export
    • Import schema and data
    • Export schema and data
  • Database Change Management
    • User Permission Management
      • Users and roles
      • Automatic authorization
    • Collaborative project management
    • Risk levels, risk identification rules, and approval processes
    • SQL check specifications
    • Manage database changes
    • SQL window specification
    • Change lock-free structures
    • Synchronize shadow tables
  • Data Lifecycle Management
    • Archive data
    • Data cleanup
    • Manage partitions
    • SQL plan task
  • Data Desensitization and Auditing
    • Data desensitization
    • Operation audit
  • System Integration
    • SSO integration
    • Approval integration
    • SQL approval integration
  • Deployment Guide
    • Deployment overview
    • Preparations before deployment
    • Deploy a single ODC node
      • Deployment process
      • Load and run an ODC image
    • Deploy ODC in high availability mode
      • Deployment process
      • Load and run an ODC image
      • Deploy SSL certificate
      • Deploy the NGINX proxy
      • Configure certificate trust
    • Deployment verification
  • Upgrade Guide
    • Overview
    • Preparations before upgrade
    • Upgrade single-node ODC
      • Upgrade process
      • Stop ODC of the earlier version
      • Load and run an ODC image
    • Upgrade high-availability
      • Upgrade process
      • Stop ODC of the earlier version
      • Load and run an ODC image
      • Upgrade NGINX image
    • Upgrade verification
    • Rollback after upgrade failed
  • Troubleshooting
    • ODC troubleshooting process
    • Collect Message
      • View the runtime environment and version information
      • View web ODC logs
      • View client ODC logs
      • View end-to-end ODC-related logs
      • View ODC MetaDB data
      • Query the index status in OceanBase Database V4.x
      • Query the index status in OceanBase Database V1.4.x to V3.2.x
      • Collect JVM runtime information
      • Use tcpdump to capture packets
    • Common Troubleshooting
      • Deployment Upgrade
        • Web ODC cannot be accessed after startup
      • Database Connection
        • Access denied in a connection trial or test
        • Connection is refused in a connection trial or test
        • Connection times out
        • `Connection reset` is reported for a time-consuming statement
        • `socket write error` or `closed by server` is reported for a connection
      • SQL Execution
        • Disconnection during SQL execution
        • `Over tenant memory limits` is reported during SQL execution
        • `Unknown thread id` is returned during SQL execution
        • `timeout` errors returned during SQL execution
        • `OutOfMemoryError` is returned during SQL execution
        • Incomplete result columns for the SELECT statement
        • Garbled Chinese characters in the SQL execution result set
        • Garbled Chinese data is returned for query of data in GBK encoding
      • PL Object
        • Debugging is not supported for invalid PL objects
        • `JSONException` is reported during PL debugging
        • Garbled variable values in debugging
        • Failed to view PL objects or garbled characters are returned
        • PL objects cannot be executed or an execution error is returned
        • ODC issues during PL debugging
        • PL anonymous block cannot be debugged
        • Alert information of a PL object is unavailable
      • Import and Export
        • Garbled Chinese characters in an imported file in GBK encoding
        • Invalid ZIP package reported during file import
        • Time-type data exported from an Oracle tenant cannot be imported
        • Mismatched columns reported during the import of a single-table CSV file
        • Failed to export a result set in ODC to an Excel file
        • Incorrect display in Excel for a result set exported in CSV format
        • Incomplete data in batch export of multiple tables
        • `javax.crypto.BadPaddingException: Given final block not properly padded` is returned for a data import or export failure
      • Client ODC Problems
        • Client ODC startup failure / H2 Database corruption: Chuck not found
        • Garbled Chinese characters in the command-line window of ODC
        • Failed to install client ODC
        • Client ODC startup failure or no response
        • `Not a valid secret key` is returned for connection creation in client ODC
        • `User does not exist` returned for connection creation in client ODC
        • High memory usage of client ODC
        • Client ODC fails to be installed or start due to a port conflict
      • Front-end Page Exception
        • JavaScript exception is thrown on the ODC page
        • No response in browser after opening ODC
        • White screen in ODC
      • Account Password Problem
        • Forgot the admin account password in ODC V3.2.0 or later
        • Forgot an account password in ODC V2.4.1 to V3.1.3
        • Forgot an account password in ODC V2.4.0 or earlier
    • FAQ
      • Installation of client ODC
      • Web ODC deployment and startup
      • Connection information
      • Command-line window
      • DDL statement display
  • Release Note
    • 90.odc-rn-4.2
      • ODC V4.2.0
    • V4.1
      • ODC V4.1.2
      • ODC V4.1.1
      • ODC V4.1.0
    • V4.0
      • ODC V4.0.2
      • ODC V4.0.0
    • V3.4
      • ODC V3.4.0
    • V3.3
      • ODC V3.3.3
      • ODC V3.3.2
      • ODC V3.3.1
      • ODC V3.3.0
    • V3.2
      • ODC V3.2.3
      • ODC V3.2.2
      • ODC V3.2.1
      • ODC V3.2.0

Download PDF

What is ODC? Features Architecture Limitations User interface Overview Install Client ODC Use Client ODC Overview Deploy Web ODC Use Web ODC Create a data source Data source and project collaboration Session management Global variable management Recycle bin management Edit and execute SQL statements Compile and debug PL objects Command-line window Edit and export results Analyze SQL statements Data mocking Import schema and data Export schema and data Users and roles Automatic authorization Collaborative project management Risk levels, risk identification rules, and approval processes SQL check specifications Manage database changes SQL window specification Change lock-free structures Synchronize shadow tables Archive data Data cleanup Manage partitions SQL plan task Data desensitization Operation audit SSO integration Approval integration SQL approval integrationDeployment overview Preparations before deployment Deployment process Load and run an ODC image Deployment process Load and run an ODC image Deploy SSL certificate Deploy the NGINX proxy Configure certificate trust Deployment verificationOverview Preparations before upgrade Upgrade process Stop ODC of the earlier version Load and run an ODC image Upgrade process Stop ODC of the earlier version Load and run an ODC image Upgrade NGINX image Upgrade verification Rollback after upgrade failed ODC troubleshooting process View the runtime environment and version information View web ODC logsView client ODC logsView end-to-end ODC-related logsView ODC MetaDB dataQuery the index status in OceanBase Database V4.xQuery the index status in OceanBase Database V1.4.x to V3.2.xCollect JVM runtime informationUse tcpdump to capture packetsInstallation of client ODCWeb ODC deployment and startupConnection informationCommand-line windowDDL statement display ODC V4.2.0 ODC V4.1.2 ODC V4.1.1 ODC V4.1.0 ODC V4.0.2 ODC V4.0.0ODC V3.4.0ODC V3.3.3 ODC V3.3.2 ODC V3.3.1 ODC V3.3.0 ODC V3.2.3 ODC V3.2.2 ODC V3.2.1 ODC V3.2.0
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Developer Center
  3. V4.2.0
iconOceanBase Developer Center
V 4.2.0
  • V 4.4.2
  • V 4.4.1
  • V 4.4.0
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.4
  • V 4.2.3
  • V 4.2.2
  • V 4.2.1
  • V 4.2.0
  • V 4.1.3 and earlier

Data desensitization

Last Updated:2026-04-13 06:20:38  Updated
share
What is on this page
Background information
Concepts
Execution process
Prerequisites
Manage sensitive columns
Add sensitive columns
Edit sensitive columns
Delete sensitive columns
Manage identification rules
Add an identification rule
Manage identification rules
View desensitization algorithms
Scenarios
Scenario 1: Data export
Scenario 2: Database changes
Scenario 3: SQL statement execution in the SQL window
References

folded

share

Background information

Data desensitization changes the forms of sensitive information, such as names, ID card numbers, mobile phone numbers, landline numbers, bank accounts, and email addresses. You can set data desensitization rules to protect sensitive data.

Concepts

  • Data desensitization: the process of deidentifying, masking, or replacing sensitive data by using special algorithms and techniques during data processing and storage to protect data security and prevent data breach.

  • Dynamic desensitization: the process of desensitizing sensitive data in real time. The data is desensitized only for a database query. The source data in the database is not modified. Dynamic desensitization is commonly used in production environments to maintain the integrity and accuracy of raw data while avoiding the risk of data breach. The drawback of dynamic desensitization is its limited processing speed, which may affect the database query efficiency.

  • Static desensitization: the process of preprocessing sensitive data and storing the processed data in storage media, such as a database. Static desensitization is usually used in testing, development, and demonstration environments. It protects sensitive data from being viewed by unauthorized personnel and avoids the legal liability of data breach. The benefit of static desensitization is the fast processing speed and high query efficiency. However, the raw data is overwritten, so the data accuracy is undermined.

  • Desensitization algorithm: an algorithm used to desensitize data. A desensitization algorithm can effectively protect the security of sensitive data, avoid information breaches, and retain data formats and structures for data query and usage.

  • Identification rule: a rule used to automatically identify sensitive data for dynamic desensitization. ODC automatically scans data and identifies sensitive columns based on the added identification rules.

  • Sensitive column: a column that contains sensitive data in a database table.

Execution process

2.2

  1. A project administrator views the built-in desensitization algorithm and tests the desensitization effect in Desensitization Algorithm under Security Specifications.

  2. The project administrator manually adds sensitive columns on the Sensitive Data tab for a project. To add sensitive columns by using the automatic scanning feature, you must first create an identification rule.

  3. A user views the table data, queries data in the SQL window, exports a result set, exports a ticket, and submits a database change ticket. The sensitive columns in the data are desensitized.

Prerequisites

  • The project administrator and DBA can manage sensitive columns and identification rules.

  • All users can view and test the desensitization effect. Users cannot create, edit, or delete a desensitization algorithm.

Manage sensitive columns

Add sensitive columns

Assume that you want to desensitize the email and mobile_phone columns in the student table in the odc_test database.

Parameter Example value
Data Source mysql_4.2.0
Source Database Name odc_test
Table Name student
  1. In the project collaboration window, choose Project > Sensitive Data > Sensitive Columns > Add Sensitive Column > Add Manually.

  2. Add sensitive columns by taking one of the following means, and then click Submit.

    • Method 1: Manually add sensitive columns.

    • Method 2: Scan for sensitive columns automatically.

      Note

      Before automatically scanning for sensitive columns, you must create an identification rule. For more information, see Manage identification rules.

  3. In the Sensitive Data list, you can view and enable the added sensitive columns.

Edit sensitive columns

As shown in the preceding figure, in the Sensitive Data list, click Edit in the Actions column to modify the desensitization algorithm.

Delete sensitive columns

On the Sensitive Data tab, click Delete in the Actions column.

Manage identification rules

Identification rules facilitate the management of sensitive data. After you manually add sensitive columns, you can add custom identification rules to automatically scan for sensitive columns. An identification rule is a matching condition that ODC uses to identify sensitive columns. ODC allows you to define an identification rule in three aspects: path, regular expression, and script.

  • Path: Use the database name, table name, or column name as the identification object. You can enter a path identification expression as an identification rule. Use periods (.) to separate database and table column names. Use asterisks (*) as wildcards. Use commas (,) to specify multiple rules.

    Parameter Required? Description
    Rule Name Yes The name of the rule. The name can contain up to 64 characters.
    Rule Status Yes The status of the rule. Valid values: Enabled and Disabled.
    Matching Rule Yes The rule that qualifies a data column as a sensitive column.
    For example, the rule *.*.mobile_phone qualifies any column named mobile_phone in all databases and tables.
    Exclusion Rule No The rule that disqualifies a data column as a sensitive column.

    Notice

    ODC checks a data column against the exclusion rule first, and then the matching rule, to determine whether it is a sensitive column.

    Desensitization Algorithm Yes The default desensitization algorithm for masking sensitive columns.
    Description No The description of the identification rule.
  • Regular expression: Use the database name, table name, column name, or column comments as the identification object. You can enter a path identification expression as an identification rule. You can enter a regular expression as an identification rule.

    Parameter Required? Description
    Rule Name Yes The name of the rule. The name can contain up to 64 characters.
    Rule Status Yes The status of the rule. Valid values: Enabled and Disabled.
    Identification object - Database name No Enter a regular expression for matching a database name.
    For example: * represents a database of any name.
    Identification object - Table name No Enter a regular expression to match a table name.
    For example, e[a-z]?.* represents any table with a lowercase English name that starts with the letter e.
    Identification object - Column name No Enter a regular expression to match a column name.
    Identification object - Column comments No Enter a regular expression for matching column comments.
    Desensitization Algorithm Yes The default desensitization algorithm for masking sensitive columns.
    Description No The description of the identification rule.
  • Script: Use the database name, table name, column name, column comments, or data type as the identification object. You can enter a Groovy script as the identification rule.

    Notice

    The output of the script must be a Boolean value, either True or False.

    Parameter Required? Description
    Rule Name Yes The name of the rule. The name can contain up to 64 characters.
    Rule Status Yes The status of the rule. Valid values: Enabled and Disabled.
    Groovy Script Yes A script that determines whether a column is a sensitive column. The script must comply with the Groovy syntax standard.
    Desensitization Algorithm No The default desensitization algorithm for masking sensitive columns.
    Description No The description of the identification rule.

    ODC has a built-in object named column for users to reference in Groovy scripts. The following table describes the attributes of the object.

    Attribute Type Description
    schema String The name of the database to which the column belongs.
    table String The name of the table to which the column belongs.
    name String The name of the column.
    comment String The comment of the column.
    type String The data type of the column.

Here are some sample scripts of general identification rules:

  • Addresses

    if (("varchar".equals(column.type) || "char".equals(column.type))) {
        if (column.name.indexOf("address") >= 0) {
            return true;
        }
        if (column.comment != null &&
                (column.comment.toLowerCase().indexOf("address") >= 0
                        || column.comment.indexOf("address") >= 0
                        || column.comment.indexOf("home address") >= 0
                        || column.comment.indexOf("location") >= 0)) {
            return true;
        }
    }
    return false;
    
  • Mobile phone numbers

    if (column.name.length() == 11 && ("varchar".equals(column.type) || "char".equals(column.type))) {
        if (column.name.indexOf("phone") >= 0 || column.name.indexOf("mobile") >= 0) {
            return true;
        }
        if (column.comment != null &&
                (column.comment.toLowerCase().indexOf("phone") >= 0
                        | | column.comment.indexOf("phone") >= 0
                        || column.comment.indexOf("mobile") >= 0
                        || column.comment.indexOf("mobile") >= 0)) {
            return true;
        }
    }
    return false;
    
  • ID card numbers

    if (column.name.length() >= 15 && ("varchar".equals(column.type) || "char".equals(column.type))) {
        if (column.name.indexOf("id_number") >= 0 || column.name.indexOf("identity_card") >= 0) {
            return true;
        }
        if (column.comment != null &&
                (column.comment.toLowerCase().indexOf("identity card") >= 0
                        || column.comment.indexOf("ID card") >= 0)) {
            return true;
        }
    }
    return false;
    

Add an identification rule

Assume that you want to add an identification rule for the mobile_phone column in the student table in the odc_test database as the administrator.

  1. In the project collaboration window, choose Project > Sensitive Data > Identification Rules > Create Identification Rule.

  2. In the Create Identification Rule dialog box, specify the rule name, rule status, and identification method.

    For example, odc_test*.student.*a,*.*.mobile_phone matches the mobile_phone column in the student table in the odc_test database.

  3. In the Identification Rules list, you can view and enable the created identification rule.

Manage identification rules

As shown in the preceding figure, you can click Edit or Delete to modify or delete an identification rule.

View desensitization algorithms

On the project collaboration page, choose Security Specifications > Desensitization Algorithms to view the desensitization algorithms supported by ODC.

The following table describes the desensitization algorithms supported by ODC.

Algorithm name Test data Result preview
Mask all (system default) test value *****
Personal name (Chinese) 个人姓名 **名
Personal name (letters) Personal name P**
Nickname Nickname N***e
Email odc@oceanbase.com o***@oceanbase.com
Address Hangzhou, Zhejiang Province, China Hangzhou, Z***
Mobile phone number 13500000000 135******00
Landline number 010-12345678 **********78
ID card number 123456789 1*******9
Bank account 1234 5678 5678 1234 ***************1234
License plate number Zhejiang AB1234 Zhejiang A**234
Unique device ID AB123456789CD ****89CD
IP address 10.123.456.789 10...*
MAC address ab:cd:ef:gh:hi:jk ab:*:*:*:*:*
MD5 default c21f969b5f03d33d43e04f8f136e7682
SHA256 default 37a8eec1ce19687d132fe29051dca629d164e2c4958ba141d5f4133a33f0688f
SHA512 default 1625cdb75d25d9f699fd2779f44095b6e320767f606f095eb7edab5581e9e3441adbb0d628832f7dc4574a77a382973ce22911b7e4df2a9d2c693826bbd125bc
SM3 default 40c357923156504f734717d8b4f5623e75209e9572701f4b51ef2a03d9ced863
Rounding 123.456 123
Empty default -
Default rule abcd1234 abc**234

Scenarios

The added sensitive columns take effect in data export, database change, and SQL window execution scenarios.

Scenario 1: Data export

Assume that you want to export the student table from the dc_test database and check the desensitization result.

  1. In the left-side navigation pane of the SQL development window, submit a ticket to export the student table. In the export task list, click View.

  2. In the lower-right corner of the export task details page, click Download.

  3. View the student table on your local disk.

Scenario 2: Database changes

Assume that you want to insert data into the student table and check the desensitization result. Data desensitization is automatically enabled in this case.

  1. In the left-side navigation pane of the SQL development window, submit a ticket to create a database change task that inserts data into the student table.

  2. In the left-side navigation pane of the SQL development window, check the student table in the odc_test database under database. The data is desensitized.

Scenario 3: SQL statement execution in the SQL window

Assume that you want to insert data into the student table and check the desensitization result. Data desensitization is automatically enabled in this case.

  1. In the SQL window, edit an SQL statement to insert data into the student table.

  2. On the Results tab, view the data in the student table. The data is desensitized.

References

  • Export data

  • Edit and execute SQL statements

  • Manage database changes

Previous topic

SQL plan task
Last

Next topic

Operation audit
Next
What is on this page
Background information
Concepts
Execution process
Prerequisites
Manage sensitive columns
Add sensitive columns
Edit sensitive columns
Delete sensitive columns
Manage identification rules
Add an identification rule
Manage identification rules
View desensitization algorithms
Scenarios
Scenario 1: Data export
Scenario 2: Database changes
Scenario 3: SQL statement execution in the SQL window
References