[SPARK-26673][SQL] File source V2 writes: create framework and migrate ORC #23601
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| /* | ||
| * 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.v2 | ||
|
|
||
| import org.apache.hadoop.mapreduce.Job | ||
|
|
||
| import org.apache.spark.internal.Logging | ||
| import org.apache.spark.internal.io.FileCommitProtocol | ||
| import org.apache.spark.sql.execution.datasources.{WriteJobDescription, WriteTaskResult} | ||
| import org.apache.spark.sql.execution.datasources.FileFormatWriter.processStats | ||
| import org.apache.spark.sql.sources.v2.writer._ | ||
| import org.apache.spark.util.SerializableConfiguration | ||
|
|
||
| class FileBatchWrite( | ||
| job: Job, | ||
| description: WriteJobDescription, | ||
| committer: FileCommitProtocol) | ||
| extends BatchWrite with Logging { | ||
| override def commit(messages: Array[WriterCommitMessage]): Unit = { | ||
| val results = messages.map(_.asInstanceOf[WriteTaskResult]) | ||
| committer.commitJob(job, results.map(_.commitMsg)) | ||
| logInfo(s"Write Job ${description.uuid} committed.") | ||
|
|
||
| processStats(description.statsTrackers, results.map(_.summary.stats)) | ||
| logInfo(s"Finished processing stats for write job ${description.uuid}.") | ||
| } | ||
|
|
||
| override def useCommitCoordinator(): Boolean = false | ||
|
|
||
| override def abort(messages: Array[WriterCommitMessage]): Unit = { | ||
| committer.abortJob(job) | ||
| } | ||
|
|
||
| override def createBatchWriterFactory(): DataWriterFactory = { | ||
| val conf = new SerializableConfiguration(job.getConfiguration) | ||
| FileWriterFactory(description, committer, conf) | ||
| } | ||
| } | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| /* | ||
| * 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.v2 | ||
|
|
||
| import java.util.UUID | ||
|
|
||
| import scala.collection.JavaConverters._ | ||
|
|
||
| import org.apache.hadoop.conf.Configuration | ||
| import org.apache.hadoop.fs.Path | ||
| import org.apache.hadoop.mapreduce.Job | ||
| import org.apache.hadoop.mapreduce.lib.output.FileOutputFormat | ||
|
|
||
| import org.apache.spark.internal.io.FileCommitProtocol | ||
| import org.apache.spark.sql.{AnalysisException, SaveMode, SparkSession} | ||
| import org.apache.spark.sql.catalyst.InternalRow | ||
| import org.apache.spark.sql.catalyst.util.{CaseInsensitiveMap, DateTimeUtils} | ||
| import org.apache.spark.sql.execution.datasources.{BasicWriteJobStatsTracker, DataSource, OutputWriterFactory, WriteJobDescription} | ||
| import org.apache.spark.sql.execution.metric.SQLMetric | ||
| import org.apache.spark.sql.internal.SQLConf | ||
| import org.apache.spark.sql.sources.v2.DataSourceOptions | ||
| import org.apache.spark.sql.sources.v2.writer.{BatchWrite, SupportsSaveMode, WriteBuilder} | ||
| import org.apache.spark.sql.types.StructType | ||
| import org.apache.spark.util.SerializableConfiguration | ||
|
|
||
| abstract class FileWriteBuilder(options: DataSourceOptions) | ||
| extends WriteBuilder with SupportsSaveMode { | ||
| private var schema: StructType = _ | ||
| private var queryId: String = _ | ||
| private var mode: SaveMode = _ | ||
|
|
||
| override def withInputDataSchema(schema: StructType): WriteBuilder = { | ||
| this.schema = schema | ||
| this | ||
| } | ||
|
|
||
| override def withQueryId(queryId: String): WriteBuilder = { | ||
| this.queryId = queryId | ||
| this | ||
| } | ||
|
|
||
| override def mode(mode: SaveMode): WriteBuilder = { | ||
| this.mode = mode | ||
| this | ||
| } | ||
|
|
||
| override def buildForBatch(): BatchWrite = { | ||
| validateInputs() | ||
| val pathName = options.paths().head | ||
| val path = new Path(pathName) | ||
| val sparkSession = SparkSession.active | ||
| val optionsAsScala = options.asMap().asScala.toMap | ||
| val hadoopConf = sparkSession.sessionState.newHadoopConfWithOptions(optionsAsScala) | ||
| val job = getJobInstance(hadoopConf, path) | ||
| val committer = FileCommitProtocol.instantiate( | ||
| sparkSession.sessionState.conf.fileCommitProtocolClass, | ||
| jobId = java.util.UUID.randomUUID().toString, | ||
| outputPath = pathName) | ||
| lazy val description = | ||
| createWriteJobDescription(sparkSession, hadoopConf, job, pathName, optionsAsScala) | ||
|
|
||
| val fs = path.getFileSystem(hadoopConf) | ||
| mode match { | ||
| case SaveMode.ErrorIfExists if fs.exists(path) => | ||
| val qualifiedOutputPath = path.makeQualified(fs.getUri, fs.getWorkingDirectory) | ||
| throw new AnalysisException(s"path $qualifiedOutputPath already exists.") | ||
|
|
||
| case SaveMode.Ignore if fs.exists(path) => | ||
| null | ||
|
|
||
| case SaveMode.Overwrite => | ||
| committer.deleteWithJob(fs, path, true) | ||
|
There was a problem hiding this comment. What happened if the path does not exist? It is possible that the underlying committer's deleteWithJob might not handle this case. There was a problem hiding this comment. if (fs.exists(path)) {
committer.deleteWithJob(fs, path, recursive = true)
}There was a problem hiding this comment. @gatorsmile I check the source code. Actually, all the implementations (that I can see in IDE) handle the case that the file path does not exist. But in Should we follow it? There was a problem hiding this comment. OK, create #23889 for this. |
||
| committer.setupJob(job) | ||
| new FileBatchWrite(job, description, committer) | ||
|
|
||
| case _ => | ||
| committer.setupJob(job) | ||
| new FileBatchWrite(job, description, committer) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Prepares a write job and returns an [[OutputWriterFactory]]. Client side job preparation can | ||
| * be put here. For example, user defined output committer can be configured here | ||
| * by setting the output committer class in the conf of spark.sql.sources.outputCommitterClass. | ||
| */ | ||
| def prepareWrite( | ||
| sqlConf: SQLConf, | ||
| job: Job, | ||
| options: Map[String, String], | ||
| dataSchema: StructType): OutputWriterFactory | ||
|
|
||
| private def validateInputs(): Unit = { | ||
| assert(schema != null, "Missing input data schema") | ||
| assert(queryId != null, "Missing query ID") | ||
| assert(mode != null, "Missing save mode") | ||
| assert(options.paths().length == 1) | ||
| DataSource.validateSchema(schema) | ||
| } | ||
|
|
||
| private def getJobInstance(hadoopConf: Configuration, path: Path): Job = { | ||
| val job = Job.getInstance(hadoopConf) | ||
| job.setOutputKeyClass(classOf[Void]) | ||
| job.setOutputValueClass(classOf[InternalRow]) | ||
| FileOutputFormat.setOutputPath(job, path) | ||
| job | ||
| } | ||
|
|
||
| private def createWriteJobDescription( | ||
| sparkSession: SparkSession, | ||
| hadoopConf: Configuration, | ||
| job: Job, | ||
| pathName: String, | ||
| options: Map[String, String]): WriteJobDescription = { | ||
| val caseInsensitiveOptions = CaseInsensitiveMap(options) | ||
| // Note: prepareWrite has side effect. It sets "job". | ||
| val outputWriterFactory = | ||
| prepareWrite(sparkSession.sessionState.conf, job, caseInsensitiveOptions, schema) | ||
| val allColumns = schema.toAttributes | ||
| val metrics: Map[String, SQLMetric] = BasicWriteJobStatsTracker.metrics | ||
| val serializableHadoopConf = new SerializableConfiguration(hadoopConf) | ||
| val statsTracker = new BasicWriteJobStatsTracker(serializableHadoopConf, metrics) | ||
| // TODO: after partitioning is supported in V2: | ||
| // 1. filter out partition columns in `dataColumns`. | ||
| // 2. Don't use Seq.empty for `partitionColumns`. | ||
| new WriteJobDescription( | ||
| uuid = UUID.randomUUID().toString, | ||
| serializableHadoopConf = new SerializableConfiguration(job.getConfiguration), | ||
| outputWriterFactory = outputWriterFactory, | ||
| allColumns = allColumns, | ||
| dataColumns = allColumns, | ||
| partitionColumns = Seq.empty, | ||
| bucketIdExpression = None, | ||
| path = pathName, | ||
| customPartitionLocations = Map.empty, | ||
| maxRecordsPerFile = caseInsensitiveOptions.get("maxRecordsPerFile").map(_.toLong) | ||
| .getOrElse(sparkSession.sessionState.conf.maxRecordsPerFile), | ||
| timeZoneId = caseInsensitiveOptions.get(DateTimeUtils.TIMEZONE_OPTION) | ||
| .getOrElse(sparkSession.sessionState.conf.sessionLocalTimeZone), | ||
| statsTrackers = Seq(statsTracker) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this method is too long, could be better if we can separate it into multiple methods