danfo.merge
Merge DataFrame or named Series objects with a database-style join.The join is done on columns or indexes.
danfo.merge(kwargs) [source]
Parameters | Type | Description | Default |
kwargs | Object | { left: A DataFrame or named Series object. right: Another DataFrame or named Series object. on: Column names to join on. Must be found in both the left and right DataFrame and/or Series objects. how: One of } | {how: inner} |
Returns:
return DataFrame
danfo.js merge function is similar to Pandas merge and performs in-memory join operations idiomatically very similar to relational databases like SQL.
danfo.js provides a single function, merge(), as the entry point for all standard database join operations between DataFrame or named Series objects.
For a more intuitive understanding, this guide on the Pandas doc is worth reading.
By default, danfo performs inner join. An inner join requires each row in the two joined DataFrames to have matching column values. This is similar to the intersection of two sets. It returns a DataFrame with only those rows that have common characteristics.
Node
Browser
Node
const dfd = require("danfojs-node")let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'],['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']]let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'],['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']]let colum1 = ['Key1', 'Key2', 'A', 'B']let colum2 = ['Key1', 'Key2', 'A', 'D']let df1 = new dfd.DataFrame(data, { columns: colum1 })let df2 = new dfd.DataFrame(data2, { columns: colum2 })df1.print()df2.print()let merge_df = dfd.merge({ "left": df1, "right": df2, "on": ["Key1"]})merge_df.print()
Browser
Output
Output
//first DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ k0 │ K1 │ A1 │ B1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K2 │ A3 │ B3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝//Second DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ K1 │ K0 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ C2 │ D2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K0 │ C3 │ D3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝//After inner join on column 'Key1'╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B │ Key2_1 │ A_1 │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 │ k0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ K1 │ K0 │ A2 │ B2 │ K0 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 │ K0 │ C2 │ D2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K2 │ A3 │ B3 │ K0 │ C3 │ D3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝
Merging by two keys takes into consideration the keys appearing in bothleft and right DataFrame.
Node
Browser
Node
const dfd = require("danfojs-node")let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'],['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']]let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'],['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']]let colum1 = ['Key1', 'Key2', 'A', 'B']let colum2 = ['Key1', 'Key2', 'A', 'D']let df1 = new dfd.DataFrame(data, { columns: colum1 })let df2 = new dfd.DataFrame(data2, { columns: colum2 })df1.print()df2.print()let merge_df = dfd.merge({ left: df1, right: df2,on: ["Key1", 'Key2'], how: "inner"})merge_df.print()
Browser
Output
Output
//first DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ k0 │ K1 │ A1 │ B1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K2 │ A3 │ B3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝//second DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ K1 │ K0 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ C2 │ D2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K0 │ C3 │ D3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝//After inner join on two keys╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B │ A_1 │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ K1 │ K0 │ A2 │ B2 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 │ C2 │ D2 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝
The how parameter takes other types of joins like left, right and outer join and these are similar to their SQL equivalent
Node
Browser
Node
const dfd = require("danfojs-node")let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'],['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']]let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'],['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']]let colum1 = ['Key1', 'Key2', 'A', 'B']let colum2 = ['Key1', 'Key2', 'A', 'D']let df1 = new dfd.DataFrame(data, { columns: colum1 })let df2 = new dfd.DataFrame(data2, { columns: colum2 })df1.print()df2.print()let merge_df = dfd.merge({ left: df1, right: df2,on: ["Key1"], how: "outer"})merge_df.print()
Browser
Output
Output
//First DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ k0 │ K1 │ A1 │ B1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K2 │ A3 │ B3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝//Second DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ K1 │ K0 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ C2 │ D2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K0 │ C3 │ D3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝//After outer join╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B │ Key2_1 │ A_1 │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 │ k0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ k0 │ K1 │ A1 │ B1 │ NaN │ NaN │ NaN ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 │ K0 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K1 │ K0 │ A2 │ B2 │ K0 │ C2 │ D2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 4 │ K2 │ K2 │ A3 │ B3 │ K0 │ C3 │ D3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝
Node
Browser
Node
const dfd = require("danfojs-node")let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'],['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']]let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'],['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']]let colum1 = ['Key1', 'Key2', 'A', 'B']let colum2 = ['Key1', 'Key2', 'A', 'D']let df1 = new dfd.DataFrame(data, { columns: colum1 })let df2 = new dfd.DataFrame(data2, { columns: colum2 })df1.print()df2.print()let merge_df = dfd.merge({ left: df1, right: df2,on: ["Key1", "Key2"], how: "left"})merge_df.print()
Browser
Output
Output
//first DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ k0 │ K1 │ A1 │ B1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K2 │ A3 │ B3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝//second DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ K1 │ K0 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ C2 │ D2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K0 │ C3 │ D3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝After left join╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B │ A_1 │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ k0 │ K1 │ A1 │ B1 │ NaN │ NaN ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K1 │ K0 │ A2 │ B2 │ C2 │ D2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 4 │ K2 │ K2 │ A3 │ B3 │ NaN │ NaN ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝
Node
Browser
Node
const dfd = require("danfojs-node")let data = [['K0', 'k0', 'A0', 'B0'], ['k0', 'K1', 'A1', 'B1'],['K1', 'K0', 'A2', 'B2'], ['K2', 'K2', 'A3', 'B3']]let data2 = [['K0', 'k0', 'C0', 'D0'], ['K1', 'K0', 'C1', 'D1'],['K1', 'K0', 'C2', 'D2'], ['K2', 'K0', 'C3', 'D3']]let colum1 = ['Key1', 'Key2', 'A', 'B']let colum2 = ['Key1', 'Key2', 'A', 'D']let df1 = new dfd.DataFrame(data, { columns: colum1 })let df2 = new dfd.DataFrame(data2, { columns: colum2 })df1.print()df2.print()let merge_df = dfd.merge({ left: df1, right: df2,on: ["Key1", "Key2"], how: "right"})merge_df.print()
Browser
Output
Output
//first DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ k0 │ K1 │ A1 │ B1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K2 │ A3 │ B3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝//second DataFrame╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ K1 │ K0 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ C2 │ D2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K0 │ C3 │ D3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝//after right join╔═══╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╤═══════════════════╗║ │ Key1 │ Key2 │ A │ B │ A_1 │ D ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 0 │ K0 │ k0 │ A0 │ B0 │ C0 │ D0 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 1 │ K1 │ K0 │ A2 │ B2 │ C1 │ D1 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 2 │ K1 │ K0 │ A2 │ B2 │ C2 │ D2 ║╟───┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────┼───────────────────╢║ 3 │ K2 │ K0 │ NaN │ NaN │ C3 │ D3 ║╚═══╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╧═══════════════════╝
See also danfo.concat for joining objects based on axis.
Last updated 12 months ago