[
https://issues.apache.org/jira/browse/BEAM-6841?focusedWorklogId=220671&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-220671
]
ASF GitHub Bot logged work on BEAM-6841:
----------------------------------------
Author: ASF GitHub Bot
Created on: 29/Mar/19 19:07
Start Date: 29/Mar/19 19:07
Worklog Time Spent: 10m
Work Description: chamikaramj commented on pull request #8061:
[BEAM-6841] Add support for reading query results using the BigQuery storage
API.
URL: https://github.com/apache/beam/pull/8061#discussion_r270540092
##########
File path:
sdks/java/io/google-cloud-platform/src/test/java/org/apache/beam/sdk/io/gcp/bigquery/BigQueryIOStorageQueryTest.java
##########
@@ -0,0 +1,712 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 org.apache.beam.sdk.io.gcp.bigquery;
+
+import static
org.apache.beam.sdk.io.gcp.bigquery.BigQueryHelpers.createJobIdToken;
+import static
org.apache.beam.sdk.io.gcp.bigquery.BigQueryHelpers.createTempTableReference;
+import static
org.apache.beam.sdk.transforms.display.DisplayDataMatchers.hasDisplayItem;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.hasItem;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+import static org.mockito.Mockito.withSettings;
+import static org.testng.Assert.assertFalse;
+
+import com.google.api.services.bigquery.model.JobStatistics;
+import com.google.api.services.bigquery.model.JobStatistics2;
+import com.google.api.services.bigquery.model.Table;
+import com.google.api.services.bigquery.model.TableFieldSchema;
+import com.google.api.services.bigquery.model.TableReference;
+import com.google.api.services.bigquery.model.TableRow;
+import com.google.api.services.bigquery.model.TableSchema;
+import com.google.cloud.bigquery.storage.v1beta1.AvroProto.AvroRows;
+import com.google.cloud.bigquery.storage.v1beta1.AvroProto.AvroSchema;
+import com.google.cloud.bigquery.storage.v1beta1.ReadOptions.TableReadOptions;
+import
com.google.cloud.bigquery.storage.v1beta1.Storage.CreateReadSessionRequest;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsRequest;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsResponse;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.ReadSession;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.Stream;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.StreamPosition;
+import com.google.protobuf.ByteString;
+import java.io.ByteArrayOutputStream;
+import java.util.Collection;
+import java.util.List;
+import java.util.Set;
+import org.apache.avro.Schema;
+import org.apache.avro.generic.GenericData.Record;
+import org.apache.avro.generic.GenericDatumWriter;
+import org.apache.avro.generic.GenericRecord;
+import org.apache.avro.io.Encoder;
+import org.apache.avro.io.EncoderFactory;
+import org.apache.beam.sdk.coders.CoderRegistry;
+import org.apache.beam.sdk.coders.KvCoder;
+import org.apache.beam.sdk.extensions.protobuf.ByteStringCoder;
+import org.apache.beam.sdk.extensions.protobuf.ProtoCoder;
+import org.apache.beam.sdk.io.BoundedSource;
+import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.TableRowParser;
+import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.TypedRead;
+import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.TypedRead.Method;
+import org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.TypedRead.QueryPriority;
+import org.apache.beam.sdk.io.gcp.bigquery.BigQueryServices.StorageClient;
+import org.apache.beam.sdk.options.ValueProvider;
+import org.apache.beam.sdk.testing.PAssert;
+import org.apache.beam.sdk.testing.TestPipeline;
+import org.apache.beam.sdk.transforms.SerializableFunction;
+import org.apache.beam.sdk.transforms.display.DisplayData;
+import org.apache.beam.sdk.transforms.display.DisplayDataEvaluator;
+import org.apache.beam.sdk.values.KV;
+import org.apache.beam.sdk.values.PCollection;
+import
org.apache.beam.vendor.guava.v20_0.com.google.common.collect.ImmutableList;
+import org.apache.beam.vendor.guava.v20_0.com.google.common.collect.Lists;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.junit.rules.TemporaryFolder;
+import org.junit.rules.TestRule;
+import org.junit.runner.Description;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+import org.junit.runners.model.Statement;
+
+/** Tests for {@link BigQueryIO#readTableRows()} using {@link
Method#DIRECT_READ}. */
+@RunWith(JUnit4.class)
+public class BigQueryIOStorageQueryTest {
+
+ private transient BigQueryOptions options;
+ private transient TemporaryFolder testFolder = new TemporaryFolder();
+ private transient TestPipeline p;
+
+ @Rule
+ public final transient TestRule folderThenPipeline =
+ new TestRule() {
+ @Override
+ public Statement apply(Statement base, Description description) {
+ // We need to set up the temporary folder, and then set up the
TestPipeline based on the
+ // chosen folder. Unfortunately, since rule evaluation order is
unspecified and unrelated
+ // to field order, and is separate from construction, that requires
manually creating this
+ // TestRule.
+ Statement withPipeline =
+ new Statement() {
+ @Override
+ public void evaluate() throws Throwable {
+ options =
TestPipeline.testingPipelineOptions().as(BigQueryOptions.class);
+ options.setProject("project-id");
+
options.setTempLocation(testFolder.getRoot().getAbsolutePath());
+ p = TestPipeline.fromOptions(options);
+ p.apply(base, description).evaluate();
+ }
+ };
+
+ return testFolder.apply(withPipeline, description);
+ }
+ };
+
+ @Rule public transient ExpectedException thrown = ExpectedException.none();
+
+ private FakeDatasetService fakeDatasetService = new FakeDatasetService();
+ private FakeJobService fakeJobService = new FakeJobService();
+
+ private FakeBigQueryServices fakeBigQueryServices =
+ new FakeBigQueryServices()
+ .withDatasetService(fakeDatasetService)
+ .withJobService(fakeJobService);
+
+ @Before
+ public void setUp() throws Exception {
+ FakeDatasetService.setUp();
+ }
+
+ private static final String DEFAULT_QUERY = "SELECT * FROM `dataset.table`
LIMIT 1";
+
+ @Test
+ public void testDefaultQueryBasedSource() throws Exception {
+ TypedRead<TableRow> typedRead = getDefaultTypedRead();
+ checkTypedReadQueryObject(typedRead, DEFAULT_QUERY);
+ assertTrue(typedRead.getValidate());
+ assertTrue(typedRead.getFlattenResults());
+ assertTrue(typedRead.getUseLegacySql());
+ assertNull(typedRead.getQueryPriority());
+ assertNull(typedRead.getQueryLocation());
+ assertNull(typedRead.getKmsKey());
+ assertFalse(typedRead.getWithTemplateCompatibility());
+ }
+
+ @Test
+ public void testQueryBasedSourceWithCustomQuery() throws Exception {
+ TypedRead<TableRow> typedRead =
+ BigQueryIO.read(new TableRowParser())
+ .fromQuery("SELECT * FROM `google.com:project.dataset.table`")
+ .withCoder(TableRowJsonCoder.of());
+ checkTypedReadQueryObject(typedRead, "SELECT * FROM
`google.com:project.dataset.table`");
+ }
+
+ @Test
+ public void testQueryBasedSourceWithoutValidation() throws Exception {
+ TypedRead<TableRow> typedRead = getDefaultTypedRead().withoutValidation();
+ checkTypedReadQueryObject(typedRead, DEFAULT_QUERY);
+ assertFalse(typedRead.getValidate());
+ }
+
+ @Test
+ public void testQueryBasedSourceWithoutResultFlattening() throws Exception {
+ TypedRead<TableRow> typedRead =
getDefaultTypedRead().withoutResultFlattening();
+ checkTypedReadQueryObject(typedRead, DEFAULT_QUERY);
+ assertFalse(typedRead.getFlattenResults());
+ }
+
+ @Test
+ public void testQueryBasedSourceWithStandardSql() throws Exception {
+ TypedRead<TableRow> typedRead = getDefaultTypedRead().usingStandardSql();
+ checkTypedReadQueryObject(typedRead, DEFAULT_QUERY);
+ assertFalse(typedRead.getUseLegacySql());
+ }
+
+ @Test
+ public void testQueryBasedSourceWithPriority() throws Exception {
+ TypedRead<TableRow> typedRead =
+ getDefaultTypedRead().withQueryPriority(QueryPriority.INTERACTIVE);
+ checkTypedReadQueryObject(typedRead, DEFAULT_QUERY);
+ assertEquals(QueryPriority.INTERACTIVE, typedRead.getQueryPriority());
+ }
+
+ @Test
+ public void testQueryBasedSourceWithQueryLocation() throws Exception {
+ TypedRead<TableRow> typedRead =
getDefaultTypedRead().withQueryLocation("US");
+ checkTypedReadQueryObject(typedRead, DEFAULT_QUERY);
+ assertEquals("US", typedRead.getQueryLocation());
+ }
+
+ @Test
+ public void testQueryBasedSourceWithKmsKey() throws Exception {
+ TypedRead<TableRow> typedRead =
getDefaultTypedRead().withKmsKey("kms_key");
+ checkTypedReadQueryObject(typedRead, DEFAULT_QUERY);
+ assertEquals("kms_key", typedRead.getKmsKey());
+ }
+
+ @Test
+ public void testQueryBasedSourceWithTemplateCompatibility() throws Exception
{
+ TypedRead<TableRow> typedRead =
getDefaultTypedRead().withTemplateCompatibility();
+ checkTypedReadQueryObject(typedRead, DEFAULT_QUERY);
+ assertTrue(typedRead.getWithTemplateCompatibility());
+ }
+
+ private TypedRead<TableRow> getDefaultTypedRead() {
+ return BigQueryIO.read(new TableRowParser())
+ .fromQuery(DEFAULT_QUERY)
+ .withCoder(TableRowJsonCoder.of())
+ .withMethod(Method.DIRECT_READ);
+ }
+
+ private void checkTypedReadQueryObject(TypedRead typedRead, String query) {
+ assertNull(typedRead.getTable());
+ assertEquals(query, typedRead.getQuery().get());
+ }
+
+ @Test
+ public void testBuildQueryBasedSourceWithReadOptions() throws Exception {
+ TableReadOptions readOptions =
TableReadOptions.newBuilder().setRowRestriction("a > 5").build();
+ TypedRead<TableRow> typedRead =
getDefaultTypedRead().withReadOptions(readOptions);
+ thrown.expect(IllegalArgumentException.class);
+ thrown.expectMessage(
+ "Invalid BigQueryIO.Read: Specifies table read options, "
+ + "which only applies when reading from a table");
+ p.apply(typedRead);
+ p.run();
+ }
+
+ @Test
+ public void testDisplayData() throws Exception {
+ TypedRead<TableRow> typedRead = getDefaultTypedRead();
+ DisplayData displayData = DisplayData.from(typedRead);
+ assertThat(displayData, hasDisplayItem("query", DEFAULT_QUERY));
+ }
+
+ @Test
+ public void testEvaluatedDisplayData() throws Exception {
+ DisplayDataEvaluator evaluator = DisplayDataEvaluator.create();
+ TypedRead<TableRow> typedRead = getDefaultTypedRead();
+ Set<DisplayData> displayData =
evaluator.displayDataForPrimitiveSourceTransforms(typedRead);
+ assertThat(displayData, hasItem(hasDisplayItem("query")));
+ }
+
+ @Test
+ public void testName() {
+ assertEquals("BigQueryIO.TypedRead", getDefaultTypedRead().getName());
+ }
+
+ @Test
+ public void testCoderInference() {
+ SerializableFunction<SchemaAndRecord, KV<ByteString, ReadSession>> parseFn
=
+ new SerializableFunction<SchemaAndRecord, KV<ByteString,
ReadSession>>() {
+ @Override
+ public KV<ByteString, ReadSession> apply(SchemaAndRecord input) {
+ return null;
+ }
+ };
+
+ assertEquals(
+ KvCoder.of(ByteStringCoder.of(), ProtoCoder.of(ReadSession.class)),
+ BigQueryIO.read(parseFn).inferCoder(CoderRegistry.createDefault()));
+ }
+
+ @Test
+ public void testQuerySourceEstimatedSize() throws Exception {
+
+ String fakeQuery = "fake query text";
+
+ fakeJobService.expectDryRunQuery(
+ options.getProject(),
+ fakeQuery,
+ new JobStatistics().setQuery(new
JobStatistics2().setTotalBytesProcessed(125L)));
+
+ BigQueryStorageQuerySource<TableRow> querySource =
+ BigQueryStorageQuerySource.create(
+ /* stepUuid = */ "stepUuid",
+ ValueProvider.StaticValueProvider.of(fakeQuery),
+ /* flattenResults = */ true,
+ /* useLegacySql = */ true,
+ /* priority = */ QueryPriority.INTERACTIVE,
+ /* location = */ null,
+ /* kmsKey = */ null,
+ new TableRowParser(),
+ TableRowJsonCoder.of(),
+ fakeBigQueryServices);
+
+ assertEquals(125L, querySource.getEstimatedSizeBytes(options));
+ }
+
+ @Test
+ public void testQuerySourceInitialSplit() throws Exception {
+ doQuerySourceInitialSplit(1024L, 1024, 50);
+ }
+
+ @Test
+ public void testQuerySourceInitialSplit_MinSplitCount() throws Exception {
+ doQuerySourceInitialSplit(1024L * 1024L, 10, 1);
+ }
+
+ @Test
+ public void testQuerySourceInitialSplit_MaxSplitCount() throws Exception {
+ doQuerySourceInitialSplit(10, 10_000, 200);
+ }
+
+ private void doQuerySourceInitialSplit(
+ long bundleSize, int requestedStreamCount, int expectedStreamCount)
throws Exception {
+
+ TableReference sourceTableRef =
BigQueryHelpers.parseTableSpec("project:dataset.table");
+
+ fakeDatasetService.createDataset(
+ sourceTableRef.getProjectId(),
+ sourceTableRef.getDatasetId(),
+ "asia-northeast1",
+ "Fake plastic tree^H^H^H^Htables",
+ null);
+
+ fakeDatasetService.createTable(
+ new
Table().setTableReference(sourceTableRef).setLocation("asia-northeast1"));
+
+ Table queryResultTable =
+ new Table()
+ .setSchema(
+ new TableSchema()
+ .setFields(
+ ImmutableList.of(
+ new
TableFieldSchema().setName("name").setType("STRING"),
+ new
TableFieldSchema().setName("number").setType("INTEGER"))))
+ .setNumBytes(1024L * 1024L);
+
+ String encodedQuery =
FakeBigQueryServices.encodeQueryResult(queryResultTable);
+
+ fakeJobService.expectDryRunQuery(
+ options.getProject(),
+ encodedQuery,
+ new JobStatistics()
+ .setQuery(
+ new JobStatistics2()
+ .setTotalBytesProcessed(1024L * 1024L)
+ .setReferencedTables(ImmutableList.of(sourceTableRef))));
+
+ String stepUuid = "testStepUuid";
+
+ TableReference tempTableReference =
+ createTempTableReference(
+ options.getProject(), createJobIdToken(options.getJobName(),
stepUuid));
+
+ CreateReadSessionRequest expectedRequest =
+ CreateReadSessionRequest.newBuilder()
+ .setParent("projects/" + options.getProject())
+
.setTableReference(BigQueryHelpers.toTableRefProto(tempTableReference))
+ .setRequestedStreams(requestedStreamCount)
+ .build();
+
+ ReadSession.Builder builder = ReadSession.newBuilder();
+ for (int i = 0; i < expectedStreamCount; i++) {
+ builder.addStreams(Stream.newBuilder().setName("stream-" + i));
+ }
+
+ StorageClient fakeStorageClient = mock(StorageClient.class);
+
when(fakeStorageClient.createReadSession(expectedRequest)).thenReturn(builder.build());
+
+ BigQueryStorageQuerySource<TableRow> querySource =
+ BigQueryStorageQuerySource.create(
+ stepUuid,
+ ValueProvider.StaticValueProvider.of(encodedQuery),
+ /* flattenResults = */ true,
+ /* useLegacySql = */ true,
+ /* priority = */ QueryPriority.BATCH,
+ /* location = */ null,
+ /* kmsKey = */ null,
+ new TableRowParser(),
+ TableRowJsonCoder.of(),
+ new FakeBigQueryServices()
+ .withDatasetService(fakeDatasetService)
+ .withJobService(fakeJobService)
+ .withStorageClient(fakeStorageClient));
+
+ List<? extends BoundedSource<TableRow>> sources =
querySource.split(bundleSize, options);
+ assertEquals(expectedStreamCount, sources.size());
+ }
+
+ /**
+ * This test simulates the scenario where the SQL text which is executed by
the query job doesn't
+ * by itself refer to any tables (e.g. "SELECT 17 AS value"), and thus there
are no referenced
+ * tables when the dry run of the query is performed.
+ */
+ @Test
+ public void testQuerySourceInitialSplit_NoReferencedTables() throws
Exception {
Review comment:
Probably rename the existing test to be similar.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 220671)
Time Spent: 6h (was: 5h 50m)
> Support reading query results with the BigQuery storage API
> -----------------------------------------------------------
>
> Key: BEAM-6841
> URL: https://issues.apache.org/jira/browse/BEAM-6841
> Project: Beam
> Issue Type: New Feature
> Components: io-java-gcp
> Reporter: Kenneth Jung
> Assignee: Kenneth Jung
> Priority: Minor
> Time Spent: 6h
> Remaining Estimate: 0h
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
