Skip to content

Commit

Permalink
Merge pull request #516 from scSenicourt/github-515
Browse files Browse the repository at this point in the history
github-515 Fix documentation of JoinMapping
  • Loading branch information
kupferk authored Jan 10, 2025
2 parents 89d3026 + ca6658f commit f5b4554
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/spec/mapping/join.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ mappings:
inputs:
- transactions
- enrichment
expression: "transactions.ext_id = enrichment.id"
condition: "transactions.ext_id = enrichment.id"
```

## Fields
Expand All @@ -30,17 +30,17 @@ Cache mode for the results of this mapping. Supported values are
* `inputs` **(mandatory)** *(type: list:string)*:
Specifies the names of the input mappings to be filtered.

* `expression` **(optional)** *(type: string)* *(default: empty)*:
* `condition` **(optional)** *(type: string)* *(default: empty)*:
Specifies the join condition. You can reference the input mappings by their name. Note that
for using an expression, the `join` mapping requires exactly two input mappings.
for using a condition, the `join` mapping requires exactly two input mappings.

* `columns` **(optional)** *(type: list:string)* *(default: empty)*:
As an alternative to explicitly specifying a join condition, you can also specify a list
of column names to join on. These columns need to be existing in all input mappings.

* `mode` **(optional)** *(type: string)* *(default: left)*:
Specifies the join mode. The following modes are supported:
`inner`, `cross`, `outer`, `full`, `full_outer`, `left`, `left_outer`, `right`, `right_outer`.
`inner`, `cross`, `outer`, `full`, `full_outer`, `left`, `left_outer`, `left_anti`, `left_semi`, `right`, `right_outer`.

* `filter` **(optional)** *(type: string)* *(default: empty)*:
An optional SQL filter expression that is applied *after* join operation.
Expand Down

0 comments on commit f5b4554

Please sign in to comment.