feat(bigquery): add QueryResultsFormat and ArrowSerializationOptions configurations #13942
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
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,143 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| private final @Nullable String bufferCompression; | ||
| private final @Nullable String 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). | ||
| */ | ||
| @BetaApi | ||
| public @Nullable String getBufferCompression() { | ||
| return bufferCompression; | ||
| } | ||
|
|
||
| /** | ||
| * <b>[Beta]</b> Returns 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 @Nullable String 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 Objects.equals(bufferCompression, that.bufferCompression) | ||
| && Objects.equals(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 @Nullable String bufferCompression; | ||
| private @Nullable String picosTimestampPrecision; | ||
|
Comment on lines
+108
to
+109
Member
There was a problem hiding this comment. Do you think it's possible we can set a default value for these so they they can be non-null and we can assert that they always will be non-null? especially in the setters? e.g. uncompressed and micro precision? |
||
|
|
||
| private Builder() {} | ||
|
|
||
| /** | ||
| * <b>[Beta]</b> Sets the buffer compression algorithm (e.g., LZ4_FRAME, ZSTD, UNCOMPRESSED). | ||
| */ | ||
| @BetaApi | ||
| public Builder setBufferCompression(String 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(String picosTimestampPrecision) { | ||
|
Comment on lines
+117
to
+131
Member
There was a problem hiding this comment. For these setters, do you think we should create enum wrappers around the options? If there is a typo in the precision on compression codec, it may fail with the apiary model |
||
| 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); | ||
| } | ||
| } | ||
| } | ||
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,54 @@ | ||
| /* | ||
| * 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(); | ||
| if (options.getBufferCompression() != null) { | ||
| optionsPb.setBufferCompression(options.getBufferCompression()); | ||
| } | ||
| if (options.getPicosTimestampPrecision() != null) { | ||
| optionsPb.setPicosTimestampPrecision(options.getPicosTimestampPrecision()); | ||
|
Comment on lines
+29
to
+38
Member
There was a problem hiding this comment. Follow the above, do you think we can just assert that the params are non-null? Also if we set a default value for ArrowSerializationOptions's params, then I don't think we need the null checks here |
||
| } | ||
| 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; | ||
| return ArrowSerializationOptions.newBuilder() | ||
| .setBufferCompression(optionsPb.getBufferCompression()) | ||
| .setPicosTimestampPrecision(optionsPb.getPicosTimestampPrecision()) | ||
| .build(); | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /* | ||
| * 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 com.google.api.core.BetaApi; | ||
| import org.jspecify.annotations.NullMarked; | ||
|
|
||
| /** <b>[Beta]</b> The format of the query results. */ | ||
| @BetaApi | ||
| @NullMarked | ||
| public enum QueryResultsFormat { | ||
| /** Serialized row data in Apache Arrow format. */ | ||
| ARROW, | ||
|
|
||
| /** Default encoding of results as JSON struct array. */ | ||
| STRUCT_ENCODING | ||
| } |
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.