Zengines Schema Definition Template
The Zengines schema definition we use (ingest) for the creation of Source and Target entities in the project has 33 columns (v2 April 2026). Schema definitions must be saved as .CSVs and comply to the format below.
Only a few columns are required, however we advise that you include all in the definition file and add as much information as possible:
|
Column name |
Required | Acceptable values | Description |
|
TABLE_SCHEMA |
YES |
string |
Reference name for the schema (definition only) |
|
TABLE_NAME |
YES |
string (unique in schema) |
Displayed on table and fields as 'Original Table Name' in platform - non editable |
|
COLUMN_NAME |
YES |
string (unique in table) |
Displayed on field as 'Original Table Name' in platform - non editable |
|
ORDINAL_POSITION |
YES |
sequential integer (unique in table) |
Displayed on field as 'Ordinal Position' in platform - non editable |
|
COLUMN_DEFAULT |
NO |
value or expression/NULL |
Displayed on field as 'Default Value' |
|
IS_NULLABLE |
NO |
‘YES’ or ‘NO’ or NULL |
Displayed on field as 'Is Required' toggle in platform |
|
DATA_TYPE |
YES |
String |
This data type name will be mapped to the Zengines core internal logical data types and constraints |
|
CHARACTER_MAXIMUM_LENGTH |
NO |
Integer/NULL |
Maximum character length allowed. Displayed on field as the 'Max Length' constraint option for a STRING data type. Is equivalent to VARCHAR(max length) |
|
CHARACTER_OCTET_LENGTH |
NO |
Integer/NULL |
Maximum character length allowed. Displayed on field as the 'Max Length' constraint option for a STRING data type. Is equivalent to NVARCHAR(max length) |
|
CHARACTER_FIXED_LENGTH |
NO |
Integer/NULL |
Required character length. Displayed on field as the 'Fixed Length' constraint option for a STRING data type. Is equivalent to CHAR(length) |
|
NUMERIC_PRECISION |
NO |
Integer/NULL |
Maximum numeric width allowed. Displayed on field as the 'Precision' constraint option for a DECIMAL data type. |
|
NUMERIC_SCALE |
NO |
Integer/NULL |
Required decimal places. Displayed on field as the 'Scale' constraint option for a DECIMAL data type. |
|
DATETIME_PRECISION |
NO |
0,3,6/NULL |
Required character length. Displayed on field as the 'Precision' constraint option for DATETIME, TIME data types. This restricts the fractions of a second show to 0(none), 3(millisecs), 6(microsecs) |
|
DATA_FORMAT_PATTERN |
NO |
string/NULL |
Reference date format. Displayed on field as the 'Format' constraint option for DATETIME, DATE, TIME data types. |
|
MAXIMUM_SIZE_BYTES |
NO |
Integer/NULL |
Maximum byte size allowed. Displayed on field as the 'Max byte size' constraint option for INTEGER, BLOB data types. |
|
CHARACTER_SET_NAME |
NO |
character set names/NULL |
Displayed on field as the 'Character set' constraint option for STRING data type. |
|
COLLATION_NAME |
NO |
collation names/NULL |
Not displayed on field, reference only |
|
COLUMN_CONSTRAINT_PRIMARY |
NO |
‘YES’ or ‘NO’/NULL |
Flag for if Primary key for table. Displayed on field as the 'Is Primary key' toggle. |
|
COLUMN_CONSTRAINT_FOREIGN |
NO |
‘YES’ or ‘NO’/NULL |
Flag for if field is a Foreign Key . Displayed on field as the 'Is Primary key' toggle. |
|
COLUMN_CONSTRAINT_CHECK |
NO |
‘YES’ or ‘NO’/NULL |
Flag for if there is a CHECK expression. Not displayed on field, reference only |
|
COLUMN_CONSTRAINT_UNIQUE |
NO |
‘YES’ or ‘NO’/NULL |
Flag for if field requires a unique value. Displayed on field as the 'Is Unique' toggle. |
|
COLUMN_CONSTRAINT_OTHER |
NO |
string/NULL |
Other type of constraint. Not displayed on field, reference only |
|
COLUMN_CONSTRAINT_NAME |
NO |
string/NULL |
Reference name for constraint. Not displayed on field, reference only |
|
COLUMN_CONSTRAINT_EXPRESSION |
NO |
expression/NULL |
evaluation expression when COLUMN_CONSTRAINT_TYPE is CHECK. Not displayed on field, reference only |
|
COLUMN_CONSTRAINT_TABLE_REFERENCE |
NO |
string/NULL |
Relation table name when COLUMN_CONSTRAINT_FOREIGN is TRUE. Displayed on field when 'Is Foreign Key' toggle is on. |
|
COLUMN_CONSTRAINT_COLUMN_REFERENCE |
NO |
string/NULL |
Relation column name when COLUMN_CONSTRAINT_FOREIGN is TRUE. Displayed on field when 'Is Foreign Key' toggle is on. |
|
COLUMN_CONSTRAINT_COLUMN_REFERENCE_CONSTRAINT_NAME |
NO |
string/NULL |
Reference Name for FOREIGN KEY constraint. Not displayed on field, reference only |
|
EXTRA |
NO |
string/NULL |
Not displayed on field, reference only |
|
PRIVILEGES |
NO |
string/NULL |
Not displayed on field, reference only |
|
COLUMN_COMMENT |
NO |
string/NULL |
Displayed on field as 'Description'. |
|
COLUMN_BUSINESS_TERM |
NO |
string/NULL |
Not displayed on field, reference only |
|
COLUMN_SENSITIVE_DATA |
NO |
‘YES’ or ‘NO’/NULL |
Flag for if data is of a sensitive type. Not displayed on field, reference only |
|
COLUMN_SENSITIVE_DATA_TYPE |
NO |
string/NULL |
Type of data sensitivity. Not displayed on field, reference only |
Definition header structure template:
|
TABLE_SCHEMA |
TABLE_NAME |
COLUMN_NAME |
ORDINAL_POSITION |
COLUMN_DEFAULT |
IS_NULLABLE |
DATA_TYPE |
CHARACTER_MAXIMUM_LENGTH |
CHARACTER_OCTET_LENGTH |
CHARACTER_FIXED_LENGTH |
NUMERIC_PRECISION |
NUMERIC_SCALE |
DATETIME_PRECISION |
DATA_FORMAT_PATTERN |
MAXIMUM_SIZE_BYTES |
CHARACTER_SET_NAME |
COLLATION_NAME |
COLUMN_CONSTRAINT_PRIMARY |
COLUMN_CONSTRAINT_FOREIGN |
COLUMN_CONSTRAINT_CHECK |
COLUMN_CONSTRAINT_UNIQUE |
COLUMN_CONSTRAINT_OTHER |
COLUMN_CONSTRAINT_NAME |
COLUMN_CONSTRAINT_EXPRESSION |
COLUMN_CONSTRAINT_TABLE_REFERENCE |
COLUMN_CONSTRAINT_COLUMN_REFERENCE |
COLUMN_CONSTRAINT_COLUMN_REFERENCE_CONSTRAINT_NAME |
EXTRA |
PRIVILEGES |
COLUMN_COMMENT |
COLUMN_BUSINESS_TERM |
COLUMN_SENSITIVE_DATA |
COLUMN_SENSITIVE_DATA_TYPE |