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

Masking: Clarify documentation

Browse Source
This commit is contained in:
Johan Wikman
2017-01-13 09:35:05 +02:00
parent fbb63f4eb8
commit ce4e26477b
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/Filters/Masking.md
View File

@ -58,9 +58,11 @@ types: `BINARY`, `VARBINARY`, `CHAR`, `VARCHAR`, 'BLOB', TINYBLOB`,
`ENUM` and `SET`. If the type of the column is something else, then no `ENUM` and `SET`. If the type of the column is something else, then no
masking will be performed. masking will be performed.
The masking filter can only work on payloads less than 16MB. If the masking Currently, the masking filter can only work on packets whose payload is less
filter encounters payloads larger than that, the value of the parameter than 16MB. If the masking filter encounters a packet whose payload is exactly
`large_payloads` specifies how such payloads should be treated. that, thus indicating a situation where the payload is delivered in multiple
packets, the value of the parameter `large_payloads` specifies how the masking
filter should handle the situation.
## Configuration ## Configuration
@ -109,11 +111,12 @@ warn_type_mismatch=always
#### `large_payload` #### `large_payload`
This optional parameter specifies how the masking filter should treat This optional parameter specifies how the masking filter should treat
payloads larger than `16MB`. payloads larger than `16MB`, that is, payloads that are delivered in
multiple MySQL protocol packets.
The values that can be used are `ignore`, which means that values in The values that can be used are `ignore`, which means that columns in
such payloads are not masked, and `abort`, which means that if such such payloads are not masked, and `abort`, which means that if such
payloads are encountered then the connection is closed. The default payloads are encountered, the client connection is closed. The default
is `abort`. is `abort`.
Note that the aborting behaviour is applied only to resultsets that Note that the aborting behaviour is applied only to resultsets that