Input Description JSON format

Minimal configuration

{
  "name": "My first batch",
  "dialect": "tsql",
  "sources": [ { "name": "." } ]
}

Basic options

• name: String. Mandatory
• dialect: String, case insensitive. Mandatory. -- Supported dialects are: TSQL (MS Sql Server), Oracle, Teradata, Impala, BigQuery
• sources: List of source specifications

  {
    "name": ...          # Dir or file entry inside uploaded ZIP containing source files.
                         # it can also be Database Model JSON file(s) *but not with .json suffix!*
                         # (only one file with .json suffix is allowed: Input Definition JSON)
    "defaultSchema": ... # optional
    "defaultDatabase":   # optional
  }

Analyzer options

{
  "analyzerOptions": { ... }
}

• autoCreate: Boolean. Default: false. Automatically create missing tables and views
• multiPass: Boolean. Default: false. Run analyzer in multiple passes to resolve more missing tables and views
• skipDatatypeErrors: Boolean. Default: false. Use "Unknown" datatype when datatype analysis fails
• showQueryLineage: Boolean. Default: false. Saves detailed query lineage to diagram.
  • see queryLineageOptions for related options

Output options

• generateObjectBrowserOutput: Boolean. Default: true.
  • Save database image and source code list for Object Browser. Object Browser is a part of client application enabling tree view and search of source code and database objects. Setting to false saves some resources.

Query lineage options

"queryLineageOptions": { ... }

• expandTables: Boolean. Default: false. Expand tables on diagram, otherwise only header is shown
• expandGroups: Boolean. Default: false. Expand groups on diagram, otherwise only header is shown
• groupExpandLevel: Int. Default: 0. Expand groups on diagram to this level. 0 means no limit
• showIndirectRelations: Boolean. Default: false. Show relations originated in WHERE/GROUP BY/HAVING/ORDER BY
• showConditionBlocks: Boolean. Default: false Show relations originated in IF/ELSIF/CASE command blocks

Database image / column lineage options

"showDatabaseImage": true,
"databaseImageOptions": { ... }

• showJoinedColumnRelations: Boolean. Default: false. Show JOINed database columns in column lineage
• and many more options, please wait for the documentation or contact us to escalate

Append mode

• append: String. Optional. Use existing batch as initial data and append new batch to it.

{
  "append": "*batch-id*"
}

• Original batch must exist in user's processed directory, otherwise the upload will be rejected.
• New batch gets its own batch id returned obviously by upload response.