-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Add column renaming transformer. * Extend e2e the test suite with the renaming transformer. * Add renaming transformer usage description to README.md.
- Loading branch information
Showing
9 changed files
with
336 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
...ingestor/implementation/transformer/column/renaming/ColumnRenamingStreamTransformer.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * Copyright 2018 ABSA Group Limited | ||
| * | ||
| * 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 za.co.absa.hyperdrive.ingestor.implementation.transformer.column.renaming | ||
|
|
||
| import org.apache.commons.configuration2.Configuration | ||
| import org.apache.logging.log4j.LogManager | ||
| import org.apache.spark.sql.DataFrame | ||
| import za.co.absa.hyperdrive.ingestor.api.transformer.{StreamTransformer, StreamTransformerFactory} | ||
|
|
||
| private[transformer] class ColumnRenamingStreamTransformer(val columnsFrom: Seq[String], val columnsTo: Seq[String]) extends StreamTransformer { | ||
| if (columnsFrom.isEmpty || columnsTo.isEmpty) { | ||
| throw new IllegalArgumentException("Empty list of columns to rename.") | ||
| } | ||
|
|
||
| if (columnsFrom.size != columnsTo.size) { | ||
| throw new IllegalArgumentException("The size of source column names doesn't match the list of target column names " + | ||
| s"${columnsFrom.size} != ${columnsTo.size}.") | ||
| } | ||
|
|
||
| override def transform(streamData: DataFrame): DataFrame = { | ||
| val renamings = columnsFrom.zip(columnsTo) | ||
|
|
||
| renamings.foldLeft(streamData){ case (df, (from, to)) => | ||
| df.withColumnRenamed(from, to) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| object ColumnRenamingStreamTransformer extends StreamTransformerFactory with ColumnRenamingStreamTransformerAttributes { | ||
| override def apply(config: Configuration): StreamTransformer = { | ||
| val columnsFrom = config.getStringArray(KEY_COLUMNS_FROM) | ||
| val columnsTo = config.getStringArray(KEY_COLUMNS_TO) | ||
| LogManager.getLogger.info(s"Going to create ColumnRenamingStreamTransformer using: " + | ||
| s"columnsFrom='${columnsFrom.mkString(",")}', columnsTo='${columnsTo.mkString(",")}'") | ||
| new ColumnRenamingStreamTransformer(columnsFrom, columnsTo) | ||
| } | ||
| } |
32 changes: 32 additions & 0 deletions
32
...mplementation/transformer/column/renaming/ColumnRenamingStreamTransformerAttributes.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* | ||
| * Copyright 2018 ABSA Group Limited | ||
| * | ||
| * 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 za.co.absa.hyperdrive.ingestor.implementation.transformer.column.renaming | ||
|
|
||
| import za.co.absa.hyperdrive.ingestor.api.{HasComponentAttributes, PropertyMetadata} | ||
|
|
||
| trait ColumnRenamingStreamTransformerAttributes extends HasComponentAttributes { | ||
| val KEY_COLUMNS_FROM = "columns.rename.from" | ||
| val KEY_COLUMNS_TO = "columns.rename.to" | ||
|
|
||
| override def getName: String = "Column Renaming Transformer" | ||
|
|
||
| override def getDescription: String = "This transformer renames given columns. Column expressions are not possible" | ||
|
|
||
| override def getProperties: Map[String, PropertyMetadata] = Map( | ||
| KEY_COLUMNS_FROM -> PropertyMetadata("Source column names", Some("Comma separated list of columns to be renames."), required = true), | ||
| KEY_COLUMNS_TO -> PropertyMetadata("Target column names", Some("Comma separated list of new names of the columns. The number of columns should match the list of source columns."), required = true) | ||
| ) | ||
| } |
22 changes: 22 additions & 0 deletions
22
...or/implementation/transformer/column/renaming/ColumnRenamingStreamTransformerLoader.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /* | ||
| * Copyright 2018 ABSA Group Limited | ||
| * | ||
| * 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 za.co.absa.hyperdrive.ingestor.implementation.transformer.column.renaming | ||
|
|
||
| import za.co.absa.hyperdrive.ingestor.api.transformer.{StreamTransformerFactory, StreamTransformerFactoryProvider} | ||
|
|
||
| class ColumnRenamingStreamTransformerLoader extends StreamTransformerFactoryProvider { | ||
| override def getComponentFactory: StreamTransformerFactory = ColumnRenamingStreamTransformer | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 126 additions & 0 deletions
126
...stor/implementation/transformer/column/renaming/TestColumnRenamingStreamTransformer.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| /* | ||
| * Copyright 2018 ABSA Group Limited | ||
| * | ||
| * 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 za.co.absa.hyperdrive.ingestor.implementation.transformer.column.renaming | ||
|
|
||
| import org.apache.commons.configuration2.convert.DefaultListDelimiterHandler | ||
| import org.apache.commons.configuration2.{BaseConfiguration, DynamicCombinedConfiguration} | ||
| import org.apache.spark.sql.DataFrame | ||
| import org.apache.spark.sql.functions.col | ||
| import org.apache.spark.sql.execution.streaming.MemoryStream | ||
| import org.apache.spark.sql.streaming.{OutputMode, Trigger} | ||
| import org.scalatest.{BeforeAndAfter, FlatSpec, Matchers} | ||
| import za.co.absa.commons.io.TempDirectory | ||
| import za.co.absa.commons.spark.SparkTestBase | ||
| import za.co.absa.hyperdrive.ingestor.api.writer.StreamWriterProperties | ||
| import za.co.absa.hyperdrive.ingestor.implementation.writer.parquet.ParquetStreamWriter | ||
|
|
||
| class TestColumnRenamingStreamTransformer extends FlatSpec with SparkTestBase with Matchers with BeforeAndAfter { | ||
| import spark.implicits._ | ||
|
|
||
| private var baseDir: TempDirectory = _ | ||
|
|
||
| private def baseDirPath = baseDir.path.toUri.toString | ||
|
|
||
| private def destinationDir = s"$baseDirPath/destination" | ||
|
|
||
| private def checkpointDir = s"$baseDirPath/checkpoint" | ||
|
|
||
| private val random = scala.util.Random | ||
|
|
||
| behavior of "ColumnRenamingStreamTransformer" | ||
|
|
||
| before { | ||
| baseDir = TempDirectory("testColumnRenamingStreamTransformer").deleteOnExit() | ||
| } | ||
|
|
||
| after { | ||
| baseDir.delete() | ||
| } | ||
|
|
||
| it should "rename an input column" in { | ||
| val config = new BaseConfiguration() | ||
| config.addProperty(ParquetStreamWriter.KEY_DESTINATION_DIRECTORY, destinationDir) | ||
| config.addProperty(ColumnRenamingStreamTransformer.KEY_COLUMNS_FROM, "value") | ||
| config.addProperty(ColumnRenamingStreamTransformer.KEY_COLUMNS_TO, "v") | ||
| val underTest = ColumnRenamingStreamTransformer(config) | ||
| val df = getDummyReadStream().toDF() | ||
|
|
||
| executeQuery(underTest.transform(df)) | ||
|
|
||
| val actualDf = spark.read.parquet(destinationDir) | ||
|
|
||
| assert(df.schema.exists(f => f.name == "value")) | ||
| assert(!df.schema.exists(f => f.name == "v")) | ||
| assert(actualDf.schema.exists(f => f.name == "v")) | ||
| assert(!actualDf.schema.exists(f => f.name == "value")) | ||
| } | ||
|
|
||
| it should "rename multiple columns while leaving existing columns intact" in { | ||
| val config = new DynamicCombinedConfiguration() | ||
| config.setListDelimiterHandler(new DefaultListDelimiterHandler(',')) | ||
|
|
||
| config.addProperty(ParquetStreamWriter.KEY_DESTINATION_DIRECTORY, destinationDir) | ||
| config.addProperty(ColumnRenamingStreamTransformer.KEY_COLUMNS_FROM, "value, value2") | ||
| config.addProperty(ColumnRenamingStreamTransformer.KEY_COLUMNS_TO, "v1, v2") | ||
| val underTest = ColumnRenamingStreamTransformer(config) | ||
| val df = getDummyReadStream().toDF() | ||
| .withColumn("value2", col("value")) | ||
| .withColumn("value3", col("value")) | ||
|
|
||
| executeQuery(underTest.transform(df)) | ||
|
|
||
| val actualDf = spark.read.parquet(destinationDir) | ||
|
|
||
| actualDf.printSchema() | ||
| assert(actualDf.schema.exists(f => f.name == "v1")) | ||
| assert(actualDf.schema.exists(f => f.name == "v2")) | ||
| assert(actualDf.schema.exists(f => f.name == "value3")) | ||
|
|
||
| assert(!actualDf.schema.exists(f => f.name == "value")) | ||
| assert(!actualDf.schema.exists(f => f.name == "value2")) | ||
| } | ||
|
|
||
| it should "throw an exception if columns from do not match columns to" in { | ||
| val config = new DynamicCombinedConfiguration() | ||
| config.setListDelimiterHandler(new DefaultListDelimiterHandler(',')) | ||
|
|
||
| config.addProperty(ParquetStreamWriter.KEY_DESTINATION_DIRECTORY, destinationDir) | ||
| config.addProperty(ColumnRenamingStreamTransformer.KEY_COLUMNS_FROM, "value, value2") | ||
| config.addProperty(ColumnRenamingStreamTransformer.KEY_COLUMNS_TO, "v1") | ||
|
|
||
| val ex = intercept[IllegalArgumentException] { | ||
| ColumnRenamingStreamTransformer(config) | ||
| } | ||
|
|
||
| assert(ex.getMessage.contains("The size of source column names doesn't match")) | ||
| } | ||
|
|
||
| private def executeQuery(df: DataFrame): Unit = { | ||
| val query = df | ||
| .writeStream | ||
| .option(StreamWriterProperties.CheckpointLocation, checkpointDir) | ||
| .outputMode(OutputMode.Append) | ||
| .trigger(Trigger.Once) | ||
| .start(destinationDir) | ||
| query.awaitTermination() | ||
| } | ||
|
|
||
| private def getDummyReadStream(): MemoryStream[Int] = { | ||
| val input = MemoryStream[Int](random.nextInt(), spark.sqlContext) | ||
| input.addData(List.range(0, 100)) | ||
| input | ||
| } | ||
| } |
80 changes: 80 additions & 0 deletions
80
...mplementation/transformer/column/renaming/TestColumnRenamingStreamTransformerObject.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| * Copyright 2018 ABSA Group Limited | ||
| * | ||
| * 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 za.co.absa.hyperdrive.ingestor.implementation.transformer.column.renaming | ||
|
|
||
| import org.apache.commons.configuration2.{BaseConfiguration, DynamicCombinedConfiguration} | ||
| import org.apache.commons.configuration2.convert.DefaultListDelimiterHandler | ||
| import org.scalatest.FlatSpec | ||
|
|
||
| import ColumnRenamingStreamTransformer._ | ||
|
|
||
| class TestColumnRenamingStreamTransformerObject extends FlatSpec { | ||
| behavior of ColumnRenamingStreamTransformer.getClass.getSimpleName | ||
|
|
||
| it should "create ColumnRenamingStreamTransformer for column pairs specified in configurations" in { | ||
| val columnsFrom = Seq("a", "b", "c") | ||
| val columnsTo = Seq("A", "b2", "C3") | ||
| val config = new DynamicCombinedConfiguration() | ||
| config.setListDelimiterHandler(new DefaultListDelimiterHandler(',')) | ||
| config.addProperty(KEY_COLUMNS_FROM, columnsFrom.mkString(",")) | ||
| config.addProperty(KEY_COLUMNS_TO, columnsTo.mkString(",")) | ||
|
|
||
| val transformer = ColumnRenamingStreamTransformer(config).asInstanceOf[ColumnRenamingStreamTransformer] | ||
| assert(columnsFrom == transformer.columnsFrom) | ||
| assert(columnsTo == transformer.columnsTo) | ||
| } | ||
|
|
||
| it should "throw an exception if source columns are not specified" in { | ||
| val columnsTo = Seq("A", "b2", "C3") | ||
| val config = new DynamicCombinedConfiguration() | ||
| config.setListDelimiterHandler(new DefaultListDelimiterHandler(',')) | ||
| config.addProperty(KEY_COLUMNS_TO, columnsTo.mkString(",")) | ||
|
|
||
| val ex = intercept[IllegalArgumentException] { | ||
| ColumnRenamingStreamTransformer(config).asInstanceOf[ColumnRenamingStreamTransformer] | ||
| } | ||
|
|
||
| assert(ex.getMessage.contains("Empty list of columns to rename.")) | ||
| } | ||
|
|
||
| it should "throw an exception if target columns are not specified" in { | ||
| val columnsFrom = Seq("a", "b", "c") | ||
| val config = new DynamicCombinedConfiguration() | ||
| config.setListDelimiterHandler(new DefaultListDelimiterHandler(',')) | ||
| config.addProperty(KEY_COLUMNS_FROM, columnsFrom.mkString(",")) | ||
|
|
||
| val ex = intercept[IllegalArgumentException] { | ||
| ColumnRenamingStreamTransformer(config).asInstanceOf[ColumnRenamingStreamTransformer] | ||
| } | ||
|
|
||
| assert(ex.getMessage.contains("Empty list of columns to rename.")) | ||
| } | ||
|
|
||
| it should "throw an exception if two lists do not match" in { | ||
| val columnsFrom = Seq("a", "b", "c") | ||
| val columnsTo = Seq("A", "b2") | ||
| val config = new DynamicCombinedConfiguration() | ||
| config.setListDelimiterHandler(new DefaultListDelimiterHandler(',')) | ||
| config.addProperty(KEY_COLUMNS_FROM, columnsFrom.mkString(",")) | ||
| config.addProperty(KEY_COLUMNS_TO, columnsTo.mkString(",")) | ||
|
|
||
| val ex = intercept[IllegalArgumentException] { | ||
| ColumnRenamingStreamTransformer(config).asInstanceOf[ColumnRenamingStreamTransformer] | ||
| } | ||
|
|
||
| assert(ex.getMessage.contains("The size of source column names doesn't match")) | ||
| } | ||
| } |