Skip to main content
Import relationships and keys


Import relationships and keys

Information about primary and foreign keys shared between related entities can be imported from Excel (.xlsx) files. Once imported, these relationships are displayed in several places in the UI:

  • In the Catalog module (on the Entity Details page)
  • In Field Detail screens (General Information and Lineage tabs) in Source and Discover modules
  • In Field and External Field grids, if User Preferences are selected to make Primary Key and/or Foreign Key visible
  • In Prepare, Primary and Foreign Keys in Source Entities are indicated for assistance with Transforms involving Joins

These relationships are discovered and populated in metadata table pd_field_related_field by either of the following methods:

  • Fetched from JDBC sources upon discovery/ingest

  • Inferred by the Relationship Inference Engine

  • Imported from external metadata (described in this section)

XLSX: Structure and format specification

An Excel (.XLSX) file is created and formatted manually by end users.

The file used to import relationships and keys can populate the relationship and primary/foreign key information for type of entities [i.e., PREPARE_TARGET, USER, INTERNAL, EXTERNAL].

Validations are done to ensure that parent and child objects exist in the target environment and verify the relations between parent and child objects are valid.

The following relationships between Parent and Child Entities are supported. The Child Objects hold the Foreign Key discovered by the various methods described above. [“User (View)” is a saved Query / Target Entity created in Explore.]

Supported relationships

Parent Entity Types

Child Entity Types






Prepare_Target, User (View)

User (View)

Prepare_Target, User (View)

XLSX Example: Note that User can ADD or REMOVE the Foreign Key relationship in the Action column.

XLSX Example

Importing Relationships and Keys: Select IMPORT/EXPORT METADATA. Click on the radio button for Import and Select Relationships and Keys from dropdown. Choose the Excel file from laptop or local directory and select whether the relationship will be imported to external and/ or internal entities:

Import/Export Relationships and Keys

Upon FINISHED Job Status, users will see Primary Keys and Foreign Keys denoted in the UI.

Import/Export Metadata finished

Catalog:Related Entities Grid, the Entity containing Primary Key will be the PARENT

Catalog Related Entities

Prepare: Primary Key and Foreign Keys display on the canvas.

Primary and Foreign Keys

External and Internal Field General Information tab

Field General Information Tab

Field and External Field grids, if User Preferences are selected to make Primary Key and/or Foreign Key visible

Field and External Field Grids