Skip to content

feat(bigquery): add ArrowDeserializer helper utility - #13943

Open
jinseopkim0 wants to merge 13 commits into
mainfrom
feat-bigquery-arrow-deserializer
Open

feat(bigquery): add ArrowDeserializer helper utility#13943
jinseopkim0 wants to merge 13 commits into
mainfrom
feat-bigquery-arrow-deserializer

Conversation

@jinseopkim0

Copy link
Copy Markdown
Contributor

Stacked PR 2 of 3: Adds the ArrowDeserializer class which handles decoding serialized Arrow schemas and record batches into standard FieldValueList rows.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request introduces the ArrowDeserializer class to convert Apache Arrow schemas and record batches into BigQuery schemas and FieldValueList rows. Feedback on the implementation highlights several critical issues: a potential native memory leak if vector creation fails, a bug in repeated record deserialization where subfields are omitted, missing defensive checks for schema and size mismatches, and an inefficient timestamp conversion that should cast to TimeStampVector and handle different time units.

@jinseopkim0
jinseopkim0 force-pushed the feat-bigquery-arrow-deserializer branch from e149afc to 796b77f Compare August 7, 2026 18:52
@jinseopkim0

Copy link
Copy Markdown
Contributor Author

@gemini-code-assist review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request introduces comprehensive documentation (including developer, user, and storage API guides) and adds support for Apache Arrow serialization and deserialization in the BigQuery client and JDBC driver. It also introduces a centralized type registry and temporal utilities for optimized type coercion. The review feedback highlights several critical improvements: optimizing memory allocation and preventing resource leaks in ArrowDeserializer by passing the BufferAllocator and using proper try-finally blocks; avoiding precision loss in timestamp formatting by using integer division; ensuring that the new Arrow configuration options are actually transmitted to the BigQuery backend by serializing them in QueryJobConfiguration.toPb(); and adhering to timezone handling rules by using legacy Calendar manipulation and LocalTime.ofNanoOfDay for java.sql.Time conversions.

@jinseopkim0

Copy link
Copy Markdown
Contributor Author

@gemini-code-assist review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request introduces Apache Arrow serialization options and deserialization support to the BigQuery client library, alongside extensive documentation and optimized type registry utilities for the JDBC driver. The review feedback highlights critical issues where the new Arrow configuration fields in QueryJobConfiguration are not serialized or deserialized in toPb() and fromPb(), rendering them ineffective. Additionally, the reviewer recommends reusing a single BufferAllocator in ArrowDeserializer to avoid high allocation overhead, ensuring exception-safe LIFO cleanup of FieldVector instances to prevent memory leaks, and using a timezone-aware manual conversion when converting java.sql.Time to java.time.LocalTime to preserve millisecond precision.

@jinseopkim0
jinseopkim0 force-pushed the feat-bigquery-arrow-deserializer branch from 9056c4c to 9ddd9d2 Compare August 7, 2026 19:16
@jinseopkim0
jinseopkim0 force-pushed the feat-bigquery-arrow-deserializer branch from 9ddd9d2 to 712b972 Compare August 7, 2026 19:19
@jinseopkim0 jinseopkim0 added kokoro:force-run Add this label to force Kokoro to re-run the tests. kokoro:run Add this label to force Kokoro to re-run the tests. labels Aug 7, 2026
@jinseopkim0
jinseopkim0 force-pushed the feat-bigquery-arrow-deserializer branch 4 times, most recently from f139009 to dd8bc5a Compare August 10, 2026 15:25
@jinseopkim0 jinseopkim0 added kokoro:force-run Add this label to force Kokoro to re-run the tests. kokoro:run Add this label to force Kokoro to re-run the tests. and removed kokoro:force-run Add this label to force Kokoro to re-run the tests. kokoro:run Add this label to force Kokoro to re-run the tests. labels Aug 10, 2026
@jinseopkim0
jinseopkim0 marked this pull request as ready for review August 11, 2026 19:19
@jinseopkim0
jinseopkim0 requested review from a team as code owners August 11, 2026 19:19
@jinseopkim0
jinseopkim0 requested a review from lqiu96 August 11, 2026 19:19
Base automatically changed from feat-bigquery-arrow-config to main August 12, 2026 14:36
@jinseopkim0
jinseopkim0 force-pushed the feat-bigquery-arrow-deserializer branch from dd8bc5a to a2486de Compare August 12, 2026 14:42
@yoshi-kokoro yoshi-kokoro removed kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Aug 12, 2026
List<FieldVector> vectors = ArrowPojoUtils.createVectors(arrowSchema, allocator);
try {
return new VectorSchemaRoot(vectors);
} catch (Throwable t) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IIUC, this may have some funky behavior with native memory. Is that why we need to catch Throwable here?

* @throws IOException if deserialization of the Arrow schema fails
*/
static Object deserializeSchema(byte[] schemaBytes) throws IOException {
return MessageSerializer.deserializeSchema(

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do we need to close ReadChannel afterwards? Or do we expect this to be the caller's responsibility?

Comment on lines +148 to +157
org.apache.arrow.vector.types.pojo.Schema arrowSchema =
arrowSchemaPojo instanceof org.apache.arrow.vector.types.pojo.Schema
? (org.apache.arrow.vector.types.pojo.Schema) arrowSchemaPojo
: (arrowSchemaJson != null
? org.apache.arrow.vector.types.pojo.Schema.fromJSON(arrowSchemaJson)
: null);

if (arrowSchema == null) {
return false;
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: Would it be possible to create a helper to get the arrowSchema so this method doesn't have as many params?

Comment on lines +169 to +170
com.google.cloud.bigquery.storage.v1.ArrowRecordBatch batch =
response.getArrowRecordBatch();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

qq, I'm not entirely sure how this works. Is the size of ArrowRecordBatch and rowBatch always equal? What happens if there is a difference in say pageSize and ArrowRecordBatch?

}
builder =
com.google.cloud.bigquery.Field.newBuilder(
name, LegacySQLTypeName.RECORD, FieldList.of(subFields));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Any reason in particular for LegacySQLTypeName instead of StandardSQLTypeName?

}
builder.setMode(Mode.REPEATED);
} else {
if (!arrowField.getChildren().isEmpty()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

qq, what are the other types where the are child nodes if it's not a list?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants