MarkLogic Server 11.0 Product Documentation

ordt.redactNumber

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

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.formatNumber function.

Example

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

op.fromView('main', 'employees')
  .bind([
     ordt.redactNumber(op.schemaCol('main', 'employees', 'salary'), {type:'decimal', min:50000, max:500000, format:'$###,##0.00'})
     ])
  .result();

  

Example

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

op.fromView('main', 'employees')
  .select([
     ordt.redactNumber(op.schemaCol('main', 'employees', 'salary'), {type:'decimal', min:50000, max:500000, format:'$###,##0.00'})
     ])
  .result();