From 99c324c60a7825da7259a3173ee6b776d0c76825 Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Mon, 29 Jun 2020 20:56:37 +0530 Subject: [PATCH] docs(samples): add create and delete routine (#493) --- .../com/example/bigquery/CreateRoutine.java | 68 +++++++++++++++++ .../com/example/bigquery/DeleteRoutine.java | 51 +++++++++++++ .../com/example/bigquery/CreateRoutineIT.java | 71 +++++++++++++++++ .../com/example/bigquery/DeleteRoutineIT.java | 76 +++++++++++++++++++ 4 files changed, 266 insertions(+) create mode 100644 samples/snippets/src/main/java/com/example/bigquery/CreateRoutine.java create mode 100644 samples/snippets/src/main/java/com/example/bigquery/DeleteRoutine.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/CreateRoutineIT.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/DeleteRoutineIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquery/CreateRoutine.java b/samples/snippets/src/main/java/com/example/bigquery/CreateRoutine.java new file mode 100644 index 000000000..de01d2ba6 --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/CreateRoutine.java @@ -0,0 +1,68 @@ +/* + * 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_routine] +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryException; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.RoutineArgument; +import com.google.cloud.bigquery.RoutineId; +import com.google.cloud.bigquery.RoutineInfo; +import com.google.cloud.bigquery.StandardSQLDataType; +import com.google.cloud.bigquery.StandardSQLTypeName; +import com.google.common.collect.ImmutableList; + +// Sample to create a routine +public class CreateRoutine { + + public static void runCreateRoutine() { + // TODO(developer): Replace these variables before running the sample. + String datasetName = "MY_DATASET_NAME"; + String routineName = "MY_ROUTINE_NAME"; + createRoutine(datasetName, routineName); + } + + public static void createRoutine(String datasetName, String routineName) { + 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(); + + RoutineId routineId = RoutineId.of(datasetName, routineName); + + RoutineInfo routineInfo = + RoutineInfo.newBuilder(routineId) + .setRoutineType("SCALAR_FUNCTION") + .setLanguage("SQL") + .setBody("x * 3") + .setArguments( + ImmutableList.of( + RoutineArgument.newBuilder() + .setName("x") + .setDataType( + StandardSQLDataType.newBuilder(StandardSQLTypeName.INT64).build()) + .build())) + .build(); + bigquery.create(routineInfo); + System.out.println("Routine created successfully"); + } catch (BigQueryException e) { + System.out.println("Routine was not created. \n" + e.toString()); + } + } +} +// [END bigquery_create_routine] diff --git a/samples/snippets/src/main/java/com/example/bigquery/DeleteRoutine.java b/samples/snippets/src/main/java/com/example/bigquery/DeleteRoutine.java new file mode 100644 index 000000000..6d26c0ee2 --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/DeleteRoutine.java @@ -0,0 +1,51 @@ +/* + * 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_delete_routine] +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryException; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.RoutineId; + +// Sample to delete a routine +public class DeleteRoutine { + + public static void runDeleteRoutine() { + // TODO(developer): Replace these variables before running the sample. + String datasetName = "MY_DATASET_NAME"; + String routineName = "MY_ROUTINE_NAME"; + deleteRoutine(datasetName, routineName); + } + + public static void deleteRoutine(String datasetName, String routineName) { + 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(); + boolean success = bigquery.delete(RoutineId.of(datasetName, routineName)); + if (success) { + System.out.println("Routine deleted successfully"); + } else { + System.out.println("Routine was not found"); + } + } catch (BigQueryException e) { + System.out.println("Routine was not deleted. \n" + e.toString()); + } + } +} +// [END bigquery_delete_routine] diff --git a/samples/snippets/src/test/java/com/example/bigquery/CreateRoutineIT.java b/samples/snippets/src/test/java/com/example/bigquery/CreateRoutineIT.java new file mode 100644 index 000000000..30b4d68f4 --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/CreateRoutineIT.java @@ -0,0 +1,71 @@ +/* + * 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 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 CreateRoutineIT { + + private String routineName; + 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() { + routineName = "MY_ROUTINE_NAME_TEST_" + UUID.randomUUID().toString().substring(0, 8); + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + // Clean up + DeleteRoutine.deleteRoutine(BIGQUERY_DATASET_NAME, routineName); + System.setOut(null); + } + + @Test + public void testCreateRoutine() { + CreateRoutine.createRoutine(BIGQUERY_DATASET_NAME, routineName); + assertThat(bout.toString()).contains("Routine created successfully"); + } +} diff --git a/samples/snippets/src/test/java/com/example/bigquery/DeleteRoutineIT.java b/samples/snippets/src/test/java/com/example/bigquery/DeleteRoutineIT.java new file mode 100644 index 000000000..0c26cc00b --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/DeleteRoutineIT.java @@ -0,0 +1,76 @@ +/* + * 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 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 DeleteRoutineIT { + + private String routineName; + 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() { + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + + // create a temporary routine + routineName = "MY_ROUTINE_NAME_TEST_" + UUID.randomUUID().toString().substring(0, 8); + CreateRoutine.createRoutine(BIGQUERY_DATASET_NAME, routineName); + + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + System.setOut(null); + } + + @Test + public void testDeleteRoutine() { + DeleteRoutine.deleteRoutine(BIGQUERY_DATASET_NAME, routineName); + assertThat(bout.toString()).contains("Routine deleted successfully"); + } +}