ordt:maskRandom

ordt:maskRandom(
   $column as item(),
   $options as map:map?
) as map:map

Summary

This function redacts a column with string values by replacing each value with random masking text. The same value may produce a different masked value every time the value is redacted. You can control characteristics such as the character set for the masked value.

Usage Notes

The options consist of the following properties:

• character: one of any (the default), mixedCase, mixedCaseNumeric, lowerCase, lowerCaseNumeric, upperCase, upperCaseNumeric, or numeric.
• length: generates a masked value of the specified length.

Example

xquery version "1.0-ml";

import module namespace op="http://marklogic.com/optic"
     at "/MarkLogic/optic.xqy";

import module namespace ordt="http://marklogic.com/optic/redaction"
     at "/MarkLogic/optic/optic-redaction.xqy";

op:from-view("main", "employees")
   => op:bind((
      ordt:mask-random("FirstName", map:entry("character","mixedCase")),
      ordt:mask-random("LastName",  map:entry("character","mixedCase"))
      ))
   => op:result()