-
Notifications
You must be signed in to change notification settings - Fork 28k
/
ParquetWriteSupport.scala
450 lines (382 loc) · 16.6 KB
/
ParquetWriteSupport.scala
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.spark.sql.execution.datasources.parquet
import java.nio.{ByteBuffer, ByteOrder}
import java.util
import scala.collection.JavaConverters.mapAsJavaMapConverter
import org.apache.hadoop.conf.Configuration
import org.apache.parquet.column.ParquetProperties
import org.apache.parquet.hadoop.ParquetOutputFormat
import org.apache.parquet.hadoop.api.WriteSupport
import org.apache.parquet.hadoop.api.WriteSupport.WriteContext
import org.apache.parquet.io.api.{Binary, RecordConsumer}
import org.apache.spark.internal.Logging
import org.apache.spark.sql.catalyst.InternalRow
import org.apache.spark.sql.catalyst.expressions.SpecializedGetters
import org.apache.spark.sql.catalyst.util.DateTimeUtils
import org.apache.spark.sql.internal.SQLConf
import org.apache.spark.sql.types._
/**
* A Parquet [[WriteSupport]] implementation that writes Catalyst [[InternalRow]]s as Parquet
* messages. This class can write Parquet data in two modes:
*
* - Standard mode: Parquet data are written in standard format defined in parquet-format spec.
* - Legacy mode: Parquet data are written in legacy format compatible with Spark 1.4 and prior.
*
* This behavior can be controlled by SQL option `spark.sql.parquet.writeLegacyFormat`. The value
* of this option is propagated to this class by the `init()` method and its Hadoop configuration
* argument.
*/
private[parquet] class ParquetWriteSupport extends WriteSupport[InternalRow] with Logging {
// A `ValueWriter` is responsible for writing a field of an `InternalRow` to the record consumer.
// Here we are using `SpecializedGetters` rather than `InternalRow` so that we can directly access
// data in `ArrayData` without the help of `SpecificMutableRow`.
private type ValueWriter = (SpecializedGetters, Int) => Unit
// Schema of the `InternalRow`s to be written
private var schema: StructType = _
// `ValueWriter`s for all fields of the schema
private var rootFieldWriters: Array[ValueWriter] = _
// The Parquet `RecordConsumer` to which all `InternalRow`s are written
private var recordConsumer: RecordConsumer = _
// Whether to write data in legacy Parquet format compatible with Spark 1.4 and prior versions
private var writeLegacyParquetFormat: Boolean = _
// Which parquet timestamp type to use when writing.
private var outputTimestampType: SQLConf.ParquetOutputTimestampType.Value = _
// Reusable byte array used to write timestamps as Parquet INT96 values
private val timestampBuffer = new Array[Byte](12)
// Reusable byte array used to write decimal values
private val decimalBuffer =
new Array[Byte](Decimal.minBytesForPrecision(DecimalType.MAX_PRECISION))
override def init(configuration: Configuration): WriteContext = {
val schemaString = configuration.get(ParquetWriteSupport.SPARK_ROW_SCHEMA)
this.schema = StructType.fromString(schemaString)
this.writeLegacyParquetFormat = {
// `SQLConf.PARQUET_WRITE_LEGACY_FORMAT` should always be explicitly set in ParquetRelation
assert(configuration.get(SQLConf.PARQUET_WRITE_LEGACY_FORMAT.key) != null)
configuration.get(SQLConf.PARQUET_WRITE_LEGACY_FORMAT.key).toBoolean
}
this.outputTimestampType = {
val key = SQLConf.PARQUET_OUTPUT_TIMESTAMP_TYPE.key
assert(configuration.get(key) != null)
SQLConf.ParquetOutputTimestampType.withName(configuration.get(key))
}
this.rootFieldWriters = schema.map(_.dataType).map(makeWriter).toArray[ValueWriter]
val messageType = new SparkToParquetSchemaConverter(configuration).convert(schema)
val metadata = Map(ParquetReadSupport.SPARK_METADATA_KEY -> schemaString).asJava
logInfo(
s"""Initialized Parquet WriteSupport with Catalyst schema:
|${schema.prettyJson}
|and corresponding Parquet message type:
|$messageType
""".stripMargin)
new WriteContext(messageType, metadata)
}
override def prepareForWrite(recordConsumer: RecordConsumer): Unit = {
this.recordConsumer = recordConsumer
}
override def write(row: InternalRow): Unit = {
consumeMessage {
writeFields(row, schema, rootFieldWriters)
}
}
private def writeFields(
row: InternalRow, schema: StructType, fieldWriters: Array[ValueWriter]): Unit = {
var i = 0
while (i < row.numFields) {
if (!row.isNullAt(i)) {
consumeField(schema(i).name, i) {
fieldWriters(i).apply(row, i)
}
}
i += 1
}
}
private def makeWriter(dataType: DataType): ValueWriter = {
dataType match {
case BooleanType =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addBoolean(row.getBoolean(ordinal))
case ByteType =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addInteger(row.getByte(ordinal))
case ShortType =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addInteger(row.getShort(ordinal))
case IntegerType | DateType =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addInteger(row.getInt(ordinal))
case LongType =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addLong(row.getLong(ordinal))
case FloatType =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addFloat(row.getFloat(ordinal))
case DoubleType =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addDouble(row.getDouble(ordinal))
case StringType =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addBinary(
Binary.fromReusedByteArray(row.getUTF8String(ordinal).getBytes))
case TimestampType =>
outputTimestampType match {
case SQLConf.ParquetOutputTimestampType.INT96 =>
(row: SpecializedGetters, ordinal: Int) =>
val (julianDay, timeOfDayNanos) = DateTimeUtils.toJulianDay(row.getLong(ordinal))
val buf = ByteBuffer.wrap(timestampBuffer)
buf.order(ByteOrder.LITTLE_ENDIAN).putLong(timeOfDayNanos).putInt(julianDay)
recordConsumer.addBinary(Binary.fromReusedByteArray(timestampBuffer))
case SQLConf.ParquetOutputTimestampType.TIMESTAMP_MICROS =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addLong(row.getLong(ordinal))
case SQLConf.ParquetOutputTimestampType.TIMESTAMP_MILLIS =>
(row: SpecializedGetters, ordinal: Int) =>
val millis = DateTimeUtils.toMillis(row.getLong(ordinal))
recordConsumer.addLong(millis)
}
case BinaryType =>
(row: SpecializedGetters, ordinal: Int) =>
recordConsumer.addBinary(Binary.fromReusedByteArray(row.getBinary(ordinal)))
case DecimalType.Fixed(precision, scale) =>
makeDecimalWriter(precision, scale)
case t: StructType =>
val fieldWriters = t.map(_.dataType).map(makeWriter).toArray[ValueWriter]
(row: SpecializedGetters, ordinal: Int) =>
consumeGroup {
writeFields(row.getStruct(ordinal, t.length), t, fieldWriters)
}
case t: ArrayType => makeArrayWriter(t)
case t: MapType => makeMapWriter(t)
case t: UserDefinedType[_] => makeWriter(t.sqlType)
// TODO Adds IntervalType support
case _ => sys.error(s"Unsupported data type $dataType.")
}
}
private def makeDecimalWriter(precision: Int, scale: Int): ValueWriter = {
assert(
precision <= DecimalType.MAX_PRECISION,
s"Decimal precision $precision exceeds max precision ${DecimalType.MAX_PRECISION}")
val numBytes = Decimal.minBytesForPrecision(precision)
val int32Writer =
(row: SpecializedGetters, ordinal: Int) => {
val unscaledLong = row.getDecimal(ordinal, precision, scale).toUnscaledLong
recordConsumer.addInteger(unscaledLong.toInt)
}
val int64Writer =
(row: SpecializedGetters, ordinal: Int) => {
val unscaledLong = row.getDecimal(ordinal, precision, scale).toUnscaledLong
recordConsumer.addLong(unscaledLong)
}
val binaryWriterUsingUnscaledLong =
(row: SpecializedGetters, ordinal: Int) => {
// When the precision is low enough (<= 18) to squeeze the decimal value into a `Long`, we
// can build a fixed-length byte array with length `numBytes` using the unscaled `Long`
// value and the `decimalBuffer` for better performance.
val unscaled = row.getDecimal(ordinal, precision, scale).toUnscaledLong
var i = 0
var shift = 8 * (numBytes - 1)
while (i < numBytes) {
decimalBuffer(i) = (unscaled >> shift).toByte
i += 1
shift -= 8
}
recordConsumer.addBinary(Binary.fromReusedByteArray(decimalBuffer, 0, numBytes))
}
val binaryWriterUsingUnscaledBytes =
(row: SpecializedGetters, ordinal: Int) => {
val decimal = row.getDecimal(ordinal, precision, scale)
val bytes = decimal.toJavaBigDecimal.unscaledValue().toByteArray
val fixedLengthBytes = if (bytes.length == numBytes) {
// If the length of the underlying byte array of the unscaled `BigInteger` happens to be
// `numBytes`, just reuse it, so that we don't bother copying it to `decimalBuffer`.
bytes
} else {
// Otherwise, the length must be less than `numBytes`. In this case we copy contents of
// the underlying bytes with padding sign bytes to `decimalBuffer` to form the result
// fixed-length byte array.
val signByte = if (bytes.head < 0) -1: Byte else 0: Byte
util.Arrays.fill(decimalBuffer, 0, numBytes - bytes.length, signByte)
System.arraycopy(bytes, 0, decimalBuffer, numBytes - bytes.length, bytes.length)
decimalBuffer
}
recordConsumer.addBinary(Binary.fromReusedByteArray(fixedLengthBytes, 0, numBytes))
}
writeLegacyParquetFormat match {
// Standard mode, 1 <= precision <= 9, writes as INT32
case false if precision <= Decimal.MAX_INT_DIGITS => int32Writer
// Standard mode, 10 <= precision <= 18, writes as INT64
case false if precision <= Decimal.MAX_LONG_DIGITS => int64Writer
// Legacy mode, 1 <= precision <= 18, writes as FIXED_LEN_BYTE_ARRAY
case true if precision <= Decimal.MAX_LONG_DIGITS => binaryWriterUsingUnscaledLong
// Either standard or legacy mode, 19 <= precision <= 38, writes as FIXED_LEN_BYTE_ARRAY
case _ => binaryWriterUsingUnscaledBytes
}
}
def makeArrayWriter(arrayType: ArrayType): ValueWriter = {
val elementWriter = makeWriter(arrayType.elementType)
def threeLevelArrayWriter(repeatedGroupName: String, elementFieldName: String): ValueWriter =
(row: SpecializedGetters, ordinal: Int) => {
val array = row.getArray(ordinal)
consumeGroup {
// Only creates the repeated field if the array is non-empty.
if (array.numElements() > 0) {
consumeField(repeatedGroupName, 0) {
var i = 0
while (i < array.numElements()) {
consumeGroup {
// Only creates the element field if the current array element is not null.
if (!array.isNullAt(i)) {
consumeField(elementFieldName, 0) {
elementWriter.apply(array, i)
}
}
}
i += 1
}
}
}
}
}
def twoLevelArrayWriter(repeatedFieldName: String): ValueWriter =
(row: SpecializedGetters, ordinal: Int) => {
val array = row.getArray(ordinal)
consumeGroup {
// Only creates the repeated field if the array is non-empty.
if (array.numElements() > 0) {
consumeField(repeatedFieldName, 0) {
var i = 0
while (i < array.numElements()) {
elementWriter.apply(array, i)
i += 1
}
}
}
}
}
(writeLegacyParquetFormat, arrayType.containsNull) match {
case (legacyMode @ false, _) =>
// Standard mode:
//
// <list-repetition> group <name> (LIST) {
// repeated group list {
// ^~~~ repeatedGroupName
// <element-repetition> <element-type> element;
// ^~~~~~~ elementFieldName
// }
// }
threeLevelArrayWriter(repeatedGroupName = "list", elementFieldName = "element")
case (legacyMode @ true, nullableElements @ true) =>
// Legacy mode, with nullable elements:
//
// <list-repetition> group <name> (LIST) {
// optional group bag {
// ^~~ repeatedGroupName
// repeated <element-type> array;
// ^~~~~ elementFieldName
// }
// }
threeLevelArrayWriter(repeatedGroupName = "bag", elementFieldName = "array")
case (legacyMode @ true, nullableElements @ false) =>
// Legacy mode, with non-nullable elements:
//
// <list-repetition> group <name> (LIST) {
// repeated <element-type> array;
// ^~~~~ repeatedFieldName
// }
twoLevelArrayWriter(repeatedFieldName = "array")
}
}
private def makeMapWriter(mapType: MapType): ValueWriter = {
val keyWriter = makeWriter(mapType.keyType)
val valueWriter = makeWriter(mapType.valueType)
val repeatedGroupName = if (writeLegacyParquetFormat) {
// Legacy mode:
//
// <map-repetition> group <name> (MAP) {
// repeated group map (MAP_KEY_VALUE) {
// ^~~ repeatedGroupName
// required <key-type> key;
// <value-repetition> <value-type> value;
// }
// }
"map"
} else {
// Standard mode:
//
// <map-repetition> group <name> (MAP) {
// repeated group key_value {
// ^~~~~~~~~ repeatedGroupName
// required <key-type> key;
// <value-repetition> <value-type> value;
// }
// }
"key_value"
}
(row: SpecializedGetters, ordinal: Int) => {
val map = row.getMap(ordinal)
val keyArray = map.keyArray()
val valueArray = map.valueArray()
consumeGroup {
// Only creates the repeated field if the map is non-empty.
if (map.numElements() > 0) {
consumeField(repeatedGroupName, 0) {
var i = 0
while (i < map.numElements()) {
consumeGroup {
consumeField("key", 0) {
keyWriter.apply(keyArray, i)
}
// Only creates the "value" field if the value if non-empty
if (!map.valueArray().isNullAt(i)) {
consumeField("value", 1) {
valueWriter.apply(valueArray, i)
}
}
}
i += 1
}
}
}
}
}
}
private def consumeMessage(f: => Unit): Unit = {
recordConsumer.startMessage()
f
recordConsumer.endMessage()
}
private def consumeGroup(f: => Unit): Unit = {
recordConsumer.startGroup()
f
recordConsumer.endGroup()
}
private def consumeField(field: String, index: Int)(f: => Unit): Unit = {
recordConsumer.startField(field, index)
f
recordConsumer.endField(field, index)
}
}
private[parquet] object ParquetWriteSupport {
val SPARK_ROW_SCHEMA: String = "org.apache.spark.sql.parquet.row.attributes"
def setSchema(schema: StructType, configuration: Configuration): Unit = {
schema.map(_.name).foreach(ParquetSchemaConverter.checkFieldName)
configuration.set(SPARK_ROW_SCHEMA, schema.json)
configuration.setIfUnset(
ParquetOutputFormat.WRITER_VERSION,
ParquetProperties.WriterVersion.PARQUET_1_0.toString)
}
}