Skip to content


Subversion checkout URL

You can clone with
Download ZIP

Getting Started

P. Oscar Boykin edited this page · 31 revisions


Getting help


Matrix API

Third Party Modules






Clone this wiki locally

Five minute REPL walk through

To get a feel for scalding, assuming you have git and java installed, try the Alice in Wonderland walkthrough which shows how to use Scalding step by step to learn about the book's text.

After that, you can follow this guide to create your first Job outside of the REPL and run it.

Preliminaries for making your first Job

To get started with Scalding, first clone the Scalding repository on Github:

git clone

Next, build the code using sbt (a standard Scala build tool). Make sure you have Scala (download here, see scalaVersion in project/Build.scala for the correct version to download), and run the following commands:

./sbt update
./sbt test     # runs the tests; if you do 'sbt assembly' below, these tests, which are long, are repeated
./sbt assembly # creates a fat jar with all dependencies, which is useful when using the scald.rb script

Now you're good to go!

Using Scalding with other versions of Scala

Scalding works with Scala 2.9 and 2.10, though a few configuration files must be changed for this to work. In project/Build.scala, ensure that the proper scalaVersion value is set. Additionally, you'll need to ensure the proper version of specs in the same config. Change the following line

libraryDependencies += "org.scala-tools.testing" % "specs_2.9.1" % "1.6.9" % "test"

to correspond to the proper version of scala (_2.9.1 should work with scala 2.9.2). You can find the published versions here.

IDE Support

Scala's IDE support is generally not as strong as Java's, but there are several options that some people prefer. Both Eclipse and IntelliJ have plugins that support Scala syntax. To generate a project file for Scalding in Eclipse, refer to this project, and for IntelliJ files, this (note that with the latter, the 1.1 snapshot is recommended).

WordCount in Scalding

Let's look at a simple WordCount job.

import com.twitter.scalding._

class WordCountJob(args : Args) extends Job(args) {
    .flatMap { line => line.split("""\s+""") }
    .groupBy { word => word }

This job reads in a file, emits every word in a line, counts the occurrences of each word, and writes these word-count pairs to a tab-separated file.

To run the job, copy the source code above into a WordCountJob.scala file, create a file named someInputfile.txt containing some arbitrary text, and then enter the following command from the root of the Scalding repository:

scripts/scald.rb --local WordCountJob.scala --input someInputfile.txt --output ./someOutputFile.tsv

This runs the WordCount job in local mode (i.e., not on a Hadoop cluster). After a few seconds, your first Scalding job should be done!

WordCount dissection

Let's take a closer look at the job.


TextLine is an example of a Scalding source that reads each line of a file into a field named line.

TextLine(args("input")) // args("input") contains a filename to read from

Another common source is a TypedTsv source that reads tab-delimited files. You can also create sources that read directly from LZO-compressed files on HDFS (possibly containing Protobuf- or Thrift-encoded objects!), or even database sources that read directly from a MySQL table. See the scalding-commons module for lzo, thrift and protobuf support. Also see scalding-avro if you use avro.


flatMap is an example of a function that you can apply to a stream of tuples.

  // flat map the "line" field to a new words separated by one or more space
  .flatMap { line => line.split("""\s+""") }

The above works just like calling flatMap on a List in scala.

Our tuple stream now contains something like the following:

input             output
this is a line    this
line 2            is

See the Type-safe api reference for more examples of flatMap (including how to flat map from and to multiple fields), as well as examples of other functions you can apply to a tuple stream.


Next, we group the same words together, and count the size of each group.

  .flatMap { line => line.split("""\s+""") }
  .groupBy { word => word }

Here, we group the stream into groups of tuples with the same word, and then we make the value for each keyed group the size of that group.

The tuple stream now looks like:

(line, 2)
(this, 1)
(is, 1)

Again, see the Type-safe api reference for more examples of grouping functions.

write, Tsv

Finally, just as we read from a TextLine source, we can also output our computations to a TypedTsv source. A TypedTsv can see the types it is putting in each column. We could write TypedTsv[(String, Long)] below to be sure we are writing what we intend, but scala can usually infer the types if we leave them off (though, when you get in trouble, try adding the types near the compilation error and see if you can get a better message as to what is going on).

    .flatMap { line => line.split("""\s+""") }
    .groupBy { word => word }


The scald.rb script in the scripts/ directory is a handy script that makes it easy to run jobs in both local mode or on a remote Hadoop cluster. It handles simple command-line parsing, and copies over necessary JAR files when running remote jobs.

If you're running many Scalding jobs, it can be useful to add scald.rb to your path, so that you don't need to provide the absolute pathname every time. One way of doing this is via (something like):

ln -s scripts/scald.rb $HOME/bin/

This creates a symlink to the scald.rb script in your $HOME/bin/ directory (which should already be included in your PATH).

See scald.rb for more information, including instructions on how to set up the script to run jobs remotely.

Next Steps

You now know the basics of Scalding! To learn more, check out the following resources:

  • REPL Example: Try the Alice in Wonderland walkthrough which shows how to use Scalding step by step to learn about the book's text.
  • tutorial/: this folder contains an introductory series of runnable jobs.
  • API Reference: includes code snippets explaining different kinds of Scalding functions (e.g., map, filter, project, groupBy, join) and much more.
  • Matrix API Reference: the API reference for the Type-safe Matrix library
  • Cookbook: Short recipes for common tasks.
Something went wrong with that request. Please try again.