Skip to content
This repository was archived by the owner on Mar 23, 2026. It is now read-only.

Commit 2c3399d

Browse files
PhongChuonggcf-owl-bot[bot]
PhongChuong
and
gcf-owl-bot[bot]
authored
feat: Add Range object to allow reading range value (#3236)
* feat: Add Range object to allow reading range value This PR also adds the ability to use Range query parameter * fix: lint error * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Add IT test for listTableData with Range value * Change Range get[Start, End] to return FieldValue * Fix QueryParameterValueTest * Update FieldValue to include type for Range values --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 975df05 commit 2c3399d

9 files changed

Lines changed: 508 additions & 8 deletions

File tree

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/FieldElementType.java‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.google.cloud.bigquery;
1717

18+
import com.google.api.services.bigquery.model.QueryParameterType;
1819
import com.google.api.services.bigquery.model.TableFieldSchema;
1920
import com.google.auto.value.AutoValue;
2021
import java.io.Serializable;
@@ -60,4 +61,14 @@ static FieldElementType fromPb(TableFieldSchema.RangeElementType rangeElementTyp
6061
}
6162
return null;
6263
}
64+
65+
/** Creates an instance of FieldElementType from QueryParameterType with RangeElementType. */
66+
static FieldElementType fromPb(QueryParameterType queryParameterTypePb) {
67+
// Treat a FieldElementType message without a Type subfield as invalid.
68+
if ((queryParameterTypePb.getRangeElementType() != null)
69+
&& (queryParameterTypePb.getRangeElementType().getType() != null)) {
70+
return newBuilder().setType(queryParameterTypePb.getRangeElementType().getType()).build();
71+
}
72+
return null;
73+
}
6374
}

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/FieldValue.java‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,10 @@ public enum Attribute {
6767
REPEATED,
6868

6969
/** A {@code FieldValue} for a field of type {@link LegacySQLTypeName#RECORD}. */
70-
RECORD
70+
RECORD,
71+
72+
/** A {@code FieldValue} for a field of type {@link LegacySQLTypeName#RANGE}. */
73+
RANGE
7174
}
7275

