From 68140d5e463304253a5cc28e6dae9cc73d1bf8d1 Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Wed, 17 Jun 2020 22:47:33 +0530 Subject: [PATCH] docs(samples): add create range partition table (#458) * docs(samples): add create range partition table * docs(samples): address feedback --- .../bigquery/CreateRangePartitionedTable.java | 83 +++++++++++++++++++ .../CreateRangePartitionedTableIT.java | 83 +++++++++++++++++++ 2 files changed, 166 insertions(+) create mode 100644 samples/snippets/src/main/java/com/example/bigquery/CreateRangePartitionedTable.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/CreateRangePartitionedTableIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquery/CreateRangePartitionedTable.java b/samples/snippets/src/main/java/com/example/bigquery/CreateRangePartitionedTable.java new file mode 100644 index 000000000..57abdff8f --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/CreateRangePartitionedTable.java @@ -0,0 +1,83 @@ +/* + * 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_create_table_range_partitioned] +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryException; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.Field; +import com.google.cloud.bigquery.RangePartitioning; +import com.google.cloud.bigquery.Schema; +import com.google.cloud.bigquery.StandardSQLTypeName; +import com.google.cloud.bigquery.StandardTableDefinition; +import com.google.cloud.bigquery.TableId; +import com.google.cloud.bigquery.TableInfo; + +// Sample to create a range partitioned table +public class CreateRangePartitionedTable { + + public static void runCreateRangePartitionedTable() { + // TODO(developer): Replace these variables before running the sample. + String datasetName = "MY_DATASET_NAME"; + String tableName = "MY_TABLE_NAME"; + Schema schema = + Schema.of( + Field.of("integerField", StandardSQLTypeName.INT64), + Field.of("stringField", StandardSQLTypeName.STRING), + Field.of("booleanField", StandardSQLTypeName.BOOL), + Field.of("dateField", StandardSQLTypeName.DATE)); + createRangePartitionedTable(datasetName, tableName, schema); + } + + public static void createRangePartitionedTable( + String datasetName, String tableName, Schema schema) { + 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); + + // Note: The field must be a top- level, NULLABLE/REQUIRED field. + // The only supported type is INTEGER/INT64 + RangePartitioning partitioning = + RangePartitioning.newBuilder() + .setField("integerField") + .setRange( + RangePartitioning.Range.newBuilder() + .setStart(1L) + .setInterval(2L) + .setEnd(10L) + .build()) + .build(); + + StandardTableDefinition tableDefinition = + StandardTableDefinition.newBuilder() + .setSchema(schema) + .setRangePartitioning(partitioning) + .build(); + TableInfo tableInfo = TableInfo.newBuilder(tableId, tableDefinition).build(); + + bigquery.create(tableInfo); + System.out.println("Range partitioned table created successfully"); + } catch (BigQueryException e) { + System.out.println("Range partitioned table was not created. \n" + e.toString()); + } + } +} +// [END bigquery_create_table_range_partitioned] diff --git a/samples/snippets/src/test/java/com/example/bigquery/CreateRangePartitionedTableIT.java b/samples/snippets/src/test/java/com/example/bigquery/CreateRangePartitionedTableIT.java new file mode 100644 index 000000000..a07497849 --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/CreateRangePartitionedTableIT.java @@ -0,0 +1,83 @@ +/* + * 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.Field; +import com.google.cloud.bigquery.Schema; +import com.google.cloud.bigquery.StandardSQLTypeName; +import java.io.ByteArrayOutputStream; +import java.io.PrintStream; +import java.util.UUID; +import org.junit.After; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; + +public class CreateRangePartitionedTableIT { + + private String tableName; + private ByteArrayOutputStream bout; + private PrintStream out; + + private static final String BIGQUERY_DATASET_NAME = requireEnvVar("BIGQUERY_DATASET_NAME"); + + 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("BIGQUERY_DATASET_NAME"); + } + + @Before + public void setUp() { + tableName = "RANGE_PARTITIONED_TABLE_TEST" + UUID.randomUUID().toString().replace('-', '_'); + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + // Clean up + DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, tableName); + System.setOut(null); + } + + @Test + public void testCreateRangePartitionedTable() { + Schema schema = + Schema.of( + Field.of("integerField", StandardSQLTypeName.INT64), + Field.of("stringField", StandardSQLTypeName.STRING), + Field.of("booleanField", StandardSQLTypeName.BOOL), + Field.of("dateField", StandardSQLTypeName.DATE)); + + CreateRangePartitionedTable.createRangePartitionedTable( + BIGQUERY_DATASET_NAME, tableName, schema); + + assertThat(bout.toString()).contains("Range partitioned table created successfully"); + } +}