com.dimajix.flowman.spec.mapping.UpsertMapping.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flowman-spec Show documentation
A Spark based ETL tool
There is a newer version: 1.2.0-synapse3.3-spark3.3-hadoop3.3
/*
 * Copyright (C) 2019 The Flowman Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.dimajix.flowman.spec.mapping

import com.fasterxml.jackson.annotation.JsonProperty
import org.apache.spark.sql.DataFrame

import com.dimajix.flowman.execution.Context
import com.dimajix.flowman.execution.Execution
import com.dimajix.flowman.model.BaseMapping
import com.dimajix.flowman.model.Mapping
import com.dimajix.flowman.model.MappingOutputIdentifier
import com.dimajix.flowman.transforms.SchemaEnforcer
import com.dimajix.flowman.types.StructType


final case class UpsertMapping(
    instanceProperties:Mapping.Properties,
    input:MappingOutputIdentifier,
    updates:MappingOutputIdentifier,
    keyColumns:Seq[String],
    filter:Option[String] = None
) extends BaseMapping {
    /**
     * Returns the dependencies of this mapping, which is the input table and the updates table
     *
     * @return
     */
    override def inputs : Set[MappingOutputIdentifier] = {
        Set(input, updates) ++ expressionDependencies(filter)
    }

    /**
      * Executes this MappingType and returns a corresponding DataFrame
      *
      * @param execution
      * @param tables
      * @return
      */
    override def execute(execution: Execution, tables: Map[MappingOutputIdentifier, DataFrame]): Map[String,DataFrame] = {
        require(execution != null)
        require(tables != null)

        require(input != null && input.nonEmpty, "Missing input table")
        require(updates != null && updates.nonEmpty, "Missing updates table")
        require(keyColumns.nonEmpty, "Missing key columns")

        val inputDf = tables(input)
        val updatesDf = tables(updates)

        // Apply optional filter to updates (for example for removing DELETEs)
        val filteredUpdates = applyFilter(updatesDf, filter, tables)

        // Project updates DataFrame to schema of input DataFrame
        val conformer = SchemaEnforcer(inputDf.schema)
        val projectedUpdates = conformer.transform(filteredUpdates)

        // Perform update operation
        val joinCondition = keyColumns.map(col => inputDf(col) <=> updatesDf(col)).reduce(_ && _)
        val result = inputDf.join(updatesDf, joinCondition, "left_anti")
            .union(projectedUpdates)

        Map("main" -> result)
    }

    /**
      * Returns the schema as produced by this mapping, relative to the given input schema
      * @param input
      * @return
      */
    override def describe(execution:Execution, input:Map[MappingOutputIdentifier,StructType]) : Map[String,StructType] = {
        require(execution != null)
        require(input != null)

        val result = input(this.input)

        // Apply documentation
        val schemas = Map("main" -> result)
        applyDocumentation(schemas)
    }
}



class UpsertMappingSpec extends MappingSpec {
    @JsonProperty(value = "input", required = true) private var input: String = _
    @JsonProperty(value = "updates", required = true) private var updates: String = _
    @JsonProperty(value = "keyColumns", required = true) private var keyColumns: Seq[String] = Seq()
    @JsonProperty(value = "filter", required = false) private var filter: Option[String] = None

    /**
      * Creates the instance of the specified Mapping with all variable interpolation being performed
      * @param context
      * @return
      */
    override def instantiate(context: Context, properties:Option[Mapping.Properties] = None): UpsertMapping = {
        UpsertMapping(
            instanceProperties(context, properties),
            MappingOutputIdentifier(context.evaluate(input)),
            MappingOutputIdentifier(context.evaluate(updates)),
            keyColumns.map(context.evaluate),
            filter.map(context.evaluate).map(_.trim).filter(_.nonEmpty)
        )
    }
}