# join-连接
调用join函数，基于索引或指定列的方式连接另一个DataFrame增强数据表对象。
最小支持版本：5.0.0
# 接口说明
已获取DataFrame实例，详情请参见readCSV (opens new window)。
# 语法
<DataFrame object>.join(<other>, <on>, <how>, <leftSuffix>, <rightSuffix>, <sort>)
1
<DataFrame object>.连接(<other>, <on>, <how>, <leftSuffix>, <rightSuffix>, <sort>)
1
# 函数类型
实例函数
# 请求参数
| 参数名称 | 类型 | 是否必选 | 默认值 | 示例值 | 描述 |
|---|---|---|---|---|---|
| other | Cube.Object | 是 | 无 | DataFrame实例2 | 待连接的对象。取值： Cube.System.DataFrame Cube.System.Series Cube.System.DataFrame列表 如果是Cube.System.Series对象，它的name属性必须被设置，它会被当做列名进行连接。 |
| on | Cube.Object | 是 | 无 | "joinName" | 使用指定的列与待连接对象的索引相等的进行连接，默认是使用当前对象与待连接对象的索引相等的进行连接。 |
| how | Cube.Lang.String | 是 | 无 | "left" | 如何连接。取值： "left"：左连接，当前对象的Index（或者列，如果on参数指定的话）作为索引。 "right"：右连接，待调用对象的Index作为索引。 "outer"：外连接，当前对象的Index（或者列，如果on参数指定的话）与待调用对象的Index的并集作为索引，并且最终使用字典序排序。 "inner"：内连接，当前对象的Index（或者列，如果on参数指定的话）与待调用对象的Index的交集作为索引，最终保留当前对象的索引的顺序。 |
| leftSuffix | Cube.Lang.String | 是 | 无 | "left" | 左侧重叠列列名的后缀。 |
| rightSuffix | Cube.Lang.String | 是 | 无 | "right" | 右侧重叠列列名的后缀。 |
| sort | Cube.Lang.Boolean | 是 | true | true | 是否按连接键的字典序进行排序。取值： true：按连接键字典序排序。 false：不按连接键字典序排序。 如果为false，连接键的顺序取决于连接类型（how关键字）。 |
# 返回参数
| 参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Result | Cube.System.DataFrame | Cube.System.DataFrame | 连接后的DataFrame增强数据表对象。 |
# 请求示例
DataFrame实例.join(DataFrame实例2)
1
最近更新时间: {
"value": "2023-09-12",
"effect": true
}