Dataset API — Typed Transformations
Typed transformations are part of the Dataset API for transforming a Dataset
with an Encoder (except the RowEncoder).
Note
|
Typed transformations are the methods in the Dataset Scala class that are grouped in typedrel group name, i.e. @group typedrel .
|
Transformation | Description | ||
---|---|---|---|
|
|||
|
|||
|
|||
Repartitions a Dataset
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Enforcing Type — as
Typed Transformation
1 2 3 4 5 |
as[U: Encoder]: Dataset[U] |
as[T]
allows for converting from a weakly-typed Dataset
of Rows to Dataset[T]
with T
being a domain class (that can enforce a stronger schema).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
// Create DataFrame of pairs val df = Seq("hello", "world!").zipWithIndex.map(_.swap).toDF("id", "token") scala> df.printSchema root |-- id: integer (nullable = false) |-- token: string (nullable = true) scala> val ds = df.as[(Int, String)] ds: org.apache.spark.sql.Dataset[(Int, String)] = [id: int, token: string] // It's more helpful to have a case class for the conversion final case class MyRecord(id: Int, token: String) scala> val myRecords = df.as[MyRecord] myRecords: org.apache.spark.sql.Dataset[MyRecord] = [id: int, token: string] |
Repartitioning Dataset with Shuffle Disabled — coalesce
Typed Transformation
1 2 3 4 5 |
coalesce(numPartitions: Int): Dataset[T] |
coalesce
operator repartitions the Dataset
to exactly numPartitions
partitions.
Internally, coalesce
creates a Repartition
logical operator with shuffle
disabled (which is marked as false
in the below explain
‘s output).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
scala> spark.range(5).coalesce(1).explain(extended = true) == Parsed Logical Plan == Repartition 1, false +- Range (0, 5, step=1, splits=Some(8)) == Analyzed Logical Plan == id: bigint Repartition 1, false +- Range (0, 5, step=1, splits=Some(8)) == Optimized Logical Plan == Repartition 1, false +- Range (0, 5, step=1, splits=Some(8)) == Physical Plan == Coalesce 1 +- *Range (0, 5, step=1, splits=Some(8)) |
dropDuplicates
Typed Transformation
1 2 3 4 5 6 7 8 |
dropDuplicates(): Dataset[T] dropDuplicates(colNames: Array[String]): Dataset[T] dropDuplicates(colNames: Seq[String]): Dataset[T] dropDuplicates(col1: String, cols: String*): Dataset[T] |
dropDuplicates
…FIXME
filter
Typed Transformation
1 2 3 4 5 6 7 |
filter(condition: Column): Dataset[T] filter(conditionExpr: String): Dataset[T] filter(func: T => Boolean): Dataset[T] |
filter
…FIXME
Creating Zero or More Records — flatMap
Typed Transformation
1 2 3 4 5 |
flatMap[U: Encoder](func: T => TraversableOnce[U]): Dataset[U] |
flatMap
returns a new Dataset
(of type U
) with all records (of type T
) mapped over using the function func
and then flattening the results.
Note
|
flatMap can create new records. It deprecated explode .
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
final case class Sentence(id: Long, text: String) val sentences = Seq(Sentence(0, "hello world"), Sentence(1, "witaj swiecie")).toDS scala> sentences.flatMap(s => s.text.split("\\s+")).show +-------+ | value| +-------+ | hello| | world| | witaj| |swiecie| +-------+ |
Internally, flatMap
calls mapPartitions with the partitions flatMap(ped)
.
intersectAll
Typed Transformation
1 2 3 4 5 |
intersectAll(other: Dataset[T]): Dataset[T] |
intersectAll
…FIXME
joinWith
Typed Transformation
1 2 3 4 5 6 |
joinWith[U](other: Dataset[U], condition: Column): Dataset[(T, U)] joinWith[U](other: Dataset[U], condition: Column, joinType: String): Dataset[(T, U)] |
joinWith
…FIXME
mapPartitions
Typed Transformation
1 2 3 4 5 |
mapPartitions[U : Encoder](func: Iterator[T] => Iterator[U]): Dataset[U] |
mapPartitions
…FIXME
Randomly Split Dataset Into Two or More Datasets Per Weight — randomSplit
Typed Transformation
1 2 3 4 5 6 |
randomSplit(weights: Array[Double]): Array[Dataset[T]] randomSplit(weights: Array[Double], seed: Long): Array[Dataset[T]] |
randomSplit
randomly splits the Dataset
per weights
.
weights
doubles should sum up to 1
and will be normalized if they do not.
You can define seed
and if you don’t, a random seed
will be used.
Note
|
randomSplit is commonly used in Spark MLlib to split an input Dataset into two datasets for training and validation.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
val ds = spark.range(10) scala> ds.randomSplit(Array[Double](2, 3)).foreach(_.show) +---+ | id| +---+ | 0| | 1| | 2| +---+ +---+ | id| +---+ | 3| | 4| | 5| | 6| | 7| | 8| | 9| +---+ |
Repartitioning Dataset (Shuffle Enabled) — repartition
Typed Transformation
1 2 3 4 5 6 7 |
repartition(partitionExprs: Column*): Dataset[T] repartition(numPartitions: Int): Dataset[T] repartition(numPartitions: Int, partitionExprs: Column*): Dataset[T] |
repartition
operators repartition the Dataset
to exactly numPartitions
partitions or using partitionExprs
expressions.
Internally, repartition
creates a Repartition or RepartitionByExpression logical operators with shuffle
enabled (which is true
in the below explain
‘s output beside Repartition
).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
scala> spark.range(5).repartition(1).explain(extended = true) == Parsed Logical Plan == Repartition 1, true +- Range (0, 5, step=1, splits=Some(8)) == Analyzed Logical Plan == id: bigint Repartition 1, true +- Range (0, 5, step=1, splits=Some(8)) == Optimized Logical Plan == Repartition 1, true +- Range (0, 5, step=1, splits=Some(8)) == Physical Plan == Exchange RoundRobinPartitioning(1) +- *Range (0, 5, step=1, splits=Some(8)) |
Note
|
repartition methods correspond to SQL’s DISTRIBUTE BY or CLUSTER BY clauses.
|
repartitionByRange
Typed Transformation
1 2 3 4 5 6 |
repartitionByRange(partitionExprs: Column*): Dataset[T] (1) repartitionByRange(numPartitions: Int, partitionExprs: Column*): Dataset[T] |
-
Uses spark.sql.shuffle.partitions configuration property for the number of partitions to use
repartitionByRange
simply creates a Dataset with a RepartitionByExpression logical operator.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
scala> spark.version res1: String = 2.3.1 val q = spark.range(10).repartitionByRange(numPartitions = 5, $"id") scala> println(q.queryExecution.logical.numberedTreeString) 00 'RepartitionByExpression ['id ASC NULLS FIRST], 5 01 +- AnalysisBarrier 02 +- Range (0, 10, step=1, splits=Some(8)) scala> println(q.queryExecution.toRdd.getNumPartitions) 5 scala> println(q.queryExecution.toRdd.toDebugString) (5) ShuffledRowRDD[18] at toRdd at <console>:26 [] +-(8) MapPartitionsRDD[17] at toRdd at <console>:26 [] | MapPartitionsRDD[13] at toRdd at <console>:26 [] | MapPartitionsRDD[12] at toRdd at <console>:26 [] | ParallelCollectionRDD[11] at toRdd at <console>:26 [] |
repartitionByRange
uses a SortOrder
with the Ascending
sort order, i.e. ascending nulls first, when no explicit sort order is specified.
repartitionByRange
throws a IllegalArgumentException
when no partitionExprs
partition-by expression is specified.
1 2 3 4 5 |
requirement failed: At least one partition-by expression must be specified. |
sample
Typed Transformation
1 2 3 4 5 6 7 8 |
sample(withReplacement: Boolean, fraction: Double): Dataset[T] sample(withReplacement: Boolean, fraction: Double, seed: Long): Dataset[T] sample(fraction: Double): Dataset[T] sample(fraction: Double, seed: Long): Dataset[T] |
sample
…FIXME
select
Typed Transformation
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
select[U1](c1: TypedColumn[T, U1]): Dataset[U1] select[U1, U2](c1: TypedColumn[T, U1], c2: TypedColumn[T, U2]): Dataset[(U1, U2)] select[U1, U2, U3]( c1: TypedColumn[T, U1], c2: TypedColumn[T, U2], c3: TypedColumn[T, U3]): Dataset[(U1, U2, U3)] select[U1, U2, U3, U4]( c1: TypedColumn[T, U1], c2: TypedColumn[T, U2], c3: TypedColumn[T, U3], c4: TypedColumn[T, U4]): Dataset[(U1, U2, U3, U4)] select[U1, U2, U3, U4, U5]( c1: TypedColumn[T, U1], c2: TypedColumn[T, U2], c3: TypedColumn[T, U3], c4: TypedColumn[T, U4], c5: TypedColumn[T, U5]): Dataset[(U1, U2, U3, U4, U5)] |
select
…FIXME
sort
Typed Transformation
1 2 3 4 5 6 |
sort(sortExprs: Column*): Dataset[T] sort(sortCol: String, sortCols: String*): Dataset[T] |
sort
…FIXME
sortWithinPartitions
Typed Transformation
1 2 3 4 5 6 |
sortWithinPartitions(sortExprs: Column*): Dataset[T] sortWithinPartitions(sortCol: String, sortCols: String*): Dataset[T] |
sortWithinPartitions
simply calls the internal sortInternal method with the global
flag disabled (false
).
toJSON
Typed Transformation
1 2 3 4 5 |
toJSON: Dataset[String] |
toJSON
maps the content of Dataset
to a Dataset
of strings in JSON format.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
scala> val ds = Seq("hello", "world", "foo bar").toDS ds: org.apache.spark.sql.Dataset[String] = [value: string] scala> ds.toJSON.show +-------------------+ | value| +-------------------+ | {"value":"hello"}| | {"value":"world"}| |{"value":"foo bar"}| +-------------------+ |
Internally, toJSON
grabs the RDD[InternalRow]
(of the QueryExecution of the Dataset
) and maps the records (per RDD partition) into JSON.
Note
|
toJSON uses Jackson’s JSON parser — jackson-module-scala.
|
Transforming Datasets — transform
Typed Transformation
1 2 3 4 5 |
transform[U](t: Dataset[T] => Dataset[U]): Dataset[U] |
transform
applies t
function to the source Dataset[T]
to produce a result Dataset[U]
. It is for chaining custom transformations.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
val dataset = spark.range(5) // Transformation t import org.apache.spark.sql.Dataset def withDoubled(longs: Dataset[java.lang.Long]) = longs.withColumn("doubled", 'id * 2) scala> dataset.transform(withDoubled).show +---+-------+ | id|doubled| +---+-------+ | 0| 0| | 1| 2| | 2| 4| | 3| 6| | 4| 8| +---+-------+ |
Internally, transform
executes t
function on the current Dataset[T]
.
unionByName
Typed Transformation
1 2 3 4 5 |
unionByName(other: Dataset[T]): Dataset[T] |
unionByName
creates a new Dataset
that is an union of the rows in this and the other Datasets column-wise, i.e. the order of columns in Datasets does not matter as long as their names and number match.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
val left = spark.range(1).withColumn("rand", rand()).select("id", "rand") val right = Seq(("0.1", 11)).toDF("rand", "id") val q = left.unionByName(right) scala> q.show +---+-------------------+ | id| rand| +---+-------------------+ | 0|0.14747380134150134| | 11| 0.1| +---+-------------------+ |
Internally, unionByName
creates a Union logical operator for this Dataset
and Project logical operator with the other
Dataset.
In the end, unionByName
applies the CombineUnions logical optimization to the Union
logical operator and requests the result LogicalPlan
to wrap the child operators with AnalysisBarriers.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
scala> println(q.queryExecution.logical.numberedTreeString) 00 'Union 01 :- AnalysisBarrier 02 : +- Project [id#90L, rand#92] 03 : +- Project [id#90L, rand(-9144575865446031058) AS rand#92] 04 : +- Range (0, 1, step=1, splits=Some(8)) 05 +- AnalysisBarrier 06 +- Project [id#103, rand#102] 07 +- Project [_1#99 AS rand#102, _2#100 AS id#103] 08 +- LocalRelation [_1#99, _2#100] |
unionByName
throws an AnalysisException
if there are duplicate columns in either Dataset.
1 2 3 4 5 |
Found duplicate column(s) |
unionByName
throws an AnalysisException
if there are columns in this Dataset has a column that is not available in the other
Dataset.
1 2 3 4 5 |
Cannot resolve column name "[name]" among ([rightNames]) |
where
Typed Transformation
1 2 3 4 5 6 |
where(condition: Column): Dataset[T] where(conditionExpr: String): Dataset[T] |
where
is simply a synonym of the filter operator, i.e. passes the input parameters along to filter
.
Creating Streaming Dataset with EventTimeWatermark Logical Operator — withWatermark
Streaming Typed Transformation
1 2 3 4 5 |
withWatermark(eventTime: String, delayThreshold: String): Dataset[T] |
Internally, withWatermark
creates a Dataset
with EventTimeWatermark
logical plan for streaming Datasets.
Note
|
withWatermark uses EliminateEventTimeWatermark logical rule to eliminate EventTimeWatermark logical plan for non-streaming batch Datasets .
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
// Create a batch dataset val events = spark.range(0, 50, 10). withColumn("timestamp", from_unixtime(unix_timestamp - 'id)). select('timestamp, 'id as "count") scala> events.show +-------------------+-----+ | timestamp|count| +-------------------+-----+ |2017-06-25 21:21:14| 0| |2017-06-25 21:21:04| 10| |2017-06-25 21:20:54| 20| |2017-06-25 21:20:44| 30| |2017-06-25 21:20:34| 40| +-------------------+-----+ // the dataset is a non-streaming batch one... scala> events.isStreaming res1: Boolean = false // ...so EventTimeWatermark is not included in the logical plan val watermarked = events. withWatermark(eventTime = "timestamp", delayThreshold = "20 seconds") scala> println(watermarked.queryExecution.logical.numberedTreeString) 00 Project [timestamp#284, id#281L AS count#288L] 01 +- Project [id#281L, from_unixtime((unix_timestamp(current_timestamp(), yyyy-MM-dd HH:mm:ss, Some(America/Chicago)) - id#281L), yyyy-MM-dd HH:mm:ss, Some(America/Chicago)) AS timestamp#284] 02 +- Range (0, 50, step=10, splits=Some(8)) // Let's create a streaming Dataset import org.apache.spark.sql.types.StructType val schema = new StructType(). add($"timestamp".timestamp). add($"count".long) scala> schema.printTreeString root |-- timestamp: timestamp (nullable = true) |-- count: long (nullable = true) val events = spark. readStream. schema(schema). csv("events"). withWatermark(eventTime = "timestamp", delayThreshold = "20 seconds") scala> println(events.queryExecution.logical.numberedTreeString) 00 'EventTimeWatermark 'timestamp, interval 20 seconds 01 +- StreamingRelation DataSource(org.apache.spark.sql.SparkSession@75abcdd4,csv,List(),Some(StructType(StructField(timestamp,TimestampType,true), StructField(count,LongType,true))),List(),None,Map(path -> events),None), FileSource[events], [timestamp#329, count#330L] |
Note
|
|
Note
|
delayThreshold must not be negative (and milliseconds and months should both be equal or greater than 0 ).
|
Note
|
withWatermark is used when…FIXME
|