docs(tutorials): add new tutorials directory and JsonWriterDefaultStream tutorial #1498
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 |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| on: | ||
| pull_request: | ||
| paths-ignore: | ||
| - 'tutorials/**' | ||
| name: auto-merge-readme | ||
| jobs: | ||
| approve: | ||
|
|
||
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 |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| on: | ||
| pull_request: | ||
| paths-ignore: | ||
| - 'tutorials/**' | ||
| name: auto-release | ||
| jobs: | ||
| approve: | ||
|
|
||
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 |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| on: | ||
| push: | ||
| paths-ignore: | ||
| - 'tutorials/**' | ||
| branches: | ||
| - main | ||
| pull_request: | ||
|
|
||
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 |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| on: | ||
| pull_request: | ||
| paths-ignore: | ||
| - 'tutorials/**' | ||
| name: samples | ||
| jobs: | ||
| checkstyle: | ||
|
|
||
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
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,126 @@ | ||
| /* | ||
| * Copyright 2022 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.bigquerystorage; | ||
|
|
||
| import com.google.api.core.ApiFuture; | ||
| import com.google.cloud.bigquery.BigQuery; | ||
| import com.google.cloud.bigquery.BigQueryOptions; | ||
| import com.google.cloud.bigquery.Field; | ||
| import com.google.cloud.bigquery.Schema; | ||
| import com.google.cloud.bigquery.StandardSQLTypeName; | ||
| import com.google.cloud.bigquery.StandardTableDefinition; | ||
| import com.google.cloud.bigquery.Table; | ||
| import com.google.cloud.bigquery.TableId; | ||
| import com.google.cloud.bigquery.TableInfo; | ||
| import com.google.cloud.bigquery.storage.v1.AppendRowsResponse; | ||
| import com.google.cloud.bigquery.storage.v1.JsonStreamWriter; | ||
| import com.google.cloud.bigquery.storage.v1.TableName; | ||
| import com.google.cloud.bigquery.storage.v1.TableSchema; | ||
| import com.google.protobuf.Descriptors.DescriptorValidationException; | ||
| import java.io.BufferedReader; | ||
| import java.io.FileReader; | ||
| import java.io.IOException; | ||
| import java.util.concurrent.ExecutionException; | ||
| import org.json.JSONArray; | ||
| import org.json.JSONObject; | ||
|
|
||
| public class JsonWriterDefaultStream { | ||
|
|
||
| public static void main(String[] args) throws Exception { | ||
| if (args.length < 4) { | ||
| System.out.println("Arguments: project, dataset, table, source_file"); | ||
| return; | ||
| } | ||
|
|
||
| String projectId = args[0]; | ||
| String datasetName = args[1]; | ||
| String tableName = args[2]; | ||
| String dataFile = args[3]; | ||
| createDestinationTable(projectId, datasetName, tableName); | ||
| writeToDefaultStream(projectId, datasetName, tableName, dataFile); | ||
| } | ||
|
|
||
| // createDestinationTable: Creates the destination table for streaming with the desired schema. | ||
| public static void createDestinationTable( | ||
| String projectId, String datasetName, String tableName) { | ||
| BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService(); | ||
| // Create a schema that matches the source data. | ||
| Schema schema = | ||
| Schema.of( | ||
| Field.of("commit", StandardSQLTypeName.STRING), | ||
| Field.newBuilder("parent", StandardSQLTypeName.STRING) | ||
| .setMode(Field.Mode.REPEATED) | ||
| .build(), | ||
| Field.of("author", StandardSQLTypeName.STRING), | ||
| Field.of("committer", StandardSQLTypeName.STRING), | ||
| Field.of("time_sec", StandardSQLTypeName.INT64), | ||
| Field.of("subject", StandardSQLTypeName.STRING), | ||
| Field.of("message", StandardSQLTypeName.STRING), | ||
| Field.of("repo_name", StandardSQLTypeName.STRING)); | ||
|
|
||
| // Create a table that uses this schema. | ||
| TableId tableId = TableId.of(projectId, datasetName, tableName); | ||
| Table table = bigquery.getTable(tableId); | ||
| if (table == null) { | ||
| TableInfo tableInfo = | ||
| TableInfo.newBuilder(tableId, StandardTableDefinition.of(schema)).build(); | ||
| bigquery.create(tableInfo); | ||
| } | ||
| } | ||
|
|
||
| // writeToDefaultStream: Writes records from the source file to the destination table. | ||
| public static void writeToDefaultStream( | ||
| String projectId, String datasetName, String tableName, String dataFile) | ||
| throws DescriptorValidationException, InterruptedException, IOException { | ||
|
|
||
| BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService(); | ||
|
|
||
| // Get the schema of the destination table and convert to the equivalent BigQueryStorage type. | ||
| Table table = bigquery.getTable(datasetName, tableName); | ||
| Schema schema = table.getDefinition().getSchema(); | ||
| TableSchema tableSchema = BqToBqStorageSchemaConverter.convertTableSchema(schema); | ||
|
|
||
| // Use the JSON stream writer to send records in JSON format. | ||
| TableName parentTable = TableName.of(projectId, datasetName, tableName); | ||
| try (JsonStreamWriter writer = | ||
| JsonStreamWriter.newBuilder(parentTable.toString(), tableSchema).build()) { | ||
| // Read JSON data from the source file and send it to the Write API. | ||
| BufferedReader reader = new BufferedReader(new FileReader(dataFile)); | ||
| String line = reader.readLine(); | ||
| while (line != null) { | ||
| // As a best practice, send batches of records, instead of single records at a time. | ||
| JSONArray jsonArr = new JSONArray(); | ||
| for (int i = 0; i < 100; i++) { | ||
| JSONObject record = new JSONObject(line); | ||
| jsonArr.put(record); | ||
| line = reader.readLine(); | ||
| if (line == null) { | ||
| break; | ||
| } | ||
| } // batch | ||
| ApiFuture<AppendRowsResponse> future = writer.append(jsonArr); | ||
| AppendRowsResponse response = future.get(); | ||
| } | ||
| System.out.println("Appended records successfully."); | ||
|
There was a problem hiding this comment. Maybe finalize the stream to report the row count? There was a problem hiding this comment. There was a problem hiding this comment. I'm not sure how to finalize the default stream. (We don't finalize the stream in the existing WriteToDefaultStream snippet.) |
||
| } catch (ExecutionException e) { | ||
| // If the wrapped exception is a StatusRuntimeException, check the state of the operation. | ||
| // If the state is INTERNAL, CANCELLED, or ABORTED, you can retry. For more information, see: | ||
| // https://grpc.github.io/grpc-java/javadoc/io/grpc/StatusRuntimeException.html | ||
| System.out.println("Failed to append records. \n" + e.toString()); | ||
| } | ||
| } | ||
| } | ||
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,84 @@ | ||
| <project> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>google-cloud-bigquerystorage</artifactId> | ||
|
|
||
| <parent> | ||
| <groupId>com.google.cloud.samples</groupId> | ||
| <artifactId>shared-configuration</artifactId> | ||
| <version>1.2.0</version> | ||
| </parent> | ||
|
|
||
| <properties> | ||
| <maven.compiler.target>1.8</maven.compiler.target> | ||
| <maven.compiler.source>1.8</maven.compiler.source> | ||
| <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
| </properties> | ||
|
|
||
| <dependencies> | ||
| <dependency> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>google-cloud-bigquerystorage</artifactId> | ||
| <version>2.8.2</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>google-cloud-bigquery</artifactId> | ||
| <version>2.6.0</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.apache.avro</groupId> | ||
| <artifactId>avro</artifactId> | ||
| <version>1.10.2</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.apache.arrow</groupId> | ||
| <artifactId>arrow-vector</artifactId> | ||
| <version>6.0.1</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.apache.arrow</groupId> | ||
| <artifactId>arrow-memory-netty</artifactId> | ||
| <version>6.0.1</version> | ||
| </dependency> | ||
| </dependencies> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.codehaus.mojo</groupId> | ||
| <artifactId>build-helper-maven-plugin</artifactId> | ||
| <version>3.0.0</version> | ||
| <executions> | ||
| <execution> | ||
| <phase>generate-sources</phase> | ||
| <goals> | ||
| <goal>add-source</goal> | ||
| </goals> | ||
| <configuration> | ||
| <sources> | ||
| <source>src/main/java</source> | ||
| <source>../snippets/src/main/java/com/example/bigquerystorage</source> | ||
| </sources> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>org.codehaus.mojo</groupId> | ||
| <artifactId>exec-maven-plugin</artifactId> | ||
| <version>3.0.0</version> | ||
| <executions> | ||
| <execution> | ||
| <goals> | ||
| <goal>exec</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| <configuration> | ||
| <executable>maven</executable> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </project> |
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.
Do we need to show how to input some more complicated types, such as DateTime, Repeated and Struct?
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.
I think this is a good idea - Veronica can make some improvements after this is merged in.
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.
We could but I'm not sure it adds much to the sample. Creating the table isn't main purpose of the sample, and in the main body I'm just reading in JSON records and passing them to the writer.
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.
Looking at the schema again, I could change
time_secto a DateTime type, that actually makes the tutorial a little simpler, because my example query on the table currently usesTIMESTAMP_SECONDSto convert the value.