VectorJoin

The VectorJoin operator allows combining multiple vector inputs into a single feature collection. There are multiple join variants defined, which are described below.

For instance, you want to join tabular data to a point collection of buildings. The point collection contains the geolocation of the buildings and their id. The attribute data collection has the building id and the height information. Combining the two feature collections leads to a single point collection with geolocation and height information.

Parameters

ParameterTypeDescriptionExample Value
typeA value of EquiGeoToData, …The type of join
"EquiGeoToData"

EquiGeoToData

ParameterTypeDescriptionExample Value
leftColumnstringThe column name of the left input
"id"
rightColumnstringThe column name of the right input
"id"
rightColumn_suffix(Optional) stringA value to suffix the right join column to avoid name clashes with the columns of the left input. If nothing is specified, the default value is right.
"right"

Inputs

The VectorJoin operator expects two vector inputs.

ParameterType
leftSingleVectorSource
rightSingleVectorSource

Errors

If the value in the left parameter is not a column of the left feature collection, an error is thrown.

If the value in the right parameter is not a column of the right feature collection, an error is thrown.

EquiGeoToData

If the left input is not a geo data collection, an error is thrown.

If the right input is not a (non-geo) data collection, an error is thrown.

Example JSON

{
  "type": "VectorJoin",
  "params": {
    "type": "EquiGeoToData",
    "leftColumn": "id",
    "rightColumn": "id",
    "rightColumnSuffix": "_other"
  },
  "sources": {
    "points": {
      "type": "OgrSource",
      "params": {
        "dataset": {
          "type": "internal",
          "datasetId": "e977b123-ca47-4c5b-aace-481119826aaf"
        },
        "attributeProjection": ["name", "population"]
      }
    },
    "polygons": {
      "type": "OgrSource",
      "params": {
        "dataset": {
          "type": "internal",
          "datasetId": "b6191257-6d61-4c6b-90a4-ebfb1b23899d"
        }
      }
    }
  }
}