-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add Dataflow SpannerIO sample * Removed counts and just left the size estimation * Tidy up dependencies * Add sample to write to Spanner * Add dataflow module * Cleaned up dependencies * Added more comments and a description on how to run
- Loading branch information
Showing
4 changed files
with
480 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
<!-- | ||
Copyright 2017 Google Inc. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
<modelVersion>4.0.0</modelVersion> | ||
|
||
<groupId>com.example.dataflow</groupId> | ||
<artifactId>dataflow-spanner</artifactId> | ||
<version>1.0-SNAPSHOT</version> | ||
<packaging>jar</packaging> | ||
|
||
<properties> | ||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
<java.version>1.8</java.version> | ||
<maven.compiler.source>1.8</maven.compiler.source> | ||
<maven.compiler.target>1.8</maven.compiler.target> | ||
<apache_beam.version>2.2.0</apache_beam.version> | ||
</properties> | ||
|
||
<build> | ||
<plugins> | ||
<plugin> | ||
<groupId>org.apache.maven.plugins</groupId> | ||
<artifactId>maven-compiler-plugin</artifactId> | ||
<version>3.7.0</version> | ||
</plugin> | ||
</plugins> | ||
</build> | ||
|
||
<dependencies> | ||
|
||
<!-- Apache Beam --> | ||
<dependency> | ||
<groupId>org.apache.beam</groupId> | ||
<artifactId>beam-sdks-java-core</artifactId> | ||
<version>${apache_beam.version}</version> | ||
</dependency> | ||
|
||
<dependency> | ||
<groupId>org.apache.beam</groupId> | ||
<artifactId>beam-sdks-java-io-google-cloud-platform</artifactId> | ||
<version>${apache_beam.version}</version> | ||
<exclusions> | ||
<exclusion> | ||
<groupId>com.google.api.grpc</groupId> | ||
<artifactId>grpc-google-common-protos</artifactId> | ||
</exclusion> | ||
</exclusions> | ||
</dependency> | ||
|
||
<dependency> | ||
<groupId>org.apache.beam</groupId> | ||
<artifactId>beam-runners-direct-java</artifactId> | ||
<version>${apache_beam.version}</version> | ||
</dependency> | ||
|
||
<dependency> | ||
<groupId>org.apache.beam</groupId> | ||
<artifactId>beam-runners-google-cloud-dataflow-java</artifactId> | ||
<version>${apache_beam.version}</version> | ||
</dependency> | ||
|
||
<!-- Google Cloud --> | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-spanner</artifactId> | ||
<version>0.20.0-beta</version> | ||
</dependency> | ||
|
||
<!-- Misc --> | ||
<dependency> | ||
<groupId>org.slf4j</groupId> | ||
<artifactId>slf4j-jdk14</artifactId> | ||
<version>1.7.25</version> | ||
</dependency> | ||
|
||
</dependencies> | ||
|
||
</project> |
154 changes: 154 additions & 0 deletions
154
dataflow/spanner-io/src/main/java/com/example/dataflow/SpannerRead.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,154 @@ | ||
/* | ||
Copyright 2017, Google, Inc. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package com.example.dataflow; | ||
|
||
import com.google.cloud.spanner.Struct; | ||
import org.apache.beam.sdk.Pipeline; | ||
import org.apache.beam.sdk.io.TextIO; | ||
import org.apache.beam.sdk.io.gcp.spanner.SpannerIO; | ||
import org.apache.beam.sdk.options.Description; | ||
import org.apache.beam.sdk.options.PipelineOptions; | ||
import org.apache.beam.sdk.options.PipelineOptionsFactory; | ||
import org.apache.beam.sdk.options.Validation; | ||
import org.apache.beam.sdk.transforms.Count; | ||
import org.apache.beam.sdk.transforms.DoFn; | ||
import org.apache.beam.sdk.transforms.PTransform; | ||
import org.apache.beam.sdk.transforms.ParDo; | ||
import org.apache.beam.sdk.transforms.Sum; | ||
import org.apache.beam.sdk.transforms.ToString; | ||
import org.apache.beam.sdk.values.PCollection; | ||
|
||
/* | ||
This sample demonstrates how to read from a Spanner table. | ||
## Prerequisites | ||
* Maven installed | ||
* Set up GCP default credentials, one of the following: | ||
- export GOOGLE_APPLICATION_CREDENTIALS=path/to/credentials.json | ||
- gcloud auth application-default login | ||
[https://developers.google.com/identity/protocols/application-default-credentials] | ||
* Create the Spanner table to read from, you'll need: | ||
- Instance ID | ||
- Database ID | ||
- Any table, preferably populated | ||
[https://cloud.google.com/spanner/docs/quickstart-console] | ||
## How to run | ||
cd java-docs-samples/dataflow/spanner-io | ||
mvn clean | ||
mvn compile | ||
mvn exec:java \ | ||
-Dexec.mainClass=com.example.dataflow.SpannerRead \ | ||
-Dexec.args="--instanceId=my-instance-id \ | ||
--databaseId=my-database-id \ | ||
--table=my_table \ | ||
--output=path/to/output_file" | ||
*/ | ||
public class SpannerRead { | ||
|
||
public interface Options extends PipelineOptions { | ||
|
||
@Description("Spanner instance ID to query from") | ||
@Validation.Required | ||
String getInstanceId(); | ||
void setInstanceId(String value); | ||
|
||
@Description("Spanner database name to query from") | ||
@Validation.Required | ||
String getDatabaseId(); | ||
void setDatabaseId(String value); | ||
|
||
@Description("Spanner table name to query from") | ||
@Validation.Required | ||
String getTable(); | ||
void setTable(String value); | ||
|
||
@Description("Output filename for records size") | ||
@Validation.Required | ||
String getOutput(); | ||
void setOutput(String value); | ||
} | ||
|
||
/** | ||
* Estimates the size of a Spanner row. For simplicity, arrays and structs aren't supported. | ||
*/ | ||
public static class EstimateStructSizeFn extends DoFn<Struct, Long> { | ||
|
||
@ProcessElement | ||
public void processElement(ProcessContext c) throws Exception { | ||
Struct row = c.element(); | ||
long sum = 0; | ||
for (int i = 0; i < row.getColumnCount(); i++) { | ||
if (row.isNull(i)) { | ||
continue; | ||
} | ||
|
||
switch (row.getColumnType(i).getCode()) { | ||
case BOOL: | ||
sum += 1; | ||
break; | ||
case INT64: | ||
case FLOAT64: | ||
sum += 8; | ||
break; | ||
case TIMESTAMP: | ||
case DATE: | ||
sum += 12; | ||
break; | ||
case BYTES: | ||
sum += row.getBytes(i).length(); | ||
break; | ||
case STRING: | ||
sum += row.getString(i).length(); | ||
break; | ||
case ARRAY: | ||
throw new IllegalArgumentException("Arrays are not supported :("); | ||
case STRUCT: | ||
throw new IllegalArgumentException("Structs are not supported :("); | ||
} | ||
} | ||
c.output(sum); | ||
} | ||
} | ||
|
||
public static void main(String[] args) { | ||
Options options = PipelineOptionsFactory.fromArgs(args).withValidation().as(Options.class); | ||
Pipeline p = Pipeline.create(options); | ||
|
||
String instanceId = options.getInstanceId(); | ||
String databaseId = options.getDatabaseId(); | ||
String query = "SELECT * FROM " + options.getTable(); | ||
|
||
PCollection<Long> tableEstimatedSize = p | ||
// Query for all the columns and rows in the specified Spanner table | ||
.apply(SpannerIO.read() | ||
.withInstanceId(instanceId) | ||
.withDatabaseId(databaseId) | ||
.withQuery(query)) | ||
// Estimate the size of every row | ||
.apply(ParDo.of(new EstimateStructSizeFn())) | ||
// Sum all the row sizes to get the total estimated size of the table | ||
.apply(Sum.longsGlobally()); | ||
|
||
// Write the total size to a file | ||
tableEstimatedSize | ||
.apply(ToString.elements()) | ||
.apply(TextIO.write().to(options.getOutput())); | ||
|
||
p.run().waitUntilFinish(); | ||
} | ||
} |
Oops, something went wrong.