/
QueryParameterValue.java
530 lines (476 loc) · 19.6 KB
/
QueryParameterValue.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
/*
* Copyright 2016 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 org.threeten.bp.temporal.ChronoField.HOUR_OF_DAY;
import static org.threeten.bp.temporal.ChronoField.MINUTE_OF_HOUR;
import static org.threeten.bp.temporal.ChronoField.NANO_OF_SECOND;
import static org.threeten.bp.temporal.ChronoField.SECOND_OF_MINUTE;
import com.google.api.services.bigquery.model.QueryParameterType;
import com.google.auto.value.AutoValue;
import com.google.cloud.Timestamp;
import com.google.common.base.Function;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.io.BaseEncoding;
import java.io.Serializable;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;
import org.threeten.bp.Instant;
import org.threeten.bp.ZoneOffset;
import org.threeten.bp.format.DateTimeFormatter;
import org.threeten.bp.format.DateTimeFormatterBuilder;
import org.threeten.bp.format.DateTimeParseException;
/**
* A value for a QueryParameter along with its type.
*
* <p>A static factory method is provided for each of the possible types (e.g. {@link #int64(Long)}
* for StandardSQLTypeName.INT64). Alternatively, an instance can be constructed by calling {@link
* #of(Object, Class)} with the value and a Class object, which will use these mappings:
*
* <p>
*
* <ul>
* <li>Boolean: StandardSQLTypeName.BOOL
* <li>String: StandardSQLTypeName.STRING
* <li>Integer: StandardSQLTypeName.INT64
* <li>Long: StandardSQLTypeName.INT64
* <li>Double: StandardSQLTypeName.FLOAT64
* <li>Float: StandardSQLTypeName.FLOAT64
* <li>BigDecimal: StandardSQLTypeName.NUMERIC
* </ul>
*
* <p>No other types are supported through that entry point. The other types can be created by
* calling {@link #of(Object, StandardSQLTypeName)} with the value and a particular
* StandardSQLTypeName enum value.
*
* <p>Struct parameters are currently not supported.
*/
@AutoValue
public abstract class QueryParameterValue implements Serializable {
private static final DateTimeFormatter timestampFormatter =
new DateTimeFormatterBuilder()
.parseLenient()
.append(DateTimeFormatter.ISO_LOCAL_DATE)
.appendLiteral(' ')
.appendValue(HOUR_OF_DAY, 2)
.appendLiteral(':')
.appendValue(MINUTE_OF_HOUR, 2)
.optionalStart()
.appendLiteral(':')
.appendValue(SECOND_OF_MINUTE, 2)
.optionalStart()
.appendFraction(NANO_OF_SECOND, 6, 9, true)
.optionalStart()
.appendOffset("+HHMM", "+00:00")
.optionalEnd()
.toFormatter()
.withZone(ZoneOffset.UTC);
private static final DateTimeFormatter timestampValidator =
new DateTimeFormatterBuilder()
.parseLenient()
.append(timestampFormatter)
.optionalStart()
.appendOffsetId()
.optionalEnd()
.toFormatter()
.withZone(ZoneOffset.UTC);
private static final DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd");
private static final DateTimeFormatter timeFormatter =
DateTimeFormatter.ofPattern("HH:mm:ss.SSSSSS");
private static final DateTimeFormatter datetimeFormatter =
DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSSSSS");
static final Function<
QueryParameterValue, com.google.api.services.bigquery.model.QueryParameterValue>
TO_VALUE_PB_FUNCTION =
new Function<
QueryParameterValue, com.google.api.services.bigquery.model.QueryParameterValue>() {
@Override
public com.google.api.services.bigquery.model.QueryParameterValue apply(
QueryParameterValue value) {
return value.toValuePb();
}
};
private static final long serialVersionUID = -5620695863123562896L;
@AutoValue.Builder
public abstract static class Builder {
/** Sets the value to the given scalar value. */
public abstract Builder setValue(String value);
/** Sets array values. The type must set to ARRAY. */
public Builder setArrayValues(List<QueryParameterValue> arrayValues) {
return setArrayValuesInner(ImmutableList.copyOf(arrayValues));
}
abstract Builder setArrayValuesInner(ImmutableList<QueryParameterValue> arrayValues);
/** Sets struct values. The type must set to STRUCT. */
public Builder setStructValues(Map<String, QueryParameterValue> structValues) {
setStructTypes(ImmutableMap.copyOf(structValues));
return setStructValuesInner(ImmutableMap.copyOf(structValues));
}
abstract Builder setStructValuesInner(Map<String, QueryParameterValue> structValues);
/** Sets the parameter data type. */
public abstract Builder setType(StandardSQLTypeName type);
/** Sets the data type of the array elements. The type must set to ARRAY. */
public abstract Builder setArrayType(StandardSQLTypeName arrayType);
/** Sets the data type of the struct elements. The type must set to STRUCT. */
public Builder setStructTypes(Map<String, QueryParameterValue> structTypes) {
return setStructTypesInner(structTypes);
}
abstract Builder setStructTypesInner(Map<String, QueryParameterValue> structTypes);
/** Creates a {@code QueryParameterValue} object. */
public abstract QueryParameterValue build();
}
QueryParameterValue() {
// Package-private so it's extensible by AutoValue but not users.
}
/** Returns the value of this parameter. */
@Nullable
public abstract String getValue();
/** Returns the array values of this parameter. The returned list, if not null, is immutable. */
@Nullable
public List<QueryParameterValue> getArrayValues() {
return getArrayValuesInner();
}
@Nullable
abstract ImmutableList<QueryParameterValue> getArrayValuesInner();
/** Returns the struct values of this parameter. The returned map, if not null, is immutable. */
@Nullable
public Map<String, QueryParameterValue> getStructValues() {
return getStructValuesInner();
}
@Nullable
abstract Map<String, QueryParameterValue> getStructValuesInner();
/** Returns the data type of this parameter. */
public abstract StandardSQLTypeName getType();
/** Returns the data type of the array elements. */
@Nullable
public abstract StandardSQLTypeName getArrayType();
/** Returns the data type of the struct elements. */
@Nullable
public Map<String, QueryParameterValue> getStructTypes() {
return getStructTypesInner();
}
@Nullable
abstract Map<String, QueryParameterValue> getStructTypesInner();
/** Creates a {@code QueryParameterValue} object with the given value and type. */
public static <T> QueryParameterValue of(T value, Class<T> type) {
return of(value, classToType(type));
}
/** Creates a {@code QueryParameterValue} object with the given value and type. */
public static <T> QueryParameterValue of(T value, StandardSQLTypeName type) {
return QueryParameterValue.newBuilder()
.setValue(valueToStringOrNull(value, type))
.setType(type)
.build();
}
/** Creates a {@code QueryParameterValue} object with a type of BOOL. */
public static QueryParameterValue bool(Boolean value) {
return of(value, StandardSQLTypeName.BOOL);
}
/** Creates a {@code QueryParameterValue} object with a type of INT64. */
public static QueryParameterValue int64(Long value) {
return of(value, StandardSQLTypeName.INT64);
}
/** Creates a {@code QueryParameterValue} object with a type of INT64. */
public static QueryParameterValue int64(Integer value) {
return of(value, StandardSQLTypeName.INT64);
}
/** Creates a {@code QueryParameterValue} object with a type of FLOAT64. */
public static QueryParameterValue float64(Double value) {
return of(value, StandardSQLTypeName.FLOAT64);
}
/** Creates a {@code QueryParameterValue} object with a type of FLOAT64. */
public static QueryParameterValue float64(Float value) {
return of(value, StandardSQLTypeName.FLOAT64);
}
/** Creates a {@code QueryParameterValue} object with a type of NUMERIC. */
public static QueryParameterValue numeric(BigDecimal value) {
return of(value, StandardSQLTypeName.NUMERIC);
}
/** Creates a {@code QueryParameterValue} object with a type of STRING. */
public static QueryParameterValue string(String value) {
return of(value, StandardSQLTypeName.STRING);
}
/** Creates a {@code QueryParameterValue} object with a type of BYTES. */
public static QueryParameterValue bytes(byte[] value) {
return of(value, StandardSQLTypeName.BYTES);
}
/** Creates a {@code QueryParameterValue} object with a type of TIMESTAMP. */
public static QueryParameterValue timestamp(Long value) {
return of(value, StandardSQLTypeName.TIMESTAMP);
}
/**
* Creates a {@code QueryParameterValue} object with a type of TIMESTAMP. Must be in the format
* "yyyy-MM-dd HH:mm:ss.SSSSSSZZ", e.g. "2014-08-19 12:41:35.220000+00:00".
*/
public static QueryParameterValue timestamp(String value) {
return of(value, StandardSQLTypeName.TIMESTAMP);
}
/**
* Creates a {@code QueryParameterValue} object with a type of DATE. Must be in the format
* "yyyy-MM-dd", e.g. "2014-08-19".
*/
public static QueryParameterValue date(String value) {
return of(value, StandardSQLTypeName.DATE);
}
/**
* Creates a {@code QueryParameterValue} object with a type of TIME. Must be in the format
* "HH:mm:ss.SSSSSS", e.g. "12:41:35.220000".
*/
public static QueryParameterValue time(String value) {
return of(value, StandardSQLTypeName.TIME);
}
/**
* Creates a {@code QueryParameterValue} object with a type of DATETIME. Must be in the format
* "yyyy-MM-dd HH:mm:ss.SSSSSS", e.g. ""2014-08-19 12:41:35.220000".
*/
public static QueryParameterValue dateTime(String value) {
return of(value, StandardSQLTypeName.DATETIME);
}
/**
* Creates a {@code QueryParameterValue} object with a type of ARRAY, and an array element type
* based on the given class.
*/
public static <T> QueryParameterValue array(T[] array, Class<T> clazz) {
return array(array, classToType(clazz));
}
/**
* Creates a {@code QueryParameterValue} object with a type of ARRAY the given array element type.
*/
public static <T> QueryParameterValue array(T[] array, StandardSQLTypeName type) {
List<QueryParameterValue> listValues = new ArrayList<>();
for (T obj : array) {
listValues.add(QueryParameterValue.of(obj, type));
}
return QueryParameterValue.newBuilder()
.setArrayValues(listValues)
.setType(StandardSQLTypeName.ARRAY)
.setArrayType(type)
.build();
}
/**
* Creates a map with {@code QueryParameterValue} object and a type of STRUCT the given struct
* element type.
*/
public static QueryParameterValue struct(Map<String, QueryParameterValue> struct) {
return QueryParameterValue.newBuilder()
.setStructValues(struct)
.setType(StandardSQLTypeName.STRUCT)
.build();
}
private static <T> StandardSQLTypeName classToType(Class<T> type) {
if (Boolean.class.isAssignableFrom(type)) {
return StandardSQLTypeName.BOOL;
} else if (String.class.isAssignableFrom(type)) {
return StandardSQLTypeName.STRING;
} else if (Integer.class.isAssignableFrom(type)) {
return StandardSQLTypeName.INT64;
} else if (Long.class.isAssignableFrom(type)) {
return StandardSQLTypeName.INT64;
} else if (Double.class.isAssignableFrom(type)) {
return StandardSQLTypeName.FLOAT64;
} else if (Float.class.isAssignableFrom(type)) {
return StandardSQLTypeName.FLOAT64;
} else if (BigDecimal.class.isAssignableFrom(type)) {
return StandardSQLTypeName.NUMERIC;
} else if (Date.class.isAssignableFrom(type)) {
return StandardSQLTypeName.DATE;
}
throw new IllegalArgumentException("Unsupported object type for QueryParameter: " + type);
}
private static <T> String valueToStringOrNull(T value, StandardSQLTypeName type) {
if (value == null) {
return null;
}
switch (type) {
case BOOL:
if (value instanceof Boolean) {
return value.toString();
}
break;
case INT64:
if (value instanceof Integer || value instanceof Long) {
return value.toString();
}
break;
case FLOAT64:
if (value instanceof Double || value instanceof Float) {
return value.toString();
}
break;
case NUMERIC:
if (value instanceof BigDecimal) {
return value.toString();
}
break;
case BYTES:
if (value instanceof byte[]) {
return BaseEncoding.base64().encode((byte[]) value);
}
break;
case STRING:
return value.toString();
case STRUCT:
throw new IllegalArgumentException("Cannot convert STRUCT to String value");
case ARRAY:
throw new IllegalArgumentException("Cannot convert ARRAY to String value");
case TIMESTAMP:
if (value instanceof Long) {
Timestamp timestamp = Timestamp.ofTimeMicroseconds((Long) value);
return timestampFormatter.format(
Instant.ofEpochSecond(timestamp.getSeconds(), timestamp.getNanos()));
} else if (value instanceof String) {
// verify that the String is in the right format
checkFormat(value, timestampValidator);
return (String) value;
}
break;
case DATE:
if (value instanceof String) {
// verify that the String is in the right format
checkFormat(value, dateFormatter);
return (String) value;
} else if (value instanceof Date) {
com.google.cloud.Date date = com.google.cloud.Date.fromJavaUtilDate((Date) value);
return date.toString();
}
break;
case TIME:
if (value instanceof String) {
// verify that the String is in the right format
checkFormat(value, timeFormatter);
return (String) value;
}
break;
case DATETIME:
if (value instanceof String) {
// verify that the String is in the right format
checkFormat(value, datetimeFormatter);
return (String) value;
}
break;
default:
throw new UnsupportedOperationException("Implementation error - Unsupported type: " + type);
}
throw new IllegalArgumentException(
"Type " + type + " incompatible with " + value.getClass().getCanonicalName());
}
private static void checkFormat(Object value, DateTimeFormatter formatter) {
try {
formatter.parse((String) value);
} catch (DateTimeParseException e) {
throw new IllegalArgumentException(e.getMessage(), e);
}
}
/** Returns a builder for a QueryParameterValue object with given value. */
public abstract Builder toBuilder();
/** Returns a builder for the {@code QueryParameterValue} object. */
public static Builder newBuilder() {
return new AutoValue_QueryParameterValue.Builder();
}
com.google.api.services.bigquery.model.QueryParameterValue toValuePb() {
com.google.api.services.bigquery.model.QueryParameterValue valuePb =
new com.google.api.services.bigquery.model.QueryParameterValue();
valuePb.setValue(getValue());
if (getArrayValues() != null) {
valuePb.setArrayValues(
Lists.transform(getArrayValues(), QueryParameterValue.TO_VALUE_PB_FUNCTION));
}
if (getStructValues() != null) {
Map<String, com.google.api.services.bigquery.model.QueryParameterValue> structValues =
new HashMap<>();
for (Map.Entry<String, QueryParameterValue> structValue : getStructValues().entrySet()) {
structValues.put(structValue.getKey(), structValue.getValue().toValuePb());
}
valuePb.setStructValues(structValues);
}
return valuePb;
}
QueryParameterType toTypePb() {
QueryParameterType typePb = new QueryParameterType();
typePb.setType(getType().toString());
if (getArrayType() != null) {
QueryParameterType arrayTypePb = new QueryParameterType();
arrayTypePb.setType(getArrayType().toString());
typePb.setArrayType(arrayTypePb);
}
if (getStructTypes() != null) {
List<QueryParameterType.StructTypes> structTypes = new ArrayList<>();
for (Map.Entry<String, QueryParameterValue> entry : getStructTypes().entrySet()) {
QueryParameterType.StructTypes structType = new QueryParameterType.StructTypes();
structType.setName(entry.getKey());
structType.setType(entry.getValue().toTypePb());
structTypes.add(structType);
}
typePb.setStructTypes(structTypes);
}
return typePb;
}
static QueryParameterValue fromPb(
com.google.api.services.bigquery.model.QueryParameterValue valuePb,
QueryParameterType typePb) {
Builder valueBuilder = newBuilder();
Map<String, QueryParameterType> parameterTypes = new HashMap<>();
StandardSQLTypeName type = StandardSQLTypeName.valueOf(typePb.getType());
valueBuilder.setType(type);
if (type == StandardSQLTypeName.ARRAY) {
valueBuilder.setArrayType(StandardSQLTypeName.valueOf(typePb.getArrayType().getType()));
if (valuePb == null || valuePb.getArrayValues() == null) {
valueBuilder.setArrayValues(ImmutableList.<QueryParameterValue>of());
} else {
ImmutableList.Builder<QueryParameterValue> arrayValues = ImmutableList.builder();
for (com.google.api.services.bigquery.model.QueryParameterValue elementValuePb :
valuePb.getArrayValues()) {
arrayValues.add(fromPb(elementValuePb, typePb.getArrayType()));
}
valueBuilder.setArrayValues(arrayValues.build());
}
} else if (type == StandardSQLTypeName.STRUCT) {
Map<String, QueryParameterValue> structTypes = new HashMap<>();
for (QueryParameterType.StructTypes types : typePb.getStructTypes()) {
structTypes.put(
types.getName(),
QueryParameterValue.newBuilder()
.setType(StandardSQLTypeName.valueOf(types.getType().getType()))
.build());
}
valueBuilder.setStructTypes(structTypes);
if (valuePb == null || valuePb.getStructValues() == null) {
valueBuilder.setStructValues(ImmutableMap.<String, QueryParameterValue>of());
} else {
Map<String, QueryParameterValue> structValues = new HashMap<>();
for (QueryParameterType.StructTypes structType : typePb.getStructTypes()) {
parameterTypes.put(structType.getName(), structType.getType());
}
for (Map.Entry<String, com.google.api.services.bigquery.model.QueryParameterValue>
structValue : valuePb.getStructValues().entrySet()) {
structValues.put(
structValue.getKey(),
QueryParameterValue.fromPb(
structValue.getValue(), parameterTypes.get(structValue.getKey())));
}
valueBuilder.setStructValues(structValues);
}
} else {
valueBuilder.setValue(valuePb == null ? "" : valuePb.getValue());
}
return valueBuilder.build();
}
}