e93908da4353586138690117cb9e86d801501d26
[spark.git] / sql / core / src / main / scala / org / apache / spark / sql / execution / datasources / text / TextFileFormat.scala
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements.  See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License.  You may obtain a copy of the License at
8  *
9  *    http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 package org.apache.spark.sql.execution.datasources.text
19
20 import org.apache.hadoop.conf.Configuration
21 import org.apache.hadoop.fs.{FileStatus, Path}
22 import org.apache.hadoop.mapreduce.{Job, TaskAttemptContext}
23
24 import org.apache.spark.TaskContext
25 import org.apache.spark.broadcast.Broadcast
26 import org.apache.spark.sql.{AnalysisException, SparkSession}
27 import org.apache.spark.sql.catalyst.InternalRow
28 import org.apache.spark.sql.catalyst.expressions.UnsafeRow
29 import org.apache.spark.sql.catalyst.expressions.codegen.UnsafeRowWriter
30 import org.apache.spark.sql.catalyst.util.CompressionCodecs
31 import org.apache.spark.sql.execution.datasources._
32 import org.apache.spark.sql.sources._
33 import org.apache.spark.sql.types.{StringType, StructType}
34 import org.apache.spark.util.SerializableConfiguration
35
36 /**
37  * A data source for reading text files.
38  */
39 class TextFileFormat extends TextBasedFileFormat with DataSourceRegister {
40
41   override def shortName(): String = "text"
42
43   override def toString: String = "Text"
44
45   private def verifySchema(schema: StructType): Unit = {
46     if (schema.size != 1) {
47       throw new AnalysisException(
48         s"Text data source supports only a single column, and you have ${schema.size} columns.")
49     }
50     val tpe = schema(0).dataType
51     if (tpe != StringType) {
52       throw new AnalysisException(
53         s"Text data source supports only a string column, but you have ${tpe.simpleString}.")
54     }
55   }
56
57   override def isSplitable(
58       sparkSession: SparkSession,
59       options: Map[String, String],
60       path: Path): Boolean = {
61     val textOptions = new TextOptions(options)
62     super.isSplitable(sparkSession, options, path) && !textOptions.wholeText
63   }
64
65   override def inferSchema(
66       sparkSession: SparkSession,
67       options: Map[String, String],
68       files: Seq[FileStatus]): Option[StructType] = Some(new StructType().add("value", StringType))
69
70   override def prepareWrite(
71       sparkSession: SparkSession,
72       job: Job,
73       options: Map[String, String],
74       dataSchema: StructType): OutputWriterFactory = {
75     verifySchema(dataSchema)
76
77     val textOptions = new TextOptions(options)
78     val conf = job.getConfiguration
79
80     textOptions.compressionCodec.foreach { codec =>
81       CompressionCodecs.setCodecConfiguration(conf, codec)
82     }
83
84     new OutputWriterFactory {
85       override def newInstance(
86           path: String,
87           dataSchema: StructType,
88           context: TaskAttemptContext): OutputWriter = {
89         new TextOutputWriter(path, dataSchema, textOptions.lineSeparatorInWrite, context)
90       }
91
92       override def getFileExtension(context: TaskAttemptContext): String = {
93         ".txt" + CodecStreams.getCompressionExtension(context)
94       }
95     }
96   }
97
98   override def buildReader(
99       sparkSession: SparkSession,
100       dataSchema: StructType,
101       partitionSchema: StructType,
102       requiredSchema: StructType,
103       filters: Seq[Filter],
104       options: Map[String, String],
105       hadoopConf: Configuration): PartitionedFile => Iterator[InternalRow] = {
106     assert(
107       requiredSchema.length <= 1,
108       "Text data source only produces a single data column named \"value\".")
109     val textOptions = new TextOptions(options)
110     val broadcastedHadoopConf =
111       sparkSession.sparkContext.broadcast(new SerializableConfiguration(hadoopConf))
112
113     readToUnsafeMem(broadcastedHadoopConf, requiredSchema, textOptions)
114   }
115
116   private def readToUnsafeMem(
117       conf: Broadcast[SerializableConfiguration],
118       requiredSchema: StructType,
119       textOptions: TextOptions): (PartitionedFile) => Iterator[UnsafeRow] = {
120
121     (file: PartitionedFile) => {
122       val confValue = conf.value.value
123       val reader = if (!textOptions.wholeText) {
124         new HadoopFileLinesReader(file, textOptions.lineSeparatorInRead, confValue)
125       } else {
126         new HadoopFileWholeTextReader(file, confValue)
127       }
128       Option(TaskContext.get()).foreach(_.addTaskCompletionListener(_ => reader.close()))
129       if (requiredSchema.isEmpty) {
130         val emptyUnsafeRow = new UnsafeRow(0)
131         reader.map(_ => emptyUnsafeRow)
132       } else {
133         val unsafeRowWriter = new UnsafeRowWriter(1)
134
135         reader.map { line =>
136           // Writes to an UnsafeRow directly
137           unsafeRowWriter.reset()
138           unsafeRowWriter.write(0, line.getBytes, 0, line.getLength)
139           unsafeRowWriter.getRow()
140         }
141       }
142     }
143   }
144 }
145
146 class TextOutputWriter(
147     path: String,
148     dataSchema: StructType,
149     lineSeparator: Array[Byte],
150     context: TaskAttemptContext)
151   extends OutputWriter {
152
153   private val writer = CodecStreams.createOutputStream(context, new Path(path))
154
155   override def write(row: InternalRow): Unit = {
156     if (!row.isNullAt(0)) {
157       val utf8string = row.getUTF8String(0)
158       utf8string.writeTo(writer)
159     }
160     writer.write(lineSeparator)
161   }
162
163   override def close(): Unit = {
164     writer.close()
165   }
166 }