hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update MaskingFilter documentation

Browse Source
This commit is contained in:
Esa Korhonen
2017-06-05 12:56:38 +03:00
parent 09a445f1b7
commit 2990edc424
1 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
Documentation/Filters/Masking.md
View File

@ -198,23 +198,21 @@ specified name.
#### `with` #### `with`
The value of this key is an object that specifies what the value The value of this key is an object that specifies what the value of the matched
of the matched column should be replaced with. Currently, the object column should be replaced with. Currently, the object is expected to contain
is expected to contain either the key `value` or the key `fill`. The either the key `value` or the key `fill`. The value of both must be a string
value of both must be a string. If both keys are specified, then with length greater than zero. If both keys are specified, `value` takes
`value` takes presedence. precedence. If `fill` is not specified, the default `X` is used as its value.
If `value` is specified, then its value is used to replace the actual If `value` is specified, then its value is used to replace the actual value
value verbatim and the length of the specified value must match the verbatim and the length of the specified value must match the actual returned
actual returned value (from the server) exactly. If the lengths do value (from the server) exactly. If the lengths do not match, the value of
not match, then if `fill` is specified its value will be used to `fill` is used to mask the actual value.
mask the actual value. Otherwise an error is logged and the value
is *not* masked.
If `fill` is specified, then its value will be used for masking the When the value of `fill` (fill-value) is used for masking the returned value,
value; as such if the lenghts match, by cutting it if the actual value the fill-value is used as many times as necessary to match the length of the
is shorter, and by repeating it, fully or partially, the necessary return value. If required, only a part of the fill-value may be used in the end
amount of times, if the actual value is longer. of the mask value to get the lengths to match.
``` ```
{ {
"rules": [ "rules": [