MarkLogic 12 Product Documentation

ordt:redact-datetime

ordt:redact-datetime(
   $column as item(),
   $options as map:map?
) as map:map

Summary

This function redacts a column with date or datetime values either by masking part of the existing value or by generating a random value. This function can be used with op:bind or op:select.

Usage Notes

The options consist of the following properties:

• level: either parsed (the default) or random; the parsed level formats the existing datetime value (which may be parsed from a string); the random level generates a random datetime value.
• format: a picture string describing how to format the redacted value; required for the parsed level; allowed for the random level; specify the picture as with the fn:format-dateTime function.
• picture: a picture string describing how to parse the date or dateTime value from a string; allowed for the parsed level; ignored for the random level; specify the picture as with the xdmp:parse-dateTime function.
• range: a comma-separated pair of years to bound generated values; ignored for the parsed level; allowed for the random level (defaulting to 1582 and the current year).

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", "expenses")
   => op:bind((
      ordt:redact-datetime(op:schema-col("main", "expenses", "expenseDate"),  map:entry("level","parsed")=>map:with("format","[M01]/[D01]/xx"))
      ))
   => op:result()
  

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", "expenses")
   => op:select((
      ordt:redact-datetime(op:schema-col("main", "expenses", "expenseDate"),  map:entry("level","parsed")=>map:with("format","[M01]/[D01]/xx"))
      ))
   => op:result()