-
Notifications
You must be signed in to change notification settings - Fork 0
/
ExportPipeline.java
116 lines (92 loc) · 4.11 KB
/
ExportPipeline.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*
* Copyright (C) 2018 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.google.cloud.teleport.spanner;
import org.apache.beam.runners.dataflow.options.DataflowPipelineOptions;
import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.PipelineResult;
import org.apache.beam.sdk.io.gcp.spanner.SpannerConfig;
import org.apache.beam.sdk.options.Default;
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.ValueProvider;
/** Dataflow template that exports a Cloud Spanner database to Avro files in GCS. */
public class ExportPipeline {
/** Options for Export pipeline. */
public interface ExportPipelineOptions extends PipelineOptions {
@Description("Instance ID for Cloud Spanner")
ValueProvider<String> getInstanceId();
void setInstanceId(ValueProvider<String> value);
@Description("Database ID for Cloud Spanner")
ValueProvider<String> getDatabaseId();
void setDatabaseId(ValueProvider<String> value);
@Description("Output directory in GCS")
ValueProvider<String> getOutputDir();
void setOutputDir(ValueProvider<String> value);
@Description("Test dataflow job identifier for Beam Direct Runner")
@Default.String(value = "")
ValueProvider<String> getTestJobId();
void setTestJobId(ValueProvider<String> jobId);
@Description("Cloud Spanner API endpoint")
@Default.String("https://batch-spanner.googleapis.com")
ValueProvider<String> getSpannerHost();
void setSpannerHost(ValueProvider<String> value);
@Description("If true, wait for job finish")
@Default.Boolean(true)
boolean getWaitUntilFinish();
void setWaitUntilFinish(boolean value);
@Description("If set, specifies the time when the snapshot must be taken."
+ " String is in the RFC 3339 format. "
+ " Example - 1990-12-31T23:59:60Z"
+ " Timestamp must be in the past and Maximum timestamp staleness applies."
+ " https://cloud.google.com/spanner/docs/timestamp-bounds#maximum_timestamp_staleness")
@Default.String(value = "")
ValueProvider<String> getSnapshotTime();
@Description("GCP Project Id of where the Spanner table lives.")
ValueProvider<String> getSpannerProjectId();
void setSpannerProjectId(ValueProvider<String> value);
void setSnapshotTime(ValueProvider<String> value);
}
/**
* Runs a pipeline to export a Cloud Spanner database to Avro files.
*
* @param args arguments to the pipeline
*/
public static void main(String[] args) {
ExportPipelineOptions options =
PipelineOptionsFactory.fromArgs(args).withValidation().as(ExportPipelineOptions.class);
Pipeline p = Pipeline.create(options);
SpannerConfig spannerConfig =
SpannerConfig.create()
.withProjectId(options.getSpannerProjectId())
.withHost(options.getSpannerHost())
.withInstanceId(options.getInstanceId())
.withDatabaseId(options.getDatabaseId());
p.begin()
.apply(
"Run Export",
new ExportTransform(spannerConfig, options.getOutputDir(), options.getTestJobId(),
options.getSnapshotTime()));
PipelineResult result = p.run();
if (options.getWaitUntilFinish() &&
/* Only if template location is null, there is a dataflow job to wait for. Else it's
* template generation which doesn't start a dataflow job.
*/
options.as(DataflowPipelineOptions.class).getTemplateLocation() == null) {
result.waitUntilFinish();
}
}
}