Databricks

Following sections explain the reverse engineering options for Databricks.

Parameter

Description

Additional Information
Reverse Engineer From Specifies whether you want to reverse engineer from a script or database

Database: Indicates that the model is reverse engineered from database

Script File: Indicates that the model is reverse engineered from a script

 
File Specifies the script file location

This option is available when Script File is selected.

While reverse engineering from script, for the LIKE TABLE syntax, ensure that you use the USING clause.

You can connect to your Databricks database using Username-Password or Personal Access Token-Password authentication methods.
For more information on generating and using Personal Access Tokens, click here.

Parameter

Description

Additional Information
Connection Type Specifies the type of connection you want to use. Select Use ODBC Data Source to connect using the ODBC data source that you have defined. Select Use JDBC Connection to connect using JDBC.  
ODBC Data Source Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer. This option is available only when Connection Type is set to Use ODBC Data Source.
Invoke ODBC Administrator Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source. This option is available only when Connection Type is set to Use ODBC Data Source.
Connection String

Specifies the connection string based on your JDBC instance in the following format:

jdbc:spark://<server-hostname>:443/default;transportMode=http;ssl=1;httpPath=<http-path>

This option is available only when Connection Type is set to Use JDBC Connection.

For example, jdbc:spark://dbc-64e36c82-9e5d.cloud.databricks.com:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/2132616201277612/1108-064928-9gy4v7gf

Parameter

Description

Additional Information
Available Catalogs Specifies a list of available unity catalogs To create a unity catalog, refer to the Setting up Unity Catalogs in Databricks topic.
Selected Catalogs Specifies a list of selected unity catalogs for reverse engineering  

Parameter

Description

Additional Information
Available Databases Specifies a list of available databases  
Selected Databases Specifies a list of selected databases for reverse engineering  
System Objects Specifies whether system databases are included under the Available Databases  

Parameter

Description

Additional Information
Available Tables Specifies a list of available tables  
Selected Tables Specifies a list of selected tables for reverse engineering  

Parameter

Description

Additional Information
Available Views Specifies a list of available view objects  
Selected Views Specifies a list of selected view objects for reverse engineering  

Parameter

Description

Additional Information
Option Set Specifies the option set template for reverse engineering

Open: Use this option to open a saved XML option set file.

Save: Use this option to save the configured option set.

Save As: Use this option to save an option set either in the model or in the XML format at some external location.

Delete: Use this option to delete an option set.

<Option Set Name> Specifies the objects to be reverse engineered according to the selected option set. You can edit this list.  

Parameter

Description

Additional Information
NSM Options Specifies the naming standard glossary file in the .CSV format  
Case Conversion of Physical Names Specifies how the case conversion of physical names is handled

None: Indicates that the case in the script file is preserved

lower: Indicates that the names are converted to lower case

UPPER: Indicates that the names are converted to upper case

Force: Indicates whether the physical name property of all the logical/physical models is overridden. If this option is enabled, the logical/physical link is broken between the logical and physical name. If this option is not enabled, all logical and physical names are set to the same value after the process completes.

Case Conversion of Logical Names Specifies how the case conversion of logical names is handled

None: Indicates that the case in the script file is preserved

lower: Indicates that the names are converted to lower case

UPPER: Indicates that the names are converted to upper case

Mixed: Indicates that the mixed-case logical names are preserved

Parameter

Description

Additional Information
Model Specifies the location and name of the reverse engineered model

For example: C:\Scheduler\<Model Name>.erwin

When you schedule a job on a remote server, ensure the model path is same for remote and local server.
Mart Folder Specifies the location or library in your mart where the reverse engineered model is saved
 To use this option, ensure that you are connected to a mart. For more information, refer to the Connecting to Mart topic.
Complete Compare Specifies whether the Complete Compare (CC) process should run while reverse engineering  
Output File Specifies the location of the CC output file generated  
File Specifies that the target model location is on the local system  
Mart Specifies that the target model location is in the mart  
Using Latest Version Specifies whether the target model is the latest version of the model in the mart This option is available only when Mart is selected.
Save To Mart Specifies whether the reverse engineered model is saved to the mart This option is available only when Using Latest Version is selected.
Target Model Specifies the location of the target model for CC  
Option Set Specifies the option set that is used for CC

Advanced Default Option Set: Indicates that all erwin DM metadata is included. CC works slowest with this option.

Speed Option Set: Indicates that only the essential metadata is included. CC works the fastest with this option set.

Standard Default Option Set: Indicates that standard metadata is included. CC works fast with this option set compared to the Advanced option set.

In addition to the above options, click Browse to select a custom option set for complete compare.

Compare Level

Specifies the selection type for the compare

Logical / Physical: Compares all objects on the logical or physical level of a model

Logical: Compares all objects on the logical level of a model

Physical: Compares all objects on the physical level of a model

Database: Compares all objects on the database level of a model

Parameter

Description

Additional Information
erwin Project Specifies whether to configure the model for an existing erwin project  
Model Name Specifies the name of the erwin project  
Location Specifies the location of the project