7376
private FieldValue(Attribute attribute, Object value) {
@@ -229,6 +232,23 @@ public BigDecimal getNumericValue() {
229232
return new BigDecimal(getStringValue());
230233
}
231234

235+
/**
236+
* Returns this field's value as a {@link Range}. This method should only be used * if the
237+
* corresponding field has {@link LegacySQLTypeName#RANGE} type.
238+
*
239+
* @throws ClassCastException if the field is not a primitive type
240+
* @throws IllegalArgumentException if the field's value could not be converted to {@link Range}
241+
* @throws NullPointerException if {@link #isNull()} returns {@code true}
242+
*/
243+
@SuppressWarnings("unchecked")
244+
public Range getRangeValue() {
245+
if (attribute == Attribute.RANGE) {
246+
return (Range) value;
247+
}
248+
// Provide best effort to convert value to Range object.
249+
return Range.of(getStringValue());
250+
}
251+
232252
/**
233253
* Returns this field's value as a list of {@link FieldValue}. This method should only be used if
234254
* the corresponding field has {@link Field.Mode#REPEATED} mode (i.e. {@link #getAttribute()} is
@@ -332,6 +352,12 @@ static FieldValue fromPb(Object cellPb, Field recordSchema) {
332352
return FieldValue.of(Attribute.PRIMITIVE, null);
333353
}
334354
if (cellPb instanceof String) {
355+
if ((recordSchema != null)
356+
&& (recordSchema.getType() == LegacySQLTypeName.RANGE)
357+
&& (recordSchema.getRangeElementType() != null)) {
358+
return FieldValue.of(
359+
Attribute.RANGE, Range.of((String) cellPb, recordSchema.getRangeElementType()));
360+
}
335361
return FieldValue.of(Attribute.PRIMITIVE, cellPb);
336362
}
337363
if (cellPb instanceof List) {

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/QueryParameterValue.java‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import static org.threeten.bp.temporal.ChronoField.SECOND_OF_MINUTE;
2323

2424
import com.google.api.services.bigquery.model.QueryParameterType;
25+
import com.google.api.services.bigquery.model.RangeValue;
2526
import com.google.auto.value.AutoValue;
2627
import com.google.cloud.Timestamp;
2728
import com.google.common.base.Function;
@@ -141,6 +142,13 @@ public Builder setStructValues(Map<String, QueryParameterValue> structValues) {
141142

142143
abstract Builder setStructValuesInner(Map<String, QueryParameterValue> structValues);
143144

145+
/** Sets range values. The type must set to RANGE. */
146+
public Builder setRangeValues(Range range) {
147+
return setRangeValuesInner(range);
148+
}
149+
150+
abstract Builder setRangeValuesInner(Range range);
151+
144152
/** Sets the parameter data type. */
145153
public abstract Builder setType(StandardSQLTypeName type);
146154

@@ -184,6 +192,15 @@ public Map<String, QueryParameterValue> getStructValues() {
184192
@Nullable
185193
abstract Map<String, QueryParameterValue> getStructValuesInner();
186194

195+
/** Returns the struct values of this parameter. The returned map, if not null, is immutable. */
196+
@Nullable
197+
public Range getRangeValues() {
198+
return getRangeValuesInner();
199+
}
200+
201+
@Nullable
202+
abstract Range getRangeValuesInner();
203+
187204
/** Returns the data type of this parameter. */
188205
public abstract StandardSQLTypeName getType();
189206

@@ -333,6 +350,14 @@ public static QueryParameterValue interval(PeriodDuration value) {
333350
return of(value, StandardSQLTypeName.INTERVAL);
334351
}
335352

353+
/** Creates a {@code QueryParameterValue} object with a type of RANGE. */
354+
public static QueryParameterValue range(Range value) {
355+
return QueryParameterValue.newBuilder()
356+
.setRangeValues(value)
357+
.setType(StandardSQLTypeName.RANGE)
358+
.build();
359+
}
360+
336361
/**
337362
* Creates a {@code QueryParameterValue} object with a type of ARRAY, and an array element type
338363
* based on the given class.
@@ -442,6 +467,8 @@ private static <T> String valueToStringOrNull(T value, StandardSQLTypeName type)
442467
throw new IllegalArgumentException("Cannot convert STRUCT to String value");
443468
case ARRAY:
444469
throw new IllegalArgumentException("Cannot convert ARRAY to String value");
470+
case RANGE:
471+
throw new IllegalArgumentException("Cannot convert RANGE to String value");
445472
case TIMESTAMP:
446473
if (value instanceof Long) {
447474
Timestamp timestamp = Timestamp.ofTimeMicroseconds((Long) value);
@@ -517,6 +544,22 @@ com.google.api.services.bigquery.model.QueryParameterValue toValuePb() {
517544
}
518545
valuePb.setStructValues(structValues);
519546
}
547+
if (getType() == StandardSQLTypeName.RANGE) {
548+
RangeValue rangeValue = new RangeValue();
549+
if (!getRangeValues().getStart().isNull()) {
550+
com.google.api.services.bigquery.model.QueryParameterValue startValue =
551+
new com.google.api.services.bigquery.model.QueryParameterValue();
552+
startValue.setValue(getRangeValues().getStart().getStringValue());
553+
rangeValue.setStart(startValue);
554+
}
555+
if (!getRangeValues().getEnd().isNull()) {
556+
com.google.api.services.bigquery.model.QueryParameterValue endValue =
557+
new com.google.api.services.bigquery.model.QueryParameterValue();
558+
endValue.setValue(getRangeValues().getEnd().getStringValue());
559+
rangeValue.setEnd(endValue);
560+
}
561+
valuePb.setRangeValue(rangeValue);
562+
}
520563
return valuePb;
521564
}
522565

@@ -544,6 +587,13 @@ QueryParameterType toTypePb() {
544587
}
545588
typePb.setStructTypes(structTypes);
546589
}
590+
if (getType() == StandardSQLTypeName.RANGE
591+
&& getRangeValues() != null
592+
&& getRangeValues().getType() != null) {
593+
QueryParameterType rangeTypePb = new QueryParameterType();
594+
rangeTypePb.setType(getRangeValues().getType().getType());
595+
typePb.setRangeElementType(rangeTypePb);
596+
}
547597
return typePb;
548598
}
549599

@@ -592,6 +642,21 @@ static QueryParameterValue fromPb(
592642
}
593643
valueBuilder.setStructValues(structValues);
594644
}
645+
} else if (type == StandardSQLTypeName.RANGE) {
646+
Range.Builder range = Range.newBuilder();
647+
if (valuePb.getRangeValue() != null) {
648+
com.google.api.services.bigquery.model.RangeValue rangeValuePb = valuePb.getRangeValue();
649+
if (rangeValuePb.getStart() != null && rangeValuePb.getStart().getValue() != null) {
650+
range.setStart(valuePb.getRangeValue().getStart().getValue());
651+
}
652+
if (rangeValuePb.getEnd() != null && rangeValuePb.getEnd().getValue() != null) {
653+
range.setEnd(valuePb.getRangeValue().getEnd().getValue());
654+
}
655+
}
656+
if (typePb.getRangeElementType() != null && typePb.getRangeElementType().getType() != null) {
657+
range.setType(FieldElementType.fromPb(typePb));
658+
}
659+
valueBuilder.setRangeValues(range.build());
595660
} else {
596661
valueBuilder.setValue(valuePb == null ? "" : valuePb.getValue());
597662
}

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/Range.java‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
/*
2+
* Copyright 2024 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.google.cloud.bigquery;
17+
18+
import static com.google.common.base.Preconditions.checkNotNull;
19+
20+
import com.google.auto.value.AutoValue;
21+
import com.google.cloud.bigquery.FieldValue.Attribute;
22+
import java.io.Serializable;
23+
import javax.annotation.Nullable;
24+
25+
@AutoValue
26+
public abstract class Range implements Serializable {
27+
private static final long serialVersionUID = 1L;
28+
29+
/** Returns the start value of the range. A null value represents an unbounded start. */
30+
public FieldValue getStart() {
31+
// The supported Range types [DATE, TIME, TIMESTAMP] are all Attribute.PRIMITIVE.
32+
return FieldValue.of(Attribute.PRIMITIVE, getStartInner());
33+
}
34+
35+
@Nullable
36+
abstract String getStartInner();
37+
38+
/** Returns the end value of the range. A null value represents an unbounded end. */
39+
public FieldValue getEnd() {
40+
// The supported Range types [DATE, TIME, TIMESTAMP] are all Attribute.PRIMITIVE.
41+
return FieldValue.of(Attribute.PRIMITIVE, getEndInner());
42+
}
43+
44+
@Nullable
45+
abstract String getEndInner();
46+
47+
/** Returns the type of the range. */
48+
@Nullable
49+
public abstract FieldElementType getType();
50+
51+
public abstract Range.Builder toBuilder();
52+
53+
@AutoValue.Builder
54+
public abstract static class Builder {
55+
56+
public Range.Builder setStart(String start) {
57+
return setStartInner(start);
58+
}
59+
60+
abstract Range.Builder setStartInner(String start);
61+
62+
public Range.Builder setEnd(String end) {
63+
return setEndInner(end);
64+
}
65+
66+
abstract Range.Builder setEndInner(String end);
67+
68+
public abstract Range.Builder setType(FieldElementType type);
69+
70+
public abstract Range build();
71+
}
72+
73+
/** Creates a range builder. Supported StandardSQLTypeName are [DATE, DATETIME, TIMESTAMP] */
74+
public static Builder newBuilder() {
75+
return new AutoValue_Range.Builder();
76+
}
77+
78+
public static Range of(String value) throws IllegalArgumentException {
79+
return of(value, null);
80+
}
81+
82+
/**
83+
* Creates an instance of {@code Range} from a string representation.
84+
*
85+
* <p>The expected string format is: "[start, end)", where start and end are string format of
86+
* [DATE, TIME, TIMESTAMP].
87+
*/
88+
public static Range of(String value, FieldElementType type) throws IllegalArgumentException {
89+
checkNotNull(value);
90+
Range.Builder builder = newBuilder();
91+
if (type != null) {
92+
builder.setType(type);
93+
}
94+
String[] startEnd = value.split(", ", 2); // Expect an extra space after ','.
95+
if (startEnd.length != 2) {
96+
throw new IllegalArgumentException(
97+
String.format("Expected Range value string to be [start, end) and got %s", value));
98+
}
99+
100+
String start = startEnd[0].substring(1); // Ignore the [
101+
String end = startEnd[1].substring(0, startEnd[1].length() - 1); // Ignore the )
102+
if (start.equalsIgnoreCase("UNBOUNDED") || (start.equalsIgnoreCase("NULL"))) {
103+
builder.setStart(null);
104+
} else {
105+
builder.setStart(start);
106+
}
107+
if (end.equalsIgnoreCase("UNBOUNDED") || (end.equalsIgnoreCase("NULL"))) {
108+
builder.setEnd(null);
109+
} else {
110+
builder.setEnd(end);
111+
}
112+
return builder.build();
113+
}
114+
}

‎google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/FieldElementTypeTest.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import static org.junit.Assert.assertEquals;
1919

20+
import com.google.api.services.bigquery.model.QueryParameterType;
2021
import org.junit.Test;
2122

2223
public class FieldElementTypeTest {
@@ -36,6 +37,11 @@ public void testBuilder() {
3637
@Test
3738
public void testFromAndPb() {
3839
assertEquals(FIELD_ELEMENT_TYPE, FieldElementType.fromPb(FIELD_ELEMENT_TYPE.toPb()));
40+
assertEquals(
41+
FIELD_ELEMENT_TYPE,
42+
FieldElementType.fromPb(
43+
new QueryParameterType()
44+
.setRangeElementType(new QueryParameterType().setType("DATE"))));
3945
}
4046

4147
private void compareFieldElementType(FieldElementType expected, FieldElementType value) {

‎google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/FieldValueTest.java‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ public class FieldValueTest {
5555
private static final Map<String, String> BYTES_FIELD = ImmutableMap.of("v", BYTES_BASE64);
5656
private static final Map<String, String> NULL_FIELD =
5757
ImmutableMap.of("v", Data.nullOf(String.class));
58+
59+
private static final Map<String, String> RANGE_FIELD = ImmutableMap.of("v", "[start, end)");
60+
5861
private static final Map<String, Object> REPEATED_FIELD =
5962
ImmutableMap.<String, Object>of("v", ImmutableList.<Object>of(INTEGER_FIELD, INTEGER_FIELD));
6063
private static final Map<String, Object> RECORD_FIELD =
@@ -99,6 +102,9 @@ public void testFromPb() {
99102
assertArrayEquals(BYTES, value.getBytesValue());
100103
value = FieldValue.fromPb(NULL_FIELD);
101104
assertNull(value.getValue());
105+
value = FieldValue.fromPb(RANGE_FIELD);
106+
assertEquals(FieldValue.Attribute.PRIMITIVE, value.getAttribute());
107+
assertEquals(Range.of(RANGE_FIELD.get("v")), value.getRangeValue());
102108
value = FieldValue.fromPb(REPEATED_FIELD);
103109
assertEquals(FieldValue.Attribute.REPEATED, value.getAttribute());
104110
assertEquals(FieldValue.fromPb(INTEGER_FIELD), value.getRepeatedValue().get(0));
@@ -156,6 +162,10 @@ public void testEquals() {
156162
assertEquals(nullValue, FieldValue.fromPb(NULL_FIELD));
157163
assertEquals(nullValue.hashCode(), FieldValue.fromPb(NULL_FIELD).hashCode());
158164

165+
FieldValue rangeValue = FieldValue.of(FieldValue.Attribute.PRIMITIVE, "[start, end)");
166+
assertEquals(rangeValue, FieldValue.fromPb(RANGE_FIELD));
167+
assertEquals(rangeValue.hashCode(), FieldValue.fromPb(RANGE_FIELD).hashCode());
168+
159169
FieldValue repeatedValue =
160170
FieldValue.of(FieldValue.Attribute.REPEATED, ImmutableList.of(integerValue, integerValue));
161171
assertEquals(repeatedValue, FieldValue.fromPb(REPEATED_FIELD));

0 commit comments

Comments
 (0)