Skip to content
Permalink
Browse files
docs(samples): Added UpdateTableDescription example. (#360)
  • Loading branch information
ejdarrow committed May 18, 2020
1 parent f327bbd commit 96d2c87bf087f980106f57ffaac0933274c84b96
@@ -0,0 +1,50 @@
/*
* 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_update_table_description]
import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQueryException;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Table;

public class UpdateTableDescription {

public static void runUpdateTableDescription() {
// TODO(developer): Replace these variables before running the sample.
String datasetName = "MY_DATASET_NAME";
String tableName = "MY_TABLE_NAME";
String newDescription = "this is the new table description";
updateTableDescription(datasetName, tableName, newDescription);
}

public static void updateTableDescription(String datasetName, String tableName,
String newDescription) {
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();

Table table = bigquery.getTable(datasetName, tableName);
bigquery.update(table.toBuilder().setDescription(newDescription).build());
System.out.println("Table description updated successfully to " + newDescription);
} catch (BigQueryException e) {
System.out.println("Table description was not updated \n" + e.toString());
}
}
}
// [END bigquery_update_table_description]
@@ -0,0 +1,77 @@
/*
* 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 UpdateTableDescriptionIT {
private ByteArrayOutputStream bout;
private PrintStream out;

private static final String BIGQUERY_DATASET_NAME = System.getenv("BIGQUERY_DATASET_NAME");


private static void requireEnvVar(String varName) {
assertNotNull(
"Environment variable " + varName + " is required to perform these tests.",
System.getenv(varName));
}

@BeforeClass
public static void checkRequirements() {
requireEnvVar("BIGQUERY_DATASET_NAME");
}

@Before
public void setUp() throws Exception {
bout = new ByteArrayOutputStream();
out = new PrintStream(bout);
System.setOut(out);
}

@After
public void tearDown() {
System.setOut(null);
}

@Test
public void updateTableDescription() {
// Create a table in order to modify its description
String tableName = "MY_TABLE_NAME_" + UUID.randomUUID().toString().replace("-", "_");
CreateTable.createTable(BIGQUERY_DATASET_NAME, tableName, null);
String newDescription = "new description!";

// Modify table's description
UpdateTableDescription.updateTableDescription(BIGQUERY_DATASET_NAME, tableName, newDescription);

assertThat(bout.toString())
.contains("Table description updated successfully to " + newDescription);

// Clean up
DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, tableName);

}
}

0 comments on commit 96d2c87

Please sign in to comment.