go/

directory
Version: v2.6.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 3, 2018 License: Apache-2.0, BSD-3-Clause, MIT

README

Go SDK (experimental)

The Go SDK is currently an experimental feature of Apache Beam and not suitable for production use. It is based on the following initial design.

How to run the examples

Prerequisites: to use Google Cloud sources and sinks (default for most examples), follow the setup here. You can verify that it works by running the corresponding Java example.

The examples are normal Go programs and are most easily run directly. They are parameterized by Go flags. For example, to run wordcount do:

$ pwd
[...]/sdks/go
$ go run examples/wordcount/wordcount.go --output=/tmp/result.txt
[{6: KV<string,int>/GW/KV<bytes,int[varintz]>}]
[{10: KV<int,string>/GW/KV<int[varintz],bytes>}]
2018/03/21 09:39:03 Pipeline:
2018/03/21 09:39:03 Nodes: {1: []uint8/GW/bytes}
{2: string/GW/bytes}
{3: string/GW/bytes}
{4: string/GW/bytes}
{5: string/GW/bytes}
{6: KV<string,int>/GW/KV<bytes,int[varintz]>}
{7: CoGBK<string,int>/GW/CoGBK<bytes,int[varintz]>}
{8: KV<string,int>/GW/KV<bytes,int[varintz]>}
{9: string/GW/bytes}
{10: KV<int,string>/GW/KV<int[varintz],bytes>}
{11: CoGBK<int,string>/GW/CoGBK<int[varintz],bytes>}
Edges: 1: Impulse [] -> [Out: []uint8 -> {1: []uint8/GW/bytes}]
2: ParDo [In(Main): []uint8 <- {1: []uint8/GW/bytes}] -> [Out: T -> {2: string/GW/bytes}]
3: ParDo [In(Main): string <- {2: string/GW/bytes}] -> [Out: string -> {3: string/GW/bytes}]
4: ParDo [In(Main): string <- {3: string/GW/bytes}] -> [Out: string -> {4: string/GW/bytes}]
5: ParDo [In(Main): string <- {4: string/GW/bytes}] -> [Out: string -> {5: string/GW/bytes}]
6: ParDo [In(Main): T <- {5: string/GW/bytes}] -> [Out: KV<T,int> -> {6: KV<string,int>/GW/KV<bytes,int[varintz]>}]
7: CoGBK [In(Main): KV<string,int> <- {6: KV<string,int>/GW/KV<bytes,int[varintz]>}] -> [Out: CoGBK<string,int> -> {7: CoGBK<string,int>/GW/CoGBK<bytes,int[varintz]>}]
8: Combine [In(Main): int <- {7: CoGBK<string,int>/GW/CoGBK<bytes,int[varintz]>}] -> [Out: KV<string,int> -> {8: KV<string,int>/GW/KV<bytes,int[varintz]>}]
9: ParDo [In(Main): KV<string,int> <- {8: KV<string,int>/GW/KV<bytes,int[varintz]>}] -> [Out: string -> {9: string/GW/bytes}]
10: ParDo [In(Main): T <- {9: string/GW/bytes}] -> [Out: KV<int,T> -> {10: KV<int,string>/GW/KV<int[varintz],bytes>}]
11: CoGBK [In(Main): KV<int,string> <- {10: KV<int,string>/GW/KV<int[varintz],bytes>}] -> [Out: CoGBK<int,string> -> {11: CoGBK<int,string>/GW/CoGBK<int[varintz],bytes>}]
12: ParDo [In(Main): CoGBK<int,string> <- {11: CoGBK<int,string>/GW/CoGBK<int[varintz],bytes>}] -> []
2018/03/21 09:39:03 Reading from gs://apache-beam-samples/shakespeare/kinglear.txt
2018/03/21 09:39:04 Writing to /tmp/result.txt

The debugging output is currently quite verbose and likely to change. The output is a local file in this case:

$ head /tmp/result.txt 
while: 2
darkling: 1
rail'd: 1
ford: 1
bleed's: 1
hath: 52
Remain: 1
disclaim: 1
sentence: 1
purse: 6

See BUILD.md for how to build Go code in general. See CONTAINERS.md for how to build and push the Go SDK harness container image.

Issues

Please use the sdk-go component for any bugs or feature requests.

Directories

