Input Definition – Documentation (hierarchical)

Generated: 2025-09-10 01:01

• InputDefinitionJson – top-level input JSON
• InputSourceDefinition – item type used within InputDefinitionJson (e.g. in sources)
• InputDefinitionOutput – output options used by InputDefinitionJson (field output)
• InputDefinitionQueryLineage – query lineage options used by InputDefinitionJson (field queryLineageOptions)
• InputDefinitionAnalyzer – analyzer options used by InputDefinitionJson (field analyzerOptions)
• InputDefinitionDatabaseImage – database image options used by InputDefinitionJson (field databaseImageOptions)

InputDefinitionJson

• name (string, required: yes) — Batch name
• dialect (string, required: yes) — Dialect. Supported is tsql, teradata, redshift, oracle, impala, bigquery, powerbi, snowflake, postgresql
• sourceFiles (array of strings, required: no) — List of file names (simple input, depracated)
• sourceFile (string, required: no) — Source file name (the most simplest input, just 1 file, deprecated)
• sources (array of InputSourceDefinition, required: no) — Source file list (recommended) (see section: InputSourceDefinition)
• replace (boolean, required: no) — If set to true, replaces old batches with the same name
• description (string, required: no) — Batch description
• showColumnTypes (boolean, required: no) — GoJS diagram option
• defaultDatabase (string, required: no) — Default database name (can be overriden for each item in 'sources'
• defaultSchema (string, required: no) — Default schema name (can be overriden for each item in 'sources'
• output (object InputDefinitionOutput, required: no) — List (JSON object) of output options (see section: InputDefinitionOutput)
• authorization (object InputDefinitionAuthorization, required: no) — List (JSON object) of authorization options
• showQueryLineage (boolean, required: no) — GoJS diagram option
• showDatabaseImage (boolean, required: no) — GoJS diagram option
• queryLineageOptions (object InputDefinitionQueryLineage, required: no) — List (JSON object) of GoJS diagram options
  • "queryLineageOptions": { ... }
  • (see section: InputDefinitionQueryLineage)
• databaseImageOptions (object InputDefinitionDatabaseImage, required: no) — List (JSON object) of GoJS diagram options. (see section: InputDefinitionDatabaseImage)
• testOptions (object InputDefinitionTest, required: no) — List (JSON object) of test options, internal use
• analyzerOptions (object InputDefinitionAnalyzer, required: no) — List (JSON object) of analyzer options (see section: InputDefinitionAnalyzer)
• maxPasses (number, required: no) — When multiPass is set, the maximum of passes
• dir (string, required: no) — Batch directory
• append (string, required: no) — Append mode. When set, the result is appended to the last batch with the same Batch ID
• tsqlOptions (object TSQLOptions, required: no) — TSQL dialect options

---

InputSourceDefinition

InputSourceDefinition – fields

• name (string, required: yes) — File or directoryh name
• defaultDatabase (string, required: no) — Default database (overrides global defaultDatabase)
• defaultSchema (string, required: no) — Default schema (overrides global defaultSchema)
• isExportedDbModel (boolean, required: no) — Custom input method
• isExportedPowerBIModel (boolean, required: no) — Custom input method
• bqDataset (string, required: no) — Big query dataset
• prependHeader (string, required: no) — Prepends the value before each source
• excludeSuffix (array of strings, required: no) — Excludes files ending with one of the listed suffixes
• replaceString (object, required: no) — Replaces string inside each source code
• ignorePattern (array of strings, required: no) — Ignore sources with given pattern (scala regexp)

---

InputDefinitionOutput

InputDefinitionOutput – fields

• generateGoJsOutput (boolean, required: no) — Create diagram for client application
• generateGoJsView (boolean, required: no) — Obsolete
• goJsOptions (object InputDefinitionGoJsOptions, required: no) — List (JSON object) of GoJS diagram options
• generateDawisoOutput (boolean, required: no) — Custom output
• generateDiagramOutput (boolean, required: no) — Diagram output for each source files
• generateObjectBrowserOutput (boolean, required: no) — Object browser output for client application
• objectBrowserOutputOptions (object InputDefinitionObjectBrowserOutput, required: no) — List (JSON object) of object browser options
• saveColumnLineageBySource (boolean, required: no) — Test option (internal use)
• saveBatchInfo (boolean, required: no) — Obsolete
• dumpGraph (boolean, required: no) — Obsolete
• dumpLineage (boolean, required: no) — Obsolete
• dumpParsingErrors (boolean, required: no) — Obsolete
• dumpAnalyzerErrors (boolean, required: no) — Obsolete
• dumpEvalTree (boolean, required: no) — Obsolete
• dumpInitialEvalTree (boolean, required: no) — Obsolete

---

InputDefinitionQueryLineage

InputDefinitionQueryLineage – fields

• expandTables (boolean, required: no) — Expand tables on diagram, otherwise only header is shown
• expandGroups (boolean, required: no) — Expand groups on diagram, otherwise only header is shown
• groupExpandLevel (number, required: no) — Expand groups on diagram to this level. 0 means no limit
• constants (object InputDefinitionQLConstants, required: no) — .
• groupCodeBlocks (boolean, required: no) — .
• groupProcedures (boolean, required: no) — .
• showColumnStruct (string, required: no) — .
• showUnresolvedVariants (boolean, required: no) — .
• showExpressions (string, required: no) — .
• showVariables (boolean, required: no) — .
• showProcedureLineage (boolean, required: no) — .
• showUnusedTableReferences (boolean, required: no) — .
• showConditionBlocks (boolean, required: no) — Show relations originated in IF/ELSIF/CASE command blocks

---

InputDefinitionAnalyzer

InputDefinitionAnalyzer – fields

• autoCreate (boolean, required: no) — Unresolved table references are added to database image as table
• multiPass (boolean, required: no) — Proces multiple passes. Repeated passes may resolve more tables using more complete image
• strict (boolean, required: no) — No autoCreate, fail when table reference is unresolved
• skipStrictErrors (boolean, required: no) — Obsolete
• skipUnresolvedHostVariables (boolean, required: no) — Teradata option
• skipParsingErrors (boolean, required: no) — Obsolete
• skipAnalyzerErrors (boolean, required: no) — Obsolete
• skipDatatypeErrors (boolean, required: no) — Datatype analysis is not strict, just ingored when fails
• showSemidirectRelations (boolean, required: no) — Process semidirect (indirect relations left from FROM clause) relations
• extraRelations (array of com.dalineage.common.adt.BatchInfoADT.ExtraRelation, required: no) — Extra relations added manually to lineage
• hardcodedFunctionLineage (array of HardcodedFunctionLineage, required: no) — List of extra sources targeting in function call
• showIndirectRelations (boolean, required: no) — Show relations originated in WHERE/GROUP BY/HAVING/ORDER BY
• trustExportedViewColumns (boolean, required: no) — DB model option. When set, initial view definitions are not trusted
• workDir (string, required: no) — Internal debig option
• keepWorkDir (boolean, required: no) — Internal debug option

---

InputDefinitionDatabaseImage

InputDefinitionDatabaseImage – fields

• expandTables (boolean, required: no) — Database image tables on diagram are initially expanded
• expandGroups (boolean, required: no) — Groups on diagram are initially expanded
• groupExpandLevel (number, required: no) — Groups on diagram are initially expanded to the given depth
• showColumnLineage (boolean, required: no) — Object browser option. Show detailed column lineage for each source
• showJoinedColumnRelations (boolean, required: no) — Show JOINed columns. This relation doesn't represent data lineage
• groupTables (string, required: no) — Grouping database image tables on diagram (GLOBAL,SCHEMA)
• showTableVersions (string, required: no) — Show complete history of table changes (typically when ADD/DROP COLUMN is called)