MarkLogic Server 11.0 Product Documentation

ordt.maskDeterministic

ordt.maskDeterministic(
   column as String,
   options as object?
) as columnBinding

Summary

This function redacts a column with string values by replacing each value with deterministic masking text. That is, a specific value generates the same masked value every time the value is redacted. You can control characteristics such as the character set for the masked value. This function can be used with op.bind or op.select .

Usage Notes

The options consist of the following properties:

• character: one of any (the default), mixedCase, mixedCaseNumeric, lowerCase, lowerCaseNumeric, upperCase, upperCaseNumeric, or numeric.
• hash: the mask algorithm; either sha256 or sha512 (the default).
• maxLength: truncates the masked value to be less than the specified maximum.
• salt: applied when masking the value.

Example

const op   = require('/MarkLogic/optic');
const ordt = require('/MarkLogic/optic/optic-redaction.sjs');

op.fromView('main', 'employees')
  .bind([
     ordt.maskDeterministic(op.schemaCol('main', 'employees', 'FirstName'), {character:'mixedCase'}),
     ordt.maskDeterministic(op.schemaCol('main', 'employees', 'LastName'),  {character:'mixedCase'})
     ])
  .result();

  

Example

const op   = require('/MarkLogic/optic');
const ordt = require('/MarkLogic/optic/optic-redaction.sjs');

op.fromView('main', 'employees')
  .select([
     ordt.maskDeterministic(op.schemaCol('main', 'employees', 'FirstName'), {character:'mixedCase'}),
     ordt.maskDeterministic(op.schemaCol('main', 'employees', 'LastName'),  {character:'mixedCase'})
     ])
  .result();