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 relax column load append #657
Merged
stephaniewang526
merged 2 commits into
googleapis:master
from
pmakani:relax_column_load_append
Aug 10, 2020
Merged
Changes from 1 commit
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
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 @@ | ||
2000,140.0,TRUE | ||
112 changes: 112 additions & 0 deletions
112
samples/snippets/src/main/java/com/example/bigquery/RelaxColumnLoadAppend.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,112 @@ | ||
/* | ||
* 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_relax_column_load_append] | ||
import com.google.cloud.bigquery.BigQuery; | ||
import com.google.cloud.bigquery.BigQueryException; | ||
import com.google.cloud.bigquery.BigQueryOptions; | ||
import com.google.cloud.bigquery.Field; | ||
import com.google.cloud.bigquery.FormatOptions; | ||
import com.google.cloud.bigquery.Job; | ||
import com.google.cloud.bigquery.JobId; | ||
import com.google.cloud.bigquery.JobInfo; | ||
import com.google.cloud.bigquery.Schema; | ||
import com.google.cloud.bigquery.StandardSQLTypeName; | ||
import com.google.cloud.bigquery.Table; | ||
import com.google.cloud.bigquery.TableDataWriteChannel; | ||
import com.google.cloud.bigquery.TableId; | ||
import com.google.cloud.bigquery.WriteChannelConfiguration; | ||
import com.google.common.collect.ImmutableList; | ||
import java.io.IOException; | ||
import java.io.OutputStream; | ||
import java.nio.channels.Channels; | ||
import java.nio.file.FileSystems; | ||
import java.nio.file.Files; | ||
import java.nio.file.Path; | ||
import java.util.UUID; | ||
|
||
// Sample to append relax column in a table. | ||
public class RelaxColumnLoadAppend { | ||
|
||
public static void runRelaxColumnLoadAppend() { | ||
// TODO(developer): Replace these variables before running the sample. | ||
String datasetName = "MY_DATASET_NAME"; | ||
String tableName = "MY_TABLE_NAME"; | ||
Path csvPath = FileSystems.getDefault().getPath("/path/to/file.csv"); | ||
relaxColumnLoadAppend(datasetName, tableName, csvPath); | ||
} | ||
|
||
public static void relaxColumnLoadAppend(String datasetName, String tableName, Path csvPath) { | ||
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(); | ||
|
||
// Retrieve destination table reference | ||
Table table = bigquery.getTable(TableId.of(datasetName, tableName)); | ||
|
||
// column as a 'REQUIRED' field. | ||
Field age = | ||
Field.newBuilder("Age", StandardSQLTypeName.INT64).setMode(Field.Mode.REQUIRED).build(); | ||
Field weight = | ||
Field.newBuilder("Weight", StandardSQLTypeName.FLOAT64) | ||
.setMode(Field.Mode.REQUIRED) | ||
.build(); | ||
Field isMagic = | ||
Field.newBuilder("IsMagic", StandardSQLTypeName.BOOL) | ||
.setMode(Field.Mode.REQUIRED) | ||
.build(); | ||
Schema schema = Schema.of(age, weight, isMagic); | ||
|
||
// Set job options | ||
WriteChannelConfiguration writeChannelConfiguration = | ||
WriteChannelConfiguration.newBuilder(table.getTableId()) | ||
.setSchema(schema) | ||
.setFormatOptions(FormatOptions.csv()) | ||
.setSchemaUpdateOptions( | ||
ImmutableList.of(JobInfo.SchemaUpdateOption.ALLOW_FIELD_RELAXATION)) | ||
.setWriteDisposition(JobInfo.WriteDisposition.WRITE_APPEND) | ||
.build(); | ||
|
||
// The location and JobName must be specified; other fields can be auto-detected. | ||
String jobName = "jobId_" + UUID.randomUUID().toString(); | ||
JobId jobId = JobId.newBuilder().setLocation("us").setJob(jobName).build(); | ||
|
||
// Imports a local file into a table. | ||
try (TableDataWriteChannel writer = bigquery.writer(jobId, writeChannelConfiguration); | ||
OutputStream stream = Channels.newOutputStream(writer)) { | ||
Files.copy(csvPath, stream); | ||
} | ||
|
||
// Get the Job created by the TableDataWriteChannel and wait for it to complete. | ||
Job job = bigquery.getJob(jobId); | ||
job = job.waitFor(); | ||
// Check the job's status for errors | ||
if (job.isDone() && job.getStatus().getError() == null) { | ||
System.out.println("Relax column append successfully loaded in a table"); | ||
} else { | ||
System.out.println( | ||
"BigQuery was unable to load into the table due to an error:" | ||
+ job.getStatus().getError()); | ||
} | ||
} catch (BigQueryException | InterruptedException | IOException e) { | ||
System.out.println("Column not added during load append \n" + e.toString()); | ||
} | ||
} | ||
} | ||
// [END bigquery_relax_column_load_append] |
95 changes: 95 additions & 0 deletions
95
samples/snippets/src/test/java/com/example/bigquery/RelaxColumnLoadAppendIT.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,95 @@ | ||
/* | ||
* 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.Schema; | ||
import com.google.cloud.bigquery.StandardSQLTypeName; | ||
import java.io.ByteArrayOutputStream; | ||
import java.io.PrintStream; | ||
import java.nio.file.FileSystems; | ||
import java.nio.file.Path; | ||
import java.util.UUID; | ||
import org.junit.After; | ||
import org.junit.Before; | ||
import org.junit.BeforeClass; | ||
import org.junit.Test; | ||
|
||
public class RelaxColumnLoadAppendIT { | ||
|
||
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 = "RELAX_COLUMN_LOAD_APPEND_TEST_" + UUID.randomUUID().toString().substring(0, 8); | ||
Field name = | ||
Field.newBuilder("Name", StandardSQLTypeName.STRING).setMode(Field.Mode.REQUIRED).build(); | ||
Field age = | ||
Field.newBuilder("Age", StandardSQLTypeName.INT64).setMode(Field.Mode.REQUIRED).build(); | ||
Field weight = | ||
Field.newBuilder("Weight", StandardSQLTypeName.FLOAT64) | ||
.setMode(Field.Mode.REQUIRED) | ||
.build(); | ||
Field isMagic = | ||
Field.newBuilder("IsMagic", StandardSQLTypeName.BOOL).setMode(Field.Mode.REQUIRED).build(); | ||
CreateTable.createTable( | ||
BIGQUERY_DATASET_NAME, tableName, Schema.of(name, age, weight, isMagic)); | ||
|
||
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 testRelaxColumnLoadAppend() { | ||
Path csvPath = FileSystems.getDefault().getPath("src/test/resources", "partialdata.csv"); | ||
RelaxColumnLoadAppend.relaxColumnLoadAppend(BIGQUERY_DATASET_NAME, tableName, csvPath); | ||
assertThat(bout.toString()).contains("Relax column append successfully loaded in a table"); | ||
} | ||
} |
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 @@ | ||
2000,140.0,TRUE |
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.
Can we use existing csv?
String sourceUri = "gs://cloud-samples-data/bigquery/us-states/us-states.csv";