From 4c7ad64e4c05f13c23e75eb51d2880236606613b Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Tue, 20 Oct 2020 18:58:54 +0530 Subject: [PATCH 1/4] docs(samples): add omni query on external table aws --- .../bigquery/CreateExternalTableAws.java | 21 ++- .../bigquery/QueryExternalTableAws.java | 89 +++++++++++ .../bigquery/CreateExternalTableAwsIT.java | 3 +- .../bigquery/QueryExternalTableAwsIT.java | 142 ++++++++++++++++++ 4 files changed, 251 insertions(+), 4 deletions(-) create mode 100644 samples/snippets/src/main/java/com/example/bigquery/QueryExternalTableAws.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquery/CreateExternalTableAws.java b/samples/snippets/src/main/java/com/example/bigquery/CreateExternalTableAws.java index 02dd669c8..4c3b115eb 100644 --- a/samples/snippets/src/main/java/com/example/bigquery/CreateExternalTableAws.java +++ b/samples/snippets/src/main/java/com/example/bigquery/CreateExternalTableAws.java @@ -16,18 +16,24 @@ package com.example.bigquery; +// [START bigquery_omni_create_external_table] import com.google.cloud.bigquery.BigQuery; import com.google.cloud.bigquery.BigQueryException; import com.google.cloud.bigquery.BigQueryOptions; import com.google.cloud.bigquery.CsvOptions; import com.google.cloud.bigquery.ExternalTableDefinition; +import com.google.cloud.bigquery.Field; +import com.google.cloud.bigquery.Schema; +import com.google.cloud.bigquery.StandardSQLTypeName; import com.google.cloud.bigquery.TableId; import com.google.cloud.bigquery.TableInfo; +// Sample to create an external aws table public class CreateExternalTableAws { public static void main(String[] args) { // TODO(developer): Replace these variables before running the sample. + String projectId = "MY_PROJECT_ID"; String datasetName = "MY_DATASET_NAME"; String tableName = "MY_TABLE_NAME"; // Create a aws connection @@ -35,21 +41,29 @@ public static void main(String[] args) { String connectionId = "MY_CONNECTION_NAME"; String sourceUri = "s3://your-bucket-name/"; CsvOptions options = CsvOptions.newBuilder().setSkipLeadingRows(1).build(); + Schema schema = + Schema.of( + Field.of("name", StandardSQLTypeName.STRING), + Field.of("post_abbr", StandardSQLTypeName.STRING)); ExternalTableDefinition externalTableDefinition = ExternalTableDefinition.newBuilder(sourceUri, options) .setConnectionId(connectionId) + .setSchema(schema) .build(); - createExternalTableAws(datasetName, tableName, externalTableDefinition); + createExternalTableAws(projectId, datasetName, tableName, externalTableDefinition); } public static void createExternalTableAws( - String datasetName, String tableName, ExternalTableDefinition externalTableDefinition) { + String projectId, + String datasetName, + String tableName, + ExternalTableDefinition externalTableDefinition) { try { // Initialize client that will be used to send requests. This client only needs to be created // once, and can be reused for multiple requests. BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService(); - TableId tableId = TableId.of(datasetName, tableName); + TableId tableId = TableId.of(projectId, datasetName, tableName); TableInfo tableInfo = TableInfo.newBuilder(tableId, externalTableDefinition).build(); bigquery.create(tableInfo); @@ -59,3 +73,4 @@ public static void createExternalTableAws( } } } +// [END bigquery_omni_create_external_table] diff --git a/samples/snippets/src/main/java/com/example/bigquery/QueryExternalTableAws.java b/samples/snippets/src/main/java/com/example/bigquery/QueryExternalTableAws.java new file mode 100644 index 000000000..21cacc898 --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/QueryExternalTableAws.java @@ -0,0 +1,89 @@ +/* + * 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.bigquery; + +// [START bigquery_omni_query_external_aws_s3] +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryException; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.CsvOptions; +import com.google.cloud.bigquery.ExternalTableDefinition; +import com.google.cloud.bigquery.Field; +import com.google.cloud.bigquery.QueryJobConfiguration; +import com.google.cloud.bigquery.Schema; +import com.google.cloud.bigquery.StandardSQLTypeName; +import com.google.cloud.bigquery.TableId; +import com.google.cloud.bigquery.TableInfo; +import com.google.cloud.bigquery.TableResult; + +// Sample to queries an external data source aws s3 using a permanent table +public class QueryExternalTableAws { + + public static void main(String[] args) { + // TODO(developer): Replace these variables before running the sample. + String projectId = "MY_PROJECT_ID"; + String datasetName = "MY_DATASET_NAME"; + String tableName = "MY_TABLE_NAME"; + // Create a aws connection + // projects/{project_id}/locations/{location_id}/connections/{connection_id} + String connectionId = "MY_CONNECTION_NAME"; + String sourceUri = "s3://your-bucket-name/"; + CsvOptions options = CsvOptions.newBuilder().setSkipLeadingRows(1).build(); + Schema schema = + Schema.of( + Field.of("name", StandardSQLTypeName.STRING), + Field.of("post_abbr", StandardSQLTypeName.STRING)); + String query = + String.format( + "SELECT * FROM s%:%s.%s WHERE name LIKE 'W%%'", projectId, datasetName, tableName); + ExternalTableDefinition externalTable = + ExternalTableDefinition.newBuilder(sourceUri, options) + .setConnectionId(connectionId) + .setSchema(schema) + .build(); + queryExternalTableAws(projectId, datasetName, tableName, externalTable, query); + } + + public static void queryExternalTableAws( + String projectId, + String datasetName, + String tableName, + ExternalTableDefinition externalTable, + String query) { + try { + // Initialize client that will be used to send requests. This client only needs to be created + // once, and can be reused for multiple requests. + BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService(); + + TableId tableId = TableId.of(projectId, datasetName, tableName); + // Create a permanent table linked to the Aws file + bigquery.create(TableInfo.of(tableId, externalTable)); + + // Example query to find states starting with 'W' + TableResult results = bigquery.query(QueryJobConfiguration.of(query)); + + results + .iterateAll() + .forEach(row -> row.forEach(val -> System.out.printf("%s,", val.toString()))); + + System.out.println("Query on aws external permanent table performed successfully."); + } catch (BigQueryException | InterruptedException e) { + System.out.println("Query not performed \n" + e.toString()); + } + } +} +// [END bigquery_omni_query_external_aws_s3] diff --git a/samples/snippets/src/test/java/com/example/bigquery/CreateExternalTableAwsIT.java b/samples/snippets/src/test/java/com/example/bigquery/CreateExternalTableAwsIT.java index 16b047398..39352b3fa 100644 --- a/samples/snippets/src/test/java/com/example/bigquery/CreateExternalTableAwsIT.java +++ b/samples/snippets/src/test/java/com/example/bigquery/CreateExternalTableAwsIT.java @@ -131,7 +131,8 @@ public void testCreateExternalTableAws() { .setConnectionId(connectionName) .setSchema(schema) .build(); - CreateExternalTableAws.createExternalTableAws(datasetName, tableName, externalTable); + CreateExternalTableAws.createExternalTableAws( + PROJECT_ID, datasetName, tableName, externalTable); assertThat(bout.toString()).contains("Aws external table created successfully"); } } diff --git a/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java b/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java new file mode 100644 index 000000000..d92f5bc5c --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java @@ -0,0 +1,142 @@ +/* + * 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.bigquery; + +import static com.google.common.truth.Truth.assertThat; +import static junit.framework.TestCase.assertNotNull; + +import com.google.cloud.bigquery.CsvOptions; +import com.google.cloud.bigquery.ExternalTableDefinition; +import com.google.cloud.bigquery.Field; +import com.google.cloud.bigquery.Schema; +import com.google.cloud.bigquery.StandardSQLTypeName; +import com.google.cloud.bigquery.connection.v1.AwsCrossAccountRole; +import com.google.cloud.bigquery.connection.v1.AwsProperties; +import com.google.cloud.bigquery.connection.v1.Connection; +import com.google.cloud.bigquery.connection.v1.CreateConnectionRequest; +import com.google.cloud.bigquery.connection.v1.DeleteConnectionRequest; +import com.google.cloud.bigquery.connection.v1.LocationName; +import com.google.cloud.bigqueryconnection.v1.ConnectionServiceClient; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.PrintStream; +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 QueryExternalTableAwsIT { + + private static final String ID = UUID.randomUUID().toString().substring(0, 8); + private static final String LOCATION = "aws-us-east-1"; + private final Logger log = Logger.getLogger(this.getClass().getName()); + private String datasetName; + private String tableName; + private String connectionName; + private ByteArrayOutputStream bout; + private PrintStream out; + private PrintStream originalPrintStream; + + private static final String PROJECT_ID = requireEnvVar("OMNI_PROJECT_ID"); + private static final String AWS_ACCOUNT_ID = requireEnvVar("AWS_ACCOUNT_ID"); + private static final String AWS_ROLE_ID = requireEnvVar("AWS_ROLE_ID"); + + 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("OMNI_PROJECT_ID"); + requireEnvVar("AWS_ACCOUNT_ID"); + requireEnvVar("AWS_ROLE_ID"); + } + + @Before + public void setUp() throws IOException { + datasetName = "QUERY_EXTERNAL_TABLE_AWS_TEST_" + ID; + tableName = "QUERY_EXTERNAL_TABLE_AWS_TEST_" + ID; + connectionName = "QUERY_EXTERNAL_TABLE_AWS_TEST_" + ID; + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + originalPrintStream = System.out; + System.setOut(out); + // create a temporary aws connection + try (ConnectionServiceClient client = ConnectionServiceClient.create()) { + LocationName parent = LocationName.of(PROJECT_ID, LOCATION); + String iamRoleId = String.format("arn:aws:iam::%s:role/%s", AWS_ACCOUNT_ID, AWS_ROLE_ID); + AwsCrossAccountRole role = AwsCrossAccountRole.newBuilder().setIamRoleId(iamRoleId).build(); + AwsProperties awsProperties = AwsProperties.newBuilder().setCrossAccountRole(role).build(); + Connection connection = Connection.newBuilder().setAws(awsProperties).build(); + CreateConnectionRequest request = + CreateConnectionRequest.newBuilder() + .setParent(parent.toString()) + .setConnection(connection) + .setConnectionId(connectionName) + .build(); + connectionName = client.createConnection(request).getName(); + } + // create a temporary dataset + CreateDatasetAws.createDatasetAws(PROJECT_ID, datasetName, LOCATION); + } + + @After + public void tearDown() throws IOException { + // delete a temporary aws connection + try (ConnectionServiceClient client = ConnectionServiceClient.create()) { + DeleteConnectionRequest request = + DeleteConnectionRequest.newBuilder().setName(connectionName).build(); + client.deleteConnection(request); + } + // Clean up + DeleteTable.deleteTable(datasetName, tableName); + DeleteDataset.deleteDataset(PROJECT_ID, datasetName); + // restores print statements in the original method + System.out.flush(); + System.setOut(originalPrintStream); + log.log(Level.INFO, bout.toString()); + } + + @Test + public void testQueryExternalTableAws() { + String sourceUri = "s3://cloud-samples-tests/us-states.csv"; + Schema schema = + Schema.of( + Field.of("name", StandardSQLTypeName.STRING), + Field.of("post_abbr", StandardSQLTypeName.STRING)); + CsvOptions options = CsvOptions.newBuilder().setSkipLeadingRows(1).build(); + ExternalTableDefinition externalTable = + ExternalTableDefinition.newBuilder(sourceUri, options) + .setConnectionId(connectionName) + .setSchema(schema) + .build(); + String query = + String.format( + "SELECT * FROM s%:%s.%s WHERE name LIKE 'W%%'", PROJECT_ID, datasetName, tableName); + QueryExternalTableAws.queryExternalTableAws( + PROJECT_ID, datasetName, tableName, externalTable, query); + assertThat(bout.toString()) + .contains("Query on aws external permanent table performed successfully."); + } +} From f06a8219207253decaf4145fad0f0282e880bfea Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Tue, 20 Oct 2020 19:29:57 +0530 Subject: [PATCH 2/4] docs(samples): update code --- .../test/java/com/example/bigquery/QueryExternalTableAwsIT.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java b/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java index d92f5bc5c..2a0c58454 100644 --- a/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java +++ b/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java @@ -133,7 +133,7 @@ public void testQueryExternalTableAws() { .build(); String query = String.format( - "SELECT * FROM s%:%s.%s WHERE name LIKE 'W%%'", PROJECT_ID, datasetName, tableName); + "SELECT * FROM %s:%s.%s WHERE name LIKE 'W%%'", PROJECT_ID, datasetName, tableName); QueryExternalTableAws.queryExternalTableAws( PROJECT_ID, datasetName, tableName, externalTable, query); assertThat(bout.toString()) From 170cbbd27acc4f2748f6875e720f7e84408e3b27 Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Tue, 20 Oct 2020 20:00:00 +0530 Subject: [PATCH 3/4] docs(samples): add user id and external id --- .../com/example/bigquery/QueryExternalTableAwsIT.java | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java b/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java index 2a0c58454..d0bd149dd 100644 --- a/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java +++ b/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java @@ -95,7 +95,13 @@ public void setUp() throws IOException { .setConnection(connection) .setConnectionId(connectionName) .build(); - connectionName = client.createConnection(request).getName(); + Connection response = client.createConnection(request); + AwsCrossAccountRole accountRole = response.getAws().getCrossAccountRole(); + System.out.println( + "Aws connection created successfully : Aws userId :" + + accountRole.getIamUserId() + + " Aws externalId :" + + accountRole.getExternalId()); } // create a temporary dataset CreateDatasetAws.createDatasetAws(PROJECT_ID, datasetName, LOCATION); @@ -108,6 +114,7 @@ public void tearDown() throws IOException { DeleteConnectionRequest request = DeleteConnectionRequest.newBuilder().setName(connectionName).build(); client.deleteConnection(request); + System.out.println("Connection deleted successfully"); } // Clean up DeleteTable.deleteTable(datasetName, tableName); From 277071a9e1b8f7e4194a026d38ccf21fbed6c85c Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Tue, 20 Oct 2020 20:30:00 +0530 Subject: [PATCH 4/4] docs(samples): fix connection name --- .../test/java/com/example/bigquery/QueryExternalTableAwsIT.java | 1 + 1 file changed, 1 insertion(+) diff --git a/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java b/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java index d0bd149dd..654016e60 100644 --- a/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java +++ b/samples/snippets/src/test/java/com/example/bigquery/QueryExternalTableAwsIT.java @@ -96,6 +96,7 @@ public void setUp() throws IOException { .setConnectionId(connectionName) .build(); Connection response = client.createConnection(request); + connectionName = response.getName(); AwsCrossAccountRole accountRole = response.getAws().getCrossAccountRole(); System.out.println( "Aws connection created successfully : Aws userId :"