Name Last modified Size Description
Parent Directory - ml-features.html 2024-08-16 21:06 612K ml-classification-regression.html 2024-08-16 21:06 463K sql-ref-functions-builtin.html 2024-08-16 21:06 310K structured-streaming-programming-guide.html 2024-08-16 21:06 282K streaming-programming-guide.html 2024-08-16 21:06 219K configuration.html 2024-08-16 21:06 196K graphx-programming-guide.html 2024-08-16 21:06 170K rdd-programming-guide.html 2024-08-16 21:06 164K mllib-evaluation-metrics.html 2024-08-16 21:06 155K sql-migration-guide.html 2024-08-16 21:06 149K mllib-clustering.html 2024-08-16 21:06 129K mllib-ensembles.html 2024-08-16 21:06 118K mllib-statistics.html 2024-08-16 21:06 113K sql-getting-started.html 2024-08-16 21:06 107K generated-agg-funcs-examples.html 2024-08-16 21:06 103K ml-pipeline.html 2024-08-16 21:06 101K running-on-kubernetes.html 2024-08-16 21:06 101K mllib-data-types.html 2024-08-16 21:06 94K generated-datetime-funcs-examples.html 2024-08-16 21:06 92K ml-clustering.html 2024-08-16 21:06 92K sparkr.html 2024-08-16 21:06 91K structured-streaming-kafka-integration.html 2024-08-16 21:06 89K mllib-linear-methods.html 2024-08-16 21:06 81K ml-tuning.html 2024-08-16 21:06 81K mllib-feature-extraction.html 2024-08-16 21:06 79K monitoring.html 2024-08-16 21:06 77K mllib-decision-tree.html 2024-08-16 21:06 75K sql-ref-null-semantics.html 2024-08-16 21:06 74K ml-migration-guide.html 2024-08-16 21:06 70K sql-ref-ansi-compliance.html 2024-08-16 21:06 67K ml-statistics.html 2024-08-16 21:06 65K ml-collaborative-filtering.html 2024-08-16 21:06 64K running-on-yarn.html 2024-08-16 21:06 62K sql-data-sources-parquet.html 2024-08-16 21:06 61K running-on-mesos.html 2024-08-16 21:06 60K security.html 2024-08-16 21:06 59K sql-ref-functions-udf-aggregate.html 2024-08-16 21:06 58K quick-start.html 2024-08-16 21:06 57K sql-ref-syntax-qry-select-groupby.html 2024-08-16 21:06 56K sql-data-sources-load-save-functions.html 2024-08-16 21:06 56K sql-ref-syntax-ddl-alter-table.html 2024-08-16 21:06 55K sql-data-sources-hive-tables.html 2024-08-16 21:06 54K mllib-optimization.html 2024-08-16 21:06 53K mllib-frequent-pattern-mining.html 2024-08-16 21:06 52K streaming-kafka-0-10-integration.html 2024-08-16 21:06 51K ml-frequent-pattern-mining.html 2024-08-16 21:06 51K sql-data-sources-avro.html 2024-08-16 21:06 50K mllib-dimensionality-reduction.html 2024-08-16 21:06 50K sql-ref-literals.html 2024-08-16 21:06 50K ml-datasource.html 2024-08-16 21:06 49K sql-ref-datatypes.html 2024-08-16 21:06 49K sql-ref-syntax-qry-select-window.html 2024-08-16 21:06 49K generated-array-funcs-examples.html 2024-08-16 21:06 48K spark-standalone.html 2024-08-16 21:06 47K sql-data-sources-jdbc.html 2024-08-16 21:06 46K mllib-collaborative-filtering.html 2024-08-16 21:06 46K sql-ref-syntax-aux-show-table.html 2024-08-16 21:06 46K generated-window-funcs-examples.html 2024-08-16 21:06 45K web-ui.html 2024-08-16 21:06 45K sql-ref-syntax-dml-insert-into.html 2024-08-16 21:06 44K generated-runtime-sql-config-table.html 2024-08-16 21:06 44K sql-ref-syntax-qry-select-join.html 2024-08-16 21:06 43K sql-ref-syntax-aux-describe-table.html 2024-08-16 21:06 42K sql-data-sources-generic-options.html 2024-08-16 21:06 42K tuning.html 2024-08-16 21:06 41K sql-ref-syntax-dml-insert-overwrite-table.html 2024-08-16 21:06 40K sql-ref-syntax-qry-select-sortby.html 2024-08-16 21:06 39K mllib-isotonic-regression.html 2024-08-16 21:06 39K sql-ref-syntax-qry-select-transform.html 2024-08-16 21:06 39K job-scheduling.html 2024-08-16 21:06 38K sql-ref-syntax-qry-select-like.html 2024-08-16 21:06 37K sql-ref-syntax-ddl-alter-view.html 2024-08-16 21:06 37K sql-ref-syntax-qry-select-lateral-view.html 2024-08-16 21:06 37K sql-ref-syntax-qry-select-hints.html 2024-08-16 21:06 36K mllib-naive-bayes.html 2024-08-16 21:06 35K sql-ref-syntax-qry-select-tvf.html 2024-08-16 21:06 35K building-spark.html 2024-08-16 21:06 35K sql-ref-syntax-ddl-create-table-hiveformat.html 2024-08-16 21:06 34K streaming-kinesis-integration.html 2024-08-16 21:06 34K sql-ref-syntax-qry-select-setops.html 2024-08-16 21:06 34K sql-performance-tuning.html 2024-08-16 21:06 34K streaming-custom-receivers.html 2024-08-16 21:06 34K sql-ref-datetime-pattern.html 2024-08-16 21:06 34K sql-ref-syntax-qry-select.html 2024-08-16 21:06 33K sql-data-sources-json.html 2024-08-16 21:06 32K sql-ref-syntax-qry-select-orderby.html 2024-08-16 21:06 31K submitting-applications.html 2024-08-16 21:06 31K sql-ref-syntax-qry-select-having.html 2024-08-16 21:06 31K sql-ref-syntax-qry-select-where.html 2024-08-16 21:06 31K sql-ref-syntax-qry-select-pivot.html 2024-08-16 21:06 30K sql-ref-functions-udf-scalar.html 2024-08-16 21:06 30K sql-ref-syntax-qry-select-case.html 2024-08-16 21:06 30K sql-ref-syntax-aux-show-views.html 2024-08-16 21:06 29K sql-ref-syntax-aux-describe-function.html 2024-08-16 21:06 29K sql-ref-syntax-aux-analyze-table.html 2024-08-16 21:06 29K cloud-integration.html 2024-08-16 21:06 28K sql-ref-syntax-ddl-create-function.html 2024-08-16 21:06 28K sql-ref-syntax-qry-select-cte.html 2024-08-16 21:06 28K sql-ref-syntax-ddl-create-table-datasource.html 2024-08-16 21:06 27K sql-ref-syntax-qry-select-limit.html 2024-08-16 21:06 27K sql-ref-syntax-aux-show-partitions.html 2024-08-16 21:06 27K sql-ref-syntax-qry-select-clusterby.html 2024-08-16 21:06 27K sql-ref-syntax-qry-select-sampling.html 2024-08-16 21:06 27K sql-ref-syntax-dml-load.html 2024-08-16 21:06 26K sql-ref-syntax-qry-select-distribute-by.html 2024-08-16 21:06 26K sql-ref-syntax-aux-show-functions.html 2024-08-16 21:06 26K sql-ref-syntax-aux-describe-query.html 2024-08-16 21:06 26K sql-ref-syntax-aux-show-tables.html 2024-08-16 21:06 25K sql-ref-syntax-aux-show-tblproperties.html 2024-08-16 21:06 25K ml-guide.html 2024-08-16 21:06 25K sql-ref-syntax-aux-describe-database.html 2024-08-16 21:06 25K sql-ref-syntax-qry-explain.html 2024-08-16 21:06 24K sparkr-migration-guide.html 2024-08-16 21:06 24K sql-ref-syntax-qry-select-inline-table.html 2024-08-16 21:06 24K sql-ref-functions-udf-hive.html 2024-08-16 21:06 24K ml-linalg-guide.html 2024-08-16 21:06 24K sql-ref-syntax-qry-select-file.html 2024-08-16 21:06 23K ml-advanced.html 2024-08-16 21:06 23K sql-ref-syntax-ddl-create-database.html 2024-08-16 21:06 23K sql-ref-syntax-ddl-drop-function.html 2024-08-16 21:06 23K sql-ref-syntax-ddl-create-view.html 2024-08-16 21:06 23K sql-ref-syntax-ddl-truncate-table.html 2024-08-16 21:06 23K sql-ref-syntax-aux-show-columns.html 2024-08-16 21:06 22K sql-ref-syntax-aux-cache-cache-table.html 2024-08-16 21:06 22K sql-ref-syntax-ddl-create-table-like.html 2024-08-16 21:06 22K sql-ref-syntax-aux-show-databases.html 2024-08-16 21:06 22K sql-ref-syntax-ddl-alter-database.html 2024-08-16 21:06 22K sql-ref-syntax-dml-insert-overwrite-directory-hive.html 2024-08-16 21:06 22K mllib-pmml-model-export.html 2024-08-16 21:06 22K sql-ref-syntax-dml-insert-overwrite-directory.html 2024-08-16 21:06 21K sql-ref-syntax-ddl-repair-table.html 2024-08-16 21:06 21K sql-ref-syntax.html 2024-08-16 21:06 21K sql-ref-syntax-aux-show-create-table.html 2024-08-16 21:06 21K sql-ref-syntax-ddl-drop-table.html 2024-08-16 21:06 21K sql-ref-syntax-ddl-drop-view.html 2024-08-16 21:06 21K sql-ref-syntax-aux-conf-mgmt-set-timezone.html 2024-08-16 21:06 21K sql-ref-syntax-aux-resource-mgmt-list-jar.html 2024-08-16 21:06 20K sql-ref-syntax-ddl-drop-database.html 2024-08-16 21:06 20K sql-distributed-sql-engine.html 2024-08-16 21:06 20K sql-ref-syntax-ddl-usedb.html 2024-08-16 21:06 20K sql-ref-syntax-aux-conf-mgmt-set.html 2024-08-16 21:06 20K generated-json-funcs-examples.html 2024-08-16 21:06 20K sql-ref-syntax-aux-cache-refresh-function.html 2024-08-16 21:06 20K sql-ref-syntax-aux-resource-mgmt-list-file.html 2024-08-16 21:06 20K sql-ref-syntax-aux-cache-refresh-table.html 2024-08-16 21:06 20K mllib-guide.html 2024-08-16 21:06 19K sql-ref-syntax-aux-cache-refresh.html 2024-08-16 21:06 19K sql-ref-syntax-aux-cache-uncache-table.html 2024-08-16 21:06 19K sql-data-sources.html 2024-08-16 21:06 19K cluster-overview.html 2024-08-16 21:06 19K sql-ref-syntax-qry-select-subqueries.html 2024-08-16 21:06 19K sql-ref-syntax-hive-format.html 2024-08-16 21:06 19K sql-data-sources-binaryFile.html 2024-08-16 21:06 19K sql-ref-syntax-aux-conf-mgmt-reset.html 2024-08-16 21:06 19K sql-ref-syntax-aux-resource-mgmt-add-file.html 2024-08-16 21:06 19K storage-openstack-swift.html 2024-08-16 21:06 19K sql-ref-syntax-ddl.html 2024-08-16 21:06 19K sql-ref-syntax-aux-resource-mgmt-add-jar.html 2024-08-16 21:06 19K mllib-classification-regression.html 2024-08-16 21:06 19K sql-ref-identifier.html 2024-08-16 21:06 18K sql-ref-syntax-aux-show.html 2024-08-16 21:06 18K sql-ref-syntax-aux-cache-clear-cache.html 2024-08-16 21:06 18K sql-ref-syntax-ddl-create-table.html 2024-08-16 21:06 18K core-migration-guide.html 2024-08-16 21:06 18K sql-ref-syntax-qry.html 2024-08-16 21:06 18K sql-programming-guide.html 2024-08-16 21:06 18K sql-ref-syntax-aux-cache.html 2024-08-16 21:06 18K sql-ref-functions.html 2024-08-16 21:06 18K ss-migration-guide.html 2024-08-16 21:06 18K sql-ref-syntax-aux-describe.html 2024-08-16 21:06 17K sql-ref-syntax-aux-resource-mgmt.html 2024-08-16 21:06 17K sql-data-sources-orc.html 2024-08-16 21:06 17K sql-ref-syntax-aux-conf-mgmt.html 2024-08-16 21:06 17K sql-ref-syntax-aux.html 2024-08-16 21:06 17K hardware-provisioning.html 2024-08-16 21:06 17K sql-ref-syntax-aux-analyze.html 2024-08-16 21:06 16K sql-ref.html 2024-08-16 21:06 16K sql-data-sources-troubleshooting.html 2024-08-16 21:06 16K sql-ref-syntax-dml-insert.html 2024-08-16 21:06 16K ml-ann.html 2024-08-16 21:06 16K sql-ref-syntax-dml.html 2024-08-16 21:06 16K ml-survival-regression.html 2024-08-16 21:06 16K ml-ensembles.html 2024-08-16 21:06 16K ml-decision-tree.html 2024-08-16 21:06 16K ml-linear-methods.html 2024-08-16 21:06 16K hadoop-provided.html 2024-08-16 21:06 15K migration-guide.html 2024-08-16 21:06 14K sql-pyspark-pandas-with-arrow.html 2024-08-16 21:06 14K sql-migration-old.html 2024-08-16 21:06 14K pyspark-migration-guide.html 2024-08-16 21:06 14K streaming-kafka-integration.html 2024-08-16 21:06 13K contributing-to-spark.html 2024-08-16 21:06 12K programming-guide.html 2024-08-16 21:06 12K README.html 2024-08-16 21:06 9.6K generated-static-sql-config-table.html 2024-08-16 21:06 9.4K generated-map-funcs-examples.html 2024-08-16 21:06 8.6K generated-agg-funcs-table.html 2024-08-16 21:06 7.9K generated-datetime-funcs-table.html 2024-08-16 21:06 7.1K generated-array-funcs-table.html 2024-08-16 21:06 3.9K generated-window-funcs-table.html 2024-08-16 21:06 2.7K generated-json-funcs-table.html 2024-08-16 21:06 1.2K generated-map-funcs-table.html 2024-08-16 21:06 782 building-with-maven.html 2024-08-16 21:06 425 sql-reference.html 2024-08-16 21:06 397 redirects.json 2024-08-16 21:06 85 js/ 2024-08-16 21:42 - img/ 2024-08-16 21:42 - css/ 2024-08-16 21:42 - api/ 2024-08-16 21:42 -
Welcome to the Spark documentation!
This readme will walk you through navigating and building the Spark documentation, which is included here with the Spark source code. You can also find documentation specific to release versions of Spark at https://spark.apache.org/documentation.html.
Read on to learn more about viewing documentation in plain text (i.e., markdown) or building the documentation yourself. Why build it yourself? So that you have the docs that correspond to whichever version of Spark you currently have checked out of revision control.
The Spark documentation build uses a number of tools to build HTML docs and API docs in Scala, Java, Python, R and SQL.
You need to have Ruby and Python installed. Also install the following libraries:
$ sudo gem install jekyll jekyll-redirect-from rouge
If your ruby version is 3.0 or higher, you should also install webrick
.
$ sudo gem install jekyll jekyll-redirect-from webrick
Note: If you are on a system with both Ruby 1.9 and Ruby 2.0 you may need to replace gem with gem2.0.
If you’d like to generate R documentation, you’ll need to install Pandoc and install these libraries:
$ sudo Rscript -e 'install.packages(c("knitr", "devtools", "testthat", "rmarkdown"), repos="https://cloud.r-project.org/")'
$ sudo Rscript -e 'devtools::install_version("roxygen2", version = "7.1.1", repos="https://cloud.r-project.org/")'
Note: Other versions of roxygen2 might work in SparkR documentation generation but RoxygenNote
field in $SPARK_HOME/R/pkg/DESCRIPTION
is 7.1.1, which is updated if the version is mismatched.
To generate API docs for any language, you’ll need to install these libraries:
$ sudo pip install 'sphinx<3.1.0' mkdocs numpy pydata_sphinx_theme ipython nbsphinx numpydoc 'jinja2<3.0.0'
We include the Spark documentation as part of the source (as opposed to using a hosted wiki, such as the github wiki, as the definitive documentation) to enable the documentation to evolve along with the source code and be captured by revision control (currently git). This way the code automatically includes the version of the documentation that is relevant regardless of which version or release you have checked out or downloaded.
In this directory you will find text files formatted using Markdown, with an “.md” suffix. You can
read those text files directly if you want. Start with index.md
.
Execute jekyll build
from the docs/
directory to compile the site. Compiling the site with
Jekyll will create a directory called _site
containing index.html
as well as the rest of the
compiled files.
$ cd docs
$ jekyll build
You can modify the default Jekyll build as follows:
# Skip generating API docs (which takes a while)
$ SKIP_API=1 jekyll build
# Serve content locally on port 4000
$ jekyll serve --watch
# Build the site with extra features used on the live page
$ PRODUCTION=1 jekyll build
You can build just the Spark scaladoc and javadoc by running ./build/sbt unidoc
from the $SPARK_HOME
directory.
Similarly, you can build just the PySpark docs by running make html
from the
$SPARK_HOME/python/docs
directory. Documentation is only generated for classes that are listed as
public in __init__.py
. The SparkR docs can be built by running $SPARK_HOME/R/create-docs.sh
, and
the SQL docs can be built by running $SPARK_HOME/sql/create-docs.sh
after building Spark first.
When you run jekyll build
in the docs
directory, it will also copy over the scaladoc and javadoc for the various
Spark subprojects into the docs
directory (and then also into the _site
directory). We use a
jekyll plugin to run ./build/sbt unidoc
before building the site so if you haven’t run it (recently) it
may take some time as it generates all of the scaladoc and javadoc using Unidoc.
The jekyll plugin also generates the PySpark docs using Sphinx, SparkR docs
using roxygen2 and SQL docs
using MkDocs.
NOTE: To skip the step of building and copying over the Scala, Java, Python, R and SQL API docs, run SKIP_API=1
jekyll build
. In addition, SKIP_SCALADOC=1
, SKIP_PYTHONDOC=1
, SKIP_RDOC=1
and SKIP_SQLDOC=1
can be used
to skip a single step of the corresponding language. SKIP_SCALADOC
indicates skipping both the Scala and Java docs.
jekyll serve --watch
will only watch what’s in docs/
, and it won’t follow symlinks. That means it won’t monitor your API docs under python/docs
or elsewhere.
To work around this limitation for Python, install entr
and run the following in a separate shell:
cd "$SPARK_HOME/python/docs"
find .. -type f -name '*.py' \
| entr -s 'make html && cp -r _build/html/. ../../docs/api/python'
Whenever there is a change to your Python code, entr
will automatically rebuild the Python API docs and copy them to docs/
, thus triggering a Jekyll update.