Skip to content

Commit 0202cb9

Browse files
mendonkaimurphy
andauthored
docs: concatenate and merge options for dataframe operations component (#12819)
* add-concatenate-and-merge-options * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> --------- Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
1 parent 5d6a7a0 commit 0202cb9

2 files changed

Lines changed: 50 additions & 0 deletions

File tree

docs/docs/Components/dataframe-operations.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,16 @@ The **Add Column** operation allows you to add a new column to the `Table` with
109109

110110
The parameters are **New Column Name** (`new_column_name`) and **New Column Value** (`new_column_value`).
111111

112+
</TabItem>
113+
<TabItem value="concatenate" label="Concatenate">
114+
115+
The **Concatenate** operation combines multiple input `Table` objects into a single `Table` by stacking their rows vertically.
116+
For example, if you have Table A and Table B, they are combined into one table with all rows from Table A, and then all rows from Table B.
117+
118+
This operation uses the **Table** (`df`) input.
119+
Connect multiple `Table` outputs to the same input to concatenate them.
120+
The output is a single `Table` containing the combined rows from all connected inputs.
121+
112122
</TabItem>
113123
<TabItem value="dropcolumn" label="Drop Column">
114124

@@ -134,6 +144,21 @@ The default is `5`.
134144

135145
The output is a `Table` containing only the selected rows.
136146

147+
</TabItem>
148+
<TabItem value="merge" label="Merge">
149+
150+
The **Merge** operation combines two input `Table` objects by matching rows that share the same value in a selected column.
151+
For example, if one table has `id` and `name`, and another has `id` and `department`, you can merge both tables on `id` to produce one table with `id`, `name`, and `department`.
152+
153+
Provide the following parameters:
154+
155+
* **Left Table** (`left_dataframe`): The primary table in the merge.
156+
* **Right Table** (`right_dataframe`): The secondary table in the merge.
157+
* **Merge On Column** (`merge_on_column`): The shared column used to match rows. This column must exist in both tables.
158+
* **Merge Type** (`merge_how`): Controls which matched and unmatched rows are kept in the output. Use `inner` to keep only matching rows, `left` to keep all rows from the left table, `right` to keep all rows from the right table, or `outer` to keep all rows from both tables.
159+
160+
The output is a `Table` containing matched records from both inputs.
161+
137162
</TabItem>
138163
<TabItem value="renamecolumn" label="Rename Column">
139164

docs/versioned_docs/version-1.9.0/Components/dataframe-operations.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,16 @@ The **Add Column** operation allows you to add a new column to the `Table` with
109109

110110
The parameters are **New Column Name** (`new_column_name`) and **New Column Value** (`new_column_value`).
111111

112+
</TabItem>
113+
<TabItem value="concatenate" label="Concatenate">
114+
115+
The **Concatenate** operation combines multiple input `Table` objects into a single `Table` by stacking their rows vertically.
116+
For example, if you have Table A, and Table B, they are combined into one table with all rows from Table A, and then all rows from Table B.
117+
118+
This operation uses the **Table** (`df`) input.
119+
Connect multiple `Table` outputs to the same input to concatenate them.
120+
The output is a single `Table` containing the combined rows from all connected inputs.
121+
112122
</TabItem>
113123
<TabItem value="dropcolumn" label="Drop Column">
114124

@@ -134,6 +144,21 @@ The default is `5`.
134144

135145
The output is a `Table` containing only the selected rows.
136146

147+
</TabItem>
148+
<TabItem value="merge" label="Merge">
149+
150+
The **Merge** operation combines two input `Table` objects by matching rows that share the same value in a selected column.
151+
For example, if one table has `id` and `name`, and another has `id` and `department`, you can merge both tables on `id` to produce one table with `id`, `name`, and `department`.
152+
153+
Provide the following parameters:
154+
155+
* **Left Table** (`left_dataframe`): The primary table in the merge.
156+
* **Right Table** (`right_dataframe`): The secondary table in the merge.
157+
* **Merge On Column** (`merge_on_column`): The shared column used to match rows. This column must exist in both tables.
158+
* **Merge Type** (`merge_how`): Controls which matched and unmatched rows are kept in the output. Use `inner` to keep only matching rows, `left` to keep all rows from the left table, `right` to keep all rows from the right table, or `outer` to keep all rows from both tables.
159+
160+
The output is a `Table` containing matched records from both inputs.
161+
137162
</TabItem>
138163
<TabItem value="renamecolumn" label="Rename Column">
139164

0 commit comments

Comments
 (0)