beam

module

v2.7.0-RC1+incompatible Latest Latest Go to latest Published: Sep 6, 2018 License: Apache-2.0, BSD-3-Clause, MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

README ¶

Apache Beam

Apache Beam is a unified model for defining both batch and streaming data-parallel processing pipelines, as well as a set of language-specific SDKs for constructing pipelines and Runners for executing them on distributed processing backends, including Apache Apex, Apache Flink, Apache Spark, and Google Cloud Dataflow.

Status

Post-commit tests status (on master branch)

Lang	Apex	Dataflow	Flink	Gearpump	Samza	Spark
Go	---	---	---	---	---	---
Java
Python	---		---	---	---	---

Overview

Beam provides a general approach to expressing embarrassingly parallel data processing pipelines and supports three categories of users, each of which have relatively disparate backgrounds and needs.

End Users: Writing pipelines with an existing SDK, running it on an existing runner. These users want to focus on writing their application logic and have everything else just work.
SDK Writers: Developing a Beam SDK targeted at a specific user community (Java, Python, Scala, Go, R, graphical, etc). These users are language geeks, and would prefer to be shielded from all the details of various runners and their implementations.
Runner Writers: Have an execution environment for distributed processing and would like to support programs written against the Beam Model. Would prefer to be shielded from details of multiple SDKs.

The Beam Model

The model behind Beam evolved from a number of internal Google data processing projects, including MapReduce, FlumeJava, and Millwheel. This model was originally known as the “Dataflow Model”.

To learn more about the Beam Model (though still under the original name of Dataflow), see the World Beyond Batch: Streaming 101 and Streaming 102 posts on O’Reilly’s Radar site, and the VLDB 2015 paper.

The key concepts in the Beam programming model are:

PCollection: represents a collection of data, which could be bounded or unbounded in size.
PTransform: represents a computation that transforms input PCollections into output PCollections.
Pipeline: manages a directed acyclic graph of PTransforms and PCollections that is ready for execution.
PipelineRunner: specifies where and how the pipeline should execute.

SDKs

Beam supports multiple language specific SDKs for writing pipelines against the Beam Model.

Currently, this repository contains SDKs for Java, Python and Go.

Have ideas for new SDKs or DSLs? See the JIRA.

Runners

Beam supports executing programs on multiple distributed processing backends through PipelineRunners. Currently, the following PipelineRunners are available:

The DirectRunner runs the pipeline on your local machine.
The ApexRunner runs the pipeline on an Apache Hadoop YARN cluster (or in embedded mode).
The DataflowRunner submits the pipeline to the Google Cloud Dataflow.
The FlinkRunner runs the pipeline on an Apache Flink cluster. The code has been donated from dataArtisans/flink-dataflow and is now part of Beam.
The SparkRunner runs the pipeline on an Apache Spark cluster. The code has been donated from cloudera/spark-dataflow and is now part of Beam.

Have ideas for new Runners? See the JIRA.

Getting Started

Please refer to the Quickstart[Java, Python, Go] available on our website.

If you'd like to build and install the whole project from the source distribution, you may need some additional tools installed in your system. In a Debian-based distribution:

sudo apt-get install \
    openjdk-8-jdk \
    python-setuptools \
    python-pip \
    virtualenv

Then please use the standard ./gradlew build command.

Contact Us

To get involved in Apache Beam:

Subscribe or mail the user@beam.apache.org list.
Subscribe or mail the dev@beam.apache.org list.
Report issues on JIRA.

We also have a contributor's guide.

