-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(bigquery): add QueryResultsFormat and ArrowSerializationOptions configurations #13942
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
Open
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
8caa072
feat(bigquery): add QueryResultsFormat and ArrowSerializationOptions …
jinseopkim0 b441a9d
docs(bigquery): add prerequisite and behavior Javadoc for QueryResult…
jinseopkim0 13a7e67
refactor(bigquery): replace fully qualified MoreObjects path with sim…
jinseopkim0 afc9951
refactor(bigquery): eliminate FQCN in ArrowSerializationOptions via c…
jinseopkim0 8f551c7
refactor(bigquery): return model ArrowSerializationOptions in toPb
jinseopkim0 30f6835
refactor(bigquery): eliminate FQCN in ArrowSerializationOptions and A…
jinseopkim0 e8e9de1
docs(bigquery): add @BetaApi annotations and [Beta] Javadoc callouts
jinseopkim0 0f8156a
feat(bigquery): add JSpecify @NullMarked and @Nullable annotations to…
jinseopkim0 bfc1461
feat(bigquery): enforce non-null parameters in ArrowSerializationOpti…
jinseopkim0 1785222
feat(bigquery): wrap Arrow options in enums and enforce non-null para…
jinseopkim0 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
192 changes: 192 additions & 0 deletions
192
...gle-cloud-bigquery/src/main/java/com/google/cloud/bigquery/ArrowSerializationOptions.java
This file contains hidden or 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,192 @@ | ||
| /* | ||
| * Copyright 2026 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.google.cloud.bigquery; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkNotNull; | ||
|
|
||
| import com.google.api.core.BetaApi; | ||
| import com.google.common.base.MoreObjects; | ||
| import java.io.Serializable; | ||
| import java.util.Objects; | ||
| import org.jspecify.annotations.NullMarked; | ||
| import org.jspecify.annotations.Nullable; | ||
|
|
||
| /** <b>[Beta]</b> Options specific to the Apache Arrow output format. */ | ||
| @BetaApi | ||
| @NullMarked | ||
| public final class ArrowSerializationOptions implements Serializable { | ||
|
|
||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| /** <b>[Beta]</b> Buffer compression codec for Apache Arrow record batches. */ | ||
| @BetaApi | ||
| public enum CompressionCodec { | ||
| UNCOMPRESSED("UNCOMPRESSED"), | ||
| LZ4_FRAME("LZ4_FRAME"), | ||
| ZSTD("ZSTD"); | ||
|
|
||
| private final String value; | ||
|
|
||
| CompressionCodec(String value) { | ||
| this.value = value; | ||
| } | ||
|
|
||
| public String getValue() { | ||
| return value; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return value; | ||
| } | ||
| } | ||
|
|
||
| /** <b>[Beta]</b> Timestamp precision for Apache Arrow timestamp types. */ | ||
| @BetaApi | ||
| public enum TimestampPrecision { | ||
| PRECISION_MILLIS("PRECISION_MILLIS"), | ||
| PRECISION_MICROS("PRECISION_MICROS"), | ||
| PRECISION_NANOS("PRECISION_NANOS"), | ||
| PRECISION_PICOS("PRECISION_PICOS"); | ||
|
|
||
| private final String value; | ||
|
|
||
| TimestampPrecision(String value) { | ||
| this.value = value; | ||
| } | ||
|
|
||
| public String getValue() { | ||
| return value; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return value; | ||
| } | ||
| } | ||
|
|
||
| private final CompressionCodec bufferCompression; | ||
| private final TimestampPrecision picosTimestampPrecision; | ||
|
|
||
| private ArrowSerializationOptions(Builder builder) { | ||
| this.bufferCompression = builder.bufferCompression; | ||
| this.picosTimestampPrecision = builder.picosTimestampPrecision; | ||
| } | ||
|
|
||
| /** | ||
| * <b>[Beta]</b> Returns the buffer compression algorithm (e.g., LZ4_FRAME, ZSTD, UNCOMPRESSED). | ||
| * Defaults to {@link CompressionCodec#UNCOMPRESSED}. | ||
| */ | ||
| @BetaApi | ||
| public CompressionCodec getBufferCompression() { | ||
| return bufferCompression; | ||
| } | ||
|
|
||
| /** | ||
| * <b>[Beta]</b> Returns the timestamp precision for Arrow timestamp types. Defaults to {@link | ||
| * TimestampPrecision#PRECISION_MICROS}. | ||
| * | ||
| * <p>Note: Only applies when {@link QueryResultsFormat#ARROW} is enabled. For Arrow result | ||
| * streams, this precision setting governs binary Arrow timestamp column types and takes | ||
| * precedence over {@link DataFormatOptions.TimestampFormatOptions}, which applies to default | ||
| * {@link QueryResultsFormat#STRUCT_ENCODING} JSON results. | ||
| */ | ||
| @BetaApi | ||
| public TimestampPrecision getPicosTimestampPrecision() { | ||
| return picosTimestampPrecision; | ||
| } | ||
|
|
||
| /** <b>[Beta]</b> Returns a new builder for {@link ArrowSerializationOptions}. */ | ||
| @BetaApi | ||
| public static Builder newBuilder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return MoreObjects.toStringHelper(this) | ||
| .add("bufferCompression", bufferCompression) | ||
| .add("picosTimestampPrecision", picosTimestampPrecision) | ||
| .toString(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(@Nullable Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| ArrowSerializationOptions that = (ArrowSerializationOptions) o; | ||
| return bufferCompression == that.bufferCompression | ||
| && picosTimestampPrecision == that.picosTimestampPrecision; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(bufferCompression, picosTimestampPrecision); | ||
| } | ||
|
|
||
| com.google.api.services.bigquery.model.ArrowSerializationOptions toPb() { | ||
| return ArrowSerializationOptionsConverter.toPb(this); | ||
| } | ||
|
|
||
| static ArrowSerializationOptions fromPb( | ||
| com.google.api.services.bigquery.model.ArrowSerializationOptions optionsPb) { | ||
| return ArrowSerializationOptionsConverter.fromPb(optionsPb); | ||
| } | ||
|
|
||
| /** <b>[Beta]</b> Builder for {@link ArrowSerializationOptions}. */ | ||
| @BetaApi | ||
| public static final class Builder { | ||
| private CompressionCodec bufferCompression = CompressionCodec.UNCOMPRESSED; | ||
| private TimestampPrecision picosTimestampPrecision = TimestampPrecision.PRECISION_MICROS; | ||
|
|
||
| private Builder() {} | ||
|
|
||
| /** | ||
| * <b>[Beta]</b> Sets the buffer compression algorithm (e.g., LZ4_FRAME, ZSTD, UNCOMPRESSED). | ||
| */ | ||
| @BetaApi | ||
| public Builder setBufferCompression(CompressionCodec bufferCompression) { | ||
| this.bufferCompression = checkNotNull(bufferCompression, "bufferCompression cannot be null"); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * <b>[Beta]</b> Sets the timestamp precision for Arrow timestamp types. | ||
| * | ||
| * <p>Note: Only applies when {@link QueryResultsFormat#ARROW} is enabled. For Arrow result | ||
| * streams, this precision setting governs binary Arrow timestamp column types and takes | ||
| * precedence over {@link DataFormatOptions.TimestampFormatOptions}, which applies to default | ||
| * {@link QueryResultsFormat#STRUCT_ENCODING} JSON results. | ||
| */ | ||
| @BetaApi | ||
| public Builder setPicosTimestampPrecision(TimestampPrecision picosTimestampPrecision) { | ||
| this.picosTimestampPrecision = | ||
| checkNotNull(picosTimestampPrecision, "picosTimestampPrecision cannot be null"); | ||
| return this; | ||
| } | ||
|
|
||
| /** <b>[Beta]</b> Builds a new instance of {@link ArrowSerializationOptions}. */ | ||
| @BetaApi | ||
| public ArrowSerializationOptions build() { | ||
| return new ArrowSerializationOptions(this); | ||
| } | ||
| } | ||
| } | ||
66 changes: 66 additions & 0 deletions
66
...-bigquery/src/main/java/com/google/cloud/bigquery/ArrowSerializationOptionsConverter.java
This file contains hidden or 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,66 @@ | ||
| /* | ||
| * Copyright 2026 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.google.cloud.bigquery; | ||
|
|
||
| import org.jspecify.annotations.NullMarked; | ||
| import org.jspecify.annotations.Nullable; | ||
|
|
||
| @NullMarked | ||
| final class ArrowSerializationOptionsConverter { | ||
|
|
||
| private ArrowSerializationOptionsConverter() {} | ||
|
|
||
| static com.google.api.services.bigquery.model.@Nullable ArrowSerializationOptions toPb( | ||
| @Nullable ArrowSerializationOptions options) { | ||
| if (options == null) { | ||
| return null; | ||
| } | ||
| com.google.api.services.bigquery.model.ArrowSerializationOptions optionsPb = | ||
| new com.google.api.services.bigquery.model.ArrowSerializationOptions(); | ||
| optionsPb.setBufferCompression(options.getBufferCompression().getValue()); | ||
| optionsPb.setPicosTimestampPrecision(options.getPicosTimestampPrecision().getValue()); | ||
| return optionsPb; | ||
| } | ||
|
|
||
| static @Nullable ArrowSerializationOptions fromPb(@Nullable Object optionsPbObj) { | ||
| if (optionsPbObj == null) { | ||
| return null; | ||
| } | ||
| com.google.api.services.bigquery.model.ArrowSerializationOptions optionsPb = | ||
| (com.google.api.services.bigquery.model.ArrowSerializationOptions) optionsPbObj; | ||
| ArrowSerializationOptions.Builder builder = ArrowSerializationOptions.newBuilder(); | ||
| if (optionsPb.getBufferCompression() != null) { | ||
| for (ArrowSerializationOptions.CompressionCodec codec : | ||
| ArrowSerializationOptions.CompressionCodec.values()) { | ||
| if (codec.getValue().equalsIgnoreCase(optionsPb.getBufferCompression())) { | ||
| builder.setBufferCompression(codec); | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| if (optionsPb.getPicosTimestampPrecision() != null) { | ||
| for (ArrowSerializationOptions.TimestampPrecision precision : | ||
| ArrowSerializationOptions.TimestampPrecision.values()) { | ||
| if (precision.getValue().equalsIgnoreCase(optionsPb.getPicosTimestampPrecision())) { | ||
| builder.setPicosTimestampPrecision(precision); | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| return builder.build(); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.