Create DDL
- env
- table
- options
- settings
- Types
Custom Procedure
- env
- table
- options
- settings
- Types
Export Script
- env
- table
- options
- settings
- Types
Index Create DDL
- env
- index
- options
- settings
- Types
Index Drop DDL
- env
- index
- options
- settings
- Types
Load Script
- env
- table
- options
- settings
- Types
Table Alter DDL
- env
- changes
- actualTable
- table
- options
- settings
- Types
Update Procedure
- env
- table
- options
- settings
- Types
Types
ActualTable
| Name | Nullable | Type | Notes |
|---|---|---|---|
| catalog | Scalar | ||
| schema | Scalar | ||
| name | Scalar | ||
| additionalInformation | Array of AdditionalDatum | ||
| columns | Array of Column |
AdditionalDatum
| Name | Nullable | Type | Notes |
|---|---|---|---|
| key | Scalar | ||
| description | Scalar | ||
| value | Scalar |
ChangeType
| Name | Nullable | Type | Notes |
|---|---|---|---|
| Types.ChangeType.TableCreation | TableCreation | ||
| Types.ChangeType.TableAdditionalInformationChange | TableAdditionalInformationChange | ||
| Types.ChangeType.ColumnAddition | ColumnAddition | ||
| Types.ChangeType.ColumnDeletion | ColumnDeletion | ||
| Types.ChangeType.ColumnNameChange | ColumnNameChange | ||
| Types.ChangeType.ColumnDataTypeChange | ColumnDataTypeChange | ||
| Types.ChangeType.ColumnAdditionalInformationChange | ColumnAdditionalInformationChange |
Column
| Name | Nullable | Type | Notes |
|---|---|---|---|
| additive | Scalar | ||
| artificial | Scalar | ||
| baseDataType | Scalar | ||
| businessKey | Scalar | ||
| changeHashKey | Scalar | ||
| columnId | Scalar | ||
| createTime | Scalar | ||
| currentFlag | Scalar | ||
| dataType | Scalar | ||
| dataTypeScale | Scalar | ||
| dataTypeSize | Scalar | ||
| defaultValue | Scalar | ||
| description | Scalar | ||
| displayName | Scalar | ||
| dss | Scalar | ||
| dssEndDate | Scalar | ||
| dssLoadDate | Scalar | ||
| dssRecordSource | Scalar | ||
| dssStartDate | Scalar | ||
| dssVersion | Scalar | ||
| format | Scalar | ||
| fullDataType | Scalar | ||
| hashKeyImmediateSources | Y | Array of column | |
| hashKeySources | Y | Array of column | |
| hubHashKey | Scalar | ||
| keyType | enum | ||
| linkHashKey | Scalar | ||
| lookupKey | Scalar | ||
| name | Scalar | ||
| nullAllowed | Scalar | ||
| numeric | Scalar | ||
| partition | Scalar | ||
| rangeEnd | Scalar | ||
| rangeStart | Scalar | ||
| slowlyChanging | Scalar | ||
| source | Scalar | ||
| sourceColumn | Y | Link to column identified by name | |
| sourceSystem | Scalar | ||
| sourceTable | Y | Link to table identified by name | |
| table | table | ||
| transform | Scalar | ||
| transformType | enum | ||
| updateTime | Scalar | ||
| zeroKeyValue | Scalar |
ColumnAddition
| Name | Nullable | Type | Notes |
|---|---|---|---|
| columnName | Scalar |
ColumnAdditionalInformationChange
| Name | Nullable | Type | Notes |
|---|---|---|---|
| columnName | Scalar | ||
| changedKey | Scalar | ||
| changedDescription | Scalar | ||
| expectedValue | Scalar | ||
| actualValue | Scalar |
ColumnDataTypeChange
| Name | Nullable | Type | Notes |
|---|---|---|---|
| columnName | Scalar | ||
| dataType | Scalar | ||
| actualDataType | Scalar |
ColumnDeletion
| Name | Nullable | Type | Notes |
|---|---|---|---|
| columnName | Scalar |
ColumnJoin
| Name | Nullable | Type | Notes |
|---|---|---|---|
| fromColumn | Link to column identified by name | ||
| toColumn | Link to column identified by name |
ColumnNameChange
| Name | Nullable | Type | Notes |
|---|---|---|---|
| columnName | Scalar | ||
| actualColumnName | Scalar |
DateBasedPartitioningInfo
| Name | Nullable | Type | Notes |
|---|---|---|---|
| partitionType | enum | ||
| dateDimensionColumn | Y | Link to column identified by name | |
| startDateKey | Scalar | ||
| endDateKey | Scalar |
EnumValue
| Name | Nullable | Type | Notes |
|---|---|---|---|
| name | Scalar | ||
| code | Scalar |
Env
| Name | Nullable | Type | Notes |
|---|---|---|---|
| licensedTo | Scalar | ||
| productVersion | Scalar | ||
| userName | Scalar | ||
| metaSchemaPrefix | Scalar | ||
| loginName | Scalar | ||
| currentTimestamp | Scalar |
ExportInfo
| Name | Nullable | Type | Notes |
|---|---|---|---|
| connectionType | enum | ||
| exportConnection | Link to connection identified by name | ||
| sourceDbType | enum | ||
| file | FileInfo | ||
| routine | Scalar | ||
| format | Scalar | ||
| headerRow | Y | enum | |
| options | Scalar | ||
| triggerFile | FileInfo | ||
| triggerParameter1 | Scalar | ||
| triggerParameter2 | Scalar | ||
| triggerParameter3 | Scalar | ||
| compressAfterExport | Scalar | ||
| compressUtility | FileInfo | ||
| compressParameters | Scalar | ||
| whereClause | Scalar |
ExtendedPropertyDefinition
| Name | Nullable | Type | Notes |
|---|---|---|---|
| id | Scalar | ||
| variableName | Scalar | ||
| displayName | Scalar | ||
| description | Scalar | ||
| isMasked | Scalar | ||
| scopes | Array of ExtendedPropertyScope |
ExtendedPropertyScope
| Name | Nullable | Type | Notes |
|---|---|---|---|
| id | Scalar | ||
| connectionType | enum | ||
| objectType | enum | ||
| databaseType | enum |
FK
| Name | Nullable | Type | Notes |
|---|---|---|---|
| fromTable | Link to table identified by name | ||
| fromColumn | Link to column identified by name | ||
| toTable | Link to table identified by name | ||
| toColumn | Link to column identified by name |
FileInfo
| Name | Nullable | Type | Notes |
|---|---|---|---|
| path | Scalar | ||
| name | Scalar | ||
| charSet | Scalar | ||
| fieldDelimiter | Scalar | ||
| fieldEnclosure | Scalar | ||
| recordDelimiter | Scalar | ||
| headerLine | Scalar | ||
| escapeEncoding | Scalar | ||
| nullEncoding | Scalar | ||
| nonStringNullEncoding | Scalar |
HiveNativeDelimitedRowFormat
| Name | Nullable | Type | Notes |
|---|---|---|---|
| delimiter | Scalar | ||
| escapedBy | Scalar | ||
| nullAs | Scalar | ||
| lineTerminator | Scalar | ||
| additionalProperties | Scalar |
HiveNativeFileFormat
| Name | Nullable | Type | Notes |
|---|---|---|---|
| storedAs | Scalar | ||
| inputFormatClass | Scalar | ||
| outputFormatClass | Scalar |
HiveNativeSerdeRowFormat
| Name | Nullable | Type | Notes |
|---|---|---|---|
| serdeName | Scalar | ||
| serdeProperties | Scalar |
HiveNativeStorage
| Name | Nullable | Type | Notes |
|---|---|---|---|
| rowFormat | Scalar | ||
| delimitedRowFormat | HiveNativeDelimitedRowFormat | ||
| serdeRowFormat | HiveNativeSerdeRowFormat | ||
| fileFormat | HiveNativeFileFormat |
HiveNonNativeStorage
| Name | Nullable | Type | Notes |
|---|---|---|---|
| storageClass | Scalar | ||
| serdeProperties | Scalar |
HiveStorage
| Name | Nullable | Type | Notes |
|---|---|---|---|
| external | Scalar | ||
| externalLocation | Scalar | ||
| clustered | Scalar | ||
| clusterColumns | Array of column | ||
| clusterSortColumns | Array of column | ||
| clusterBuckets | Scalar | ||
| skew | Scalar | ||
| skewAsDirectories | Scalar | ||
| skewColumns | Array of column | ||
| skewValues | Scalar | ||
| skipFirstRow | Scalar | ||
| native | Scalar | ||
| nativeStorage | HiveNativeStorage | ||
| nonNativeStorage | HiveNonNativeStorage | ||
| additionalTableProperties | Map of Scalar |
LoadInfo
| Name | Nullable | Type | Notes |
|---|---|---|---|
| loadType | enum | ||
| sourceConnection | Y | Link to connection identified by name | |
| sourceConnectionType | enum | ||
| scriptConnection | Y | Link to connection identified by name | |
| fileParsed | Scalar | ||
| sourceFile | FileInfo | ||
| sqoopSourceFileEnclosureType | enum | ||
| triggerFile | FileInfo | ||
| triggerParameterNamePrefix | Scalar | ||
| wait | Scalar | ||
| waitSeconds | Scalar | ||
| waitAction | enum | ||
| archiveFile | FileInfo | ||
| triggerArchiveFile | FileInfo | ||
| tptHadoopHost | Scalar | ||
| pdwOptions | PDWLoadOptions | ||
| selectDistinctValues | Scalar | ||
| sourceSchema | Scalar | ||
| sourceTables | Scalar | ||
| useOverrideSourceColumns | Scalar | ||
| overrideSourceColumns | Scalar | ||
| whereAndGroupByClauses | Scalar | ||
| overrideLoadSQL | Scalar | ||
| fileLoaderOptions | Scalar | ||
| tempDatabase | Scalar | ||
| tptOptions | TPTLoadOptions | ||
| ssisOptions | SSISLoadOptions | ||
| sqoopOptions | SqoopLoadOptions |
Options
| Name | Nullable | Type | Notes |
|---|---|---|---|
| endOfStatement | Scalar | ||
| extendedPropertyScopesById | Map of ExtendedPropertyScope | ||
| extendedPropertyDefinitionsByName | Map of ExtendedPropertyDefinition | ||
| extendedPropertyDefinitions | Array of definitions |
PDWLoadOptions
| Name | Nullable | Type | Notes |
|---|---|---|---|
| loadMode | Scalar | ||
| upsertKeyColumns | Scalar | ||
| useStagingDatabase | Scalar | ||
| stagingDatabase | Scalar | ||
| useMultiTransMode | Scalar |
Relation
| Name | Nullable | Type | Notes |
|---|---|---|---|
| joinLookup | Scalar | ||
| fk | Scalar | ||
| fks | Array of FK | ||
| ansi | Scalar | ||
| noWarningForUnmatchedBusinessKeys | Scalar | ||
| detailLogForUnmatchedBusinessKeys | Scalar | ||
| useDateColForTrackingChangingDimTable | Scalar | ||
| autoAddUnmatchedBusinessKeys | Scalar | ||
| autoAddProcedure | Scalar | ||
| identifyUnmatchedBusinessKeyMethod | Scalar | ||
| logWhenAutoAdd | Scalar | ||
| currentFlag | Scalar | ||
| trackingDateColumn | Y | column |
Relationship
| Name | Nullable | Type | Notes |
|---|---|---|---|
| joinType | enum | ||
| fromTable | Link to table identified by name | ||
| toTable | Link to table identified by name | ||
| columnJoins | Array of ColumnJoin | ||
| primaryJoin | Scalar |
SSISLoadOptions
| Name | Nullable | Type | Notes |
|---|---|---|---|
| sourceIdentifierEncapsulation | Scalar | ||
| sourceAlwaysUseDefaultCodePage | Scalar | ||
| destinationAlwaysUseDefaultCodePage | Scalar | ||
| useRowCountLog | Scalar | ||
| loadMode | Scalar | ||
| upsertKeyColumns | Scalar | ||
| rollbackOnTableFailure | Scalar | ||
| useStagingDatabase | Scalar | ||
| stagingDatabase | Scalar | ||
| acquireTableLock | Scalar | ||
| commitInterval | Scalar | ||
| sourceIdentifierCaseConversion | enum | ||
| destinationIdentifierCaseConversion | enum | ||
| sourceCodePage | Y | Scalar | |
| destinationCodePage | Y | Scalar | |
| rowsPerBatch | Y | Scalar |
SourceJoinDetails
| Name | Nullable | Type | Notes |
|---|---|---|---|
| distinct | Scalar | ||
| groupBy | Scalar | ||
| join | Scalar | ||
| where | Scalar |
SourceTableInfo
| Name | Nullable | Type | Notes |
|---|---|---|---|
| sourceTable | Link to table identified by name | ||
| lockingMethod | Y | Scalar |
SqoopLoadOptions
| Name | Nullable | Type | Notes |
|---|---|---|---|
| baseTempDir | Scalar | ||
| genericArguments | Scalar | ||
| toolArguments | Scalar | ||
| splitByColumn | Y | Scalar |
Storage
| Name | Nullable | Type | Notes |
|---|---|---|---|
| dataBlockSize | Scalar | ||
| distributionColumns | Array of column | ||
| distributionMethod | Scalar | ||
| fallback | Scalar | ||
| freeSpace | Scalar | ||
| multiSet | Scalar | ||
| optionalCreateClause | Scalar | ||
| organizingColumns | Array of column | ||
| partitionFunction | Scalar | ||
| partitionScheme | Scalar | ||
| partitioned | Scalar | ||
| partitioningColumns | Array of column | ||
| storageIndex | Y | index | |
| hiveStorage | HiveStorage |
TPTLoadOptions
| Name | Nullable | Type | Notes |
|---|---|---|---|
| tptRoutine | Scalar | ||
| characterSet | Scalar | ||
| odbcOperatorAttributes | Scalar | ||
| loadOperatorAttributes | Scalar | ||
| jobName | Scalar | ||
| tbuildOptions | Scalar | ||
| tlogviewOptions | Scalar | ||
| sharedMemorySize | Scalar | ||
| sessionsMin | Scalar | ||
| readInstances | Scalar | ||
| writeInstances | Scalar | ||
| sessionsMax | Y | Scalar |
Table
| Name | Nullable | Type | Notes |
|---|---|---|---|
| id | Scalar | ||
| columns | Array of column | ||
| columnsByName | Map of Column | ||
| database | Scalar | ||
| dbType | enum | ||
| indexes | Array of Link to index identified by name | ||
| name | Scalar | ||
| objectType | enum | ||
| relations | Array of Relation | ||
| relationships | Array of Relationship | ||
| schema | Scalar | ||
| shortName | Scalar | ||
| displayName | Scalar | ||
| description | Scalar | ||
| sourceJoinDetails | SourceJoinDetails | ||
| storage | Storage | ||
| subType | Scalar | ||
| target | Link to target identified by name | ||
| updateProcedure | Y | Link to procedure identified by name | |
| customProcedure | Y | Link to procedure identified by name | |
| getFunction | Y | Link to procedure identified by name | |
| postLoadProcedure | Y | Link to procedure identified by name | |
| loadScript | Y | Link to host script identified by name | |
| postExportProcedure | Y | Link to procedure identified by name | |
| exportScript | Y | Link to host script identified by name | |
| loadInfo | Y | LoadInfo | |
| exportInfo | Y | ExportInfo | |
| viewInfo | Y | ViewInfo | |
| extendedPropertyValuesByName | Map of Scalar | ||
| sourceMappings | Y | Array of Link to source mapping identified by sourceMappingName |
TableAdditionalInformationChange
| Name | Nullable | Type | Notes |
|---|---|---|---|
| changedKey | Scalar | ||
| changedDescription | Scalar | ||
| expectedValue | Scalar | ||
| actualValue | Scalar |
TableCreation
| Name | Nullable | Type | Notes |
|---|---|---|---|
UpdateProcSettings
| Name | Nullable | Type | Notes |
|---|---|---|---|
| batchDateGrain | Scalar | ||
| batchJoinTableColumn | Scalar | ||
| batchProcessingField | Scalar | ||
| changeDetectionEndCurrent | Scalar | ||
| changeDetectionEndExpiring | Scalar | ||
| changeDetectionStartInitial | Scalar | ||
| changeDetectionStartNew | Scalar | ||
| changeDetectionUpdateCurrentRecordsOnly | Scalar | ||
| createStorageIndexAfterCTAS | Scalar | ||
| dateBasedPartitioningInfo | DateBasedPartitioningInfo | ||
| deleteBeforeInsert | Scalar | ||
| deleteBeforeInsertMultiPass | Scalar | ||
| deleteBeforeInsertTruncate | Scalar | ||
| deleteRowsNotInSource | Scalar | ||
| deleteTruncateOption | Scalar | ||
| deleteWhereClause | Scalar | ||
| dssCurrentFlagColumnName | Scalar | ||
| dssEndDateColumnName | Scalar | ||
| dssStartDateColumnName | Scalar | ||
| enableParallelDml | Scalar | ||
| includeExplicitLock | Scalar | ||
| includeInitialLoadInsert | Scalar | ||
| insert | Scalar | ||
| insertHint | Scalar | ||
| insertMinusHint | Scalar | ||
| insertNewRowIdentificationMethodExcept | Scalar | ||
| insertNewRowsOnly | Scalar | ||
| insertZeroKeyRecord | Scalar | ||
| lockClause | Scalar | ||
| merge | Scalar | ||
| mergeChangedRowsOnly | Scalar | ||
| mergeHint | Scalar | ||
| mergeMinusHint | Scalar | ||
| mergeNewRowIdentificationMethodExcept | Scalar | ||
| minimalLogging | Scalar | ||
| nullSupport | Scalar | ||
| parameters | Array of Scalar | ||
| partitionExchangeTable | Y | Link to table identified by name | |
| procedureName | Scalar | ||
| processByBatch | Scalar | ||
| selectHint | Scalar | ||
| sourceJoinDetails | SourceJoinDetails | ||
| sourceTablesByName | Map of SourceTableInfo | ||
| template | Y | template | |
| update | Scalar | ||
| updateChangeRowIdentificationMethodExcept | Scalar | ||
| updateChangedRowsOnly | Scalar | ||
| updateCurrentRowsOnly | Scalar | DEPRECATED: Use updateChangedRowsOnly instead | |
| updateHint | Scalar | ||
| updateMinusHint | Scalar | ||
| warnOnDelete | Scalar |
VanillaSettings
| Name | Nullable | Type | Notes |
|---|---|---|---|
| template | Y | template |
ViewInfo
| Name | Nullable | Type | Notes |
|---|---|---|---|
| viewType | enum | ||
| distinct | Scalar | ||
| whereClause | Scalar | ||
| userDefined | Scalar | ||
| userDefinition | Scalar |