More Information

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
runners
gcp/gcemd gcemd is a metadata-configured provisioning server for GCE.	gcemd is a metadata-configured provisioning server for GCE.
gcp/gcsproxy gcsproxy is an artifact server backed by GCS and can run in either retrieval (read) or staging (write) mode.	gcsproxy is an artifact server backed by GCS and can run in either retrieval (read) or staging (write) mode.
sdks
go/cmd/beamctl beamctl is a command line client for the Apache Beam portability services.	beamctl is a command line client for the Apache Beam portability services.
go/cmd/beamctl/cmd Package cmd contains the commands for beamctl.	Package cmd contains the commands for beamctl.
go/cmd/specialize specialize is a low-level tool to generate type-specialized code.	specialize is a low-level tool to generate type-specialized code.
go/cmd/symtab Package verifies that functions sym2addr and addr2sym work correctly.	Package verifies that functions sym2addr and addr2sym work correctly.
go/container
go/examples/complete/autocomplete
go/examples/contains
go/examples/cookbook/combine
go/examples/cookbook/filter
go/examples/cookbook/join
go/examples/cookbook/max
go/examples/cookbook/tornadoes tornadoes is an example that reads the public samples of weather data from BigQuery, counts the number of tornadoes that occur in each month, and writes the results to BigQuery.	tornadoes is an example that reads the public samples of weather data from BigQuery, counts the number of tornadoes that occur in each month, and writes the results to BigQuery.
go/examples/debugging_wordcount debugging_wordcount is an example that verifies word counts in Shakespeare and includes Beam best practices.	debugging_wordcount is an example that verifies word counts in Shakespeare and includes Beam best practices.
go/examples/forest forest is an example that shows that pipeline construction is normal Go code -- the pipeline "forest" is created recursively and uses a global variable -- and that a pipeline may contain non-connected parts.	forest is an example that shows that pipeline construction is normal Go code -- the pipeline "forest" is created recursively and uses a global variable -- and that a pipeline may contain non-connected parts.
go/examples/grades
go/examples/minimal_wordcount minimal_wordcount is an example that counts words in Shakespeare.	minimal_wordcount is an example that counts words in Shakespeare.
go/examples/multiout multiout is a wordcount variation that uses a multi-outout DoFn and writes 2 output files.	multiout is a wordcount variation that uses a multi-outout DoFn and writes 2 output files.
go/examples/pingpong
go/examples/streaming_wordcap streaming_wordcap is a toy streaming pipeline that uses PubSub.	streaming_wordcap is a toy streaming pipeline that uses PubSub.
go/examples/windowed_wordcount windowed_wordcount counts words in text, and can run over either unbounded or bounded input collections.	windowed_wordcount counts words in text, and can run over either unbounded or bounded input collections.
go/examples/wordcap
go/examples/wordcount wordcount is an example that counts words in Shakespeare and includes Beam best practices.	wordcount is an example that counts words in Shakespeare and includes Beam best practices.
go/examples/yatzy yatzy is an implementation of https://en.wikipedia.org/wiki/Yatzy that shows that pipeline construction is normal Go code.	yatzy is an implementation of https://en.wikipedia.org/wiki/Yatzy that shows that pipeline construction is normal Go code.
go/pkg/beam Package beam is an implementation of the Apache Beam (https://beam.apache.org) programming model in Go.	Package beam is an implementation of the Apache Beam (https://beam.apache.org) programming model in Go.
go/pkg/beam/artifact Package artifact contains utilities for staging and retrieving artifacts.	Package artifact contains utilities for staging and retrieving artifacts.
go/pkg/beam/artifact/gcsproxy Package gcsproxy contains artifact staging and retrieval servers backed by GCS.	Package gcsproxy contains artifact staging and retrieval servers backed by GCS.
go/pkg/beam/core/funcx Package funcx contains functions and types used to perform type analysis of Beam functions.	Package funcx contains functions and types used to perform type analysis of Beam functions.
go/pkg/beam/core/graph Package graph is the internal representation of the Beam execution plan.	Package graph is the internal representation of the Beam execution plan.
go/pkg/beam/core/graph/coder Package coder contains coder representation and utilities.	Package coder contains coder representation and utilities.
go/pkg/beam/core/graph/mtime Package mtime contains a millisecond representation of time.	Package mtime contains a millisecond representation of time.
go/pkg/beam/core/graph/window Package window contains window representation, windowing strategies and utilities.	Package window contains window representation, windowing strategies and utilities.
go/pkg/beam/core/metrics Package metrics implements the Beam metrics API, described at http://s.apache.org/beam-metrics-api Metrics in the Beam model are uniquely identified by a namespace, a name, and the PTransform context in which they are used.	Package metrics implements the Beam metrics API, described at http://s.apache.org/beam-metrics-api Metrics in the Beam model are uniquely identified by a namespace, a name, and the PTransform context in which they are used.
go/pkg/beam/core/runtime Package runtime contains runtime hooks and utilities for pipeline options and type registration.	Package runtime contains runtime hooks and utilities for pipeline options and type registration.
go/pkg/beam/core/runtime/coderx Package coderx contains primitive coders.	Package coderx contains primitive coders.
go/pkg/beam/core/runtime/exec Package exec contains runtime plan representation and execution.	Package exec contains runtime plan representation and execution.
go/pkg/beam/core/runtime/exec/optimized Package optimized contains type-specialized shims for faster execution.	Package optimized contains type-specialized shims for faster execution.
go/pkg/beam/core/runtime/graphx Package graphx provides facilities to help with the serialization of pipelines into a serializable graph structure suitable for the worker.	Package graphx provides facilities to help with the serialization of pipelines into a serializable graph structure suitable for the worker.
go/pkg/beam/core/runtime/graphx/v1 Package v1 is a generated protocol buffer package.	Package v1 is a generated protocol buffer package.
go/pkg/beam/core/runtime/harness Package harness implements the SDK side of the Beam FnAPI.	Package harness implements the SDK side of the Beam FnAPI.
go/pkg/beam/core/runtime/harness/init Package init contains the harness initialization code defined by the FnAPI.	Package init contains the harness initialization code defined by the FnAPI.
go/pkg/beam/core/runtime/harness/session Package session is a generated protocol buffer package.	Package session is a generated protocol buffer package.
go/pkg/beam/core/runtime/pipelinex Package pipelinex contains utilities for manipulating Beam proto pipelines.	Package pipelinex contains utilities for manipulating Beam proto pipelines.
go/pkg/beam/core/typex Package typex contains full type representation and utilities for type checking.	Package typex contains full type representation and utilities for type checking.
go/pkg/beam/core/util/dot Package dot produces DOT graphs from Beam graph representations.	Package dot produces DOT graphs from Beam graph representations.
go/pkg/beam/core/util/hooks Package hooks allows runners to tailor execution of the worker harness.	Package hooks allows runners to tailor execution of the worker harness.
go/pkg/beam/core/util/ioutilx Package ioutilx contains additional io utilities.	Package ioutilx contains additional io utilities.
go/pkg/beam/core/util/protox Package protox contains utilities for working with protobufs.	Package protox contains utilities for working with protobufs.
go/pkg/beam/core/util/reflectx Package reflectx contains a set of reflection utilities and well-known types.	Package reflectx contains a set of reflection utilities and well-known types.
go/pkg/beam/core/util/stringx Package stringx contains utilities for working with strings.	Package stringx contains utilities for working with strings.
go/pkg/beam/core/util/symtab Package symtab allows reading low-level symbol information from the symbol table.	Package symtab allows reading low-level symbol information from the symbol table.
go/pkg/beam/io/bigqueryio Package bigqueryio provides transformations and utilities to interact with Google BigQuery.	Package bigqueryio provides transformations and utilities to interact with Google BigQuery.
go/pkg/beam/io/datastoreio Package datastoreio provides transformations and utilities to interact with Google Datastore.	Package datastoreio provides transformations and utilities to interact with Google Datastore.
go/pkg/beam/io/filesystem Package filesystem contains an extensible file system abstraction.	Package filesystem contains an extensible file system abstraction.
go/pkg/beam/io/filesystem/gcs Package gcs contains a Google Cloud Storage (GCS) implementation of the Beam file system.	Package gcs contains a Google Cloud Storage (GCS) implementation of the Beam file system.
go/pkg/beam/io/filesystem/local Package local contains a local file implementation of the Beam file system.	Package local contains a local file implementation of the Beam file system.
go/pkg/beam/io/filesystem/memfs Package memfs contains a in-memory Beam filesystem.	Package memfs contains a in-memory Beam filesystem.
go/pkg/beam/io/pubsubio Package pubsubio provides access to PubSub on Dataflow streaming.	Package pubsubio provides access to PubSub on Dataflow streaming.
go/pkg/beam/io/pubsubio/v1 Package v1 is a generated protocol buffer package.	Package v1 is a generated protocol buffer package.
go/pkg/beam/io/textio Package textio contains transforms for reading and writing text files.	Package textio contains transforms for reading and writing text files.
go/pkg/beam/log Package log contains a re-targetable context-aware logging system.	Package log contains a re-targetable context-aware logging system.
go/pkg/beam/model Package model contains the portable Beam model contracts.	Package model contains the portable Beam model contracts.
go/pkg/beam/model/fnexecution_v1
go/pkg/beam/model/jobmanagement_v1
go/pkg/beam/model/pipeline_v1
go/pkg/beam/options/gcpopts Package gcpopts contains shared options for Google Cloud Platform.	Package gcpopts contains shared options for Google Cloud Platform.
go/pkg/beam/options/jobopts Package jobopts contains shared options for job submission.	Package jobopts contains shared options for job submission.
go/pkg/beam/provision Package provision contains utilities for obtaining runtime provision, information -- such as pipeline options.	Package provision contains utilities for obtaining runtime provision, information -- such as pipeline options.
go/pkg/beam/runners/dataflow Package dataflow contains the Dataflow runner for submitting pipelines to Google Cloud Dataflow.	Package dataflow contains the Dataflow runner for submitting pipelines to Google Cloud Dataflow.
go/pkg/beam/runners/dataflow/dataflowlib Package dataflowlib translates a Beam pipeline model to the Dataflow API job model, for submission to Google Cloud Dataflow.	Package dataflowlib translates a Beam pipeline model to the Dataflow API job model, for submission to Google Cloud Dataflow.
go/pkg/beam/runners/direct Package direct contains the direct runner for running single-bundle pipelines in the current process.	Package direct contains the direct runner for running single-bundle pipelines in the current process.
go/pkg/beam/runners/dot Package dot is a Beam runner that "runs" a pipeline by producing a DOT graph of the execution plan.	Package dot is a Beam runner that "runs" a pipeline by producing a DOT graph of the execution plan.
go/pkg/beam/runners/flink Package flink contains the Flink runner.	Package flink contains the Flink runner.
go/pkg/beam/runners/session
go/pkg/beam/runners/universal Package universal contains a general-purpose runner that can submit jobs to any portable Beam runner.	Package universal contains a general-purpose runner that can submit jobs to any portable Beam runner.
go/pkg/beam/runners/universal/runnerlib Package runnerlib contains utilities for submitting Go pipelines to a Beam model runner.	Package runnerlib contains utilities for submitting Go pipelines to a Beam model runner.
go/pkg/beam/testing/passert Package passert contains verification transformations for testing pipelines.	Package passert contains verification transformations for testing pipelines.
go/pkg/beam/testing/ptest Package ptest contains utilities for pipeline unit testing.	Package ptest contains utilities for pipeline unit testing.
go/pkg/beam/transforms/filter Package filter contains transformations for removing pipeline elements based on various conditions.	Package filter contains transformations for removing pipeline elements based on various conditions.
go/pkg/beam/transforms/stats Pacakge stats contains transforms for statistical processing.	Pacakge stats contains transforms for statistical processing.
go/pkg/beam/transforms/top Package top contains transformations for finding the smallest (or largest) N elements based on arbitrary orderings.	Package top contains transformations for finding the smallest (or largest) N elements based on arbitrary orderings.
go/pkg/beam/util/errorx Package errorx contains utilities for handling errors.	Package errorx contains utilities for handling errors.
go/pkg/beam/util/execx Package execx contains wrappers and utilities for the exec package.	Package execx contains wrappers and utilities for the exec package.
go/pkg/beam/util/gcsx Package gcsx contains utilities for working with Google Cloud Storage (GCS).	Package gcsx contains utilities for working with Google Cloud Storage (GCS).
go/pkg/beam/util/grpcx Package grpcx contains utilities for working with gRPC.	Package grpcx contains utilities for working with gRPC.
go/pkg/beam/util/pubsubx Package pubsubx contains utilities for working with Google PubSub.	Package pubsubx contains utilities for working with Google PubSub.
go/pkg/beam/util/syscallx Package syscallx provides system call utilities that attempt to hide platform differences.	Package syscallx provides system call utilities that attempt to hide platform differences.
go/pkg/beam/x/beamx Package beamx is a convenience package for beam.	Package beamx is a convenience package for beam.
go/pkg/beam/x/debug
go/pkg/beam/x/hooks/perf Package perf is to add performance measuring hooks to a runner, such as cpu, or trace profiles.	Package perf is to add performance measuring hooks to a runner, such as cpu, or trace profiles.
go/test/integration The integration driver provides a suite of tests to run against a registered runner.	The integration driver provides a suite of tests to run against a registered runner.
go/test/integration/primitives
go/test/integration/wordcount Package wordcount contains transforms for wordcount.	Package wordcount contains transforms for wordcount.
go/test/regression Package regression contains pipeline regression tests.	Package regression contains pipeline regression tests.
java/container boot is the boot code for the Java SDK harness container.	boot is the boot code for the Java SDK harness container.
python/container boot is the boot code for the Python SDK harness container.	boot is the boot code for the Python SDK harness container.