org.apache.spark.sql.avro.functions.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spark-connect-client-jvm_2.12 Show documentation
The newest version!
/*
 * 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.avro

import scala.collection.JavaConverters._

import org.apache.spark.annotation.Experimental
import org.apache.spark.sql.Column
import org.apache.spark.sql.functions.{fnWithOptions, lit}

// scalastyle:off: object.name
object functions {
// scalastyle:on: object.name

  /**
   * Converts a binary column of avro format into its corresponding catalyst value. The specified
   * schema must match the read data, otherwise the behavior is undefined: it may fail or return
   * arbitrary result.
   *
   * @param data
   *   the binary column.
   * @param jsonFormatSchema
   *   the avro schema in JSON string format.
   *
   * @since 3.5.0
   */
  @Experimental
  def from_avro(data: Column, jsonFormatSchema: String): Column = {
    Column.fn("from_avro", data, lit(jsonFormatSchema))
  }

  /**
   * Converts a binary column of Avro format into its corresponding catalyst value. 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 data
   *   the binary column.
   * @param jsonFormatSchema
   *   the avro schema in JSON string format.
   * @param options
   *   options to control how the Avro record is parsed.
   *
   * @since 3.5.0
   */
  @Experimental
  def from_avro(
      data: Column,
      jsonFormatSchema: String,
      options: java.util.Map[String, String]): Column = {
    fnWithOptions("from_avro", options.asScala.iterator, data, lit(jsonFormatSchema))
  }

  /**
   * Converts a column into binary of avro format.
   *
   * @param data
   *   the data column.
   *
   * @since 3.5.0
   */
  @Experimental
  def to_avro(data: Column): Column = {
    Column.fn("to_avro", data)
  }

  /**
   * Converts a column into binary of avro format.
   *
   * @param data
   *   the data column.
   * @param jsonFormatSchema
   *   user-specified output avro schema in JSON string format.
   *
   * @since 3.5.0
   */
  @Experimental
  def to_avro(data: Column, jsonFormatSchema: String): Column = {
    Column.fn("to_avro", data, lit(jsonFormatSchema))
  }
}