Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(samples): add create view ddl #558

Merged
merged 2 commits into from Jul 17, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -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;

// [START bigquery_ddl_create_view]
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 view using DDL
public class DDLCreateView {

public static void runDDLCreateView() {
// TODO(developer): Replace these variables before running the sample.
String projectId = "MY_PROJECT_ID";
String datasetId = "MY_DATASET_ID";
String tableId = "MY_VIEW_ID";
String sql =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should name this string ddl? since this is a ddl create view sample?

"CREATE VIEW "
+ "`"
+ projectId
+ "."
+ datasetId
+ "."
+ tableId
+ "`"
+ " OPTIONS("
+ " expiration_timestamp=TIMESTAMP_ADD("
+ " CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),"
+ " friendly_name=\"new_view\","
+ " description=\"a view that expires in 2 days\","
+ " labels=[(\"org_unit\", \"development\")]"
+ " )"
+ " AS SELECT name, state, year, number"
+ " FROM `bigquery-public-data.usa_names.usa_1910_current`"
+ " WHERE state LIKE 'W%'`";
ddlCreateView(sql);
}

public static void ddlCreateView(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 view 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("View created successfully");
} else {
System.out.println("View was not created");
}
} catch (BigQueryException | InterruptedException e) {
System.out.println("View was not created. \n" + e.toString());
}
}
}
// [END bigquery_ddl_create_view]
@@ -0,0 +1,92 @@
/*
* 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 DDLCreateViewIT {

private String viewName;
private ByteArrayOutputStream bout;
private PrintStream out;

private static final String PROJECT_ID = requireEnvVar("GOOGLE_CLOUD_PROJECT");
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("GOOGLE_CLOUD_PROJECT");
requireEnvVar("BIGQUERY_DATASET_NAME");
}

@Before
public void setUp() {
viewName = "MY_VIEW_NAME_TEST_" + UUID.randomUUID().toString().substring(0, 8);
bout = new ByteArrayOutputStream();
out = new PrintStream(bout);
System.setOut(out);
}

@After
public void tearDown() {
// Clean up
DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, viewName);
System.setOut(null);
}

@Test
public void testDDLCreateView() {
String sql =
"CREATE VIEW "
+ "`"
+ PROJECT_ID
+ "."
+ BIGQUERY_DATASET_NAME
+ "."
+ viewName
+ "`"
+ " OPTIONS("
+ " expiration_timestamp=TIMESTAMP_ADD("
+ " CURRENT_TIMESTAMP(), INTERVAL 48 HOUR),"
+ " friendly_name=\"new_view\","
+ " description=\"a view that expires in 2 days\","
+ " labels=[(\"org_unit\", \"development\")]"
+ " )"
+ " AS SELECT name, state, year, number"
+ " FROM `bigquery-public-data.usa_names.usa_1910_current`"
+ " WHERE state LIKE 'W%'";
DDLCreateView.ddlCreateView(sql);
assertThat(bout.toString()).contains("View created successfully");
}
}