From 093823687b6d870e3e443d349fe6a2ad035e6a85 Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Wed, 14 Oct 2020 22:04:20 +0530 Subject: [PATCH] docs(samples): add create cloud storage transfer (#431) --- .../CreateAmazonS3Transfer.java | 1 - .../CreateCloudStorageTransfer.java | 79 ++++++++++ .../CreateCloudStorageTransferIT.java | 140 ++++++++++++++++++ 3 files changed, 219 insertions(+), 1 deletion(-) create mode 100644 samples/snippets/src/main/java/com/example/bigquerydatatransfer/CreateCloudStorageTransfer.java create mode 100644 samples/snippets/src/test/java/com/example/bigquerydatatransfer/CreateCloudStorageTransferIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquerydatatransfer/CreateAmazonS3Transfer.java b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/CreateAmazonS3Transfer.java index c0f2356a..00b2e3fe 100644 --- a/samples/snippets/src/main/java/com/example/bigquerydatatransfer/CreateAmazonS3Transfer.java +++ b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/CreateAmazonS3Transfer.java @@ -77,7 +77,6 @@ public static void createAmazonS3Transfer(String projectId, TransferConfig trans } catch (ApiException ex) { System.out.print("Amazon s3 transfer was not created." + ex.toString()); } - ; } } // [END bigquerydatatransfer_create_amazons3_transfer] diff --git a/samples/snippets/src/main/java/com/example/bigquerydatatransfer/CreateCloudStorageTransfer.java b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/CreateCloudStorageTransfer.java new file mode 100644 index 00000000..c4f1e41c --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/CreateCloudStorageTransfer.java @@ -0,0 +1,79 @@ +/* + * 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_create_cloudstorage_transfer] +import com.google.api.gax.rpc.ApiException; +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.IOException; +import java.util.HashMap; +import java.util.Map; + +// Sample to create google cloud storage transfer config +public class CreateCloudStorageTransfer { + + public static void main(String[] args) throws IOException { + // TODO(developer): Replace these variables before running the sample. + final String projectId = "MY_PROJECT_ID"; + String datasetId = "MY_DATASET_ID"; + String tableId = "MY_TABLE_ID"; + // GCS Uri + String sourceUri = "gs://cloud-samples-data/bigquery/us-states/us-states.csv"; + String fileFormat = "CSV"; + String fieldDelimiter = ","; + String skipLeadingRows = "1"; + Map params = new HashMap<>(); + params.put( + "destination_table_name_template", Value.newBuilder().setStringValue(tableId).build()); + params.put("data_path_template", Value.newBuilder().setStringValue(sourceUri).build()); + params.put("write_disposition", Value.newBuilder().setStringValue("APPEND").build()); + params.put("file_format", Value.newBuilder().setStringValue(fileFormat).build()); + params.put("field_delimiter", Value.newBuilder().setStringValue(fieldDelimiter).build()); + params.put("skip_leading_rows", Value.newBuilder().setStringValue(skipLeadingRows).build()); + TransferConfig transferConfig = + TransferConfig.newBuilder() + .setDestinationDatasetId(datasetId) + .setDisplayName("Your Google Cloud Storage Config Name") + .setDataSourceId("google_cloud_storage") + .setParams(Struct.newBuilder().putAllFields(params).build()) + .setSchedule("every 24 hours") + .build(); + createCloudStorageTransfer(projectId, transferConfig); + } + + public static void createCloudStorageTransfer(String projectId, TransferConfig transferConfig) + throws IOException { + try (DataTransferServiceClient client = DataTransferServiceClient.create()) { + ProjectName parent = ProjectName.of(projectId); + CreateTransferConfigRequest request = + CreateTransferConfigRequest.newBuilder() + .setParent(parent.toString()) + .setTransferConfig(transferConfig) + .build(); + TransferConfig config = client.createTransferConfig(request); + System.out.println("Cloud storage transfer created successfully :" + config.getName()); + } catch (ApiException ex) { + System.out.print("Cloud storage transfer was not created." + ex.toString()); + } + } +} +// [END bigquerydatatransfer_create_cloudstorage_transfer] diff --git a/samples/snippets/src/test/java/com/example/bigquerydatatransfer/CreateCloudStorageTransferIT.java b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/CreateCloudStorageTransferIT.java new file mode 100644 index 00000000..2121b2fb --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/CreateCloudStorageTransferIT.java @@ -0,0 +1,140 @@ +/* + * 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.Field; +import com.google.cloud.bigquery.Schema; +import com.google.cloud.bigquery.StandardSQLTypeName; +import com.google.cloud.bigquery.StandardTableDefinition; +import com.google.cloud.bigquery.TableDefinition; +import com.google.cloud.bigquery.TableId; +import com.google.cloud.bigquery.TableInfo; +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 CreateCloudStorageTransferIT { + + private static final Logger LOG = Logger.getLogger(CreateCloudStorageTransferIT.class.getName()); + private static final String ID = UUID.randomUUID().toString().substring(0, 8); + private BigQuery bigquery; + private ByteArrayOutputStream bout; + private String name; + private String displayName; + private String datasetName; + private String tableName; + 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() { + displayName = "CLOUD_STORAGE_CONFIG_TEST_" + ID; + datasetName = "CLOUD_STORAGE_DATASET_NAME_TEST_" + ID; + tableName = "CLOUD_STORAGE_TABLE_NAME_TEST_" + ID; + // create a temporary dataset + bigquery = BigQueryOptions.getDefaultInstance().getService(); + bigquery.create(DatasetInfo.of(datasetName)); + // create a temporary table + Schema schema = + Schema.of( + Field.of("name", StandardSQLTypeName.STRING), + Field.of("post_abbr", StandardSQLTypeName.STRING)); + TableDefinition tableDefinition = StandardTableDefinition.of(schema); + TableInfo tableInfo = TableInfo.of(TableId.of(datasetName, tableName), tableDefinition); + bigquery.create(tableInfo); + + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + originalPrintStream = System.out; + System.setOut(out); + } + + @After + public void tearDown() throws IOException { + // Clean up + DeleteTransferConfig.deleteTransferConfig(name); + // delete a temporary table + bigquery.delete(TableId.of(datasetName, tableName)); + // 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 testCreateCloudStorageTransfer() throws IOException { + String sourceUri = "gs://cloud-samples-data/bigquery/us-states/us-states.csv"; + String fileFormat = "CSV"; + String fieldDelimiter = ","; + String skipLeadingRows = "1"; + Map params = new HashMap<>(); + params.put( + "destination_table_name_template", Value.newBuilder().setStringValue(tableName).build()); + params.put("data_path_template", Value.newBuilder().setStringValue(sourceUri).build()); + params.put("write_disposition", Value.newBuilder().setStringValue("APPEND").build()); + params.put("file_format", Value.newBuilder().setStringValue(fileFormat).build()); + params.put("field_delimiter", Value.newBuilder().setStringValue(fieldDelimiter).build()); + params.put("skip_leading_rows", Value.newBuilder().setStringValue(skipLeadingRows).build()); + TransferConfig transferConfig = + TransferConfig.newBuilder() + .setDestinationDatasetId(datasetName) + .setDisplayName(displayName) + .setDataSourceId("google_cloud_storage") + .setParams(Struct.newBuilder().putAllFields(params).build()) + .setSchedule("every 24 hours") + .build(); + CreateCloudStorageTransfer.createCloudStorageTransfer(PROJECT_ID, transferConfig); + String result = bout.toString(); + name = result.substring(result.indexOf(":") + 1, result.length() - 1); + assertThat(result).contains("Cloud storage transfer created successfully :"); + } +}