Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This document provides additional information regarding the Beam Transform Serviceservice. For primary document regarding the Transform Serviceservice, please see the Beam programming guide.

Transforms included in the Transform

...

service

This section includes a list of Beam transforms currently included in the Transform Serviceservice. Following information regarding the transforms are provided.

...

TransformSDK implementedUnique ID typeUnique ID
JDBC I/O readJavaschema-awarebeam:schematransform:org.apache.beam:jdbc_read:v1
JDBC I/O writeJavaschema-awarebeam:schematransform:org.apache.beam:jdbc_write:v1
Pub/Sub I/O readJavaschema-awarebeam:schematransform:org.apache.beam:pubsub_read:v1
Pub/Sub I/O writeJavaschema-awarebeam:schematransform:org.apache.beam:pubsub_write:v1
Pub/Sub Lite I/O readJavaschema-awarebeam:schematransform:org.apache.beam:pubsublite_read:v1
Pub/Sub Lite I/O writeJavaschema-awarebeam:schematransform:org.apache.beam:pubsublite_write:v1
Kafka I/O readJavaschema-awarebeam:schematransform:org.apache.beam:kafka_read:v1
Kafka I/O writeJavaschema-awarebeam:schematransform:org.apache.beam:kafka_write:v1
BigQuery I/O read (Storage Read API)Javaschema-awarebeam:schematransform:org.apache.beam:bigquery_storage_read:v1
BigQuery I/O read (BQ file export)Javaschema-awarebeam:schematransform:org.apache.beam:bigquery_export_read:v1
BigQuery I/O write (Storage Write API)Javaschema-awarebeam:schematransform:org.apache.beam:bigquery_storage_write:v1
BigQuery I/O write (BQ file load jobs)Javaschema-awarebeam:schematransform:org.apache.beam:bigquery_fileloads_write:v1
BigTable I/O readJavaschema-awarebeam:schematransform:org.apache.beam:bigtable_read:v1
BigTable I/O writeJavaschema-awarebeam:schematransform:org.apache.beam:bigtable_write:v1
Spanner I/O CDC readJavaschema-awarebeam:schematransform:org.apache.beam:spanner_cdc_read:v1
Spanner I/O writeJavaschema-awarebeam:schematransform:org.apache.beam:spanner_write:v1
JDBC I/O readJavaurnbeam:transform:org.apache.beam:schemaio_jdbc_read:v1
JDBC I/O writeJavaurnbeam:transform:org.apache.beam:schemaio_jdbc_write:v1
Pub/Sub I/O readJavaurnbeam:transform:org.apache.beam:pubsub_read:v1
Pub/Sub I/O writeJavaurnbeam:transform:org.apache.beam:pubsub_write:v1
Avro I/O readJavaurnbeam:transform:org.apache.beam:schemaio_avro_read:v1
Avro I/O writeJavaurnbeam:transform:org.apache.beam:schemaio_avro_write:v1
BigQuery I/O readJavaurnbeam:transform:org.apache.beam:schemaio_bigquery_read:v1
BigQuery I/O writeJavaurnbeam:transform:org.apache.beam:schemaio_bigquery_write:v1
Datastore I/O readJavaurnbeam:transform:org.apache.beam:schemaio_datastoreV1_read:v1
Datastore I/O writeJavaurnbeam:transform:org.apache.beam:schemaio_datastoreV1_write:v1
Kafka I/O read without metadataJavaurnbeam:transform:org.apache.beam:kafka_read_without_metadata:v1
Kafka I/O read with metadataJavaurnbeam:transform:org.apache.beam:kafka_read_with_metadata
Kafka I/O writeJavaurnbeam:transform:org.apache.beam:kafka_write:v1
Pub/Sub I/O readJavaurnbeam:transform:org.apache.beam:schemaio_pubsub_read:v1
Pub/Sub I/O writeJavaurnbeam:transform:org.apache.beam:schemaio_pubsub_write:v1
Pub/Sub Lite readJavaurnbeam:transform:org.apache.beam:pubsublite_read:v1
Pub/Sub Lite writeJavaurnbeam:transform:org.apache.beam:pubsublite_write:v1
Spanner insertJavaurnbeam:transform:org.apache.beam:spanner_insert:v1
Spanner updateJavaurnbeam:transform:org.apache.beam:spanner_update:v1
Spanner replaceJavaurnbeam:transform:org.apache.beam:spanner_replace:v1
Spanner insert or updateJavaurnbeam:transform:org.apache.beam:spanner_insert_or_update
Spanner deleteJavaurnbeam:transform:org.apache.beam:spanner_delete:v1
Spanner I/O readJavaurnbeam:transform:org.apache.beam:spanner_read:v1
RunInferencePythonpython-nameapache_beam.ml.inference.base.RunInference.from_callable
DataframePythonpython-nameapache_beam.dataframe.transforms.DataframeTransform


Upgrade

...

transforms without upgrading the pipeline

Beam Transform Service service allows Beam pipeline authors to upgrade specific transforms within their pipelines to a newer Beam version without upgrading the full pipeline. Please see the Beam programming guide for more details regarding this feature and supported SDKs and Beam versions.

...

Code Block
export BEAM_VERSION=<Beam version> # Needs to be Beam 2.53.0 or later.

mvn archetype:generate \
    -DarchetypeGroupId=org.apache.beam \
    -DarchetypeArtifactId=beam-sdks-java-maven-archetypes-examples \
    -DarchetypeVersion=$BEAM_VERSION \
    -DgroupId=org.example \
    -DartifactId=beam-transform-upgrade \
    -Dversion="0.1" \
    -Dpackage=org.apache.beam.examples \
    -DinteractiveMode=false

cd beam-transform-upgrade


  • Add the Beam examples Java dependency to the <dependencies> section of the Maven pom.xml file.

    Code Block
    <dependency>
    <groupId>org.apache.beam</groupId>
    <artifactId>beam-examples-java</artifactId>
    <version>${beam.version}</version>
    </dependency>


  • Execute the pipeline using a portable Beam runner. Following example uses Dataflow Runner v2.

Code Block
export GCP_PROJECT=<GCP project>
export GCP_BUCKET=<GCP bucket>
export GCP_REGION=<GCP region>
export OUTPUT_BIGQUERY_TABLE=<A BigQuery table to write the output to>
export TRANSFORM_BEAM_VERSION=<Beam version to upgrade transforms to> # Needs to be Beam 2.53.0 or later.

mvn compile exec:java -Dexec.mainClass=org.apache.beam.examples.cookbook.BigQueryTornadoes -Dexec.args="--runner=DataflowRunner --project=$GCP_PROJECT \
                 --region=$GCP_REGION \
                 --tempLocation=gs://$GCP_BUCKET/transform-upgrade/tmp \
                 --experiments=use_runner_v2 --output=$OUTPUT_BIGQUERY_TABLE \
                 --transformsToOverride=beam:transform:org.apache.beam:bigquery_read:v1,beam:transform:org.apache.beam:bigquery_write:v1 \
                 --transformServiceBeamVersion=$TRANSFORM_BEAM_VERSION" -Pdataflow-runner

...