Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MaskingPolicy

A masking policy defines the approach to mask data in a target database. It's basically a collection of columns to be masked, called masking columns, and the associated masking formats to be used to mask these columns. A masking policy can be used to mask multiple databases provided that they have the same schema design. For more information, see <a href="https://docs.oracle.com/en/cloud/paas/data-safe/udscs/masking-policies.html\">Masking Policies in the Oracle Data Safe documentation.

Properties

Optional columnSource

compartmentId

compartmentId: string

The OCID of the compartment that contains the masking policy.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

The description of the masking policy.

displayName

displayName: string

The display name of the masking policy.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the masking policy.

isDropTempTablesEnabled

isDropTempTablesEnabled: boolean

Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users.

isRedoLoggingEnabled

isRedoLoggingEnabled: boolean

Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked.

isRefreshStatsEnabled

isRefreshStatsEnabled: boolean

Indicates if statistics gathering is enabled. It's enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes.

lifecycleState

lifecycleState: MaskingLifecycleState

The current state of the masking policy.

parallelDegree

parallelDegree: string

Specifies options to enable parallel execution when running data masking. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.

Optional postMaskingScript

postMaskingScript: undefined | string

A post-masking script, which can contain SQL and PL/SQL statements. It's executed after the core masking script generated using the masking policy. It's usually used to perform additional transformation or cleanup work after masking.

Optional preMaskingScript

preMaskingScript: undefined | string

A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before the core masking script generated using the masking policy. It's usually used to perform any preparation or prerequisite work before masking data.

recompile

recompile: Recompile

Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), 'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree attribute is used. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.

timeCreated

timeCreated: Date

The date and time the masking policy was created, in the format defined by RFC3339.

timeUpdated

timeUpdated: Date

The date and time the masking policy was last updated, in the format defined by RFC3339

Functions

getDeserializedJsonObj

getJsonObj