From df6479f2243193e692313790cbb1720d0279d47a Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Thu, 18 Jun 2020 23:20:10 +0530 Subject: [PATCH] docs(samples): add create and delete model (#462) * docs(samples): add create and delete model * docs(samples): fix flaky test * docs(samples): fix npe --- .../com/example/bigquery/CreateModel.java | 74 +++++++++++++++ .../com/example/bigquery/DeleteModel.java | 51 ++++++++++ .../com/example/bigquery/CreateModelIT.java | 87 +++++++++++++++++ .../com/example/bigquery/DeleteModelIT.java | 93 +++++++++++++++++++ 4 files changed, 305 insertions(+) create mode 100644 samples/snippets/src/main/java/com/example/bigquery/CreateModel.java create mode 100644 samples/snippets/src/main/java/com/example/bigquery/DeleteModel.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/CreateModelIT.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/DeleteModelIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquery/CreateModel.java b/samples/snippets/src/main/java/com/example/bigquery/CreateModel.java new file mode 100644 index 000000000..d7ebe2c28 --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/CreateModel.java @@ -0,0 +1,74 @@ +/* + * 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_model] +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryException; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.Job; +import com.google.cloud.bigquery.JobInfo; +import com.google.cloud.bigquery.QueryJobConfiguration; + +// Sample to create a model +public class CreateModel { + + public static void runCreateModel() { + // TODO(developer): Replace these variables before running the sample. + String datasetName = "MY_DATASET_NAME"; + String modelName = "MY_MODEL_NAME"; + String sql = + "CREATE MODEL `" + + datasetName + + "." + + modelName + + "`" + + "OPTIONS ( " + + "model_type='linear_reg', " + + "max_iteration=1, " + + "learn_rate=0.4, " + + "learn_rate_strategy='constant' " + + ") AS ( " + + " SELECT 'a' AS f1, 2.0 AS label " + + "UNION ALL " + + "SELECT 'b' AS f1, 3.8 AS label " + + ")"; + createModel(sql); + } + + public static void createModel(String sql) { + 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(); + + QueryJobConfiguration config = QueryJobConfiguration.newBuilder(sql).build(); + + // create a model using query and it will wait to complete job. + Job job = bigquery.create(JobInfo.of(config)); + job = job.waitFor(); + if (job.isDone()) { + System.out.println("Model created successfully"); + } else { + System.out.println("Model was not created"); + } + } catch (BigQueryException | InterruptedException e) { + System.out.println("Model was not created. \n" + e.toString()); + } + } +} +// [END bigquery_create_model] diff --git a/samples/snippets/src/main/java/com/example/bigquery/DeleteModel.java b/samples/snippets/src/main/java/com/example/bigquery/DeleteModel.java new file mode 100644 index 000000000..dbf3bb0a6 --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/DeleteModel.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_model] +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryException; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.ModelId; + +// Sample to delete a model +public class DeleteModel { + + public static void runDeleteModel() { + // TODO(developer): Replace these variables before running the sample. + String datasetName = "MY_DATASET_NAME"; + String modelName = "MY_MODEL_NAME"; + deleteModel(datasetName, modelName); + } + + public static void deleteModel(String datasetName, String modelName) { + 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(ModelId.of(datasetName, modelName)); + if (success) { + System.out.println("Model deleted successfully"); + } else { + System.out.println("Model was not found"); + } + } catch (BigQueryException e) { + System.out.println("Model was not deleted. \n" + e.toString()); + } + } +} +// [END bigquery_delete_model] diff --git a/samples/snippets/src/test/java/com/example/bigquery/CreateModelIT.java b/samples/snippets/src/test/java/com/example/bigquery/CreateModelIT.java new file mode 100644 index 000000000..b0bcb7ca6 --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/CreateModelIT.java @@ -0,0 +1,87 @@ +/* + * 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 CreateModelIT { + + private String modelName; + 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() { + modelName = "MY_MODEL_NAME_TEST_" + UUID.randomUUID().toString().replace('-', '_'); + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + // Clean up + DeleteModel.deleteModel(BIGQUERY_DATASET_NAME, modelName); + System.setOut(null); + } + + @Test + public void testCreateModel() { + String sql = + "CREATE MODEL `" + + BIGQUERY_DATASET_NAME + + "." + + modelName + + "`" + + "OPTIONS ( " + + "model_type='linear_reg', " + + "max_iteration=1, " + + "learn_rate=0.4, " + + "learn_rate_strategy='constant' " + + ") AS ( " + + " SELECT 'a' AS f1, 2.0 AS label " + + "UNION ALL " + + "SELECT 'b' AS f1, 3.8 AS label " + + ")"; + CreateModel.createModel(sql); + assertThat(bout.toString()).contains("Model created successfully"); + } +} diff --git a/samples/snippets/src/test/java/com/example/bigquery/DeleteModelIT.java b/samples/snippets/src/test/java/com/example/bigquery/DeleteModelIT.java new file mode 100644 index 000000000..1933a3a7a --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/DeleteModelIT.java @@ -0,0 +1,93 @@ +/* + * 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 DeleteModelIT { + + private String modelName; + 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 new model to be deleted + modelName = "MY_MODEL_NAME_TEST_" + UUID.randomUUID().toString().substring(0, 8); + String sql = + "CREATE MODEL `" + + BIGQUERY_DATASET_NAME + + "." + + modelName + + "`" + + "OPTIONS ( " + + "model_type='linear_reg', " + + "max_iteration=1, " + + "learn_rate=0.4, " + + "learn_rate_strategy='constant' " + + ") AS ( " + + " SELECT 'a' AS f1, 2.0 AS label " + + "UNION ALL " + + "SELECT 'b' AS f1, 3.8 AS label " + + ")"; + CreateModel.createModel(sql); + + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + System.setOut(null); + } + + @Test + public void testDeleteModel() { + // Delete the model that was just created + DeleteModel.deleteModel(BIGQUERY_DATASET_NAME, modelName); + assertThat(bout.toString()).contains("Model deleted successfully"); + } +}