nushell/docs/commands/dfr_join.md
JT 8c0a2d3c15
Auto-generate markdown command docs (#4451)
* Finish updating

* a couple improvements

* Update renames

* cleanup examples
2022-02-13 21:22:51 -05:00

29 lines
633 B
Markdown

---
title: dfr join
layout: command
version: 0.59.0
---
Joins a dataframe using columns as reference
## Signature
```> dfr join (dataframe) --left --right --type --suffix```
## Parameters
- `dataframe`: right dataframe to join
- `--left {table}`: left column names to perform join
- `--right {table}`: right column names to perform join
- `--type {string}`: type of join. Inner by default
- `--suffix {string}`: suffix for the columns of the right dataframe
## Examples
inner join dataframe
```shell
> let right = ([[a b c]; [1 2 5] [3 4 5] [5 6 6]] | dfr to-df);
$right | dfr join $right -l [a b] -r [a b]
```