From e63f06eeaa18386a8489b41cdad8d2c8e63fc146 Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Fri, 19 Jun 2020 21:22:07 +0530 Subject: [PATCH] docs(samples): add create job (#470) Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [X] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/java-bigquery/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [X] Ensure the tests and linter pass - [X] Code coverage does not decrease (if any source code was changed) - [X] Appropriate docs were updated (if necessary) --- .../java/com/example/bigquery/CreateJob.java | 71 +++++++++++++++++++ .../com/example/bigquery/CreateJobIT.java | 51 +++++++++++++ 2 files changed, 122 insertions(+) create mode 100644 samples/snippets/src/main/java/com/example/bigquery/CreateJob.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/CreateJobIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquery/CreateJob.java b/samples/snippets/src/main/java/com/example/bigquery/CreateJob.java new file mode 100644 index 000000000..aadf8c88f --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/CreateJob.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; + +// [START bigquery_create_job] +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.JobId; +import com.google.cloud.bigquery.JobInfo; +import com.google.cloud.bigquery.QueryJobConfiguration; +import com.google.common.collect.ImmutableMap; +import java.util.UUID; + +// Sample to create a job +public class CreateJob { + + public static void runCreateJob() { + // TODO(developer): Replace these variables before running the sample. + String query = "SELECT country_name from `bigquery-public-data.utility_us.country_code_iso`"; + createJob(query); + } + + public static void createJob(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(); + + // Specify a job configuration to set optional job resource properties. + QueryJobConfiguration queryConfig = + QueryJobConfiguration.newBuilder(query) + .setLabels(ImmutableMap.of("example-label", "example-value")) + .build(); + + // The location and job name are optional, + // if both are not specified then client will auto-create. + String jobName = "jobId_" + UUID.randomUUID().toString(); + JobId jobId = JobId.newBuilder().setLocation("us").setJob(jobName).build(); + + // Create a job with job ID + bigquery.create(JobInfo.of(jobId, queryConfig)); + + // Get a job that was just created + Job job = bigquery.getJob(jobId); + if (job.getJobId().getJob().equals(jobId.getJob())) { + System.out.println("Job created successfully"); + } else { + System.out.println("Job was not created"); + } + } catch (BigQueryException e) { + System.out.println("Job was not created. \n" + e.toString()); + } + } +} +// [END bigquery_create_job] diff --git a/samples/snippets/src/test/java/com/example/bigquery/CreateJobIT.java b/samples/snippets/src/test/java/com/example/bigquery/CreateJobIT.java new file mode 100644 index 000000000..abd7017a4 --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/CreateJobIT.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; + +import static com.google.common.truth.Truth.assertThat; + +import java.io.ByteArrayOutputStream; +import java.io.PrintStream; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +public class CreateJobIT { + + private ByteArrayOutputStream bout; + private PrintStream out; + + @Before + public void setUp() { + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + System.setOut(null); + } + + @Test + public void testCreateJob() { + String query = "SELECT country_name from `bigquery-public-data.utility_us.country_code_iso`"; + + CreateJob.createJob(query); + assertThat(bout.toString()).contains("Job created successfully"); + } +}