Guide list

Sparkling documentation is organized as a number of guides, covering all kinds of topics.

We recommend that you read these guides, if possible, in this order:

Getting started

This guide combines an overview of Sparkling with a quick tutorial that helps you to get started with it. It should take about 10 minutes to read and study the provided code examples. This guide covers:

  • Feature of Sparkling, why Sparkling was created
  • Clojure and Apache Spark version requirements
  • How to add Sparkling dependency to your project

Fully working tutorial project

This guide takes you through a full project from setting it up with lein new to running it locally. Take an hour to complete. This guide covers:

  • Setting up a project, adding required dependencies
  • REPL-driven development, Test-driven development of both pure-Clojure functions and Spark transformations
  • Dealing with Spark‚Äôs Tuple2 instances and destructuring them e.g. after map-to-pair or join.
  • Running your Spark powered application locally.

Tell Us What You Think!

Please take a moment to tell us what you think about this guide on Twitter or open an issue on Github.

Let us know what was unclear or what has not been covered. Reader feedback is key to making the documentation better. If we know people are reading the documentation, we'll be much more inclined to make the documentation that much better. Please speak up!