This article applies to the Admin Console > Data > Sources settings.
Automatic Database Discovery enables you to quickly and easily add many Data Objects and Joins from a single Data Source. Discovery can only be performed on the following database types: mssql, oracle, mysql, postgresql, db2, and Informix.
Automatic Database Discovery is not supported for ODBC data sources.
To start using Automatic Database Discovery, select a Data Source from the list and click the Discover Database Metadata icon at the top of the main menu. This will open a discovery tab for the Data Source.
In the discovery tab you can:
- Select the Tables, Views, Functions, and Stored Procedures you would like to add by either:
- checking individual item checkboxes
- clicking Select All Complete Objects to select only those objects with unique key values already defined
- clicking Select All Objects to select all data objects regardless of whether or not unique key values are defined
Objects with identified unique key values will have a key icon () next to them and objects with associated joins will have a join icon () next to them.
Incomplete objects will have a question mark () icon next to them.
- Add Unique Key fields by right-clicking on an object and selecting Add/Edit Primary Key Info.
- Check Preview Only and then Add Objects to preview the selected objects and joins.
- Uncheck Preview Only and then add the selected Data Objects to the system by clicking Add Objects or Add Objects and Joins to add the selected objects and any associated joins.
If any selected Objects are missing unique key values they can be completed individually in a new tab which will open entitled Incomplete Objects.
Customizing Data Discovery SQL v2016.3.6+
The SQL used for Automatic Database Discovery can be customized if necessary, in order to accommodate non-standard key names.
To customize the discovery SQL, locate the file
dbconfigs.json in the
Config/Other folder in the Web Application's install directory, and open it in a text editor.
Locate the property for your data source type and edit the SQL for either or both primary and foreign keys. Save the file, then run Database Discovery to see your changes.