[SPARK-48545][SQL] Create to_avro and from_avro SQL functions to match DataFrame equivalents #46977
Next
Next commit
commit
commit commit commit commit commit commit
- Loading branch information
commit a7c08a68adf6150aaaffc1d13035fb699887e64c
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,144 @@ | ||
| /* | ||
| * 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.catalyst.expressions | ||
|
|
||
| import org.apache.spark.sql.catalyst.analysis.TypeCheckResult | ||
| import org.apache.spark.sql.catalyst.util.ArrayBasedMapData | ||
| import org.apache.spark.sql.types.{MapType, NullType, StringType} | ||
| import org.apache.spark.unsafe.types.UTF8String | ||
| import org.apache.spark.util.Utils | ||
|
|
||
| /** | ||
| * Converts a binary column of Avro format into its corresponding Catalyst value. | ||
| * This is a thin wrapper over the [[AvroDataToCatalyst]] class to create a SQL function. | ||
| * The specified schema must match actual schema of the read data, otherwise the behavior | ||
| * is undefined: it may fail or return arbitrary result. | ||
| * To deserialize the data with a compatible and evolved schema, the expected Avro schema can be | ||
| * set via the option avroSchema. | ||
| * | ||
| * @param child the Catalyst binary input column. | ||
| * @param jsonFormatSchema the Avro schema in JSON string format. | ||
| * @param options the options to use when performing the conversion | ||
| * | ||
| * @since 4.0.0 | ||
| */ | ||
| case class FromAvroSqlFunction(child: Expression, jsonFormatSchema: Expression, options: Expression) | ||
dtenedor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| extends TernaryExpression with RuntimeReplaceable { | ||
| override def first: Expression = child | ||
| override def second: Expression = jsonFormatSchema | ||
| override def third: Expression = options | ||
|
|
||
| override def withNewChildrenInternal( | ||
| newFirst: Expression, newSecond: Expression, newThird: Expression): Expression = { | ||
| copy(child = newFirst, jsonFormatSchema = newSecond, options = newThird) | ||
| } | ||
|
|
||
| override def checkInputDataTypes(): TypeCheckResult = { | ||
| val schemaCheck = jsonFormatSchema.dataType match { | ||
| case _: StringType | | ||
| _: NullType | ||
| if jsonFormatSchema.foldable => | ||
| None | ||
| case _ => | ||
| Some(TypeCheckResult.TypeCheckFailure( | ||
| "The second argument of the FROM_AVRO SQL function must be a constant string " + | ||
| "containing the JSON representation of the schema to use for converting the value " + | ||
| "from AVRO format")) | ||
| } | ||
| val optionsCheck = options.dataType match { | ||
| case MapType(StringType, StringType, _) | | ||
| MapType(NullType, NullType, _) | | ||
| _: NullType | ||
| if options.foldable => | ||
| None | ||
| case _ => | ||
| Some(TypeCheckResult.TypeCheckFailure( | ||
| "The third argument of the FROM_AVRO SQL function must be a constant map of strings to " + | ||
| "strings containing the options to use for converting the value from AVRO format")) | ||
| } | ||
| schemaCheck.getOrElse( | ||
| optionsCheck.getOrElse( | ||
| TypeCheckResult.TypeCheckSuccess)) | ||
| } | ||
|
|
||
| override def replacement: Expression = { | ||
| val schemaValue: String = jsonFormatSchema.eval() match { | ||
| case s: UTF8String => | ||
| s.toString | ||
| case null => | ||
| "" | ||
| } | ||
| val optionsValue: Map[String, String] = options.eval() match { | ||
| case a: ArrayBasedMapData if a.keyArray.array.nonEmpty => | ||
| val keys: Array[String] = a.keyArray.array.map(_.toString) | ||
| val values: Array[String] = a.valueArray.array.map(_.toString) | ||
| keys.zip(values).toMap | ||
| case _ => | ||
| Map.empty | ||
| } | ||
| val constructor = | ||
| Utils.classForName("org.apache.spark.sql.avro.AvroDataToCatalyst").getConstructors().head | ||
gengliangwang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| val expr = constructor.newInstance(child, schemaValue, optionsValue) | ||
| expr.asInstanceOf[Expression] | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Converts a Catalyst binary input value into its corresponding AvroAvro format result. | ||
| * This is a thin wrapper over the [[CatalystDataToAvro]] class to create a SQL function. | ||
| * | ||
| * @param child the Catalyst binary input column. | ||
| * @param jsonFormatSchema the Avro schema in JSON string format. | ||
| * | ||
| * @since 4.0.0 | ||
| */ | ||
| case class ToAvroSqlFunction(child: Expression, jsonFormatSchema: Expression) | ||
| extends BinaryExpression with RuntimeReplaceable { | ||
| override def left: Expression = child | ||
|
|
||
| override def right: Expression = jsonFormatSchema | ||
|
|
||
| override def withNewChildrenInternal(newLeft: Expression, newRight: Expression): Expression = { | ||
| copy(child = newLeft, jsonFormatSchema = newRight) | ||
| } | ||
|
|
||
| override def checkInputDataTypes(): TypeCheckResult = { | ||
| jsonFormatSchema.dataType match { | ||
| case _: StringType if jsonFormatSchema.foldable => | ||
| TypeCheckResult.TypeCheckSuccess | ||
| case _ => | ||
| TypeCheckResult.TypeCheckFailure( | ||
| "The second argument of the TO_AVRO SQL function must be a constant string " + | ||
| "containing the JSON representation of the schema to use for converting the value " + | ||
| "to AVRO format") | ||
| } | ||
| } | ||
|
|
||
| override def replacement: Expression = { | ||
| val schemaValue: Option[String] = jsonFormatSchema.eval() match { | ||
| case null => | ||
| None | ||
| case s: UTF8String => | ||
| Some(s.toString) | ||
| } | ||
| val constructor = | ||
| Utils.classForName("org.apache.spark.sql.avro.CatalystDataToAvro").getConstructors().head | ||
| val expr = constructor.newInstance(child, schemaValue) | ||
| expr.asInstanceOf[Expression] | ||
| } | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.