/
BigQueryConnection.cs
981 lines (848 loc) · 41.4 KB
/
BigQueryConnection.cs
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
/*
* 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.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Text.RegularExpressions;
using Apache.Arrow.Ipc;
using Apache.Arrow.Types;
using Google.Api.Gax;
using Google.Apis.Auth.OAuth2;
using Google.Apis.Bigquery.v2.Data;
using Google.Cloud.BigQuery.V2;
namespace Apache.Arrow.Adbc.Drivers.BigQuery
{
/// <summary>
/// BigQuery-specific implementation of <see cref="AdbcConnection"/>
/// </summary>
public class BigQueryConnection : AdbcConnection
{
readonly IReadOnlyDictionary<string, string> properties;
BigQueryClient? client;
GoogleCredential? credential;
const string infoDriverName = "ADBC BigQuery Driver";
const string infoDriverVersion = "1.0.0";
const string infoVendorName = "BigQuery";
const string infoDriverArrowVersion = "1.0.0";
readonly IReadOnlyList<AdbcInfoCode> infoSupportedCodes = new List<AdbcInfoCode> {
AdbcInfoCode.DriverName,
AdbcInfoCode.DriverVersion,
AdbcInfoCode.DriverArrowVersion,
AdbcInfoCode.VendorName
};
public BigQueryConnection(IReadOnlyDictionary<string, string> properties)
{
this.properties = properties;
// add the default value for now and set to true until C# has a BigDecimal
Dictionary<string, string> modifiedProperties = this.properties.ToDictionary(k => k.Key, v => v.Value);
modifiedProperties[BigQueryParameters.LargeDecimalsAsString] = BigQueryConstants.TreatLargeDecimalAsString;
this.properties = new ReadOnlyDictionary<string, string>(modifiedProperties);
}
/// <summary>
/// Initializes the internal BigQuery connection
/// </summary>
/// <exception cref="ArgumentException"></exception>
internal void Open()
{
string projectId = string.Empty;
string clientId = string.Empty;
string clientSecret = string.Empty;
string refreshToken = string.Empty;
string tokenEndpoint = BigQueryConstants.TokenEndpoint;
string authenticationType = BigQueryConstants.UserAuthenticationType;
// TODO: handle token expiration
if (!this.properties.TryGetValue(BigQueryParameters.ProjectId, out projectId))
throw new ArgumentException($"The {BigQueryParameters.ProjectId} parameter is not present");
if (this.properties.ContainsKey(BigQueryParameters.AuthenticationType))
{
this.properties.TryGetValue(BigQueryParameters.AuthenticationType, out authenticationType);
if(!authenticationType.Equals(BigQueryConstants.UserAuthenticationType, StringComparison.OrdinalIgnoreCase) &&
!authenticationType.Equals(BigQueryConstants.ServiceAccountAuthenticationType, StringComparison.OrdinalIgnoreCase))
{
throw new ArgumentException($"The {BigQueryParameters.AuthenticationType} parameter can only be `{BigQueryConstants.UserAuthenticationType}` or `{BigQueryConstants.ServiceAccountAuthenticationType}`");
}
}
if (authenticationType.Equals(BigQueryConstants.UserAuthenticationType, StringComparison.OrdinalIgnoreCase))
{
if (!this.properties.TryGetValue(BigQueryParameters.ClientId, out clientId))
throw new ArgumentException($"The {BigQueryParameters.ClientId} parameter is not present");
if (!this.properties.TryGetValue(BigQueryParameters.ClientSecret, out clientSecret))
throw new ArgumentException($"The {BigQueryParameters.ClientSecret} parameter is not present");
if (!this.properties.TryGetValue(BigQueryParameters.RefreshToken, out refreshToken))
throw new ArgumentException($"The {BigQueryParameters.RefreshToken} parameter is not present");
this.credential = GoogleCredential.FromAccessToken(GetAccessToken(clientId, clientSecret, refreshToken, tokenEndpoint));
}
else
{
string json = string.Empty;
if (!this.properties.TryGetValue(BigQueryParameters.JsonCredential, out json))
throw new ArgumentException($"The {BigQueryParameters.JsonCredential} parameter is not present");
this.credential = GoogleCredential.FromJson(json);
}
this.client = BigQueryClient.Create(projectId, this.credential);
}
public override IArrowArrayStream GetInfo(List<AdbcInfoCode> codes)
{
const int strValTypeID = 0;
UnionType infoUnionType = new UnionType(
new List<Field>()
{
new Field("string_value", StringType.Default, true),
new Field("bool_value", BooleanType.Default, true),
new Field("int64_value", Int64Type.Default, true),
new Field("int32_bitmask", Int32Type.Default, true),
new Field(
"string_list",
new ListType(
new Field("item", StringType.Default, true)
),
false
),
new Field(
"int32_to_int32_list_map",
new ListType(
new Field("entries", new StructType(
new List<Field>()
{
new Field("key", Int32Type.Default, false),
new Field("value", Int32Type.Default, true),
}
), false)
),
true
)
},
new int[] { 0, 1, 2, 3, 4, 5 }.ToArray(),
UnionMode.Dense);
if (codes.Count == 0)
{
codes = new List<AdbcInfoCode>(infoSupportedCodes);
}
UInt32Array.Builder infoNameBuilder = new UInt32Array.Builder();
ArrowBuffer.Builder<byte> typeBuilder = new ArrowBuffer.Builder<byte>();
ArrowBuffer.Builder<int> offsetBuilder = new ArrowBuffer.Builder<int>();
StringArray.Builder stringInfoBuilder = new StringArray.Builder();
int nullCount = 0;
int arrayLength = codes.Count;
foreach (AdbcInfoCode code in codes)
{
switch (code)
{
case AdbcInfoCode.DriverName:
infoNameBuilder.Append((UInt32)code);
typeBuilder.Append(strValTypeID);
offsetBuilder.Append(stringInfoBuilder.Length);
stringInfoBuilder.Append(infoDriverName);
break;
case AdbcInfoCode.DriverVersion:
infoNameBuilder.Append((UInt32)code);
typeBuilder.Append(strValTypeID);
offsetBuilder.Append(stringInfoBuilder.Length);
stringInfoBuilder.Append(infoDriverVersion);
break;
case AdbcInfoCode.DriverArrowVersion:
infoNameBuilder.Append((UInt32)code);
typeBuilder.Append(strValTypeID);
offsetBuilder.Append(stringInfoBuilder.Length);
stringInfoBuilder.Append(infoDriverArrowVersion);
break;
case AdbcInfoCode.VendorName:
infoNameBuilder.Append((UInt32)code);
typeBuilder.Append(strValTypeID);
offsetBuilder.Append(stringInfoBuilder.Length);
stringInfoBuilder.Append(infoVendorName);
break;
default:
infoNameBuilder.Append((UInt32)code);
typeBuilder.Append(strValTypeID);
offsetBuilder.Append(stringInfoBuilder.Length);
stringInfoBuilder.AppendNull();
nullCount++;
break;
}
}
StructType entryType = new StructType(
new List<Field>(){
new Field("key", Int32Type.Default, false),
new Field("value", Int32Type.Default, true)});
StructArray entriesDataArray = new StructArray(entryType, 0,
new[] { new Int32Array.Builder().Build(), new Int32Array.Builder().Build() },
new ArrowBuffer.BitmapBuilder().Build());
List<IArrowArray> childrenArrays = new List<IArrowArray>()
{
stringInfoBuilder.Build(),
new BooleanArray.Builder().Build(),
new Int64Array.Builder().Build(),
new Int32Array.Builder().Build(),
new ListArray.Builder(StringType.Default).Build(),
CreateNestedListArray(new List<IArrowArray?>(){ entriesDataArray }, entryType)
};
DenseUnionArray infoValue = new DenseUnionArray(infoUnionType, arrayLength, childrenArrays, typeBuilder.Build(), offsetBuilder.Build(), nullCount);
List<IArrowArray> dataArrays = new List<IArrowArray>
{
infoNameBuilder.Build(),
infoValue
};
return new BigQueryInfoArrowStream(StandardSchemas.GetInfoSchema, dataArrays, 4);
}
public override IArrowArrayStream GetObjects(
GetObjectsDepth depth,
string catalogPattern,
string dbSchemaPattern,
string tableNamePattern,
List<string> tableTypes,
string columnNamePattern)
{
List<IArrowArray> dataArrays = GetCatalogs(depth, catalogPattern, dbSchemaPattern,
tableNamePattern, tableTypes, columnNamePattern);
return new BigQueryInfoArrowStream(StandardSchemas.GetObjectsSchema, dataArrays, 1);
}
private List<IArrowArray> GetCatalogs(
GetObjectsDepth depth,
string catalogPattern,
string dbSchemaPattern,
string tableNamePattern,
List<string> tableTypes,
string columnNamePattern)
{
StringArray.Builder catalogNameBuilder = new StringArray.Builder();
List<IArrowArray?> catalogDbSchemasValues = new List<IArrowArray?>();
string catalogRegexp = PatternToRegEx(catalogPattern);
PagedEnumerable<ProjectList, CloudProject> catalogs = this.client.ListProjects();
foreach (CloudProject catalog in catalogs)
{
if (Regex.IsMatch(catalog.ProjectId, catalogRegexp, RegexOptions.IgnoreCase))
{
catalogNameBuilder.Append(catalog.ProjectId);
if (depth == GetObjectsDepth.Catalogs)
{
catalogDbSchemasValues.Add(null);
}
else
{
catalogDbSchemasValues.Add(GetDbSchemas(
depth, catalog.ProjectId, dbSchemaPattern,
tableNamePattern, tableTypes, columnNamePattern));
}
}
}
List<IArrowArray> dataArrays = new List<IArrowArray>
{
catalogNameBuilder.Build(),
CreateNestedListArray(catalogDbSchemasValues, new StructType(StandardSchemas.DbSchemaSchema)),
};
return dataArrays;
}
private StructArray GetDbSchemas(
GetObjectsDepth depth,
string catalog,
string dbSchemaPattern,
string tableNamePattern,
List<string> tableTypes,
string columnNamePattern)
{
StringArray.Builder dbSchemaNameBuilder = new StringArray.Builder();
List<IArrowArray?> dbSchemaTablesValues = new List<IArrowArray?>();
ArrowBuffer.BitmapBuilder nullBitmapBuffer = new ArrowBuffer.BitmapBuilder();
int length = 0;
string dbSchemaRegexp = PatternToRegEx(dbSchemaPattern);
PagedEnumerable<DatasetList, BigQueryDataset> schemas = this.client.ListDatasets(catalog);
foreach (BigQueryDataset schema in schemas)
{
if (Regex.IsMatch(schema.Reference.DatasetId, dbSchemaRegexp, RegexOptions.IgnoreCase))
{
dbSchemaNameBuilder.Append(schema.Reference.DatasetId);
length++;
nullBitmapBuffer.Append(true);
if (depth == GetObjectsDepth.DbSchemas)
{
dbSchemaTablesValues.Add(null);
}
else
{
dbSchemaTablesValues.Add(GetTableSchemas(
depth, catalog, schema.Reference.DatasetId,
tableNamePattern, tableTypes, columnNamePattern));
}
}
}
List<IArrowArray> dataArrays = new List<IArrowArray>
{
dbSchemaNameBuilder.Build(),
CreateNestedListArray(dbSchemaTablesValues, new StructType(StandardSchemas.TableSchema)),
};
return new StructArray(
new StructType(StandardSchemas.DbSchemaSchema),
length,
dataArrays,
nullBitmapBuffer.Build());
}
private StructArray GetTableSchemas(
GetObjectsDepth depth,
string catalog,
string dbSchema,
string tableNamePattern,
List<string> tableTypes,
string columnNamePattern)
{
StringArray.Builder tableNameBuilder = new StringArray.Builder();
StringArray.Builder tableTypeBuilder = new StringArray.Builder();
List<IArrowArray?> tableColumnsValues = new List<IArrowArray?>();
List<IArrowArray?> tableConstraintsValues = new List<IArrowArray?>();
ArrowBuffer.BitmapBuilder nullBitmapBuffer = new ArrowBuffer.BitmapBuilder();
int length = 0;
string query = string.Format("SELECT * FROM `{0}`.`{1}`.INFORMATION_SCHEMA.TABLES",
Sanitize(catalog), Sanitize(dbSchema));
if (tableNamePattern != null)
{
query = string.Concat(query, string.Format(" WHERE table_name LIKE '{0}'", Sanitize(tableNamePattern)));
if (tableTypes.Count > 0)
{
List<string> sanitizedTypes = tableTypes.Select(x => Sanitize(x)).ToList();
query = string.Concat(query, string.Format(" AND table_type IN ('{0}')", string.Join("', '", sanitizedTypes).ToUpper()));
}
}
else
{
if (tableTypes.Count > 0)
{
List<string> sanitizedTypes = tableTypes.Select(x => Sanitize(x)).ToList();
query = string.Concat(query, string.Format(" WHERE table_type IN ('{0}')", string.Join("', '", sanitizedTypes).ToUpper()));
}
}
BigQueryResults result = this.client.ExecuteQuery(query, parameters: null);
foreach (BigQueryRow row in result)
{
tableNameBuilder.Append(row["table_name"].ToString());
tableTypeBuilder.Append(row["table_type"].ToString());
nullBitmapBuffer.Append(true);
length++;
tableConstraintsValues.Add(GetConstraintSchema(
depth, catalog, dbSchema, row["table_name"].ToString(), columnNamePattern));
if (depth == GetObjectsDepth.Tables)
{
tableColumnsValues.Add(null);
}
else
{
tableColumnsValues.Add(GetColumnSchema(catalog, dbSchema, row["table_name"].ToString(), columnNamePattern));
}
}
List<IArrowArray> dataArrays = new List<IArrowArray>
{
tableNameBuilder.Build(),
tableTypeBuilder.Build(),
CreateNestedListArray(tableColumnsValues, new StructType(StandardSchemas.ColumnSchema)),
CreateNestedListArray(tableConstraintsValues, new StructType(StandardSchemas.ConstraintSchema))
};
return new StructArray(
new StructType(StandardSchemas.TableSchema),
length,
dataArrays,
nullBitmapBuffer.Build());
}
private StructArray GetColumnSchema(
string catalog,
string dbSchema,
string table,
string columnNamePattern)
{
StringArray.Builder columnNameBuilder = new StringArray.Builder();
Int32Array.Builder ordinalPositionBuilder = new Int32Array.Builder();
StringArray.Builder remarksBuilder = new StringArray.Builder();
Int16Array.Builder xdbcDataTypeBuilder = new Int16Array.Builder();
StringArray.Builder xdbcTypeNameBuilder = new StringArray.Builder();
Int32Array.Builder xdbcColumnSizeBuilder = new Int32Array.Builder();
Int16Array.Builder xdbcDecimalDigitsBuilder = new Int16Array.Builder();
Int16Array.Builder xdbcNumPrecRadixBuilder = new Int16Array.Builder();
Int16Array.Builder xdbcNullableBuilder = new Int16Array.Builder();
StringArray.Builder xdbcColumnDefBuilder = new StringArray.Builder();
Int16Array.Builder xdbcSqlDataTypeBuilder = new Int16Array.Builder();
Int16Array.Builder xdbcDatetimeSubBuilder = new Int16Array.Builder();
Int32Array.Builder xdbcCharOctetLengthBuilder = new Int32Array.Builder();
StringArray.Builder xdbcIsNullableBuilder = new StringArray.Builder();
StringArray.Builder xdbcScopeCatalogBuilder = new StringArray.Builder();
StringArray.Builder xdbcScopeSchemaBuilder = new StringArray.Builder();
StringArray.Builder xdbcScopeTableBuilder = new StringArray.Builder();
BooleanArray.Builder xdbcIsAutoincrementBuilder = new BooleanArray.Builder();
BooleanArray.Builder xdbcIsGeneratedcolumnBuilder = new BooleanArray.Builder();
ArrowBuffer.BitmapBuilder nullBitmapBuffer = new ArrowBuffer.BitmapBuilder();
int length = 0;
string query = string.Format("SELECT * FROM `{0}`.`{1}`.INFORMATION_SCHEMA.COLUMNS WHERE table_name = '{2}'",
Sanitize(catalog), Sanitize(dbSchema), Sanitize(table));
if (columnNamePattern != null)
{
query = string.Concat(query, string.Format("AND column_name LIKE '{0}'", Sanitize(columnNamePattern)));
}
BigQueryResults result = this.client.ExecuteQuery(query, parameters: null);
foreach (BigQueryRow row in result)
{
columnNameBuilder.Append(row["column_name"].ToString());
ordinalPositionBuilder.Append((int)(long)row["ordinal_position"]);
remarksBuilder.Append("");
xdbcDataTypeBuilder.AppendNull();
string dataType = ToTypeName(row["data_type"].ToString());
xdbcTypeNameBuilder.Append(dataType);
xdbcColumnSizeBuilder.AppendNull();
xdbcDecimalDigitsBuilder.AppendNull();
xdbcNumPrecRadixBuilder.AppendNull();
xdbcNullableBuilder.AppendNull();
xdbcColumnDefBuilder.AppendNull();
xdbcSqlDataTypeBuilder.Append((short)ToXdbcDataType(dataType));
xdbcDatetimeSubBuilder.AppendNull();
xdbcCharOctetLengthBuilder.AppendNull();
xdbcIsNullableBuilder.Append(row["is_nullable"].ToString());
xdbcScopeCatalogBuilder.AppendNull();
xdbcScopeSchemaBuilder.AppendNull();
xdbcScopeTableBuilder.AppendNull();
xdbcIsAutoincrementBuilder.AppendNull();
xdbcIsGeneratedcolumnBuilder.Append(row["is_generated"].ToString().ToUpper() == "YES");
nullBitmapBuffer.Append(true);
length++;
}
List<IArrowArray> dataArrays = new List<IArrowArray>
{
columnNameBuilder.Build(),
ordinalPositionBuilder.Build(),
remarksBuilder.Build(),
xdbcDataTypeBuilder.Build(),
xdbcTypeNameBuilder.Build(),
xdbcColumnSizeBuilder.Build(),
xdbcDecimalDigitsBuilder.Build(),
xdbcNumPrecRadixBuilder.Build(),
xdbcNullableBuilder.Build(),
xdbcColumnDefBuilder.Build(),
xdbcSqlDataTypeBuilder.Build(),
xdbcDatetimeSubBuilder.Build(),
xdbcCharOctetLengthBuilder.Build(),
xdbcIsNullableBuilder.Build(),
xdbcScopeCatalogBuilder.Build(),
xdbcScopeSchemaBuilder.Build(),
xdbcScopeTableBuilder.Build(),
xdbcIsAutoincrementBuilder.Build(),
xdbcIsGeneratedcolumnBuilder.Build()
};
return new StructArray(
new StructType(StandardSchemas.ColumnSchema),
length,
dataArrays,
nullBitmapBuffer.Build());
}
private StructArray GetConstraintSchema(
GetObjectsDepth depth,
string catalog,
string dbSchema,
string table,
string columnNamePattern)
{
StringArray.Builder constraintNameBuilder = new StringArray.Builder();
StringArray.Builder constraintTypeBuilder = new StringArray.Builder();
List<IArrowArray?> constraintColumnNamesValues = new List<IArrowArray?>();
List<IArrowArray?> constraintColumnUsageValues = new List<IArrowArray?>();
ArrowBuffer.BitmapBuilder nullBitmapBuffer = new ArrowBuffer.BitmapBuilder();
int length = 0;
string query = string.Format("SELECT * FROM `{0}`.`{1}`.INFORMATION_SCHEMA.TABLE_CONSTRAINTS WHERE table_name = '{2}'",
Sanitize(catalog), Sanitize(dbSchema), Sanitize(table));
BigQueryResults result = this.client.ExecuteQuery(query, parameters: null);
foreach (BigQueryRow row in result)
{
string constraintName = row["constraint_name"].ToString();
constraintNameBuilder.Append(constraintName);
string constraintType = row["constraint_type"].ToString();
constraintTypeBuilder.Append(constraintType);
nullBitmapBuffer.Append(true);
length++;
if (depth == GetObjectsDepth.All)
{
constraintColumnNamesValues.Add(GetConstraintColumnNames(
catalog, dbSchema, table, constraintName));
if (constraintType.ToUpper() == "FOREIGN KEY")
{
constraintColumnUsageValues.Add(GetConstraintsUsage(
catalog, dbSchema, table, constraintName));
}
else
{
constraintColumnUsageValues.Add(null);
}
}
else
{
constraintColumnNamesValues.Add(null);
constraintColumnUsageValues.Add(null);
}
}
List<IArrowArray> dataArrays = new List<IArrowArray>
{
constraintNameBuilder.Build(),
constraintTypeBuilder.Build(),
CreateNestedListArray(constraintColumnNamesValues, StringType.Default),
CreateNestedListArray(constraintColumnUsageValues, new StructType(StandardSchemas.UsageSchema))
};
return new StructArray(
new StructType(StandardSchemas.ConstraintSchema),
length,
dataArrays,
nullBitmapBuffer.Build());
}
private StringArray GetConstraintColumnNames(
string catalog,
string dbSchema,
string table,
string constraintName)
{
string query = string.Format("SELECT * FROM `{0}`.`{1}`.INFORMATION_SCHEMA.KEY_COLUMN_USAGE WHERE table_name = '{2}' AND constraint_name = '{3}' ORDER BY ordinal_position",
Sanitize(catalog), Sanitize(dbSchema), Sanitize(table), Sanitize(constraintName));
StringArray.Builder constraintColumnNamesBuilder = new StringArray.Builder();
BigQueryResults result = this.client.ExecuteQuery(query, parameters: null);
foreach (BigQueryRow row in result)
{
constraintColumnNamesBuilder.Append(row["column_name"].ToString());
}
return constraintColumnNamesBuilder.Build();
}
private StructArray GetConstraintsUsage(
string catalog,
string dbSchema,
string table,
string constraintName)
{
StringArray.Builder constraintFkCatalogBuilder = new StringArray.Builder();
StringArray.Builder constraintFkDbSchemaBuilder = new StringArray.Builder();
StringArray.Builder constraintFkTableBuilder = new StringArray.Builder();
StringArray.Builder constraintFkColumnNameBuilder = new StringArray.Builder();
ArrowBuffer.BitmapBuilder nullBitmapBuffer = new ArrowBuffer.BitmapBuilder();
int length = 0;
string query = string.Format("SELECT * FROM `{0}`.`{1}`.INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE WHERE table_name = '{2}' AND constraint_name = '{3}'",
Sanitize(catalog), Sanitize(dbSchema), Sanitize(table), Sanitize(constraintName));
BigQueryResults result = this.client.ExecuteQuery(query, parameters: null);
foreach (BigQueryRow row in result)
{
constraintFkCatalogBuilder.Append(row["constraint_catalog"].ToString());
constraintFkDbSchemaBuilder.Append(row["constraint_schema"].ToString());
constraintFkTableBuilder.Append(row["table_name"].ToString());
constraintFkColumnNameBuilder.Append(row["column_name"].ToString());
nullBitmapBuffer.Append(true);
length++;
}
List<IArrowArray> dataArrays = new List<IArrowArray>
{
constraintFkCatalogBuilder.Build(),
constraintFkDbSchemaBuilder.Build(),
constraintFkTableBuilder.Build(),
constraintFkColumnNameBuilder.Build()
};
return new StructArray(
new StructType(StandardSchemas.UsageSchema),
length,
dataArrays,
nullBitmapBuffer.Build());
}
private string PatternToRegEx(string pattern)
{
if (pattern == null)
return ".*";
StringBuilder builder = new StringBuilder("(?i)^");
string convertedPattern = pattern.Replace("_", ".").Replace("%", ".*");
builder.Append(convertedPattern);
builder.Append("$");
return builder.ToString();
}
private string ToTypeName(string type)
{
int index = Math.Min(type.IndexOf("("), type.IndexOf("<"));
string dataType = index == -1 ? type : type.Substring(0, index);
return dataType;
}
private XdbcDataType ToXdbcDataType(string type)
{
switch (type)
{
case "INTEGER" or "INT64":
return XdbcDataType.XdbcDataType_XDBC_INTEGER;
case "FLOAT" or "FLOAT64":
return XdbcDataType.XdbcDataType_XDBC_FLOAT;
case "BOOL" or "BOOLEAN":
return XdbcDataType.XdbcDataType_XDBC_BIT;
case "STRING" or "GEOGRAPHY" or "JSON":
return XdbcDataType.XdbcDataType_XDBC_VARCHAR;
case "BYTES":
return XdbcDataType.XdbcDataType_XDBC_BINARY;
case "DATETIME":
return XdbcDataType.XdbcDataType_XDBC_DATETIME;
case "TIMESTAMP":
return XdbcDataType.XdbcDataType_XDBC_TIMESTAMP;
case "TIME":
return XdbcDataType.XdbcDataType_XDBC_TIME;
case "DATE":
return XdbcDataType.XdbcDataType_XDBC_DATE;
case "RECORD" or "STRUCT":
return XdbcDataType.XdbcDataType_XDBC_VARBINARY;
case "NUMERIC" or "DECIMAL" or "BIGNUMERIC" or "BIGDECIMAL":
return XdbcDataType.XdbcDataType_XDBC_NUMERIC;
default:
return XdbcDataType.XdbcDataType_XDBC_UNKNOWN_TYPE;
}
}
public override Schema GetTableSchema(string catalog, string dbSchema, string tableName)
{
string query = string.Format("SELECT * FROM `{0}`.`{1}`.INFORMATION_SCHEMA.COLUMNS WHERE table_name = '{2}'",
Sanitize(catalog), Sanitize(dbSchema), Sanitize(tableName));
BigQueryResults result = this.client.ExecuteQuery(query, parameters: null);
List<Field> fields = new List<Field>();
foreach (BigQueryRow row in result)
{
fields.Add(DescToField(row));
}
return new Schema(fields, null);
}
private Field DescToField(BigQueryRow row)
{
Dictionary<string, string> metaData = new Dictionary<string, string>();
metaData.Add("PRIMARY_KEY", "");
metaData.Add("ORDINAL_POSITION", row["ordinal_position"].ToString());
metaData.Add("DATA_TYPE", row["data_type"].ToString());
Field.Builder fieldBuilder = SchemaFieldGenerator(row["column_name"].ToString().ToLower(), row["data_type"].ToString());
fieldBuilder.Metadata(metaData);
if (!row["is_nullable"].ToString().Equals("YES", StringComparison.OrdinalIgnoreCase))
{
fieldBuilder.Nullable(false);
}
fieldBuilder.Name(row["column_name"].ToString().ToLower());
return fieldBuilder.Build();
}
private Field.Builder SchemaFieldGenerator(string name, string type)
{
int index = type.IndexOf("(");
index = index == -1 ? type.IndexOf("<") : Math.Max(index, type.IndexOf("<"));
string dataType = index == -1 ? type : type.Substring(0, index);
return GetFieldBuilder(name, type, dataType, index);
}
private Field.Builder GetFieldBuilder(string name, string type, string dataType, int index)
{
Field.Builder fieldBuilder = new Field.Builder();
fieldBuilder.Name(name);
switch (dataType)
{
case "INTEGER" or "INT64":
return fieldBuilder.DataType(Int64Type.Default);
case "FLOAT" or "FLOAT64":
return fieldBuilder.DataType(DoubleType.Default);
case "BOOL" or "BOOLEAN":
return fieldBuilder.DataType(BooleanType.Default);
case "STRING" or "GEOGRAPHY" or "JSON":
return fieldBuilder.DataType(StringType.Default);
case "BYTES":
return fieldBuilder.DataType(BinaryType.Default);
case "DATETIME":
return fieldBuilder.DataType(TimestampType.Default);
case "TIMESTAMP":
return fieldBuilder.DataType(TimestampType.Default);
case "TIME":
return fieldBuilder.DataType(Time64Type.Default);
case "DATE":
return fieldBuilder.DataType(Date64Type.Default);
case "RECORD" or "STRUCT":
string fieldRecords = type.Substring(index + 1);
fieldRecords = fieldRecords.Remove(fieldRecords.Length - 1);
List<Field> nestedFields = new List<Field>();
foreach (string record in fieldRecords.Split(','))
{
string fieldRecord = record.Trim();
string fieldName = fieldRecord.Split(' ')[0];
string fieldType = fieldRecord.Split(' ')[1];
nestedFields.Add(SchemaFieldGenerator(fieldName, fieldType).Build());
}
return fieldBuilder.DataType(new StructType(nestedFields));
case "NUMERIC" or "DECIMAL":
ParsedDecimalValues values128 = ParsePrecisionAndScale(type);
return fieldBuilder.DataType(new Decimal128Type(values128.Precision, values128.Scale));
case "BIGNUMERIC" or "BIGDECIMAL":
ParsedDecimalValues values256 = ParsePrecisionAndScale(type);
return fieldBuilder.DataType(new Decimal256Type(values256.Precision, values256.Scale));
case "ARRAY":
string arrayType = type.Substring(dataType.Length).Replace("<", "").Replace(">", "");
return GetFieldBuilder(name, type, arrayType, index);
default: throw new InvalidOperationException($"{dataType} cannot be handled");
}
}
private class ParsedDecimalValues
{
public int Precision { get; set; }
public int Scale { get; set; }
}
private ParsedDecimalValues ParsePrecisionAndScale(string type)
{
if(string.IsNullOrWhiteSpace(type)) throw new ArgumentNullException(nameof(type));
string[] values = type.Substring(type.IndexOf("(") + 1).TrimEnd(')').Split(",".ToCharArray());
return new ParsedDecimalValues()
{
Precision = Convert.ToInt32(values[0]),
Scale = Convert.ToInt32(values[1])
};
}
public override IArrowArrayStream GetTableTypes()
{
StringArray.Builder tableTypesBuilder = new StringArray.Builder();
tableTypesBuilder.AppendRange(new string[] { "BASE TABLE", "VIEW" });
List<IArrowArray> dataArrays = new List<IArrowArray>
{
tableTypesBuilder.Build()
};
return new BigQueryInfoArrowStream(StandardSchemas.TableTypesSchema, dataArrays, 1);
}
private ListArray CreateNestedListArray(List<IArrowArray> arrayList, IArrowType dataType)
{
ArrowBuffer.Builder<int> valueOffsetsBufferBuilder = new ArrowBuffer.Builder<int>();
ArrowBuffer.BitmapBuilder validityBufferBuilder = new ArrowBuffer.BitmapBuilder();
List<ArrayData> arrayDataList = new List<ArrayData>(arrayList.Count);
int length = 0;
int nullCount = 0;
foreach (IArrowArray array in arrayList)
{
if (array == null)
{
valueOffsetsBufferBuilder.Append(length);
validityBufferBuilder.Append(false);
nullCount++;
}
else
{
valueOffsetsBufferBuilder.Append(length);
validityBufferBuilder.Append(true);
arrayDataList.Add(array.Data);
length += array.Length;
}
}
ArrowBuffer validityBuffer = nullCount > 0
? validityBufferBuilder.Build() : ArrowBuffer.Empty;
ArrayData data = ArrayDataConcatenator.Concatenate(arrayDataList);
IArrowArray value = null;
if (data == null)
value = new NullArray(0);
else
value = ArrowArrayFactory.BuildArray(data);
valueOffsetsBufferBuilder.Append(length);
return new ListArray(new ListType(dataType), arrayList.Count,
valueOffsetsBufferBuilder.Build(), value,
validityBuffer, nullCount, 0);
}
public override AdbcStatement CreateStatement()
{
if (this.client == null || this.credential == null)
{
throw new InvalidOperationException();
}
BigQueryStatement statement = new BigQueryStatement(this.client, this.credential);
statement.Options = ParseOptions();
return statement;
}
private IReadOnlyDictionary<string, string> ParseOptions()
{
Dictionary<string, string> options = new Dictionary<string, string>();
foreach (KeyValuePair<string,string> keyValuePair in this.properties)
{
if (keyValuePair.Key == BigQueryParameters.AllowLargeResults)
{
options[keyValuePair.Key] = keyValuePair.Value;
}
if (keyValuePair.Key == BigQueryParameters.UseLegacySQL)
{
options[keyValuePair.Key] = keyValuePair.Value;
}
if (keyValuePair.Key == BigQueryParameters.LargeDecimalsAsString)
{
options[keyValuePair.Key] = keyValuePair.Value;
}
}
return new ReadOnlyDictionary<string, string>(options);
}
public override void Dispose()
{
this.client?.Dispose();
this.client = null;
}
private static Regex sanitizedInputRegex = new Regex("^[a-zA-Z0-9_-]+");
private string Sanitize(string input)
{
bool isValidInput = sanitizedInputRegex.IsMatch(input);
if (isValidInput)
{
return input;
}
else
{
throw new AdbcException($"{input} is invalid", AdbcStatusCode.InvalidArgument);
}
}
/// <summary>
/// Gets the access token from the token endpoint.
/// </summary>
/// <param name="clientId"></param>
/// <param name="clientSecret"></param>
/// <param name="refreshToken"></param>
/// <param name="tokenEndpoint"></param>
/// <returns></returns>
private string GetAccessToken(string clientId, string clientSecret, string refreshToken, string tokenEndpoint)
{
string body = string.Format(
"grant_type=refresh_token&client_id={0}&client_secret={1}&refresh_token={2}",
clientId,
clientSecret,
Uri.EscapeDataString(refreshToken));
HttpClient httpClient = new HttpClient();
HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, tokenEndpoint);
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent(body, Encoding.UTF8, "application/x-www-form-urlencoded");
HttpResponseMessage response = httpClient.SendAsync(request).Result;
string responseBody = response.Content.ReadAsStringAsync().Result;
BigQueryTokenResponse bigQueryTokenResponse = JsonSerializer.Deserialize<BigQueryTokenResponse>(responseBody);
return bigQueryTokenResponse.AccessToken;
}
enum XdbcDataType
{
XdbcDataType_XDBC_UNKNOWN_TYPE = 0,
XdbcDataType_XDBC_CHAR = 1,
XdbcDataType_XDBC_NUMERIC = 2,
XdbcDataType_XDBC_DECIMAL = 3,
XdbcDataType_XDBC_INTEGER = 4,
XdbcDataType_XDBC_SMALLINT = 5,
XdbcDataType_XDBC_FLOAT = 6,
XdbcDataType_XDBC_REAL = 7,
XdbcDataType_XDBC_DOUBLE = 8,
XdbcDataType_XDBC_DATETIME = 9,
XdbcDataType_XDBC_INTERVAL = 10,
XdbcDataType_XDBC_VARCHAR = 12,
XdbcDataType_XDBC_DATE = 91,
XdbcDataType_XDBC_TIME = 92,
XdbcDataType_XDBC_TIMESTAMP = 93,
XdbcDataType_XDBC_LONGVARCHAR = -1,
XdbcDataType_XDBC_BINARY = -2,
XdbcDataType_XDBC_VARBINARY = -3,
XdbcDataType_XDBC_LONGVARBINARY = -4,
XdbcDataType_XDBC_BIGINT = -5,
XdbcDataType_XDBC_TINYINT = -6,
XdbcDataType_XDBC_BIT = -7,
XdbcDataType_XDBC_WCHAR = -8,
XdbcDataType_XDBC_WVARCHAR = -9,
}
}
}