hana-cli
Version:
HANA Developer Command Line Interface
83 lines (59 loc) • 2.17 kB
Markdown
# dataMask
> Command: `dataMask`
> Category: **System Tools**
> Status: Production Ready
## Description
Apply masking rules for sensitive data protection
## Syntax
```bash
hana-cli dataMask [options]
```
## Command Diagram
```mermaid
graph TD
Start([hana-cli dataMask]) --> Read[Read schema/table/mask options]
Read --> Load[Load rows from target table]
Load --> Rules[Apply masking rules per column]
Rules --> DryRun{dryRun enabled?}
DryRun -->|Yes| SQL[Print SQL statements]
DryRun -->|No| Execute[Execute updates]
SQL --> Complete([Command Complete])
Execute --> Complete
style Start fill:#0092d1
style Complete fill:#2ecc71
style DryRun fill:#f39c12
```
## Aliases
- `mask`
- `dataprivacy`
- `anonymize`
- `pii`
## Parameters
### Options
| Option | Alias | Type | Default | Description |
|--------|-------|------|---------|-------------|
| `--schema` | `-s` | string | - | Schema containing target table |
| `--table` | `-t` | string | - | Target table to mask |
| `--rules` | `-r` | string | - | Inline masking rules definition |
| `--rulesFile` | `-rf` | string | - | Path to masking rules file |
| `--columns` | `-c` | string | - | Comma-separated columns to mask |
| `--maskType` | `-mt` | string | `redact` | Masking strategy. Choices: `redact`, `hash`, `shuffle`, `replace`, `truncate`, `pattern`, `random` |
| `--dryRun` | `-dr` | boolean | `true` | Generate masking SQL without executing |
| `--whereClause` | `-w` | string | - | Restrict rows to mask |
| `--output` | `-o` | string | - | Output file for generated SQL |
| `--profile` | `-p` | string | - | Connection profile |
For a complete list of parameters and options, use:
```bash
hana-cli dataMask --help
```
## Examples
### Basic Usage
```bash
hana-cli dataMask --table CUSTOMERS --maskType hash --columns EMAIL
```
Apply hash masking to matching rows and columns in the target table.
## Related Commands
See the [Commands Reference](../all-commands.md) for other commands in this category.
## See Also
- [Category: System Tools](..)
- [All Commands A-Z](../all-commands.md)