Skip to main content
This page describes the schema for join input objects used to define table relationships.

​
JoinInput

Input type for specifying join relationships between tables when updating data sources in a domain.
​
leftTable
TableInput!
required
The left table in the join relationship. See TableInput.
​
rightTable
TableInput!
required
The right table in the join relationship. See TableInput.
​
relationshipType
RelationshipType!
required
The type of relationship between the tables. See RelationshipType.
​
joinConditions
[JoinConditionInput!]!
required
List of join conditions that define how the tables are connected. See JoinConditionInput.

​
JoinConditionInput

Defines a single join condition between two table columns.
​
leftColumnName
String!
required
The name of the column in the left table to join on.
​
rightColumnName
String!
required
The name of the column in the right table to join on.

​
RelationshipType

The RelationshipType enum defines the cardinality between joined tables and can be set to one of the following values:
Relationship TypeDescription
RELATIONSHIP_TYPE_UNKNOWNRelationship type is not specified or unclear.
ONE_TO_ONEEach record in the left table matches exactly one record in the right table.
ONE_TO_MANYEach record in the left table can match multiple records in the right table.
MANY_TO_ONEMultiple records in the left table can match one record in the right table.
MANY_TO_MANYMultiple records in the left table can match multiple records in the right table.

Update Data Sources

Use JoinInput to define table relationships

TableInput Schema

Configure tables that participate in joins

DomainModel Schema

Understand how joins fit within domain structure

Create Domain

Start with domain creation before adding joins