Apache Spark - A unified analytics engine for large-scale data processing
Go to file
Daniel Santana 9f13f0fc17 [MINOR][DOCS] Added Missing back slashes
## What changes were proposed in this pull request?

When studying spark many users just copy examples on the documentation and paste on their terminals
and because of that the missing backlashes lead them run into some shell errors.

The added backslashes avoid that problem for spark users with that behavior.

## How was this patch tested?

I generated the documentation locally using jekyll and checked the generated pages

Author: Daniel Santana <mestresan@gmail.com>

Closes #11699 from danielsan/master.
2016-03-14 12:26:08 -07:00
.github [MINOR][MAINTENANCE] Fix typo for the pull request template. 2016-02-24 00:45:31 -08:00
assembly [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version 2016-01-30 00:20:28 -08:00
bin [SPARK-13848][SPARK-5185] Update to Py4J 0.9.2 in order to fix classloading issue 2016-03-14 12:22:02 -07:00
build [SPARK-13324][CORE][BUILD] Update plugin, test, example dependencies for 2.x 2016-02-17 19:03:29 -08:00
common [SPARK-12583][MESOS] Mesos shuffle service: Don't delete shuffle files before application has stopped 2016-03-14 12:22:57 -07:00
conf [SPARK-13264][DOC] Removed multi-byte characters in spark-env.sh.template 2016-02-11 09:30:36 +00:00
core [SPARK-12583][MESOS] Mesos shuffle service: Don't delete shuffle files before application has stopped 2016-03-14 12:22:57 -07:00
data [SPARK-13013][DOCS] Replace example code in mllib-clustering.md using include_example 2016-03-03 09:32:47 -08:00
dev [SPARK-13848][SPARK-5185] Update to Py4J 0.9.2 in order to fix classloading issue 2016-03-14 12:22:02 -07:00
docs [MINOR][DOCS] Added Missing back slashes 2016-03-14 12:26:08 -07:00
examples [MINOR][DOCS] Fix more typos in comments/strings. 2016-03-14 09:07:39 +00:00
external [SPARK-13848][SPARK-5185] Update to Py4J 0.9.2 in order to fix classloading issue 2016-03-14 12:22:02 -07:00
graphx [MINOR][DOCS] Fix more typos in comments/strings. 2016-03-14 09:07:39 +00:00
launcher [SPARK-13578][CORE] Modify launch scripts to not use assemblies. 2016-03-14 11:13:26 -07:00
licenses [SPARK-10833] [BUILD] Inline, organize BSD/MIT licenses in LICENSE 2015-09-28 22:56:43 -04:00
mllib [MINOR][DOCS] Fix more typos in comments/strings. 2016-03-14 09:07:39 +00:00
project [MINOR][DOCS] Fix more typos in comments/strings. 2016-03-14 09:07:39 +00:00
python [SPARK-13848][SPARK-5185] Update to Py4J 0.9.2 in order to fix classloading issue 2016-03-14 12:22:02 -07:00
R [SPARK-13812][SPARKR] Fix SparkR lint-r test errors. 2016-03-13 14:30:44 -07:00
repl [SPARK-3854][BUILD] Scala style: require spaces before {. 2016-03-10 15:57:22 -08:00
sbin [SPARK-13848][SPARK-5185] Update to Py4J 0.9.2 in order to fix classloading issue 2016-03-14 12:22:02 -07:00
sql [SPARK-13658][SQL] BooleanSimplification rule is slow with large boolean expressions 2016-03-14 11:23:29 -07:00
streaming [MINOR][DOCS] Fix more typos in comments/strings. 2016-03-14 09:07:39 +00:00
tools [SPARK-13294][PROJECT INFRA] Remove MiMa's dependency on spark-class / Spark assembly 2016-03-10 23:28:34 -08:00
yarn [SPARK-13848][SPARK-5185] Update to Py4J 0.9.2 in order to fix classloading issue 2016-03-14 12:22:02 -07:00
.gitattributes [SPARK-3870] EOL character enforcement 2014-10-31 12:39:52 -07:00
.gitignore [SPARK-13596][BUILD] Move misc top-level build files into appropriate subdirs 2016-03-07 14:48:02 -08:00
CONTRIBUTING.md [SPARK-6889] [DOCS] CONTRIBUTING.md updates to accompany contribution doc updates 2015-04-21 22:34:31 -07:00
LICENSE [SPARK-13848][SPARK-5185] Update to Py4J 0.9.2 in order to fix classloading issue 2016-03-14 12:22:02 -07:00
NOTICE [SPARK-8725][PROJECT-INFRA] Test modules in topologically-sorted order in dev/run-tests 2016-01-26 14:20:11 -08:00
pom.xml [SPARK-13663][CORE] Upgrade Snappy Java to 1.1.2.1 2016-03-10 15:17:37 +00:00
README.md Add links howto to setup IDEs for developing spark 2015-12-04 14:43:16 +00:00
scalastyle-config.xml [SPARK-3854][BUILD] Scala style: require spaces before {. 2016-03-10 15:57:22 -08:00

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 and project wiki. 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.) More detailed documentation is available from the project site, at "Building Spark". For developing Spark using an IDE, see Eclipse and IntelliJ.

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.

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" 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.