Skip to content
Permalink
Browse files
docs(samples): add list dataset by label (#555)
  • Loading branch information
Praful Makani committed Jul 15, 2020
1 parent 48cdc92 commit a0d7beab025a2895f0efc1e9888594e386a0a1b3
@@ -0,0 +1,60 @@
/*
* 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_datasets_by_label]
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.Dataset;

// Sample to get list of datasets by label
public class ListDatasetsByLabel {

public static void runListDatasetsByLabel() {
// TODO(developer): Replace these variables before running the sample.
String projectId = "MY_PROJECT_ID";
String filter = "MY_LABEL_FILTER";
listDatasetsByLabel(projectId, filter);
}

public static void listDatasetsByLabel(String projectId, String filter) {
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<Dataset> datasets =
bigquery.listDatasets(
projectId,
BigQuery.DatasetListOption.pageSize(100),
BigQuery.DatasetListOption.labelFilter(filter)); // "labels.color:green"
if (datasets == null) {
System.out.println("Dataset does not contain any models");
return;
}
datasets
.iterateAll()
.forEach(
dataset -> System.out.printf("Success! Dataset ID: %s ", dataset.getDatasetId()));
} catch (BigQueryException e) {
System.out.println("Project does not contain any datasets \n" + e.toString());
}
}
}
// [END bigquery_list_datasets_by_label]
@@ -0,0 +1,80 @@
/*
* 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 ListDatasetsByLabelIT {

private String datasetName;
private ByteArrayOutputStream bout;
private PrintStream out;

private static final String PROJECT_ID = requireEnvVar("GOOGLE_CLOUD_PROJECT");

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("GOOGLE_CLOUD_PROJECT");
}

@Before
public void setUp() {
bout = new ByteArrayOutputStream();
out = new PrintStream(bout);
System.setOut(out);
// create a temporary dataset
datasetName = "MY_DATASET_TEST_" + UUID.randomUUID().toString().substring(0, 8);
CreateDataset.createDataset(datasetName);
// add a label on dataset
LabelDataset.labelDataset(datasetName);

bout = new ByteArrayOutputStream();
out = new PrintStream(bout);
System.setOut(out);
}

@After
public void tearDown() {
// delete a temporary dataset
DeleteDataset.deleteDataset(PROJECT_ID, datasetName);
System.setOut(null);
}

@Test
public void testListDatasetsByLabel() {
String filter = "labels.color:green";
ListDatasetsByLabel.listDatasetsByLabel(PROJECT_ID, filter);
assertThat(bout.toString()).contains("Success! Dataset ID");
}
}

0 comments on commit a0d7bea

Please sign in to comment.