MarkLogic 12 Product Documentation

ordt:redact-number

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

Summary

This function redacts a column by generating a random number within a configurable range either as a numeric data type or as a formatted string. This function can be used with op:bind or op:select.

Usage Notes

The options consist of the following properties:

• min: the smallest generated number (with 0 default).
• max: the largest generated number (with 18446744073709551615 default).
• type: the numeric data type of the generated number as one of either integer (the default), decimal, or double; the min and max values must have the same data type.
• format: a picture string describing how to format the generated number as a string instead of returning the number as a value of the data type; specify the picture as with the fn:format-number function.

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:redact-number(op:schema-col("main", "employees", "salary"),
          map:entry("type","decimal")=>map:with("min",50000)=>map:with("max",500000)=>map:with("format","$###,##0.00"))
      ))
   => 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", "employees")
   => op:select((
      ordt:redact-number(op:schema-col("main", "employees", "salary"),
          map:entry("type","decimal")=>map:with("min",50000)=>map:with("max",500000)=>map:with("format","$###,##0.00"))
      ))
   => op:result()