com.databricks.spark.xml.functions.scala Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2019 Databricks
*
* Licensed 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 com.databricks.spark.xml
import org.apache.spark.sql.Column
import org.apache.spark.sql.types.DataType
/**
* Support functions for working with XML columns directly.
*/
object functions {
/**
* Parses a column containing a XML string into a `StructType` with the specified schema.
*
* @param col a string column containing XML data
* @param schema the schema to use when parsing the XML string. Must be a StructType if
* column is string-valued, or ArrayType[StructType] if column is an array of strings
* @param options key-value pairs that correspond to those supported by [[XmlOptions]]
*/
def from_xml(col: Column, schema: DataType, options: Map[String, String] = Map.empty): Column = {
new Column(XmlDataToCatalyst(col.expr, schema, XmlOptions(options)))
}
}