forked from adbc-drivers/bigquery
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBigQueryStatement.cs
More file actions
1308 lines (1129 loc) · 59 KB
/
BigQueryStatement.cs
File metadata and controls
1308 lines (1129 loc) · 59 KB
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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2025 ADBC Drivers Contributors
*
* This file has been modified from its original version, which is
* under the Apache License:
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Apache.Arrow;
using Apache.Arrow.Adbc;
using Apache.Arrow.Adbc.Extensions;
using Apache.Arrow.Adbc.Tracing;
using Apache.Arrow.Ipc;
using Apache.Arrow.Types;
using Google;
using Google.Api.Gax;
using Google.Apis.Auth.OAuth2;
using Google.Apis.Bigquery.v2.Data;
using Google.Cloud.BigQuery.Storage.V1;
using Google.Cloud.BigQuery.V2;
using TableFieldSchema = Google.Apis.Bigquery.v2.Data.TableFieldSchema;
using TableSchema = Google.Apis.Bigquery.v2.Data.TableSchema;
namespace AdbcDrivers.BigQuery
{
/// <summary>
/// BigQuery-specific implementation of <see cref="AdbcStatement"/>
/// </summary>
class BigQueryStatement : TracingStatement, ITokenProtectedResource, IDisposable
{
private const string ClassName = nameof(BigQueryStatement);
readonly BigQueryConnection bigQueryConnection;
readonly CancellationRegistry cancellationRegistry;
bool isMetadataCommand = false;
string? catalogName = null;
string? schemaName = null;
string? tableName = null;
public BigQueryStatement(BigQueryConnection bigQueryConnection) : base(bigQueryConnection)
{
if (bigQueryConnection == null) { throw new AdbcException($"{nameof(bigQueryConnection)} cannot be null", AdbcStatusCode.InvalidArgument); }
// pass on the handler since this isn't accessible publicly
UpdateToken = bigQueryConnection.UpdateToken;
this.bigQueryConnection = bigQueryConnection;
this.cancellationRegistry = new CancellationRegistry();
}
public Func<Task>? UpdateToken { get; set; }
internal Dictionary<string, string>? Options { get; set; }
private BigQueryClient Client => this.bigQueryConnection.Client ?? throw new AdbcException("Client cannot be null");
private GoogleCredential Credential => this.bigQueryConnection.Credential ?? throw new AdbcException("Credential cannot be null");
private int MaxRetryAttempts => this.bigQueryConnection.MaxRetryAttempts;
private int RetryDelayMs => this.bigQueryConnection.RetryDelayMs;
public override string AssemblyVersion => BigQueryUtils.BigQueryAssemblyVersion;
public override string AssemblyName => BigQueryUtils.BigQueryAssemblyName;
public override void SetOption(string key, string value)
{
if (Options == null)
{
Options = new Dictionary<string, string>();
}
Options[key] = value;
}
public override QueryResult ExecuteQuery()
{
try
{
return ExecuteQueryInternalAsync().GetAwaiter().GetResult();
}
catch (Exception ex) when (BigQueryConnection.IsUnauthorizedException(ex, out GoogleApiException? googleEx))
{
throw new AdbcException(googleEx!.Message, AdbcStatusCode.Unauthorized, ex);
}
}
private async Task<QueryResult> ExecuteQueryInternalAsync()
{
return await this.TraceActivityAsync(async activity =>
{
QueryOptions queryOptions = ValidateOptions(activity);
activity?.AddConditionalTag(SemanticConventions.Db.Query.Text, SqlQuery, this.bigQueryConnection.IsSafeToTrace);
if (isMetadataCommand)
{
return await ExecuteMetadataCommandQuery(activity);
}
BigQueryJob job = await Client.CreateQueryJobAsync(SqlQuery, null, queryOptions);
JobReference jobReference = job.Reference;
GetQueryResultsOptions getQueryResultsOptions = new GetQueryResultsOptions();
if (Options?.TryGetValue(BigQueryParameters.GetQueryResultsOptionsTimeout, out string? timeoutSeconds) == true &&
int.TryParse(timeoutSeconds, out int seconds) &&
seconds >= 0)
{
getQueryResultsOptions.Timeout = TimeSpan.FromSeconds(seconds);
activity?.AddBigQueryParameterTag(BigQueryParameters.GetQueryResultsOptionsTimeout, seconds);
}
activity?.AddBigQueryParameterTag(BigQueryParameters.ClientTimeout, Client.Service.HttpClient.Timeout.Seconds);
using JobCancellationContext cancellationContext = new JobCancellationContext(cancellationRegistry, job);
// We can't checkJobStatus, Otherwise, the timeout in QueryResultsOptions is meaningless.
// When encountering a long-running job, it should be controlled by the timeout in the Google SDK instead of blocking in a while loop.
Func<Task<BigQueryResults>> getJobResults = async () =>
{
return await ExecuteCancellableJobAsync(cancellationContext, activity, async (context) =>
{
return await this.TraceActivityAsync(async activity =>
{
// if the authentication token was reset, then we need a new job with the latest token
context.Job = await Client.GetJobAsync(jobReference, cancellationToken: context.CancellationToken).ConfigureAwait(false);
return await context.Job.GetQueryResultsAsync(getQueryResultsOptions, cancellationToken: context.CancellationToken).ConfigureAwait(false);
}, ClassName + "." + nameof(ExecuteQueryInternalAsync) + "." + nameof(BigQueryJob.GetQueryResultsAsync));
}).ConfigureAwait(false);
};
BigQueryResults results = await ExecuteWithRetriesAsync(getJobResults, activity, cancellationContext.CancellationToken).ConfigureAwait(false);
TokenProtectedReadClientManger clientMgr = new TokenProtectedReadClientManger(Credential);
clientMgr.UpdateToken = () => Task.Run(() =>
{
this.bigQueryConnection.SetCredential();
clientMgr.UpdateCredential(Credential);
});
// For multi-statement queries, StatementType == "SCRIPT"
if (results.TableReference == null || job.Statistics.Query.StatementType.Equals("SCRIPT", StringComparison.OrdinalIgnoreCase))
{
string statementType = string.Empty;
if (Options?.TryGetValue(BigQueryParameters.StatementType, out string? statementTypeString) == true)
{
statementType = statementTypeString;
}
int statementIndex = 1;
if (Options?.TryGetValue(BigQueryParameters.StatementIndex, out string? statementIndexString) == true &&
int.TryParse(statementIndexString, out int statementIndexInt) &&
statementIndexInt > 0)
{
statementIndex = statementIndexInt;
}
string evaluationKind = string.Empty;
if (Options?.TryGetValue(BigQueryParameters.EvaluationKind, out string? evaluationKindString) == true)
{
evaluationKind = evaluationKindString;
}
Func<Task<BigQueryResults>> getMultiJobResults = async () =>
{
// To get the results of all statements in a multi-statement query, enumerate the child jobs. Related public docs: https://cloud.google.com/bigquery/docs/multi-statement-queries#get_all_executed_statements.
// Can filter by StatementType and EvaluationKind. Related public docs: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobstatistics2, https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#evaluationkind
ListJobsOptions listJobsOptions = new ListJobsOptions();
listJobsOptions.ParentJobId = results.JobReference.JobId;
var joblist = Client.ListJobs(listJobsOptions)
.Select(job => Client.GetJob(job.Reference))
.Where(job => string.IsNullOrEmpty(evaluationKind) || job.Statistics.ScriptStatistics.EvaluationKind.Equals(evaluationKind, StringComparison.OrdinalIgnoreCase))
.Where(job => string.IsNullOrEmpty(statementType) || job.Statistics.Query.StatementType.Equals(statementType, StringComparison.OrdinalIgnoreCase))
.OrderBy(job => job.Resource.Statistics.CreationTime)
.ToList();
if (joblist.Count > 0)
{
if (statementIndex < 1 || statementIndex > joblist.Count)
{
throw new ArgumentOutOfRangeException($"The specified index {statementIndex} is out of range. There are {joblist.Count} jobs available.");
}
BigQueryJob indexedJob = joblist[statementIndex - 1];
cancellationContext.Job = indexedJob;
return await ExecuteCancellableJobAsync(cancellationContext, activity, async (context) =>
{
return await indexedJob.GetQueryResultsAsync(getQueryResultsOptions, cancellationToken: context.CancellationToken).ConfigureAwait(false);
}).ConfigureAwait(false);
}
throw new AdbcException($"Unable to obtain result from statement [{statementIndex}]", AdbcStatusCode.InvalidData);
};
results = await ExecuteWithRetriesAsync(getMultiJobResults, activity, cancellationContext.CancellationToken).ConfigureAwait(false);
}
if (results?.TableReference == null)
{
throw new AdbcException("There is no query statement");
}
string table = $"projects/{results.TableReference.ProjectId}/datasets/{results.TableReference.DatasetId}/tables/{results.TableReference.TableId}";
int maxStreamCount = 1;
if (Options?.TryGetValue(BigQueryParameters.MaxFetchConcurrency, out string? maxStreamCountString) == true)
{
if (int.TryParse(maxStreamCountString, out int count))
{
if (count >= 0)
{
maxStreamCount = count;
}
}
}
long totalRows = results.TotalRows == null ? -1L : (long)results.TotalRows.Value;
Func<Task<IEnumerable<IArrowReader>>> getArrowReadersFunc = async () =>
{
return await ExecuteCancellableJobAsync(cancellationContext, activity, async (context) =>
{
return await this.TraceActivityAsync(async activity =>
{
// Cancelling this step may leave the server with unread streams.
return await GetArrowReaders(clientMgr, table, results.TableReference.ProjectId, maxStreamCount, activity, context.CancellationToken).ConfigureAwait(false);
}, ClassName + "." + nameof(ExecuteQueryInternalAsync) + "." + nameof(GetArrowReaders));
}).ConfigureAwait(false);
};
IEnumerable<IArrowReader> readers = await ExecuteWithRetriesAsync(getArrowReadersFunc, activity, cancellationContext.CancellationToken).ConfigureAwait(false);
// Note: MultiArrowReader must dispose the cancellationContext.
IArrowArrayStream stream = new MultiArrowReader(this, TranslateSchema(results.Schema), readers, new CancellationContext(cancellationRegistry));
activity?.AddTag(SemanticConventions.Db.Response.ReturnedRows, totalRows);
return new QueryResult(totalRows, stream);
}, ClassName + "." + nameof(ExecuteQueryInternalAsync));
}
private Task<QueryResult> ExecuteMetadataCommandQuery(Activity? activity)
{
const string SupportedMetadataCommands = "GetCatalogs,GetSchemas,GetTables,GetColumns,GetPrimaryKeys";
return SqlQuery?.ToLowerInvariant() switch
{
"getcatalogs" => GetCatalogs(activity),
"getschemas" => GetSchemas(activity),
"gettables" => GetTables(activity),
"getcolumns" => GetTableSchema(activity),
"getprimarykeys" => GetPrimaryKeys(activity),
null or "" => throw new ArgumentNullException(nameof(SqlQuery), $"Metadata command for property 'SqlQuery' must not be empty or null. Supported metadata commands: {SupportedMetadataCommands}"),
_ => throw new NotSupportedException($"Metadata command '{SqlQuery}' is not supported. Supported metadata commands: {SupportedMetadataCommands}"),
};
}
protected Task<QueryResult> GetTables(Activity? activity)
{
StringArray.Builder tableNameBuilder = new StringArray.Builder();
StringArray.Builder tableTypeBuilder = new StringArray.Builder();
Func<Task<PagedEnumerable<TableList, BigQueryTable>?>> func = () => Task.Run(() =>
{
return Client?.ListTables(this.catalogName, this.schemaName);
});
PagedEnumerable<TableList, BigQueryTable>? tables;
tables = ExecuteWithRetriesAsync<PagedEnumerable<TableList, BigQueryTable>?>(func, activity).GetAwaiter().GetResult();
if (tables != null)
{
// Sort tables by name for consistency
var sortedTables = tables.OrderBy(x => x.Reference.TableId).ToList();
foreach (var table in sortedTables)
{
tableNameBuilder.Append(table.Reference.TableId);
// Map BigQuery types to ADBC standard types
string tableType = table.Resource.Type switch
{
"TABLE" => "BASE TABLE", // ADBC standard name
"VIEW" => "VIEW",
"EXTERNAL" => "EXTERNAL TABLE",
"SNAPSHOT" => "SNAPSHOT",
"CLONE" => "CLONE",
_ => table.Resource.Type // fallback to original
};
tableTypeBuilder.Append(tableType);
}
}
IArrowArray[] dataArrays = new IArrowArray[]
{
tableNameBuilder.Build(),
tableTypeBuilder.Build()
};
// Create schema with both columns
Schema schema = new Schema(
new Field[]
{
new Field("table_name", StringType.Default, false),
new Field("table_type", StringType.Default, false)
},
metadata: null
);
schema.Validate(dataArrays);
IArrowArrayStream stream = new BigQueryInfoArrowStream(schema, dataArrays);
return Task.FromResult(new QueryResult(dataArrays[0].Length, stream));
}
protected Task<QueryResult> GetPrimaryKeys(Activity? activity)
{
StringArray.Builder columnNameBuilder = new StringArray.Builder();
Func<Task<BigQueryTable?>> func = () => Task.Run(() =>
{
return Client?.GetTable(this.catalogName, this.schemaName, this.tableName);
});
BigQueryTable? table = ExecuteWithRetriesAsync<BigQueryTable?>(func, activity).GetAwaiter().GetResult();
if (table?.Resource?.TableConstraints?.PrimaryKey?.Columns != null)
{
List<string> primaryKeyColumns = new List<string>();
primaryKeyColumns = table.Resource.TableConstraints.PrimaryKey.Columns.ToList();
foreach (string columnName in primaryKeyColumns)
{
columnNameBuilder.Append(columnName);
}
}
IArrowArray[] dataArrays = new IArrowArray[]
{
columnNameBuilder.Build()
};
Schema schema = new Schema(
new Field[] { new Field("column_name", StringType.Default, false) },
metadata: null
);
schema.Validate(dataArrays);
IArrowArrayStream stream = new BigQueryInfoArrowStream(schema, dataArrays);
return Task.FromResult(new QueryResult(dataArrays[0].Length, stream));
}
/*
* Retrieves the schema information for a BigQuery table, including all nested fields.
*
* This method flattens nested STRUCT/RECORD types into individual rows, preserving all field properties
* at every nesting level. Each field is represented by a separate row with its full qualified name
* using dot notation (e.g., "address.city.name").
*
* Output columns include:
* - column_name: Full qualified field name with dot notation for nested fields
* - column_type: BigQuery data type (STRING, INT64, STRUCT, etc.)
* - column_mode: Field mode (NULLABLE, REQUIRED, REPEATED)
* - column_description: Field description
* - column_max_length: Maximum length for STRING/BYTES types
* - column_precision: Precision for NUMERIC types
* - column_scale: Scale for NUMERIC types
* - column_default_value_expression: Default value expression
* - column_collation: Collation specification
* - column_policy_tags: List of policy tags
* - column_rounding_mode: Rounding mode for NUMERIC types
* - column_range_element_type: Element type for RANGE types
* - column_depth: Nesting level (0 for top-level, 1+ for nested)
* - column_parent_name: Full qualified parent field name (null for top-level)
*
* Example:
* For a BigQuery table with the following schema:
*
* CREATE TABLE example (
* id INT64,
* name STRING,
* address STRUCT<
* street STRING,
* city STRUCT<
* name STRING,
* zipcode INT64
* >
* >
* )
*
* The output will contain these rows:
*
* | column_name | column_type | column_depth | column_parent_name |
* |----------------------|-------------|--------------|-------------------|
* | id | INT64 | 0 | null |
* | name | STRING | 0 | null |
* | address | STRUCT | 0 | null |
* | address.street | STRING | 1 | address |
* | address.city | STRUCT | 1 | address |
* | address.city.name | STRING | 2 | address.city |
* | address.city.zipcode | INT64 | 2 | address.city |
*/
protected Task<QueryResult> GetTableSchema(Activity? activity)
{
StringArray.Builder columnNameBuilder = new StringArray.Builder();
StringArray.Builder columnTypeBuilder = new StringArray.Builder();
StringArray.Builder columnModeBuilder = new StringArray.Builder();
StringArray.Builder columnDescriptionBuilder = new StringArray.Builder();
Int64Array.Builder columnMaxLengthBuilder = new Int64Array.Builder();
Int64Array.Builder columnPrecisionBuilder = new Int64Array.Builder();
Int64Array.Builder columnScaleBuilder = new Int64Array.Builder();
StringArray.Builder columnDefaultValueExpressionBuilder = new StringArray.Builder();
StringArray.Builder columnCollationBuilder = new StringArray.Builder();
ListArray.Builder columnPolicyTagsBuilder = new ListArray.Builder(StringType.Default);
StringArray.Builder columnRoundingModeBuilder = new StringArray.Builder();
StringArray.Builder columnRangeElementTypeBuilder = new StringArray.Builder();
Int64Array.Builder columnDepthBuilder = new Int64Array.Builder();
StringArray.Builder columnParentNameBuilder = new StringArray.Builder();
Func<Task<BigQueryTable?>> func = () => Task.Run(() =>
{
return Client?.GetTable(this.catalogName, this.schemaName, this.tableName);
});
BigQueryTable? table = ExecuteWithRetriesAsync<BigQueryTable?>(func, activity).GetAwaiter().GetResult();
if (table != null)
{
FlattenFields(table.Schema.Fields, string.Empty, string.Empty, 0,
columnNameBuilder, columnTypeBuilder, columnModeBuilder, columnDescriptionBuilder,
columnMaxLengthBuilder, columnPrecisionBuilder, columnScaleBuilder,
columnDefaultValueExpressionBuilder, columnCollationBuilder,
columnPolicyTagsBuilder, columnRoundingModeBuilder, columnRangeElementTypeBuilder,
columnDepthBuilder, columnParentNameBuilder);
}
IArrowArray[] dataArrays = new IArrowArray[]
{
columnNameBuilder.Build(),
columnTypeBuilder.Build(),
columnModeBuilder.Build(),
columnDescriptionBuilder.Build(),
columnMaxLengthBuilder.Build(),
columnPrecisionBuilder.Build(),
columnScaleBuilder.Build(),
columnDefaultValueExpressionBuilder.Build(),
columnCollationBuilder.Build(),
columnPolicyTagsBuilder.Build(),
columnRoundingModeBuilder.Build(),
columnRangeElementTypeBuilder.Build(),
columnDepthBuilder.Build(),
columnParentNameBuilder.Build()
};
Schema schema = new Schema(
new Field[]
{
new Field("column_name", StringType.Default, false),
new Field("column_type", StringType.Default, false),
new Field("column_mode", StringType.Default, true),
new Field("column_description", StringType.Default, true),
new Field("column_max_length", Int64Type.Default, true),
new Field("column_precision", Int64Type.Default, true),
new Field("column_scale", Int64Type.Default, true),
new Field("column_default_value_expression", StringType.Default, true),
new Field("column_collation", StringType.Default, true),
new Field("column_policy_tags", new ListType(StringType.Default), true),
new Field("column_rounding_mode", StringType.Default, true),
new Field("column_range_element_type", StringType.Default, true),
new Field("column_depth", Int64Type.Default, false),
new Field("column_parent_name", StringType.Default, true)
},
metadata: null
);
schema.Validate(dataArrays);
IArrowArrayStream stream = new BigQueryInfoArrowStream(schema, dataArrays);
return Task.FromResult(new QueryResult(dataArrays[0].Length, stream));
}
/*
* Recursively flattens nested BigQuery table fields into a flat structure with dot notation.
*
* This method processes each field in the collection and recursively handles nested STRUCT/RECORD types.
* For each field, it:
* 1. Constructs the full qualified name using dot notation
* 2. Appends all field properties to their respective builders
* 3. Records the depth level and parent field name
* 4. Recursively processes nested fields if present
*
* Example:
* Given a field structure:
*
* address STRUCT<
* street STRING,
* location STRUCT<
* lat FLOAT64,
* lon FLOAT64
* >
* >
*
* The method will generate these entries:
*
* Depth 0: "address" (parent: null)
* Depth 1: "address.street" (parent: "address")
* Depth 1: "address.location" (parent: "address")
* Depth 2: "address.location.lat" (parent: "address.location")
* Depth 2: "address.location.lon" (parent: "address.location")
*/
private void FlattenFields(
IList<TableFieldSchema> fields,
string prefix,
string parentName,
int depth,
StringArray.Builder columnNameBuilder,
StringArray.Builder columnTypeBuilder,
StringArray.Builder columnModeBuilder,
StringArray.Builder columnDescriptionBuilder,
Int64Array.Builder columnMaxLengthBuilder,
Int64Array.Builder columnPrecisionBuilder,
Int64Array.Builder columnScaleBuilder,
StringArray.Builder columnDefaultValueExpressionBuilder,
StringArray.Builder columnCollationBuilder,
ListArray.Builder columnPolicyTagsBuilder,
StringArray.Builder columnRoundingModeBuilder,
StringArray.Builder columnRangeElementTypeBuilder,
Int64Array.Builder columnDepthBuilder,
StringArray.Builder columnParentNameBuilder)
{
foreach (TableFieldSchema field in fields)
{
string fieldName = string.IsNullOrEmpty(prefix) ? field.Name : $"{prefix}.{field.Name}";
columnNameBuilder.Append(fieldName);
columnTypeBuilder.Append(field.Type);
columnModeBuilder.Append(field.Mode);
columnDescriptionBuilder.Append(field.Description);
if (field.MaxLength.HasValue)
columnMaxLengthBuilder.Append(field.MaxLength.Value);
else
columnMaxLengthBuilder.AppendNull();
if (field.Precision.HasValue)
columnPrecisionBuilder.Append(field.Precision.Value);
else
columnPrecisionBuilder.AppendNull();
if (field.Scale.HasValue)
columnScaleBuilder.Append(field.Scale.Value);
else
columnScaleBuilder.AppendNull();
columnDefaultValueExpressionBuilder.Append(field.DefaultValueExpression);
columnCollationBuilder.Append(field.Collation);
if (field.PolicyTags?.Names != null && field.PolicyTags.Names.Count > 0)
{
StringArray.Builder valueBuilder = (StringArray.Builder)columnPolicyTagsBuilder.ValueBuilder;
foreach (string tag in field.PolicyTags.Names)
{
valueBuilder.Append(tag);
}
columnPolicyTagsBuilder.Append();
}
else
{
columnPolicyTagsBuilder.AppendNull();
}
columnRoundingModeBuilder.Append(field.RoundingMode);
columnRangeElementTypeBuilder.Append(field.RangeElementType?.Type);
// Add depth information
columnDepthBuilder.Append(depth);
// Add parent name (null for top-level fields)
columnParentNameBuilder.Append(string.IsNullOrEmpty(parentName) ? null : parentName);
// Recursively flatten nested fields (for STRUCT/RECORD types)
if (field.Fields != null && field.Fields.Count > 0)
{
FlattenFields(field.Fields, fieldName, fieldName, depth + 1,
columnNameBuilder, columnTypeBuilder, columnModeBuilder, columnDescriptionBuilder,
columnMaxLengthBuilder, columnPrecisionBuilder, columnScaleBuilder,
columnDefaultValueExpressionBuilder, columnCollationBuilder,
columnPolicyTagsBuilder, columnRoundingModeBuilder, columnRangeElementTypeBuilder,
columnDepthBuilder, columnParentNameBuilder);
}
}
}
protected Task<QueryResult> GetSchemas(Activity? activity)
{
StringArray.Builder schemaNameBuilder = new StringArray.Builder();
List<string> datasetIds = new List<string>();
Func<Task<PagedEnumerable<DatasetList, BigQueryDataset>?>> func = () => Task.Run(() =>
{
// stick with this call because PagedAsyncEnumerable has different behaviors for selecting items
return Client?.ListDatasets(this.catalogName);
});
PagedEnumerable<DatasetList, BigQueryDataset>? datasets;
datasets = ExecuteWithRetriesAsync<PagedEnumerable<DatasetList, BigQueryDataset>?>(func, activity).GetAwaiter().GetResult();
if (datasets != null)
{
datasetIds = datasets.Select(x => x.Reference.DatasetId).ToList();
datasetIds.Sort();
foreach (string datasetId in datasetIds)
{
schemaNameBuilder.Append(datasetId);
}
}
IArrowArray[] dataArrays = new IArrowArray[]
{
schemaNameBuilder.Build()
};
Schema schema = GetObjectSchema("Name");
schema.Validate(dataArrays);
IArrowArrayStream stream = new BigQueryInfoArrowStream(schema, dataArrays);
return Task.FromResult(new QueryResult(dataArrays[0].Length, stream));
}
protected Task<QueryResult> GetCatalogs(Activity? activity)
{
StringArray.Builder catalogNameBuilder = new StringArray.Builder();
List<string> projectIds = new List<string>();
Func<Task<PagedEnumerable<ProjectList, CloudProject>?>> func = () => Task.Run(() =>
{
// stick with this call because PagedAsyncEnumerable has different behaviors for selecting items
return Client?.ListProjects();
});
PagedEnumerable<ProjectList, CloudProject>? catalogs;
catalogs = ExecuteWithRetriesAsync<PagedEnumerable<ProjectList, CloudProject>?>(func, activity).GetAwaiter().GetResult();
if (catalogs != null)
{
projectIds = catalogs.Select(x => x.ProjectId).ToList();
}
if (this.bigQueryConnection.IncludePublicProjectIds && !projectIds.Contains(BigQueryConstants.PublicProjectId))
{
projectIds.Add(BigQueryConstants.PublicProjectId);
}
projectIds.Sort();
foreach (string projectId in projectIds)
{
catalogNameBuilder.Append(projectId);
}
IArrowArray[] dataArrays = new IArrowArray[]
{
catalogNameBuilder.Build()
};
Schema schema = GetObjectSchema("Name");
schema.Validate(dataArrays);
IArrowArrayStream stream = new BigQueryInfoArrowStream(schema, dataArrays);
return Task.FromResult(new QueryResult(dataArrays[0].Length, stream));
}
private async Task<IEnumerable<IArrowReader>> GetArrowReaders(
TokenProtectedReadClientManger clientMgr,
string table,
string projectId,
int maxStreamCount,
Activity? activity,
CancellationToken cancellationToken = default)
{
ReadSession rs = new ReadSession { Table = table, DataFormat = DataFormat.Arrow };
BigQueryReadClient bigQueryReadClient = clientMgr.ReadClient;
ReadSession rrs = await bigQueryReadClient.CreateReadSessionAsync("projects/" + projectId, rs, maxStreamCount);
var readers = rrs.Streams
.Select(s => ReadChunk(bigQueryReadClient, s.Name, activity, this.bigQueryConnection.IsSafeToTrace, cancellationToken))
.Where(chunk => chunk != null)
.Cast<IArrowReader>();
return readers;
}
public override UpdateResult ExecuteUpdate()
{
try
{
return ExecuteUpdateInternalAsync().GetAwaiter().GetResult();
}
catch (Exception ex) when (BigQueryConnection.IsUnauthorizedException(ex, out GoogleApiException? googleEx))
{
throw new AdbcException(googleEx!.Message, AdbcStatusCode.Unauthorized, ex);
}
}
public override void Cancel()
{
this.TraceActivity(_ =>
{
this.cancellationRegistry.CancelAll();
}, ClassName + "." + nameof(Cancel));
}
public override void Dispose()
{
this.cancellationRegistry.Dispose();
base.Dispose();
}
private Schema GetObjectSchema(string objectName)
{
return new Schema(
new Field[]
{
new Field(objectName, StringType.Default, false)
},
metadata: null);
}
private async Task<UpdateResult> ExecuteUpdateInternalAsync()
{
return await this.TraceActivityAsync(async activity =>
{
GetQueryResultsOptions getQueryResultsOptions = new GetQueryResultsOptions();
if (Options?.TryGetValue(BigQueryParameters.GetQueryResultsOptionsTimeout, out string? timeoutSeconds) == true &&
int.TryParse(timeoutSeconds, out int seconds) &&
seconds >= 0)
{
getQueryResultsOptions.Timeout = TimeSpan.FromSeconds(seconds);
activity?.AddBigQueryParameterTag(BigQueryParameters.GetQueryResultsOptionsTimeout, seconds);
}
activity?.AddConditionalTag(SemanticConventions.Db.Query.Text, SqlQuery, this.bigQueryConnection.IsSafeToTrace);
using JobCancellationContext context = new(cancellationRegistry);
// Cannot set destination table in jobs with DDL statements, otherwise an error will be prompted
Func<Task<BigQueryResults?>> getQueryResultsAsyncFunc = async () =>
{
return await ExecuteCancellableJobAsync(context, activity, async (context) =>
{
context.Job = await this.Client.CreateQueryJobAsync(SqlQuery, null, null, context.CancellationToken).ConfigureAwait(false);
return await context.Job.GetQueryResultsAsync(getQueryResultsOptions, context.CancellationToken).ConfigureAwait(false);
}).ConfigureAwait(false);
};
BigQueryResults? result = await ExecuteWithRetriesAsync(getQueryResultsAsyncFunc, activity, context.CancellationToken);
long updatedRows = result?.NumDmlAffectedRows.HasValue == true ? result.NumDmlAffectedRows.Value : -1L;
activity?.AddTag(SemanticConventions.Db.Response.ReturnedRows, updatedRows);
return new UpdateResult(updatedRows);
}, ClassName + "." + nameof(ExecuteUpdateInternalAsync));
}
private Schema TranslateSchema(TableSchema schema)
{
return new Schema(schema.Fields.Select(TranslateField), null);
}
private Field TranslateField(TableFieldSchema field)
{
List<KeyValuePair<string, string>> metadata = new List<KeyValuePair<string, string>>()
{
new KeyValuePair<string, string>("BIGQUERY_TYPE", field.Type),
new KeyValuePair<string, string>("BIGQUERY_MODE", field.Mode)
};
return new Field(field.Name, TranslateType(field), field.Mode == "NULLABLE", metadata);
}
private IArrowType TranslateType(TableFieldSchema field)
{
// per https://developers.google.com/resources/api-libraries/documentation/bigquery/v2/java/latest/com/google/api/services/bigquery/model/TableFieldSchema.html#getType--
switch (field.Type)
{
case "INTEGER" or "INT64":
return GetType(field, Int64Type.Default);
case "FLOAT" or "FLOAT64":
return GetType(field, DoubleType.Default);
case "BOOL" or "BOOLEAN":
return GetType(field, BooleanType.Default);
case "STRING":
return GetType(field, StringType.Default);
case "BYTES":
return GetType(field, BinaryType.Default);
case "DATETIME":
return GetType(field, TimestampType.Default);
case "TIMESTAMP":
return GetType(field, TimestampType.Default);
case "TIME":
return GetType(field, Time64Type.Microsecond);
case "DATE":
return GetType(field, Date32Type.Default);
case "RECORD" or "STRUCT":
return GetType(field, BuildStructType(field));
// treat these values as strings
case "GEOGRAPHY" or "JSON":
return GetType(field, StringType.Default);
// get schema cannot get precision and scale for NUMERIC or BIGNUMERIC types
// instead, the max values are returned from BigQuery
// see 'precision' on https://cloud.google.com/bigquery/docs/reference/rest/v2/tables
// and discussion in https://github.com/apache/arrow-adbc/pull/1192#discussion_r1365987279
case "NUMERIC" or "DECIMAL":
return GetType(field, new Decimal128Type(38, 9));
case "BIGNUMERIC" or "BIGDECIMAL":
if (Options != null)
return bool.Parse(Options[BigQueryParameters.LargeDecimalsAsString]) ? GetType(field, StringType.Default) : GetType(field, new Decimal256Type(76, 38));
else
return GetType(field, StringType.Default);
default: throw new InvalidOperationException($"{field.Type} cannot be translated");
}
}
private StructType BuildStructType(TableFieldSchema field)
{
List<Field> arrowFields = new List<Field>();
foreach (TableFieldSchema subfield in field.Fields)
{
Field arrowField = TranslateField(subfield);
arrowFields.Add(arrowField);
}
return new StructType(arrowFields.AsReadOnly());
}
private IArrowType GetType(TableFieldSchema field, IArrowType type)
{
if (field.Mode == "REPEATED")
return new ListType(type);
return type;
}
private static IArrowReader? ReadChunk(BigQueryReadClient client, string streamName, Activity? activity, bool isSafeToTrace, CancellationToken cancellationToken = default)
{
// Ideally we wouldn't need to indirect through a stream, but the necessary APIs in Arrow
// are internal. (TODO: consider changing Arrow).
activity?.AddConditionalBigQueryTag("read_stream", streamName, isSafeToTrace);
BigQueryReadClient.ReadRowsStream readRowsStream = client.ReadRows(new ReadRowsRequest { ReadStream = streamName });
IAsyncEnumerator<ReadRowsResponse> enumerator = readRowsStream.GetResponseStream().GetAsyncEnumerator(cancellationToken);
ReadRowsStream stream = new ReadRowsStream(enumerator);
activity?.AddBigQueryTag("read_stream.has_rows", stream.HasRows);
return stream.HasRows ? stream : null;
}
private QueryOptions ValidateOptions(Activity? activity)
{
QueryOptions options = new QueryOptions();
if (Client.ProjectId == BigQueryConstants.DetectProjectId)
{
activity?.AddBigQueryTag("client_project_id", BigQueryConstants.DetectProjectId);
// An error occurs when calling CreateQueryJob without the ID set,
// so use the first one that is found. This does not prevent from calling
// to other 'project IDs' (catalogs) with a query.
Func<Task<PagedEnumerable<ProjectList, CloudProject>?>> func = () => Task.Run(() =>
{
return Client?.ListProjects();
});
PagedEnumerable<ProjectList, CloudProject>? projects = ExecuteWithRetriesAsync<PagedEnumerable<ProjectList, CloudProject>?>(func, activity).GetAwaiter().GetResult();
if (projects != null)
{
string? firstProjectId = projects.Select(x => x.ProjectId).FirstOrDefault();
if (firstProjectId != null)
{
options.ProjectId = firstProjectId;
activity?.AddBigQueryTag("detected_client_project_id", firstProjectId);
// need to reopen the Client with the projectId specified
this.bigQueryConnection.Open(firstProjectId);
}
}
}
if (Options == null || Options.Count == 0)
return options;
string largeResultDatasetId = BigQueryConstants.DefaultLargeDatasetId;
foreach (KeyValuePair<string, string> keyValuePair in Options)
{
switch (keyValuePair.Key)
{
case BigQueryParameters.AllowLargeResults:
options.AllowLargeResults = true ? keyValuePair.Value.Equals("true", StringComparison.OrdinalIgnoreCase) : false;
activity?.AddBigQueryParameterTag(BigQueryParameters.AllowLargeResults, options.AllowLargeResults);
break;
case BigQueryParameters.LargeResultsDataset:
largeResultDatasetId = keyValuePair.Value;
activity?.AddBigQueryParameterTag(BigQueryParameters.LargeResultsDataset, largeResultDatasetId);
break;
case BigQueryParameters.LargeResultsDestinationTable:
string destinationTable = keyValuePair.Value;
if (!destinationTable.Contains("."))
{
throw new InvalidOperationException($"{BigQueryParameters.LargeResultsDestinationTable} is invalid");
}
string projectId = string.Empty;
string datasetId = string.Empty;
string tableId = string.Empty;
string[] segments = destinationTable.Split('.');
if (segments.Length != 3)
throw new InvalidOperationException($"{BigQueryParameters.LargeResultsDestinationTable} cannot be parsed");
projectId = segments[0];
datasetId = segments[1];
tableId = segments[2];
if (string.IsNullOrEmpty(projectId.Trim()) || string.IsNullOrEmpty(datasetId.Trim()) || string.IsNullOrEmpty(tableId.Trim()))
throw new InvalidOperationException($"{BigQueryParameters.LargeResultsDestinationTable} contains invalid values");
options.DestinationTable = new TableReference()
{
ProjectId = projectId,
DatasetId = datasetId,
TableId = tableId
};
activity?.AddBigQueryParameterTag(BigQueryParameters.LargeResultsDestinationTable, destinationTable);
break;
case BigQueryParameters.UseLegacySQL:
options.UseLegacySql = true ? keyValuePair.Value.Equals("true", StringComparison.OrdinalIgnoreCase) : false;
activity?.AddBigQueryParameterTag(BigQueryParameters.UseLegacySQL, options.UseLegacySql);
break;
case BigQueryParameters.IsMetadataCommand:
isMetadataCommand = keyValuePair.Value.Equals("true", StringComparison.OrdinalIgnoreCase);
activity?.AddBigQueryParameterTag(BigQueryParameters.IsMetadataCommand, isMetadataCommand);
break;
case BigQueryParameters.CatalogName:
catalogName = keyValuePair.Value;
break;
case BigQueryParameters.SchemaName:
schemaName = keyValuePair.Value;
break;
case BigQueryParameters.TableName:
tableName = keyValuePair.Value;
break;
}
}
if (options.AllowLargeResults == true && options.DestinationTable == null)
{
options.DestinationTable = TryGetLargeDestinationTableReference(largeResultDatasetId, activity);
}
return options;
}
/// <summary>
/// Attempts to retrieve or create the specified dataset.
/// </summary>
/// <param name="datasetId">The name of the dataset.</param>
/// <param name="activity">The current activity for tracing.</param>
/// <returns>A <see cref="TableReference"/> to a randomly generated table name in the specified dataset.</returns>
private TableReference TryGetLargeDestinationTableReference(string datasetId, Activity? activity)
{
BigQueryDataset? dataset = null;
try
{
activity?.AddBigQueryTag("large_results.dataset.try_find", datasetId);
dataset = this.Client.GetDataset(datasetId);
activity?.AddBigQueryTag("large_results.dataset.found", datasetId);
}
catch (GoogleApiException gaEx)
{
if (gaEx.HttpStatusCode != System.Net.HttpStatusCode.NotFound)
{
activity?.AddException(gaEx);
throw new AdbcException($"Failure trying to retrieve dataset {datasetId}", gaEx);