Path Synopsis
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.
beamctl/cmd
Package cmd contains the commands for beamctl.
Package cmd contains the commands for beamctl.
specialize
specialize is a low-level tool to generate type-specialized code.
specialize is a low-level tool to generate type-specialized code.
symtab
Package verifies that functions sym2addr and addr2sym work correctly.
Package verifies that functions sym2addr and addr2sym work correctly.
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.
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.
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.
minimal_wordcount
minimal_wordcount is an example that counts words in Shakespeare.
minimal_wordcount is an example that counts words in Shakespeare.
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.
streaming_wordcap
streaming_wordcap is a toy streaming pipeline that uses PubSub.
streaming_wordcap is a toy streaming pipeline that uses PubSub.
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.
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.
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.
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.
beam/artifact
Package artifact contains utilities for staging and retrieving artifacts.
Package artifact contains utilities for staging and retrieving artifacts.
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.
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.
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.
beam/core/graph/coder
Package coder contains coder representation and utilities.
Package coder contains coder representation and utilities.
beam/core/graph/mtime
Package mtime contains a millisecond representation of time.
Package mtime contains a millisecond representation of time.
beam/core/graph/window
Package window contains window representation, windowing strategies and utilities.
Package window contains window representation, windowing strategies and utilities.
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.
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.
beam/core/runtime/coderx
Package coderx contains primitive coders.
Package coderx contains primitive coders.
beam/core/runtime/exec
Package exec contains runtime plan representation and execution.
Package exec contains runtime plan representation and execution.
beam/core/runtime/exec/optimized
Package optimized contains type-specialized shims for faster execution.
Package optimized contains type-specialized shims for faster execution.
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.
beam/core/runtime/graphx/v1
Package v1 is a generated protocol buffer package.
Package v1 is a generated protocol buffer package.
beam/core/runtime/harness
Package harness implements the SDK side of the Beam FnAPI.
Package harness implements the SDK side of the Beam FnAPI.
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.
beam/core/runtime/harness/session
Package session is a generated protocol buffer package.
Package session is a generated protocol buffer package.
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.
beam/core/util/dot
Package dot produces DOT graphs from Beam graph representations.
Package dot produces DOT graphs from Beam graph representations.
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.
beam/core/util/ioutilx
Package ioutilx contains additional io utilities.
Package ioutilx contains additional io utilities.
beam/core/util/protox
Package protox contains utilities for working with protobufs.
Package protox contains utilities for working with protobufs.
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.
beam/core/util/stringx
Package stringx contains utilities for working with strings.
Package stringx contains utilities for working with strings.
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.
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.
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.
beam/io/filesystem
Package filesystem contains an extensible file system abstraction.
Package filesystem contains an extensible file system abstraction.
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.
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.
beam/io/filesystem/memfs
Package memfs contains a in-memory Beam filesystem.
Package memfs contains a in-memory Beam filesystem.
beam/io/pubsubio
Package pubsubio provides access to PubSub on Dataflow streaming.
Package pubsubio provides access to PubSub on Dataflow streaming.
beam/io/pubsubio/v1
Package v1 is a generated protocol buffer package.
Package v1 is a generated protocol buffer package.
beam/io/textio
Package textio contains transforms for reading and writing text files.
Package textio contains transforms for reading and writing text files.
beam/log
Package log contains a re-targetable context-aware logging system.
Package log contains a re-targetable context-aware logging system.
beam/model
Package model contains the portable Beam model contracts.
Package model contains the portable Beam model contracts.
beam/options/gcpopts
Package gcpopts contains shared options for Google Cloud Platform.
Package gcpopts contains shared options for Google Cloud Platform.
beam/options/jobopts
Package jobopts contains shared options for job submission.
Package jobopts contains shared options for job submission.
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.
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.
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.
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.
beam/runners/flink
Package flink contains the Flink runner.
Package flink contains the Flink runner.
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.
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.
beam/testing/passert
Package passert contains verification transformations for testing pipelines.
Package passert contains verification transformations for testing pipelines.
beam/testing/ptest
Package ptest contains utilities for pipeline unit testing.
Package ptest contains utilities for pipeline unit testing.
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.
beam/transforms/stats
Pacakge stats contains transforms for statistical processing.
Pacakge stats contains transforms for statistical processing.
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.
beam/util/errorx
Package errorx contains utilities for handling errors.
Package errorx contains utilities for handling errors.
beam/util/execx
Package execx contains wrappers and utilities for the exec package.
Package execx contains wrappers and utilities for the exec package.
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).
beam/util/grpcx
Package grpcx contains utilities for working with gRPC.
Package grpcx contains utilities for working with gRPC.
beam/util/pubsubx
Package pubsubx contains utilities for working with Google PubSub.
Package pubsubx contains utilities for working with Google PubSub.
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.
beam/x/beamx
Package beamx is a convenience package for beam.
Package beamx is a convenience package for beam.
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.
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.
integration/wordcount
Package wordcount contains transforms for wordcount.
Package wordcount contains transforms for wordcount.
regression
Package regression contains pipeline regression tests.
Package regression contains pipeline regression tests.

Jump to

Keyboard shortcuts

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