SQL Databases
The following are the connection parameters of SQL databases supported in erwin DM.
Parameter |
Description |
Additional Information |
---|---|---|
Database | Specifies the database to which you want to connect | |
Authentication | Specifies the type of authentication to use to establish a connection |
Database Authentication: Indicates that database access credentials are used to establish a connection for reverse engineering. |
User Name | Specifies the user name to access the database | Available when Database Authentication is selected. |
Password | Specifies the password to access the database | |
Connection Method | Specifies the type of connection you want to use. Select JDBC to connect using JDBC. Or, select ODBC to connect using the ODBC data source that you have defined. | |
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 when Connection Method is set to ODBC. |
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 when Connection Method is set to ODBC. For Reverse Engineering from a PostgreSQL or AlloyDB database, use the PostgreSQL ANSI ODBC driver. |
Connection String |
Specifies the connection string for PostgreSQL database server in the following formats:
|
This option is available when Connection Method is set to JDBC. For example,
|
Database |
Specifies the name of the database to which you want to connect |
This option is available when Connection Method is set to JDBC. |
Parameter |
Description |
Additional Information |
---|---|---|
Authentication |
Specifies the database connection authentication type. Select Database Authentication to connect using the database login credentials. Or, select Multi Factor Authentication type to use multi-factor authentication for database connection. |
Multi Factor Authentication is only available for ODBC connection. |
Connection Method | Specifies the type of connection you want to use. Select JDBC to connect using JDBC. Or, select ODBC to connect using the ODBC data source that you have defined. | Reverse engineering a model from a database using the ODBC connection retrieves only 64 characters. |
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 Method is set to ODBC. |
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 Method is set to ODBC. |
Connection String |
Specifies the connection string based on your JDBC instance and Azure Synapse database name in the following format: jdbc: sqlserver://<server name>.sql.azuresynapse.net:1433; |
For example, jdbc:sqlserver://localhost.sql.azuresynapse.net:1433; This option is available when Connection Method is set to JDBC. |
Database | Specifies the name of the database that you want to connect to | This option is available when Connection Method is set to JDBC. |
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 |
---|---|---|
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. | |
Alternate Catalog | Specifies the name of the alternate catalog that you want to use for the connection. If you leave this value empty, the application connects to the system catalog. If necessary, consider connecting to the alternate catalog for faster reverse engineering. | |
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. |
Parameter |
Description |
Additional Information |
---|---|---|
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. | |
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. |
Parameter |
Description |
Additional Information |
---|---|---|
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. | |
Alternate Catalog | Specifies the name of the alternate catalog that you want to use for the connection. If you leave this value empty, the application connects to the system catalog. If necessary, consider connecting to the alternate catalog for faster reverse engineering. | |
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. |
Parameter |
Description |
Additional Information |
---|---|---|
Metastore Database | Specifies the relational database that stores the metadata for Hive tables and partitions in a relational database | Ensure that you install the drivers that correspond to the Metastore Database that you select. |
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. | |
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. | For FE or Alter Script process, on the Hive Connection dialog, always set the Metastore Database to Default and the ODBC Data Source to relevant Hive connection driver. |
Parameter |
Description |
Additional Information |
---|---|---|
Database | Specifies the database to which you want to connect | |
Authentication | Specifies the type of authentication to use to establish connection |
Database Authentication:Indicates that database access credentials are used to establish connection for reverse engineering. |
User Name | Specifies the user name to access the database | |
Password | Specifies the password to access the database | |
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. | |
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. |
Parameter |
Description |
Additional Information |
---|---|---|
Connection Method | Specifies the type of connection you want to use. Select JDBC to connect using JDBC. Or, select ODBC to connect using the ODBC data source that you have defined. |
For the JDBC connection to work seamlessly, ensure that you:
|
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 when Connection Method is set to ODBC. |
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 when Connection Method is set to ODBC. |
Database | Specifies the name of the database that you want to connect to | |
Connection String |
Specifies the connection string for MariaDB database server in the following format: jdbc:mariadb. |
This option is available when Connection Method is set to JDBC. |
Hostname/IP | Specifies the hostname or IP address of the server where your database is hosted | This option is available when Connection Method is set to JDBC. |
Port | Specifies the port configured for your database | This option is available when Connection Method is set to JDBC. |
Parameter |
Description |
Additional Information |
---|---|---|
Connection Method | Specifies the type of connection you want to use. Select JDBC to connect using JDBC. Or, select ODBC to connect using the ODBC data source that you have defined. |
erwin DM 2021 R1 does not support the Unicode driver. For Reverse Engineering a MySQL database, use the MySQL ANSI ODBC driver. For the JDBC connection to work seamlessly, ensure that you:
|
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 when Connection Method is set to ODBC. |
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 when Connection Method is set to ODBC. |
Hostname/IP | Specifies the hostname or IP address of the server where your database is hosted | This option is available when Connection Method is set to JDBC. |
Port | Specifies the port configured for your database | This option is available when Connection Method is set to JDBC. |
MySQL on Azure |
Indicates whether the database is hosted on Azure |
This option is available when Connection Method is set to JDBC. |
Parameter |
Description |
Additional Information |
---|---|---|
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. | |
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. |
Parameter |
Description |
Additional Information |
---|---|---|
Connection Method | Specifies the type of connection you want to use. Select ODBC to connect using the ODBC data source that you have defined. Select JDBC 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 when Connection Method is set to ODBC. |
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 when Connection Method is set to ODBC. |
Instance |
Specifies the JDBC instance to which you want to connect. For a cloud-based connection, the instance name is as follows: TNS_ADMIN=<Path of unzipped cloud wallet file> |
Ensure that you have downloaded, saved, and unzipped the cloud wallet file. This option is available when Connection Method is set to JDBC. |
Connection String |
Specifies the connection string based on your JDBC instance in the following format: jdbc:oracle:thin:@//<servername>:1521/ For a cloud instance, the connection string is as follows: jdbc:oracle:thin:@<dbname_priority>? |
This option is available when connection method is set to JDBC. For example, JDBC instance: JDBC:ORACLE:thin:@//localhost:1521/ Cloud instance: jdbc:oracle:thin:@dbtest_medium? This option is also available in erwin Data Modeler Workgroup Edition. |
Parameter |
Description |
Additional Information |
---|---|---|
Database | Specifies the database to which you want to connect | |
Authentication | Specifies the type of authentication to use to establish a connection |
Database Authentication: Indicates that database access credentials are used to establish a connection for reverse engineering. |
User Name | Specifies the user name to access the database | Available when Database Authentication is selected. |
Password | Specifies the password to access the database | |
Connection Method | Specifies the type of connection you want to use. Select JDBC to connect using JDBC. Or, select ODBC to connect using the ODBC data source that you have defined. | |
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 when Connection Method is set to ODBC. |
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 when Connection Method is set to ODBC. For Reverse Engineering from a PostgreSQL or AlloyDB database, use the PostgreSQL ANSI ODBC driver. |
Connection String |
Specifies the connection string for PostgreSQL database server in the following formats:
|
This option is available when Connection Method is set to JDBC. For example,
|
Database |
Specifies the name of the database to which you want to connect |
This option is available when Connection Method is set to JDBC. |
Parameter |
Description |
Additional Information |
---|---|---|
Database | Specifies the database to which you want to connect | |
Authentication | Specifies the type of authentication to use to establish connection |
Database Authentication:Indicates that database access credentials are used to establish connection for reverse engineering. |
User Name | Specifies the user name to access the database | |
Password | Specifies the password to access the database | |
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. | |
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. |
Parameter |
Description |
Additional Information |
---|---|---|
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. | |
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. |
Parameter |
Description |
Additional Information |
---|---|---|
Connection Method | Specifies the type of connection you want to use. Select ODBC to connect using the ODBC data source that you have defined. Select JDBC 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 when Connection Method is set to ODBC. |
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 when Connection Method is set to ODBC. |
Database | Specifies the name of the database that you want to connect to |
This option is available when Connection Method is set to JDBC. This option is also available in erwin Data Modeler Workgroup Edition. |
Connection String |
Specifies the connection string based on your JDBC instance and SAP ASE database name in the following format: jdbc:sybase:Tds:<servername>:5000 |
For example, jdbc:sybase:Tds:localhost:5000 This option is available when Connection Method is set to JDBC. |
Server | Specifies the server name | This option is also available in erwin Data Modeler Workgroup Edition. |
Parameter |
Description |
Additional Information |
---|---|---|
Server | Specifies the name of the server where the database is installed | |
Database | Specifies the name of the database that you want to connect to |
Parameter |
Description |
Additional Information |
---|---|---|
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. | |
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. |
Parameter |
Description |
Additional Information |
---|---|---|
Connection Method | Specifies the type of connection you want to use. Select JDBC to connect using JDBC. Or select ODBC to connect using the ODBC data source that you have defined. | |
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 when Connection Method is set to ODBC. |
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 when Connection Method is set to ODBC. |
Connection String |
Specifies the connection string based on your JDBC instance and Snowflake database name |
This option is available when Connection Method is set to JDBC. For example: jdbc:snowflake://<account_name>.snowflakecomputing.com/ |
Database | Specifies the name of the database that you want to connect to | This option is available when Connection Method is set to JDBC. |
Warehouse | Specifies the name of the warehouse that you want to connect to | This option is available when Connection Method is set to JDBC. |
Role | Specifies the role that you want to use to connect to the database | This option is available when Connection Method is set to JDBC. |
Schema | Specifies the name of the schema that you want to connect to |
This option is available when Connection Method is set to JDBC. Ensure that, you specify the schema name in this field to retrieve all database objects and properties during a reverse engineering process. |
Authentication URL | Specifies the authentication URL |
This option is available when Connection Method is set to JDBC. Set the value as EXTERNALBROWSER when you connect using OKTA or AzureAD. |
Private Key File (For Key-Pair Auth) | Specifies the path to private key file for key-pair authentication. |
For example: C:\Users\<User>\Documents\Keys\rsa_key.p8 This option is available when Connection Method is set to JDBC. Ensure that you generate a public key and private key for using key pair authentication. To generate key, refer to the Snowflake Key-Pair Authentication topic. |
Private Key File Password (For Key-Pair Auth) | Specifies the path to private key pass phrase file for key-pair authentication | This option is available when Connection Method is set to JDBC. |
Parameter |
Description |
Additional Information |
---|---|---|
Connection Method | Specifies the type of connection you want to use. Select Use Native Connection to connect using the API provided by the SQL Server Native client software. Select Use ODBC Data to connect using the ODBC data source that you have defined. Select Use JDBC Connection to connect using JDBC. | |
Server | Specifies the name of the server where the database is installed | This option is also available in erwin Data Modeler Workgroup Edition. |
Database | Specifies the name of the database that you want to connect to | This option is also available in erwin Data Modeler Workgroup Edition. |
Use Encrypted Connection |
Indicates that the SQL Server connection that is being established is encrypted to guarantee privacy |
|
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. | |
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. | |
Instance | Specifies the JDBC instance to which you want to connect | |
Connection String |
Specifies the connection string based on your JDBC instance and SQL Server database name in the following format: jdbc:sqlserver://<servername>:1433;database=<SqlDBname> |
For example, jdbc:sqlserver://localhost:1433 |
Parameter |
Description |
Additional Information |
---|---|---|
Connection Type | Specifies the type of connection you want to use. Select Use Native Connection to connect using the API provided by the SQL Server Native client software. Select Use ODBC Data to connect using the ODBC data source that you have defined. Select Use JDBC Connection to connect using JDBC. | |
Server | Specifies the name of the server where the database is installed | You may need to append the SQL Azure server name to the login in the connection string using the <login>@<server> notation. If you do, separate the login and the SQL Azure server name with the at (@) symbol. For more information, see Connecting to SQL Azure. |
Database | Specifies the name of the database that you want to connect to | |
Use Encrypted Connection |
Indicates that the SQL Server connection that is being established is encrypted to guarantee privacy |
|
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. | |
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. | |
Instance | Specifies the JDBC instance to which you want to connect | |
Connection String |
Specifies the connection string based on your JDBC instance and SQL Server database name in the following format: jdbc:sqlserver://<servername>:1433;database=<SqlDBname> |
For example, jdbc:sqlserver://localhost:1433 |
Connect to Managed Instance | Specifies whether the connection should be to an Azure SQL Managed Instance | erwin Data Modeler 2021 R1 supports Azure AD accounts connection via ODBC. |
Parameter |
Description |
Additional Information |
---|---|---|
Database | Specifies the database to which you want to connect | |
Authentication | Specifies the type of authentication to use to establish connection |
Database Authentication:Indicates that database access credentials are used to establish connection for reverse engineering. Windows Authentication:Indicates that Windows credentials are used to establish connection for reverse engineering. |
User Name | Specifies the user name to access the database | Available when Database Authentication is selected. |
Password | Specifies the password to access the database | |
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. | |
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. |
erwin Data Modeler (DM) 32-bit version does not support JDBC connectivity.
Copyright © 2024 Quest Software, Inc. |