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 load CSV from GCS sample #426
Merged
gcf-merge-on-green
merged 2 commits into
googleapis:master
from
stephaniewang526:load-csv-gcs
Jun 8, 2020
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
68 changes: 68 additions & 0 deletions
68
samples/snippets/src/main/java/com/example/bigquery/LoadCsvFromGcs.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,68 @@ | ||
/* | ||
* 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_load_table_gcs_csv] | ||
import com.google.cloud.bigquery.BigQuery; | ||
import com.google.cloud.bigquery.BigQueryException; | ||
import com.google.cloud.bigquery.BigQueryOptions; | ||
import com.google.cloud.bigquery.FormatOptions; | ||
import com.google.cloud.bigquery.Job; | ||
import com.google.cloud.bigquery.Table; | ||
|
||
// Sample to load CSV data from Cloud Storage into a new BigQuery table | ||
public class LoadCsvFromGcs { | ||
|
||
public static void runLoadCsvFromGcs() throws Exception { | ||
// TODO(developer): Replace these variables before running the sample. | ||
String datasetName = "MY_DATASET_NAME"; | ||
String tableName = "MY_TABLE_NAME"; | ||
String sourceUri = "gs://cloud-samples-data/bigquery/us-states/us-states.csv"; | ||
loadCsvFromGcs(datasetName, tableName, sourceUri); | ||
} | ||
|
||
public static void loadCsvFromGcs(String datasetName, String tableName, String sourceUri) | ||
throws Exception { | ||
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); | ||
Job loadJob = table.load(FormatOptions.csv(), sourceUri); | ||
|
||
// Load data from a GCS parquet file into the table | ||
// Blocks until this load table job completes its execution, either failing or succeeding. | ||
Job completedJob = loadJob.waitFor(); | ||
|
||
// Check for errors | ||
if (completedJob == null) { | ||
throw new Exception("Job not executed since it no longer exists."); | ||
} else if (completedJob.getStatus().getError() != null) { | ||
// You can also look at queryJob.getStatus().getExecutionErrors() for all | ||
// errors, not just the latest one. | ||
throw new Exception( | ||
"BigQuery was unable to load into the table due to an error: \n" | ||
+ loadJob.getStatus().getError()); | ||
} | ||
System.out.println("CSV from GCS successfully added during load append job"); | ||
} catch (BigQueryException | InterruptedException e) { | ||
System.out.println("Column not added during load append \n" + e.toString()); | ||
} | ||
} | ||
} | ||
// [END bigquery_load_table_gcs_csv] |
88 changes: 88 additions & 0 deletions
88
samples/snippets/src/test/java/com/example/bigquery/LoadCsvFromGcsIT.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,88 @@ | ||
/* | ||
* 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 com.google.cloud.bigquery.Field; | ||
import com.google.cloud.bigquery.LegacySQLTypeName; | ||
import com.google.cloud.bigquery.Schema; | ||
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 LoadCsvFromGcsIT { | ||
|
||
private String tableName; | ||
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 test table | ||
tableName = "loadCsvFromGcs_TEST_" + UUID.randomUUID().toString().replace('-', '_'); | ||
|
||
Schema schema = | ||
Schema.of( | ||
Field.of("name", LegacySQLTypeName.STRING), | ||
Field.of("post_abbr", LegacySQLTypeName.STRING)); | ||
|
||
CreateTable.createTable(BIGQUERY_DATASET_NAME, tableName, schema); | ||
|
||
bout = new ByteArrayOutputStream(); | ||
out = new PrintStream(bout); | ||
System.setOut(out); | ||
} | ||
|
||
@After | ||
public void tearDown() { | ||
// Clean up | ||
DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, tableName); | ||
System.setOut(null); | ||
} | ||
|
||
@Test | ||
public void loadCsvFromGcs() throws Exception { | ||
String sourceUri = "gs://cloud-samples-data/bigquery/us-states/us-states.csv"; | ||
LoadCsvFromGcs.loadCsvFromGcs(BIGQUERY_DATASET_NAME, tableName, sourceUri); | ||
assertThat(bout.toString()).contains("CSV from GCS successfully added during load append job"); | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Can you add the
//TODO(developer):
lineThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done