Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion google-cloud-jar-parent/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
<dependency>
<groupId>com.google.apis</groupId>
<artifactId>google-api-services-bigquery</artifactId>
<version>v2-rev20260612-2.0.0</version>
<version>v2-rev20260707-2.0.0</version>
</dependency>

</dependencies>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
/*
* 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 com.google.common.base.MoreObjects;
import java.io.Serializable;
import java.util.Objects;

/** Options specific to the Apache Arrow output format. */
@BetaApi
public final class ArrowSerializationOptions implements Serializable {

private static final long serialVersionUID = 1L;

private final String bufferCompression;
private final String picosTimestampPrecision;

private ArrowSerializationOptions(Builder builder) {
this.bufferCompression = builder.bufferCompression;
this.picosTimestampPrecision = builder.picosTimestampPrecision;
}

public String getBufferCompression() {
return bufferCompression;
}

public String getPicosTimestampPrecision() {
return picosTimestampPrecision;
}

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(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);
}

public static final class Builder {
private String bufferCompression;
private String picosTimestampPrecision;

private Builder() {}

public Builder setBufferCompression(String bufferCompression) {
this.bufferCompression = bufferCompression;
return this;
}

public Builder setPicosTimestampPrecision(String picosTimestampPrecision) {
this.picosTimestampPrecision = picosTimestampPrecision;
return this;
}

public ArrowSerializationOptions build() {
return new ArrowSerializationOptions(this);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* 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;

final class ArrowSerializationOptionsConverter {

private ArrowSerializationOptionsConverter() {}

static com.google.api.services.bigquery.model.ArrowSerializationOptions toPb(
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());
}
return optionsPb;
}

static ArrowSerializationOptions fromPb(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();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ public final class QueryJobConfiguration extends JobConfiguration {
private final Long maxResults;
private final JobCreationMode jobCreationMode;
private final String reservation;
private final QueryResultsFormat queryResultsFormat;
private final ArrowSerializationOptions arrowSerializationOptions;

/**
* Priority levels for a query. If not specified the priority is assumed to be {@link
Expand Down Expand Up @@ -144,6 +146,8 @@ public static final class Builder
private Long maxResults;
private JobCreationMode jobCreationMode;
private String reservation;
private QueryResultsFormat queryResultsFormat;
private ArrowSerializationOptions arrowSerializationOptions;

private Builder() {
super(Type.QUERY);
Expand Down Expand Up @@ -181,6 +185,8 @@ private Builder(QueryJobConfiguration jobConfiguration) {
this.maxResults = jobConfiguration.maxResults;
this.jobCreationMode = jobConfiguration.jobCreationMode;
this.reservation = jobConfiguration.reservation;
this.queryResultsFormat = jobConfiguration.queryResultsFormat;
this.arrowSerializationOptions = jobConfiguration.arrowSerializationOptions;
}

private Builder(com.google.api.services.bigquery.model.JobConfiguration configurationPb) {
Expand Down Expand Up @@ -701,6 +707,40 @@ public Builder setReservation(String reservation) {
return this;
}

/**
* Sets the query results response format. Defaults to {@link
* QueryResultsFormat#STRUCT_ENCODING}.
*
* <p>When set to {@link QueryResultsFormat#ARROW}, query results are returned in binary Apache
* Arrow format, utilizing gRPC Storage Read streams for subsequent pages.
*
* <p><b>Prerequisite:</b> Requires the BigQuery Storage Read API ({@code
* bigquerystorage.googleapis.com}) to be enabled on your GCP project and your credentials to
* have Storage Read permissions (e.g. {@code bigquery.readsessions.create}).
*
* @param queryResultsFormat the format for query result payloads
* @return the Builder
*/
public Builder setQueryResultsFormat(QueryResultsFormat queryResultsFormat) {
this.queryResultsFormat = queryResultsFormat;
return this;
}

/**
* Sets Arrow serialization options. Defaults to null.
*
* <p>Note: Only applied in the request payload when {@code queryResultsFormat} is {@code
* ARROW}.
*
* @param arrowSerializationOptions the Arrow serialization options to set
* @return the Builder
*/
public Builder setArrowSerializationOptions(
ArrowSerializationOptions arrowSerializationOptions) {
this.arrowSerializationOptions = arrowSerializationOptions;
return this;
}

public QueryJobConfiguration build() {
return new QueryJobConfiguration(this);
}
Expand Down Expand Up @@ -747,6 +787,8 @@ private QueryJobConfiguration(Builder builder) {
this.maxResults = builder.maxResults;
this.jobCreationMode = builder.jobCreationMode;
this.reservation = builder.reservation;
this.queryResultsFormat = builder.queryResultsFormat;
this.arrowSerializationOptions = builder.arrowSerializationOptions;
}

/**
Expand Down Expand Up @@ -973,6 +1015,14 @@ public Builder toBuilder() {
return new Builder(this);
}

public QueryResultsFormat getQueryResultsFormat() {
return queryResultsFormat;
}

public ArrowSerializationOptions getArrowSerializationOptions() {
return arrowSerializationOptions;
}

@Override
ToStringHelper toStringHelper() {
return super.toStringHelper()
Expand Down Expand Up @@ -1004,13 +1054,23 @@ ToStringHelper toStringHelper() {
.add("rangePartitioning", rangePartitioning)
.add("connectionProperties", connectionProperties)
.add("jobCreationMode", jobCreationMode)
.add("reservation", reservation);
.add("reservation", reservation)
.add("queryResultsFormat", queryResultsFormat)
.add("arrowSerializationOptions", arrowSerializationOptions);
}

@Override
public boolean equals(Object obj) {
return obj == this
|| obj instanceof QueryJobConfiguration && baseEquals((QueryJobConfiguration) obj);
if (obj == this) {
return true;
}
if (obj == null || !(obj instanceof QueryJobConfiguration)) {
return false;
}
QueryJobConfiguration other = (QueryJobConfiguration) obj;
return baseEquals(other)
&& Objects.equals(queryResultsFormat, other.queryResultsFormat)
&& Objects.equals(arrowSerializationOptions, other.arrowSerializationOptions);
}

@Override
Expand Down Expand Up @@ -1043,7 +1103,9 @@ public int hashCode() {
labels,
rangePartitioning,
connectionProperties,
reservation);
reservation,
queryResultsFormat,
arrowSerializationOptions);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* 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;

/** The format of the query results. */
@BetaApi
public enum QueryResultsFormat {
/** Serialized row data in Apache Arrow format. */
ARROW,

/** Default encoding of results as JSON struct array. */
STRUCT_ENCODING
}
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,35 @@ public void testJobCreationMode() {
QUERY_JOB_CONFIGURATION_SET_JOB_CREATION_MODE.toBuilder().build());
}

@Test
public void testArrowConfigurations() {
QueryResultsFormat format = QueryResultsFormat.ARROW;
ArrowSerializationOptions options =
ArrowSerializationOptions.newBuilder()
.setBufferCompression("LZ4")
.setPicosTimestampPrecision("PRECISION_MILLIS")
.build();
QueryJobConfiguration job =
QueryJobConfiguration.newBuilder(QUERY)
.setQueryResultsFormat(format)
.setArrowSerializationOptions(options)
.build();

assertEquals(format, job.getQueryResultsFormat());
assertEquals(options, job.getArrowSerializationOptions());

// Test toBuilder
QueryJobConfiguration copiedJob = job.toBuilder().build();
assertEquals(job, copiedJob);
assertEquals(format, copiedJob.getQueryResultsFormat());
assertEquals(options, copiedJob.getArrowSerializationOptions());

// Test toPb/fromPb (not preserved)
QueryJobConfiguration jobFromPb = QueryJobConfiguration.fromPb(job.toPb());
assertNull(jobFromPb.getQueryResultsFormat());
assertNull(jobFromPb.getArrowSerializationOptions());
Comment thread
jinseopkim0 marked this conversation as resolved.
}

private void compareQueryJobConfiguration(
QueryJobConfiguration expected, QueryJobConfiguration value) {
assertEquals(expected, value);
Expand Down
Loading