-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(samples): add list routines (#546)
- Loading branch information
Praful Makani
authored
Jul 14, 2020
1 parent
f7f6e73
commit 2cd81d4
Showing
2 changed files
with
133 additions
and
0 deletions.
There are no files selected for viewing
55 changes: 55 additions & 0 deletions
55
samples/snippets/src/main/java/com/example/bigquery/ListRoutines.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/* | ||
* 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_list_routines] | ||
import com.google.api.gax.paging.Page; | ||
import com.google.cloud.bigquery.BigQuery; | ||
import com.google.cloud.bigquery.BigQueryException; | ||
import com.google.cloud.bigquery.BigQueryOptions; | ||
import com.google.cloud.bigquery.Routine; | ||
|
||
// Sample to get list of routines | ||
public class ListRoutines { | ||
|
||
public static void runListRoutines() { | ||
// TODO(developer): Replace these variables before running the sample. | ||
String datasetName = "MY_DATASET_NAME"; | ||
listRoutines(datasetName); | ||
} | ||
|
||
public static void listRoutines(String datasetName) { | ||
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(); | ||
|
||
Page<Routine> routines = | ||
bigquery.listRoutines(datasetName, BigQuery.RoutineListOption.pageSize(100)); | ||
if (routines == null) { | ||
System.out.println("Dataset does not contain any routines."); | ||
return; | ||
} | ||
routines | ||
.iterateAll() | ||
.forEach(routine -> System.out.printf("Success! Routine ID: %s", routine.getRoutineId())); | ||
} catch (BigQueryException e) { | ||
System.out.println("Routines not listed in dataset due to error: \n" + e.toString()); | ||
} | ||
} | ||
} | ||
// [END bigquery_list_routines] |
78 changes: 78 additions & 0 deletions
78
samples/snippets/src/test/java/com/example/bigquery/ListRoutinesIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
/* | ||
* 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 ListRoutinesIT { | ||
|
||
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 new routine to be deleted | ||
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() { | ||
// Clean up | ||
DeleteRoutine.deleteRoutine(BIGQUERY_DATASET_NAME, routineName); | ||
System.setOut(null); | ||
} | ||
|
||
@Test | ||
public void testListRoutines() { | ||
ListRoutines.listRoutines(BIGQUERY_DATASET_NAME); | ||
assertThat(bout.toString()).contains("Success! Routine ID"); | ||
} | ||
} |