Classification file
Published 19 October 2023
The classify
command outputs a JSON that outlines the tables and columns in your database.
Here's what each part means:
- jsonSchemaVersion: The version of the schema of the classification file. Defaults to 1.
- tables: An array of table descriptors
- schema: The namespace within the database.
- name: The name of the table.
- exclude: Ignores this table when masking if true, false by default.
- columns: An array of column descriptors.
- name: The name of the column.
- type: How the information has been classified in this column. Classify auto classifies information identified as linked PII, as defined by NIST.
- exclude: Ignores this column if true, false by default.
- maxLength: The maximum length of the data in that column.
For default behavior, there is no need to edit the classification before using as input for the map
command.
Advanced customization
For advanced use-cases, you can edit the JSON to meet your needs, but it is preferrable to provide an options file.
More information is detailed on our Anonymization configuration page.
In this example, the AddressLine1 column in the Address table under the Person schema is identified as a street address with a maximum length of 60 characters.
{ "jsonSchemaVersion": 1 "tables": [ { "schema": "Person", "name": "Address", "columns": [ { "name": "AddressLine1", "type": "StreetAddresses", "maxLength": 60 } ] } ] }