8e15ac1c67
### What changes were proposed in this pull request? This PR aims to add a documentation on how to read and write TEXT files through various APIs such as Scala, Python and JAVA in Spark to [Data Source documents](https://spark.apache.org/docs/latest/sql-data-sources.html#data-sources). ### Why are the changes needed? Documentation on how Spark handles TEXT files is missing. It should be added to the document for user convenience. ### Does this PR introduce _any_ user-facing change? Yes, this PR adds a new page to Data Sources documents. ### How was this patch tested? Manually build documents and check the page on local as below.  Closes #32053 from itholic/SPARK-34491-TEXT. Authored-by: itholic <haejoon.lee@databricks.com> Signed-off-by: Max Gekk <max.gekk@gmail.com>
1.8 KiB
1.8 KiB
| layout | title | displayTitle | license |
|---|---|---|---|
| global | Text Files | Text Files | 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. |
Spark SQL provides spark.read().text("file_name") to read a file or directory of text files into a Spark DataFrame, and dataframe.write().text("path") to write to a text file. When reading a text file, each line becomes each row that has string "value" column by default. The line separator can be changed as shown in the example below. The option() function can be used to customize the behavior of reading or writing, such as controlling behavior of the line separator, compression, and so on.
{% include_example text_dataset scala/org/apache/spark/examples/sql/SQLDataSourceExample.scala %}
{% include_example text_dataset java/org/apache/spark/examples/sql/JavaSQLDataSourceExample.java %}
{% include_example text_dataset python/sql/datasource.py %}