Mirror of Apache Spark
Clone or download
dongjoon-hyun [SPARK-25656][SQL][DOC][EXAMPLE] Add a doc and examples about extra d…
…ata source options

## What changes were proposed in this pull request?

Our current doc does not explain how we are passing the data source specific options to the underlying data source. According to [the review comment](#22622 (comment)), this PR aims to add more detailed information and examples

## How was this patch tested?

Manual.

Closes #22801 from dongjoon-hyun/SPARK-25656.

Authored-by: Dongjoon Hyun <dongjoon@apache.org>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
Latest commit 4506dad Oct 23, 2018
Permalink
Failed to load latest commit information.
.github [SPARK-18073][DOCS][WIP] Migrate wiki to spark.apache.org web site Nov 23, 2016
R [SPARK-24207][R] add R API for PrefixSpan Oct 21, 2018
assembly [SPARK-25592] Setting version to 3.0.0-SNAPSHOT Oct 2, 2018
bin [HOTFIX] Fix PySpark pip packaging tests by non-ascii compatible char… Oct 20, 2018
build fix security issue of zinc(simplier version) Oct 19, 2018
common [SPARK-25535][CORE] Work around bad error handling in commons-crypto. Oct 9, 2018
conf [SPARK-22466][SPARK SUBMIT] export SPARK_CONF_DIR while conf is default Nov 9, 2017
core [SPARK-25812][UI][TEST] Fix test failure in PagedTableSuite Oct 23, 2018
data [SPARK-22666][ML][SQL] Spark datasource for image format Sep 5, 2018
dev [SPARK-25757][BUILD] Upgrade netty-all from 4.1.17.Final to 4.1.30.Final Oct 21, 2018
docs [SPARK-25656][SQL][DOC][EXAMPLE] Add a doc and examples about extra d… Oct 23, 2018
examples [SPARK-25656][SQL][DOC][EXAMPLE] Add a doc and examples about extra d… Oct 23, 2018
external [SPARK-24601][FOLLOWUP] Update Jackson to 2.9.6 in Kinesis Oct 18, 2018
graphx [SPARK-25592] Setting version to 3.0.0-SNAPSHOT Oct 2, 2018
hadoop-cloud [SPARK-25016][BUILD][CORE] Remove support for Hadoop 2.6 Oct 10, 2018
launcher [SPARK-25592] Setting version to 3.0.0-SNAPSHOT Oct 2, 2018
licenses-binary [SPARK-23654][BUILD] remove jets3t as a dependency of spark Aug 16, 2018
licenses [SPARK-24654][BUILD] Update, fix LICENSE and NOTICE, and specialize f… Jul 1, 2018
mllib-local [SPARK-25592] Setting version to 3.0.0-SNAPSHOT Oct 2, 2018
mllib [SPARK-24207][R] add R API for PrefixSpan Oct 21, 2018
project [SPARK-25680][SQL] SQL execution listener shouldn't happen on executi… Oct 17, 2018
python Revert "[SPARK-25758][ML] Deprecate computeCost on BisectingKMeans" Oct 21, 2018
repl [SPARK-25592] Setting version to 3.0.0-SNAPSHOT Oct 2, 2018
resource-managers [SPARK-25730][K8S] Delete executor pods from kubernetes after figurin… Oct 21, 2018
sbin [SPARK-25735][CORE][MINOR] Improve start-thriftserver.sh: print clean… Oct 17, 2018
sql [SPARK-25791][SQL] Datatype of serializers in RowEncoder should be ac… Oct 23, 2018
streaming [SPARK-19287][CORE][STREAMING] JavaPairRDD flatMapValues requires fun… Oct 12, 2018
tools [SPARK-25592] Setting version to 3.0.0-SNAPSHOT Oct 2, 2018
.gitattributes [SPARK-3870] EOL character enforcement Oct 31, 2014
.gitignore [MINOR] Add .crc files to .gitignore Aug 21, 2018
CONTRIBUTING.md [SPARK-18073][DOCS][WIP] Migrate wiki to spark.apache.org web site Nov 23, 2016
LICENSE [SPARK-24654][BUILD] Update, fix LICENSE and NOTICE, and specialize f… Jul 1, 2018
LICENSE-binary [SPARK-23654][BUILD] remove jets3t as a dependency of spark Aug 16, 2018
NOTICE [SPARK-23654][BUILD] remove jets3t as a dependency of spark Aug 16, 2018
NOTICE-binary [SPARK-23654][BUILD] remove jets3t as a dependency of spark Aug 16, 2018
README.md [DOC] Update some outdated links Sep 4, 2018
appveyor.yml [MINOR][BUILD] Remove -Phive-thriftserver profile within appveyor.yml Jul 30, 2018
pom.xml [SPARK-25757][BUILD] Upgrade netty-all from 4.1.17.Final to 4.1.30.Final Oct 21, 2018
scalastyle-config.xml [SPARK-25565][BUILD] Add scalastyle rule to check add Locale.ROOT to … Sep 30, 2018

README.md

Apache Spark

Spark is a fast and general cluster computing system for Big Data. It provides high-level APIs in Scala, Java, Python, and R, and an optimized engine that supports general computation graphs for data analysis. It also supports a rich set of higher-level tools including Spark SQL for SQL and DataFrames, MLlib for machine learning, GraphX for graph processing, and Spark Streaming for stream processing.

http://spark.apache.org/

Online Documentation

You can find the latest Spark documentation, including a programming guide, on the project web page. This README file only contains basic setup instructions.

Building Spark

Spark is built using Apache Maven. To build Spark and its example programs, run:

build/mvn -DskipTests clean package

(You do not need to do this if you downloaded a pre-built package.)

You can build Spark using more than one thread by using the -T option with Maven, see "Parallel builds in Maven 3". More detailed documentation is available from the project site, at "Building Spark".

For general development tips, including info on developing Spark using an IDE, see "Useful Developer Tools".

Interactive Scala Shell

The easiest way to start using Spark is through the Scala shell:

./bin/spark-shell

Try the following command, which should return 1000:

scala> sc.parallelize(1 to 1000).count()

Interactive Python Shell

Alternatively, if you prefer Python, you can use the Python shell:

./bin/pyspark

And run the following command, which should also return 1000:

>>> sc.parallelize(range(1000)).count()

Example Programs

Spark also comes with several sample programs in the examples directory. To run one of them, use ./bin/run-example <class> [params]. For example:

./bin/run-example SparkPi

will run the Pi example locally.

You can set the MASTER environment variable when running examples to submit examples to a cluster. This can be a mesos:// or spark:// URL, "yarn" to run on YARN, and "local" to run locally with one thread, or "local[N]" to run locally with N threads. You can also use an abbreviated class name if the class is in the examples package. For instance:

MASTER=spark://host:7077 ./bin/run-example SparkPi

Many of the example programs print usage help if no params are given.

Running Tests

Testing first requires building Spark. Once Spark is built, tests can be run using:

./dev/run-tests

Please see the guidance on how to run tests for a module, or individual tests.

There is also a Kubernetes integration test, see resource-managers/kubernetes/integration-tests/README.md

A Note About Hadoop Versions

Spark uses the Hadoop core library to talk to HDFS and other Hadoop-supported storage systems. Because the protocols have changed in different versions of Hadoop, you must build Spark against the same version that your cluster runs.

Please refer to the build documentation at "Specifying the Hadoop Version and Enabling YARN" for detailed guidance on building for a particular distribution of Hadoop, including building for particular Hive and Hive Thriftserver distributions.

Configuration

Please refer to the Configuration Guide in the online documentation for an overview on how to configure Spark.

Contributing

Please review the Contribution to Spark guide for information on how to get started contributing to the project.