A Scala API for Apache Beam and Google Cloud Dataflow.
Permalink
Failed to load latest commit information.
.circleci Add jdk11 build steps (#1361) Sep 12, 2018
logo add logo Jul 26, 2017
project 1384: Add a compiler flags for coder warnings (#1401) Sep 21, 2018
scio-avro/src Register sys.props (#1404) Sep 25, 2018
scio-bench add in long-running, hourly polled streaming benchmark (#1333) Sep 5, 2018
scio-bigquery/src Apply scalafix rules (#1405) Sep 25, 2018
scio-bigtable/src Apply scalafix rules (#1405) Sep 25, 2018
scio-cassandra2/src remove ByteBuffer coder, fix CassandraIO warnings (#1380) Sep 19, 2018
scio-cassandra3/src remove ByteBuffer coder, fix CassandraIO warnings (#1380) Sep 19, 2018
scio-coders-macros/src/main/scala/com/spotify/scio/coders Register sys.props (#1404) Sep 25, 2018
scio-coders/src tweak scalafmt (#1400) Sep 24, 2018
scio-core/src Add registered sys props to --help (#1406) Sep 26, 2018
scio-elasticsearch2/src Apply scalafix rules (#1405) Sep 25, 2018
scio-elasticsearch5/src Apply scalafix rules (#1405) Sep 25, 2018
scio-examples/src Add scalafmt (#1372) Sep 18, 2018
scio-extra/src Apply scalafix rules (#1405) Sep 25, 2018
scio-jdbc/src Add scalafmt (#1372) Sep 18, 2018
scio-jmh/src/test/scala/com/spotify/scio/jmh tweak scalafmt (#1400) Sep 24, 2018
scio-parquet/src Apply scalafix rules (#1405) Sep 25, 2018
scio-repl/src Apply scalafix rules (#1405) Sep 25, 2018
scio-schemas/src/main Add scalafmt (#1372) Sep 18, 2018
scio-tensorflow/src Move avro static invoke coder (#1391) Sep 20, 2018
scio-test/src Apply scalafix rules (#1405) Sep 25, 2018
scripts tweak scalafmt (#1400) Sep 24, 2018
site refactor site layout Nov 8, 2017
.gitignore Fix kryo performance Oct 6, 2017
.jvmopts Use xlarge resource class (#1200) Jun 7, 2018
.scalafmt.conf Add scalafmt (#1372) Sep 18, 2018
CONTRIBUTING.md add scalafmt to CONTRIBUTING.md Sep 18, 2018
LICENSE Add license file Feb 19, 2016
NOTICE add NOTICE Feb 23, 2016
README.md Update README with reference to scio.g8 (#1072) Mar 10, 2018
apache.sbt add nightly build with Beam SNAPSHOTs, fix #512 Jan 5, 2018
build.sbt Register sys.props (#1404) Sep 25, 2018
scalastyle-config.xml Add scalafmt (#1372) Sep 18, 2018
version.sbt Setting version to 0.7.0-SNAPSHOT Sep 19, 2018

README.md

Scio

Build Status codecov.io GitHub license Maven Central Join the chat at https://gitter.im/spotify/scio

Scio Logo

Ecclesiastical Latin IPA: /ˈʃi.o/, [ˈʃiː.o], [ˈʃi.i̯o]

Verb: I can, know, understand, have knowledge.

Scio is a Scala API for Apache Beam and Google Cloud Dataflow inspired by Apache Spark and Scalding.

Scio 0.3.0 and future versions depend on Apache Beam (org.apache.beam) while earlier versions depend on Google Cloud Dataflow SDK (com.google.cloud.dataflow). See this page for a list of breaking changes.

Features

  • Scala API close to that of Spark and Scalding core APIs
  • Unified batch and streaming programming model
  • Fully managed service*
  • Integration with Google Cloud products: Cloud Storage, BigQuery, Pub/Sub, Datastore, Bigtable
  • HDFS, JDBC, TensorFlow TFRecords, Cassandra, Elasticsearch and Parquet I/O
  • Interactive mode with Scio REPL
  • Type safe BigQuery
  • Integration with Algebird and Breeze
  • Pipeline orchestration with Scala Futures
  • Distributed cache

* provided by Google Cloud Dataflow

Quick Start

Use our giter8 template to quickly setup a project:

sbt new spotify/scio.g8

Compile it:

sbt pack

Run the included word count example:

target/pack/bin/word-count --output=wc

Inspect the results:

cat wc/part-00000-of-00001.txt

Documentation

Getting Started is the best place to start with Scio. If you are new to Apache Beam and distributed data processing, check out the Beam Programming Guide first for a detailed explanation of the Beam programming model and concepts. If you have experience with other Scala data processing libraries, check out this comparison between Scio, Scalding and Spark. Finally check out this document about the relationship between Scio, Beam and Dataflow.

Example Scio pipelines and tests can be found under scio-examples. A lot of them are direct ports from Beam's Java examples. See this page for some of them with side-by-side explanation. Also see Big Data Rosetta Code for common data processing code snippets in Scio, Scalding and Spark.

Artifacts

Scio includes the following artifacts:

  • scio-core: core library
  • scio-test: test utilities, add to your project as a "test" dependency
  • scio-avro: add-on for Avro, included in scio-core but can also be used standalone
  • scio-bigquery: add-on for BigQuery, included in scio-core but can also be used standalone
  • scio-bigtable: add-on for Bigtable
  • scio-cassandra2: add-on for Cassandra 2.x
  • scio-cassandra3: add-on for Cassandra 3.x
  • scio-elasticsearch2: add-on for Elasticsearch 2.x
  • scio-elasticsearch5: add-on for Elasticsearch 5.x
  • scio-extra: extra utilities for working with collections, Breeze, etc.
  • scio-hdfs: add-on for HDFS IO
  • scio-jdbc: add-on for JDBC IO
  • scio-parquet: add-on for Parquet
  • scio-tensorflow: add-on for TensorFlow TFRecords IO and prediction

License

Copyright 2016 Spotify AB.

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0