From e2228375d191ab783f48cd94d3f1974b2da0ab9c Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Wed, 9 Sep 2020 21:18:26 +0530 Subject: [PATCH 1/3] docs(samples): add run details --- .../bigquerydatatransfer/RunDetails.java | 47 ++++++ .../bigquerydatatransfer/RunDetailsIT.java | 138 ++++++++++++++++++ 2 files changed, 185 insertions(+) create mode 100644 samples/snippets/src/main/java/com/example/bigquerydatatransfer/RunDetails.java create mode 100644 samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquerydatatransfer/RunDetails.java b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/RunDetails.java new file mode 100644 index 00000000..5b122f9c --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/RunDetails.java @@ -0,0 +1,47 @@ +/* + * Copyright 2020 Google LLC + * + * 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.bigquerydatatransfer; + +// [START bigquerydatatransfer_get_run_details] +import com.google.api.gax.rpc.ApiException; +import com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient; +import com.google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest; +import com.google.cloud.bigquery.datatransfer.v1.TransferRun; +import java.io.IOException; + +// Sample to get run details from transfer config. +public class RunDetails { + + public static void main(String[] args) throws IOException { + // TODO(developer): Replace these variables before running the sample. + String runId = "MY_RUN_ID"; + // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or + // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` + runDetails(runId); + } + + public static void runDetails(String runId) throws IOException { + try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + GetTransferRunRequest request = GetTransferRunRequest.newBuilder().setName(runId).build(); + TransferRun run = dataTransferServiceClient.getTransferRun(request); + System.out.print("Run details retrieved successfully :" + run.getName() + "\n"); + } catch (ApiException ex) { + System.out.print("Run details not found." + ex.toString()); + } + } +} +// [END bigquerydatatransfer_get_run_details] diff --git a/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java new file mode 100644 index 00000000..07b830dd --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java @@ -0,0 +1,138 @@ +/* + * Copyright 2020 Google LLC + * + * 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.bigquerydatatransfer; + +import static com.google.common.truth.Truth.assertThat; +import static junit.framework.TestCase.assertNotNull; + +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.DatasetInfo; +import com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest; +import com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient; +import com.google.cloud.bigquery.datatransfer.v1.ProjectName; +import com.google.cloud.bigquery.datatransfer.v1.TransferConfig; +import com.google.protobuf.Struct; +import com.google.protobuf.Value; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.PrintStream; +import java.util.HashMap; +import java.util.Map; +import java.util.UUID; +import java.util.logging.Level; +import java.util.logging.Logger; +import org.junit.After; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; + +public class RunDetailsIT { + + private static final Logger LOG = Logger.getLogger(GetTransferConfigInfoIT.class.getName()); + private static final String ID = UUID.randomUUID().toString().substring(0, 8); + private BigQuery bigquery; + private ByteArrayOutputStream bout; + private String name; + private String runName; + private String displayName; + private String datasetName; + private PrintStream out; + private PrintStream originalPrintStream; + + private static final String PROJECT_ID = requireEnvVar("GOOGLE_CLOUD_PROJECT"); + + private static String requireEnvVar(String varName) { + String value = System.getenv(varName); + assertNotNull( + "Environment variable " + varName + " is required to perform these tests.", + System.getenv(varName)); + return value; + } + + @BeforeClass + public static void checkRequirements() { + requireEnvVar("GOOGLE_CLOUD_PROJECT"); + } + + @Before + public void setUp() throws IOException { + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + originalPrintStream = System.out; + System.setOut(out); + + displayName = "MY_SCHEDULE_NAME_TEST_" + ID; + datasetName = "MY_DATASET_NAME_TEST_" + ID; + // create a temporary dataset + bigquery = BigQueryOptions.getDefaultInstance().getService(); + bigquery.create(DatasetInfo.of(datasetName)); + // create a scheduled query + String query = + "SELECT CURRENT_TIMESTAMP() as current_time, @run_time as intended_run_time, " + + "@run_date as intended_run_date, 17 as some_integer"; + String destinationTableName = + "MY_DESTINATION_TABLE_" + UUID.randomUUID().toString().substring(0, 8) + "_{run_date}"; + Map params = new HashMap<>(); + params.put("query", Value.newBuilder().setStringValue(query).build()); + params.put( + "destination_table_name_template", + Value.newBuilder().setStringValue(destinationTableName).build()); + params.put("write_disposition", Value.newBuilder().setStringValue("WRITE_TRUNCATE").build()); + params.put("partitioning_field", Value.newBuilder().setStringValue("").build()); + TransferConfig transferConfig = + TransferConfig.newBuilder() + .setDestinationDatasetId(datasetName) + .setDisplayName(displayName) + .setDataSourceId("scheduled_query") + .setParams(Struct.newBuilder().putAllFields(params).build()) + .setSchedule("every 24 hours") + .build(); + try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + ProjectName parent = ProjectName.of(PROJECT_ID); + CreateTransferConfigRequest request = + CreateTransferConfigRequest.newBuilder() + .setParent(parent.toString()) + .setTransferConfig(transferConfig) + .build(); + name = dataTransferServiceClient.createTransferConfig(request).getName(); + System.out.println("\nScheduled query created successfully :" + name); + } + try (DataTransferServiceClient client = DataTransferServiceClient.create()) { + client.listTransferRuns(name).iterateAll().forEach(run -> runName = run.getName()); + } + } + + @After + public void tearDown() throws IOException { + // delete scheduled query that was just created + DeleteScheduledQuery.deleteScheduledQuery(name); + // delete a temporary dataset + bigquery.delete(datasetName, BigQuery.DatasetDeleteOption.deleteContents()); + + // restores print statements in the original method + System.out.flush(); + System.setOut(originalPrintStream); + LOG.log(Level.INFO, bout.toString()); + } + + @Test + public void testRunDetails() throws IOException { + RunDetails.runDetails(runName); + assertThat(bout.toString()).contains("Run details retrieved successfully :"); + } +} From 02ff7d5849039caf7d2fac3c9c6d3e535a8b937f Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Thu, 10 Sep 2020 17:43:48 +0530 Subject: [PATCH 2/3] docs(samples): address feedback --- .../java/com/example/bigquerydatatransfer/RunDetails.java | 3 ++- .../java/com/example/bigquerydatatransfer/RunDetailsIT.java | 5 ++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/samples/snippets/src/main/java/com/example/bigquerydatatransfer/RunDetails.java b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/RunDetails.java index 5b122f9c..ccb36270 100644 --- a/samples/snippets/src/main/java/com/example/bigquerydatatransfer/RunDetails.java +++ b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/RunDetails.java @@ -28,9 +28,10 @@ public class RunDetails { public static void main(String[] args) throws IOException { // TODO(developer): Replace these variables before running the sample. - String runId = "MY_RUN_ID"; + // runId examples: // `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or // `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` + String runId = "MY_RUN_ID"; runDetails(runId); } diff --git a/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java index 07b830dd..a8dae381 100644 --- a/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java +++ b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java @@ -85,8 +85,7 @@ public void setUp() throws IOException { String query = "SELECT CURRENT_TIMESTAMP() as current_time, @run_time as intended_run_time, " + "@run_date as intended_run_date, 17 as some_integer"; - String destinationTableName = - "MY_DESTINATION_TABLE_" + UUID.randomUUID().toString().substring(0, 8) + "_{run_date}"; + String destinationTableName = "MY_DESTINATION_TABLE_" + ID + "_{run_date}"; Map params = new HashMap<>(); params.put("query", Value.newBuilder().setStringValue(query).build()); params.put( @@ -110,7 +109,7 @@ public void setUp() throws IOException { .setTransferConfig(transferConfig) .build(); name = dataTransferServiceClient.createTransferConfig(request).getName(); - System.out.println("\nScheduled query created successfully :" + name); + System.out.println("Scheduled query created successfully :" + name); } try (DataTransferServiceClient client = DataTransferServiceClient.create()) { client.listTransferRuns(name).iterateAll().forEach(run -> runName = run.getName()); From 7449dde012fc26a0cfcfcbbe1953de8be868b916 Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Thu, 17 Sep 2020 17:39:04 +0530 Subject: [PATCH 3/3] docs(samples): add envvar --- .../bigquerydatatransfer/RunDetailsIT.java | 63 +------------------ 1 file changed, 3 insertions(+), 60 deletions(-) diff --git a/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java index a8dae381..e7f8850f 100644 --- a/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java +++ b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java @@ -19,21 +19,10 @@ import static com.google.common.truth.Truth.assertThat; import static junit.framework.TestCase.assertNotNull; -import com.google.cloud.bigquery.BigQuery; -import com.google.cloud.bigquery.BigQueryOptions; -import com.google.cloud.bigquery.DatasetInfo; -import com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest; import com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient; -import com.google.cloud.bigquery.datatransfer.v1.ProjectName; -import com.google.cloud.bigquery.datatransfer.v1.TransferConfig; -import com.google.protobuf.Struct; -import com.google.protobuf.Value; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.PrintStream; -import java.util.HashMap; -import java.util.Map; -import java.util.UUID; import java.util.logging.Level; import java.util.logging.Logger; import org.junit.After; @@ -44,17 +33,12 @@ public class RunDetailsIT { private static final Logger LOG = Logger.getLogger(GetTransferConfigInfoIT.class.getName()); - private static final String ID = UUID.randomUUID().toString().substring(0, 8); - private BigQuery bigquery; private ByteArrayOutputStream bout; - private String name; private String runName; - private String displayName; - private String datasetName; private PrintStream out; private PrintStream originalPrintStream; - private static final String PROJECT_ID = requireEnvVar("GOOGLE_CLOUD_PROJECT"); + private static final String CONFIG_NAME = requireEnvVar("DTS_TRANSFER_CONFIG_NAME"); private static String requireEnvVar(String varName) { String value = System.getenv(varName); @@ -66,7 +50,7 @@ private static String requireEnvVar(String varName) { @BeforeClass public static void checkRequirements() { - requireEnvVar("GOOGLE_CLOUD_PROJECT"); + requireEnvVar("DTS_TRANSFER_CONFIG_NAME"); } @Before @@ -75,54 +59,13 @@ public void setUp() throws IOException { out = new PrintStream(bout); originalPrintStream = System.out; System.setOut(out); - - displayName = "MY_SCHEDULE_NAME_TEST_" + ID; - datasetName = "MY_DATASET_NAME_TEST_" + ID; - // create a temporary dataset - bigquery = BigQueryOptions.getDefaultInstance().getService(); - bigquery.create(DatasetInfo.of(datasetName)); - // create a scheduled query - String query = - "SELECT CURRENT_TIMESTAMP() as current_time, @run_time as intended_run_time, " - + "@run_date as intended_run_date, 17 as some_integer"; - String destinationTableName = "MY_DESTINATION_TABLE_" + ID + "_{run_date}"; - Map params = new HashMap<>(); - params.put("query", Value.newBuilder().setStringValue(query).build()); - params.put( - "destination_table_name_template", - Value.newBuilder().setStringValue(destinationTableName).build()); - params.put("write_disposition", Value.newBuilder().setStringValue("WRITE_TRUNCATE").build()); - params.put("partitioning_field", Value.newBuilder().setStringValue("").build()); - TransferConfig transferConfig = - TransferConfig.newBuilder() - .setDestinationDatasetId(datasetName) - .setDisplayName(displayName) - .setDataSourceId("scheduled_query") - .setParams(Struct.newBuilder().putAllFields(params).build()) - .setSchedule("every 24 hours") - .build(); - try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { - ProjectName parent = ProjectName.of(PROJECT_ID); - CreateTransferConfigRequest request = - CreateTransferConfigRequest.newBuilder() - .setParent(parent.toString()) - .setTransferConfig(transferConfig) - .build(); - name = dataTransferServiceClient.createTransferConfig(request).getName(); - System.out.println("Scheduled query created successfully :" + name); - } try (DataTransferServiceClient client = DataTransferServiceClient.create()) { - client.listTransferRuns(name).iterateAll().forEach(run -> runName = run.getName()); + client.listTransferRuns(CONFIG_NAME).iterateAll().forEach(run -> runName = run.getName()); } } @After public void tearDown() throws IOException { - // delete scheduled query that was just created - DeleteScheduledQuery.deleteScheduledQuery(name); - // delete a temporary dataset - bigquery.delete(datasetName, BigQuery.DatasetDeleteOption.deleteContents()); - // restores print statements in the original method System.out.flush(); System.setOut(originalPrintStream);