-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathodbc_api.cc
More file actions
4013 lines (3594 loc) · 165 KB
/
Copy pathodbc_api.cc
File metadata and controls
4013 lines (3594 loc) · 165 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 2023 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
//
// https://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.
//////////////////////////////////////////////////////////////////
// This file is the entry point for the implementation of the
// ODBC APIs defined in <sql.h>, <sqlext.h> and <sqlucode.h>
//////////////////////////////////////////////////////////////////
#include "google/cloud/odbc/bq_driver/internal/odbc_conn_attr.h"
#include "google/cloud/odbc/bq_driver/internal/odbc_type_utils.h"
#include "google/cloud/odbc/bq_driver/internal/trace_utils.h"
#include "google/cloud/odbc/bq_driver/internal/utils.h"
#include "google/cloud/odbc/bq_driver/odbc_commons.h"
#include "google/cloud/odbc/bq_driver/odbc_connection.h"
#include "google/cloud/odbc/bq_driver/odbc_descriptor.h"
#include "google/cloud/odbc/bq_driver/odbc_diagnostics.h"
#include "google/cloud/odbc/bq_driver/odbc_driver_metadata.h"
#include "google/cloud/odbc/bq_driver/odbc_environment.h"
#include "google/cloud/odbc/bq_driver/odbc_lock.h"
#include "google/cloud/odbc/bq_driver/odbc_sql_requests.h"
#include "google/cloud/odbc/bq_driver/odbc_sql_results.h"
#include "google/cloud/odbc/bq_driver/odbc_statement.h"
#include "google/cloud/odbc/bq_driver/odbc_utils.h"
#include "google/cloud/odbc/internal/odbc_includes.h"
#include "google/cloud/status_or.h"
#ifdef _WIN32
#include "google/cloud/odbc/bq_driver/odbc_windows.h"
#endif //_WIN32
////////////////////////////////////////////////////////////////////////////////////////
//
// ODBC APIs supported in initial driver release.
//
////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////
// Suppressing clang-tidy errors as we don't have function
// implementation right now. Remove the lint blocks once
// functions are implemented.
////////////////////////////////////////////////////////////////////////////////////////
// NOLINTBEGIN
using ::google::cloud::Status;
using ::google::cloud::StatusOr;
using google::cloud::odbc_bq_driver_internal::BqConvertSQLWCHARToString;
using google::cloud::odbc_bq_driver_internal::ConnectionAttr;
using google::cloud::odbc_bq_driver_internal::ConnectionHandle;
using google::cloud::odbc_bq_driver_internal::ConnectionValueType;
using google::cloud::odbc_bq_driver_internal::DescriptorHandle;
using google::cloud::odbc_bq_driver_internal::IsDiagIdentifierString;
using google::cloud::odbc_bq_driver_internal::IsFieldIdentifierString;
using google::cloud::odbc_bq_driver_internal::IsInfoTypeString;
using google::cloud::odbc_bq_driver_internal::StatementHandle;
using ::google::cloud::odbc_bq_driver_internal::TraceOptions;
using google::cloud::odbc_bq_driver_internal::Utf8ToUtf16;
using google::cloud::odbc_bq_driver_internal::WireWcharSize;
using google::cloud::odbc_bq_driver_internal::WriteWideToWireBuffer;
using google::cloud::odbc_bq_driver_internal::WStrToOutputBufferResponse;
using ::google::cloud::odbc_internal::SQLStates;
using google::cloud::odbc_internal::StatusRecord;
using ::google::cloud::odbc_internal::StatusRecordOr;
using ::google::cloud::odbc_bq_driver::HandleLock;
using ::google::cloud::odbc_bq_driver::HandleLockError;
using google::cloud::odbc_bq_driver::ToCharStr;
using google::cloud::odbc_bq_driver::ToSqlChar;
constexpr int kBufferLength = 4096;
// Internal Helper Functions
namespace {
void RecordTraceStatus(std::string const& name, StatusRecord const& s) {
if (!s.ok()) {
std::cout << "Tracing is misconfigured: " << s.message << std::endl;
std::cout << "ODBC API: " << name << " will not be traced." << std::endl;
}
}
void InitializeTracing(std::string const& name) {
bool const kInitLogging = TraceOptions::InitializeLogging();
}
// Converts input pointer value which is SQLWCHAR* to SQLCHAR*
// and returns the converted value.
StatusRecordOr<std::string> ConvertSQLPointerToSQLChar(SQLPOINTER in_val,
SQLINTEGER in_val_len) {
SQLWCHAR* in_wchar_val = reinterpret_cast<SQLWCHAR*>(in_val);
StatusRecordOr<std::string> utf8_in_val =
BqConvertSQLWCHARToString(in_wchar_val, in_val_len);
if (!utf8_in_val) {
return utf8_in_val.GetStatusRecord();
}
return utf8_in_val;
}
// Converts input pointer value which is a SQLCHAR* to SQLWCHAR*
// and returns the converted value.
StatusRecordOr<std::wstring> ConvertSQLPointerToSQLWChar(
SQLPOINTER in_val, SQLINTEGER in_val_len) {
SQLCHAR* in_sqlchar_val = reinterpret_cast<SQLCHAR*>(in_val);
std::string in_str_val(ToCharStr(in_sqlchar_val));
StatusRecordOr<std::wstring> utf16_in_val = Utf8ToUtf16(in_str_val);
if (!utf16_in_val) {
return utf16_in_val.GetStatusRecord();
}
return utf16_in_val;
}
} // namespace
////////////////////////////////////////////////////////////////////////////////////////
// SQLAllocHandle allocates an environment, connection, statement,
// or descriptor handle based on the handle type passed in.
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlallochandle-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLAllocHandle(SQLSMALLINT handleType, SQLHANDLE inputHandle,
SQLHANDLE* outputHandle) {
SQLRETURN rc = SQL_SUCCESS;
InitializeTracing("SQLAllocHandle");
switch (handleType) {
case SQL_HANDLE_ENV: {
// Call to Acquire mutex for environment handle in odbc_lock.h.
// Environment handle has no parent, so inputHandle isn't required.
// Passing nullptr lets HandleLock use the global driver mutex for
// thread-safe allocation.
HandleLock lock(nullptr, SQL_HANDLE_ENV, true);
if (!lock.isLocked()) {
return SQL_ERROR;
}
rc = google::cloud::odbc_bq_driver::SQLAllocEnvHandle(outputHandle);
// Call to Release mutex for environment handle in odbc_lock.h.
break;
}
case SQL_HANDLE_DBC: {
// Call to Acquire mutex for connection handle in odbc_lock.h.
HandleLock lock(inputHandle, SQL_HANDLE_ENV);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, inputHandle, "SQLAllocHandle");
return SQL_ERROR;
}
rc = google::cloud::odbc_bq_driver::SQLAllocConnHandle(inputHandle,
outputHandle);
// Call to Release mutex for connection handle in odbc_lock.h.
break;
}
case SQL_HANDLE_STMT: {
// Call to Acquire mutex for connection handle in odbc_lock.h.
HandleLock lock(inputHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_STMT, inputHandle, "SQLAllocHandle");
return SQL_ERROR;
}
rc = google::cloud::odbc_bq_driver::SQLAllocStmtHandle(inputHandle,
outputHandle);
// Call to Release mutex for connection handle in odbc_lock.h.
break;
}
case SQL_HANDLE_DESC: {
// Call to Acquire mutex for descriptor handle in odbc_lock.h.
HandleLock lock(inputHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DESC, inputHandle, "SQLAllocHandle");
return SQL_ERROR;
}
rc = google::cloud::odbc_bq_driver::SQLAllocDescHandle(inputHandle,
outputHandle);
// Call to Trace function exit in odbc_trace.h if tracing is enabled.
// Call to Release mutex for descriptor handle in odbc_lock.h.
break;
}
default: {
return SQL_INVALID_HANDLE;
}
}
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Establishes connection to a driver and data source.
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqldriverconnect-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLDriverConnectA(
SQLHDBC connectionHandle, SQLHWND windowHandle, SQLCHAR* inConnectionString,
SQLSMALLINT inConnectionStringLen, SQLCHAR* outConnectionString,
SQLSMALLINT outConnectionStringBufferLen,
SQLSMALLINT* outConnectionStringLen, SQLUSMALLINT driverCompletion) {
return SQLDriverConnect(connectionHandle, windowHandle, inConnectionString,
inConnectionStringLen, outConnectionString,
outConnectionStringBufferLen, outConnectionStringLen,
driverCompletion);
}
SQLRETURN SQL_API SQLDriverConnect(
SQLHDBC connectionHandle, SQLHWND windowHandle, SQLCHAR* inConnectionString,
SQLSMALLINT inConnectionStringLen, SQLCHAR* outConnectionString,
SQLSMALLINT outConnectionStringBufferLen,
SQLSMALLINT* outConnectionStringLen, SQLUSMALLINT driverCompletion) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLDriverConnect");
// Call to Acquire mutex for connection handle in odbc_lock.h.
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLDriverConnect");
return SQL_ERROR;
}
// Call to internal common function for SQLDriverConnect and SQLDriverConnectW
// in odbc_connection.h.
rc = google::cloud::odbc_bq_driver::SQLDriverConnectInternal(
connectionHandle, windowHandle, inConnectionString, inConnectionStringLen,
outConnectionString, outConnectionStringBufferLen, outConnectionStringLen,
driverCompletion);
return rc;
}
//////////////////////////////////////
// Unicode version of SQLDriverConnect.
//////////////////////////////////////
// TODO(b/361047481): Add Integration Testcase for Unicode Support.
SQLRETURN SQL_API SQLDriverConnectW(
SQLHDBC connectionHandle, SQLHWND windowHandle,
SQLWCHAR* inConnectionString, SQLSMALLINT inConnectionStringLen,
SQLWCHAR* outConnectionString, SQLSMALLINT outConnectionStringBufferLen,
SQLSMALLINT* outConnectionStringLen, SQLUSMALLINT driverCompletion) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLDriverConnectW");
// Call to Acquire mutex for connection handle in odbc_lock.h.
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLDriverConnectW");
return SQL_ERROR;
}
// Handle Unicode conversion of input parameters.
StatusRecordOr<std::string> utf8_in_connection_str;
SQLCHAR* sqlchar_in_connection_str = nullptr;
if (inConnectionString) {
utf8_in_connection_str =
BqConvertSQLWCHARToString(inConnectionString, inConnectionStringLen);
if (!utf8_in_connection_str) {
return utf8_in_connection_str.GetCalculatedReturnCode();
}
sqlchar_in_connection_str = ToSqlChar(utf8_in_connection_str->data());
if (inConnectionStringLen && inConnectionStringLen != SQL_NTS)
inConnectionStringLen = utf8_in_connection_str->length();
}
// outConnectionString is an output value that is not populated by the user.
// This should not be unicode converted if it is empty. Instead we send a
// SQLCHAR empty value directly to the internal function.
SQLCHAR* out_conn_str = reinterpret_cast<SQLCHAR*>(outConnectionString);
SQLSMALLINT out_conn_str_len = 0;
// Call to internal common function for SQLDriverConnect and
// SQLDriverConnectW in odbc_connection.h.
rc = google::cloud::odbc_bq_driver::SQLDriverConnectInternal(
connectionHandle, windowHandle, sqlchar_in_connection_str,
inConnectionStringLen, out_conn_str, outConnectionStringBufferLen,
&out_conn_str_len, driverCompletion);
// Handle Unicode conversion of output parameters.
if (SQL_SUCCEEDED(rc) && outConnectionString) {
StatusRecordOr<std::wstring> utf16_out_conn_str;
if (out_conn_str_len > 0) {
utf16_out_conn_str = Utf8ToUtf16((char*)out_conn_str);
} else {
std::string val(ToCharStr(out_conn_str));
utf16_out_conn_str = Utf8ToUtf16(val);
}
if (!utf16_out_conn_str) {
return utf16_out_conn_str.GetCalculatedReturnCode();
}
WriteWideToWireBuffer(*utf16_out_conn_str, outConnectionString,
out_conn_str_len);
}
if (outConnectionStringLen) *outConnectionStringLen = out_conn_str_len;
// Call to Release mutex for connection handle in odbc_lock.h.
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Establishes connection to a driver and data source.
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlbrowseconnect-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLBrowseConnectA(SQLHDBC connectionHandle,
SQLCHAR* inConnectionString,
SQLSMALLINT inConnectionStringLen,
SQLCHAR* outConnectionString,
SQLSMALLINT outConnectionStringBufferLen,
SQLSMALLINT* outConnectionStringLen) {
return SQLBrowseConnect(connectionHandle, inConnectionString,
inConnectionStringLen, outConnectionString,
outConnectionStringBufferLen, outConnectionStringLen);
}
SQLRETURN SQL_API SQLBrowseConnect(SQLHDBC connectionHandle,
SQLCHAR* inConnectionString,
SQLSMALLINT inConnectionStringLen,
SQLCHAR* outConnectionString,
SQLSMALLINT outConnectionStringBufferLen,
SQLSMALLINT* outConnectionStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLBrowseConnect");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLBrowseConnect");
return SQL_ERROR;
}
// Call to internal common function for SQLBrowseConnect and SQLBrowseConnectW
// in odbc_connection.h.
rc = google::cloud::odbc_bq_driver::SQLBrowseConnectInternal(
connectionHandle, inConnectionString, inConnectionStringLen,
outConnectionString, outConnectionStringBufferLen,
outConnectionStringLen);
return rc;
}
//////////////////////////////////////
// Unicode version of SQLBrowseConnect.
//////////////////////////////////////
// TODO(b/361047481): Add Integration Testcase for Unicode Support.
SQLRETURN SQL_API SQLBrowseConnectW(SQLHDBC connectionHandle,
SQLWCHAR* inConnectionString,
SQLSMALLINT inConnectionStringLen,
SQLWCHAR* outConnectionString,
SQLSMALLINT outConnectionStringBufferLen,
SQLSMALLINT* outConnectionStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLBrowseConnectW");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLBrowseConnectW");
return SQL_ERROR;
}
// Handle Unicode conversion of input parameters.
SQLCHAR* sqlchar_in_connection_str = nullptr;
StatusRecordOr<std::string> utf8_in_connection_str;
if (inConnectionString) {
utf8_in_connection_str =
BqConvertSQLWCHARToString(inConnectionString, inConnectionStringLen);
if (!utf8_in_connection_str) {
return utf8_in_connection_str.GetCalculatedReturnCode();
}
sqlchar_in_connection_str = ToSqlChar(utf8_in_connection_str->data());
if (inConnectionStringLen && inConnectionStringLen != SQL_NTS)
inConnectionStringLen = utf8_in_connection_str->length();
}
// Call to internal common function for SQLBrowseConnect and SQLBrowseConnectW
// in odbc_connection.h.
// TODO: Internal call should be made with out_connection_string and
// out_connection_string_len as the output parameters
SQLCHAR* out_connection_string =
reinterpret_cast<SQLCHAR*>(outConnectionString);
rc = google::cloud::odbc_bq_driver::SQLBrowseConnectInternal(
connectionHandle, sqlchar_in_connection_str, inConnectionStringLen,
out_connection_string, outConnectionStringBufferLen,
outConnectionStringLen);
// Handle Unicode conversion of output parameters.
if (SQL_SUCCEEDED(rc) || rc == SQL_NEED_DATA) {
StatusRecordOr<std::wstring> utf16_out_conn_str =
Utf8ToUtf16((char*)out_connection_string);
if (!utf16_out_conn_str) {
return utf16_out_conn_str.GetCalculatedReturnCode();
}
{
size_t const dest_chars =
static_cast<size_t>(outConnectionStringBufferLen);
size_t const to_copy =
std::min<size_t>(utf16_out_conn_str->size(), dest_chars);
// memset zeros the entire dest, which leaves the trailing wire NUL in
// place after we write `to_copy` chars.
std::memset(outConnectionString, '\0', dest_chars * WireWcharSize());
WriteWideToWireBuffer(*utf16_out_conn_str, outConnectionString, to_copy);
}
}
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Establishes connection to a driver and data source.
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlconnect-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLConnectA(SQLHDBC connectionHandle, SQLCHAR* serverName,
SQLSMALLINT serverNameLen, SQLCHAR* userName,
SQLSMALLINT userNameLen, SQLCHAR* authString,
SQLSMALLINT authStringLen) {
return SQLConnect(connectionHandle, serverName, serverNameLen, userName,
userNameLen, authString, authStringLen);
}
SQLRETURN SQL_API SQLConnect(SQLHDBC connectionHandle, SQLCHAR* serverName,
SQLSMALLINT serverNameLen, SQLCHAR* userName,
SQLSMALLINT userNameLen, SQLCHAR* authString,
SQLSMALLINT authStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLConnect");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLConnect");
return SQL_ERROR;
}
// Call to internal common function for SQLConnect and SQLConnectW
// in odbc_connection.h.
rc = google::cloud::odbc_bq_driver::SQLConnectInternal(
connectionHandle, serverName, serverNameLen, userName, userNameLen,
authString, authStringLen);
return rc;
}
//////////////////////////////////////
// Unicode version of SQLConnect.
//////////////////////////////////////
// TODO(b/361047481): Add Integration Testcase for Unicode Support.
SQLRETURN SQL_API SQLConnectW(SQLHDBC connectionHandle, SQLWCHAR* serverName,
SQLSMALLINT serverNameLen, SQLWCHAR* userName,
SQLSMALLINT userNameLen, SQLWCHAR* authString,
SQLSMALLINT authStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLConnectW");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLConnectW");
return SQL_ERROR;
}
// Handle Unicode conversion of input parameters.
// For this API, DriverManager requires serverName or DSN string
// to be non-empty hence we need to validate it before proceeding further.
size_t w_server_name_len = 0;
if (serverName) {
std::wstring w_server_str(reinterpret_cast<wchar_t const*>(serverName));
w_server_name_len = w_server_str.length();
if (w_server_name_len == 0) {
auto status =
StatusRecord{SQLStates::k_HY000(),
"serverName or datasource name cannot be null/empty"};
return status.CalculateReturnCode();
}
} else {
auto status =
StatusRecord{SQLStates::k_HY000(),
"serverName or datasource name cannot be null/empty"};
return status.CalculateReturnCode();
}
StatusRecordOr<std::string> utf8_server_name =
BqConvertSQLWCHARToString(serverName, serverNameLen);
if (!utf8_server_name) {
return utf8_server_name.GetCalculatedReturnCode();
}
if (serverNameLen && serverNameLen != SQL_NTS)
serverNameLen = utf8_server_name->length();
// User name and Auth strings are optional. Make sure they are non-empty
// before converting to unicode.
size_t w_user_name_len = 0;
StatusRecordOr<std::string> utf8_user_name;
if (userName) {
std::wstring w_user_name_str(reinterpret_cast<wchar_t const*>(userName));
w_user_name_len = w_user_name_str.length();
}
if (w_user_name_len > 0) {
utf8_user_name = BqConvertSQLWCHARToString(userName, w_user_name_len);
if (!utf8_user_name) {
return utf8_user_name.GetCalculatedReturnCode();
}
if (userNameLen && userNameLen != SQL_NTS)
userNameLen = utf8_user_name->length();
}
size_t w_auth_str_len = 0;
StatusRecordOr<std::string> utf8_auth_str;
if (authString) {
std::wstring w_auth_str(reinterpret_cast<wchar_t const*>(authString));
w_auth_str_len = w_auth_str.length();
}
if (w_auth_str_len > 0) {
utf8_auth_str = BqConvertSQLWCHARToString(authString, w_auth_str_len);
if (!utf8_auth_str) {
return utf8_auth_str.GetCalculatedReturnCode();
}
if (authStringLen && authStringLen != SQL_NTS)
authStringLen = utf8_auth_str->length();
} else if (w_user_name_len > 0) {
// It is an error to supply a username without a auth string.
auto status = StatusRecord{
SQLStates::k_HY000(),
"authString cannot be empty or null of non-empty userName"};
return status.CalculateReturnCode();
}
// Call to internal common function for SQLConnect and SQLConnectW
// in odbc_connection.h.
if (w_user_name_len > 0) {
rc = google::cloud::odbc_bq_driver::SQLConnectInternal(
connectionHandle, ToSqlChar(utf8_server_name->data()), serverNameLen,
ToSqlChar(utf8_user_name->data()), userNameLen,
ToSqlChar(utf8_auth_str->data()), authStringLen);
} else {
rc = google::cloud::odbc_bq_driver::SQLConnectInternal(
connectionHandle, ToSqlChar(utf8_server_name->data()), serverNameLen,
ToSqlChar(""), w_user_name_len, ToSqlChar(""), w_auth_str_len);
}
// Handle Unicode conversion of output parameters.
StatusRecordOr<std::wstring> utf16_server_name =
Utf8ToUtf16(*utf8_server_name);
if (!utf16_server_name) {
return utf16_server_name.GetCalculatedReturnCode();
}
serverNameLen = utf16_server_name->length();
WriteWideToWireBuffer(*utf16_server_name, serverName, serverNameLen);
if (w_user_name_len > 0) {
StatusRecordOr<std::wstring> utf16_user_name = Utf8ToUtf16(*utf8_user_name);
if (!utf16_user_name) {
return utf16_user_name.GetCalculatedReturnCode();
}
userNameLen = utf16_user_name->length();
WriteWideToWireBuffer(*utf16_user_name, userName, userNameLen);
}
if (w_auth_str_len > 0) {
StatusRecordOr<std::wstring> utf16_auth_str = Utf8ToUtf16(*utf8_auth_str);
if (!utf16_auth_str) {
return utf16_auth_str.GetCalculatedReturnCode();
}
authStringLen = utf16_auth_str->length();
WriteWideToWireBuffer(*utf16_auth_str, authString, authStringLen);
}
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Returns general information about the driver and data source
// associated with a connection
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlgetinfo-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLGetInfoA(SQLHDBC connectionHandle, SQLUSMALLINT infoType,
SQLPOINTER infoValue,
SQLSMALLINT infoValueBufferLen,
SQLSMALLINT* infoValueStringLen) {
return SQLGetInfo(connectionHandle, infoType, infoValue, infoValueBufferLen,
infoValueStringLen);
}
SQLRETURN SQL_API SQLGetInfo(SQLHDBC connectionHandle, SQLUSMALLINT infoType,
SQLPOINTER infoValue,
SQLSMALLINT infoValueBufferLen,
SQLSMALLINT* infoValueStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLGetInfo");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLGetInfo");
return SQL_ERROR;
}
// Call to internal common function for SQLGetInfo and SQLGetInfoW
// in odbc_driver_metadata.h.
rc = ::google::cloud::odbc_bq_driver::SQLGetInfoInternal(
connectionHandle, infoType, infoValue, infoValueBufferLen,
infoValueStringLen);
return rc;
}
//////////////////////////////////////
// Unicode version of SQLGetInfo.
//////////////////////////////////////
// TODO(b/361047481): Add Integration Testcase for Unicode Support.
SQLRETURN SQL_API SQLGetInfoW(SQLHDBC connectionHandle, SQLUSMALLINT infoType,
SQLPOINTER infoValue,
SQLSMALLINT infoValueBufferLen,
SQLSMALLINT* infoValueStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLGetInfoW");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLGetInfoW");
return SQL_ERROR;
}
SQLCHAR info_val_buffer[kBufferLength] = {0};
SQLSMALLINT info_val_buffer_len = 0;
// Handle Unicode conversion of input parameters.
// Call to internal common function for SQLGetInfo and SQLGetInfoW
// in odbc_driver_metadata.h.
rc = ::google::cloud::odbc_bq_driver::SQLGetInfoInternal(
connectionHandle, infoType, info_val_buffer, infoValueBufferLen,
&info_val_buffer_len);
// Handle Unicode conversion of output parameters.
if (SQL_SUCCEEDED(rc)) {
if (IsInfoTypeString(infoType)) {
std::memset(infoValue, '\0', infoValueBufferLen);
if (info_val_buffer_len > 0) {
StatusRecordOr<std::wstring> utf16_info_val =
Utf8ToUtf16((char*)info_val_buffer);
if (!utf16_info_val) {
return utf16_info_val.GetCalculatedReturnCode();
}
size_t const wire_sz = WireWcharSize();
size_t const dest_chars =
static_cast<size_t>(infoValueBufferLen) / wire_sz;
size_t const to_copy =
std::min<size_t>(utf16_info_val->size(), dest_chars);
bool const can_null_terminate = to_copy < dest_chars;
WriteWideToWireBuffer(*utf16_info_val, infoValue, to_copy,
can_null_terminate);
}
} else {
if (info_val_buffer_len > 0) {
std::memcpy(infoValue, info_val_buffer, info_val_buffer_len);
} else {
std::memset(infoValue, '\0', infoValueBufferLen);
}
}
}
if (infoValueStringLen) {
if (IsInfoTypeString(infoType)) {
*infoValueStringLen = info_val_buffer_len * WireWcharSize();
} else {
*infoValueStringLen = info_val_buffer_len;
}
}
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Returns information about whether a driver supports a specific ODBC function.
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlgetfunctions-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLGetFunctions(SQLHDBC connectionHandle,
SQLUSMALLINT functionId,
SQLUSMALLINT* supportedFunction) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLGetFunctions");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLGetFunctions");
return SQL_ERROR;
}
// Call to internal function for SQLGetFunctions in odbc_driver_metadata.h.
rc = ::google::cloud::odbc_bq_driver::SQLGetFunctionsInternal(
connectionHandle, functionId, supportedFunction);
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Returns information about data types supported by the data source.
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlgettypeinfo-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLGetTypeInfoA(SQLHSTMT statementHandle,
SQLSMALLINT dataType) {
return SQLGetTypeInfo(statementHandle, dataType);
}
SQLRETURN SQL_API SQLGetTypeInfo(SQLHSTMT statementHandle,
SQLSMALLINT dataType) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLGetTypeInfo");
HandleLock lock(statementHandle, SQL_HANDLE_STMT);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_STMT, statementHandle, "SQLGetTypeInfo");
return SQL_ERROR;
}
// Call to internal common function for SQLGetTypeInfo and SQLGetTypeInfoW
// in odbc_driver_metadata.h.
rc = ::google::cloud::odbc_bq_driver::SQLGetTypeInfoInternal(statementHandle,
dataType);
return rc;
}
////////////////////////////////////////
// Unicode version of SQLGetTypeInfo.
////////////////////////////////////////
// TODO(b/361047481): Add Integration Testcase for Unicode Support.
SQLRETURN SQL_API SQLGetTypeInfoW(SQLHSTMT statementHandle,
SQLSMALLINT dataType) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLGetTypeInfoW");
HandleLock lock(statementHandle, SQL_HANDLE_STMT);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_STMT, statementHandle, "SQLGetTypeInfoW");
return SQL_ERROR;
}
// Call to internal common function for SQLGetTypeInfo and SQLGetTypeInfoW
// in odbc_driver_metadata.h.
rc = ::google::cloud::odbc_bq_driver::SQLGetTypeInfoInternal(statementHandle,
dataType);
// Handle Unicode conversion of output parameters.
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Sets connection attributes.
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlsetconnectattr-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLSetConnectAttrA(SQLHDBC connectionHandle,
SQLINTEGER attribute, SQLPOINTER value,
SQLINTEGER valueStringLen) {
return SQLSetConnectAttr(connectionHandle, attribute, value, valueStringLen);
}
SQLRETURN SQL_API SQLSetConnectAttr(SQLHDBC connectionHandle,
SQLINTEGER attribute, SQLPOINTER value,
SQLINTEGER valueStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLSetConnectAttr");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLSetConnectAttr");
return SQL_ERROR;
}
// Call to internal common function for SQLSetConnectAttr and
// SQLSetConnectAttrW in odbc_connection.h.
rc = ::google::cloud::odbc_bq_driver::SQLSetConnectAttrInternal(
connectionHandle, attribute, value, valueStringLen);
return rc;
}
////////////////////////////////////////
// Unicode version of SQLSetConnectAttr.
////////////////////////////////////////
// TODO(b/361047481): Add Integration Testcase for Unicode Support.
SQLRETURN SQL_API SQLSetConnectAttrW(SQLHDBC connectionHandle,
SQLINTEGER attribute, SQLPOINTER value,
SQLINTEGER valueStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLSetConnectAttrW");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLSetConnectAttrW");
return SQL_ERROR;
}
// If the Attribute value is a character string then we need to do the unicode
// conversion on the input parameters.
SQLPOINTER updated_attrib_val;
SQLINTEGER updated_value_string_len;
StatusRecordOr<std::string> updated_attrib_status;
ConnectionAttr conn_attr;
if (conn_attr.GetAttributeValueType(attribute) ==
ConnectionValueType::kSqlChr) {
if (valueStringLen && valueStringLen > 0) {
updated_attrib_status =
ConvertSQLPointerToSQLChar(value, valueStringLen / WireWcharSize());
} else {
updated_attrib_status = ConvertSQLPointerToSQLChar(value, valueStringLen);
}
if (!updated_attrib_status) {
return updated_attrib_status.GetCalculatedReturnCode();
}
updated_attrib_val = (SQLPOINTER)ToSqlChar(updated_attrib_status->data());
updated_value_string_len = strlen(updated_attrib_status->c_str());
} else {
// If we are not dealing with strings no conversions needed.
updated_attrib_val = value;
updated_value_string_len = valueStringLen;
}
// Handle Unicode conversion of input parameters.
// Call to internal common function for SQLSetConnectAttr and
// SQLSetConnectAttrW in odbc_connection.h.
rc = ::google::cloud::odbc_bq_driver::SQLSetConnectAttrInternal(
connectionHandle, attribute, updated_attrib_val,
updated_value_string_len);
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Returns the current setting of a connection attribute.
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlgetconnectattr-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLGetConnectAttrA(SQLHDBC connectionHandle,
SQLINTEGER attribute, SQLPOINTER value,
SQLINTEGER valueBufferLen,
SQLINTEGER* valueStringLen) {
return SQLGetConnectAttr(connectionHandle, attribute, value, valueBufferLen,
valueStringLen);
}
SQLRETURN SQL_API SQLGetConnectAttr(SQLHDBC connectionHandle,
SQLINTEGER attribute, SQLPOINTER value,
SQLINTEGER valueBufferLen,
SQLINTEGER* valueStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLGetConnectAttr");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLGetConnectAttr");
return SQL_ERROR;
}
// Call to internal common function for SQLGetConnectAttr and
// SQLGetConnectAttrW in odbc_connection.h.
rc = ::google::cloud::odbc_bq_driver::SQLGetConnectAttrInternal(
connectionHandle, attribute, value, valueBufferLen, valueStringLen);
return rc;
}
////////////////////////////////////////
// Unicode version of SQLGetConnectAttr.
////////////////////////////////////////
// TODO(b/361047481): Add Integration Testcase for Unicode Support.
SQLRETURN SQL_API SQLGetConnectAttrW(SQLHDBC connectionHandle,
SQLINTEGER attribute, SQLPOINTER value,
SQLINTEGER valueBufferLen,
SQLINTEGER* valueStringLen) {
SQLRETURN rc = SQL_SUCCESS;
SQLRETURN status;
InitializeTracing("SQLGetConnectAttrW");
HandleLock lock(connectionHandle, SQL_HANDLE_DBC);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_DBC, connectionHandle, "SQLGetConnectAttrW");
return SQL_ERROR;
}
// For character strings SQLPOINTER may point to a WCHAR output value.
// They need to be handled separately.
ConnectionAttr conn_attr;
SQLPOINTER updated_attrib_val;
SQLCHAR attrib_val[kBufferLength] = "Not Set";
StatusRecordOr<std::wstring> updated_out_attr_status;
if (conn_attr.GetAttributeValueType(attribute) ==
ConnectionValueType::kSqlChr) {
updated_attrib_val = (SQLPOINTER)attrib_val;
} else {
updated_attrib_val = value;
}
// Handle Unicode conversion of input parameters.
// Call to internal common function for SQLGetConnectAttr and
// SQLGetConnectAttrW in odbc_connection.h.
SQLINTEGER internal_str_len = 0;
rc = ::google::cloud::odbc_bq_driver::SQLGetConnectAttrInternal(
connectionHandle, attribute, updated_attrib_val,
static_cast<SQLINTEGER>(kBufferLength), &internal_str_len);
// Handle unicode conversion for attribute string values for output
// parameters.
if (SQL_SUCCEEDED(rc) && conn_attr.GetAttributeValueType(attribute) ==
ConnectionValueType::kSqlChr) {
updated_out_attr_status =
ConvertSQLPointerToSQLWChar(updated_attrib_val, valueBufferLen);
if (!updated_out_attr_status) {
return updated_out_attr_status.GetCalculatedReturnCode();
}
{
size_t const wire_sz = WireWcharSize();
size_t const dest_chars = static_cast<size_t>(valueBufferLen) / wire_sz;
size_t const to_copy =
std::min<size_t>(updated_out_attr_status->size(), dest_chars);
if (valueStringLen) {
*valueStringLen =
static_cast<SQLLEN>(updated_out_attr_status->size() * wire_sz);
}
std::memset(value, '\0', valueBufferLen);
WriteWideToWireBuffer(*updated_out_attr_status, value, to_copy);
}
}
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Sets attributes related to a statement.
//
// For more details see:
// https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlsetstmtattr-function
////////////////////////////////////////////////////////////////////////////////////////
SQLRETURN SQL_API SQLSetStmtAttrA(SQLHSTMT statementHandle,
SQLINTEGER attribute, SQLPOINTER value,
SQLINTEGER valueStringLen) {
return SQLSetStmtAttr(statementHandle, attribute, value, valueStringLen);
}
SQLRETURN SQL_API SQLSetStmtAttr(SQLHSTMT statementHandle, SQLINTEGER attribute,
SQLPOINTER value, SQLINTEGER valueStringLen) {
SQLRETURN rc = SQL_SUCCESS;
InitializeTracing("SQLSetStmtAttr");
HandleLock lock(statementHandle, SQL_HANDLE_STMT);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_STMT, statementHandle, "SQLSetStmtAttr");
return SQL_ERROR;
}
// Call to internal common function for SQLSetStmtAttr and SQLSetStmtAttrW
// in odbc_statement.h.
rc = ::google::cloud::odbc_bq_driver::SQLSetStmtAttrInternal(
statementHandle, attribute, value, valueStringLen);
return rc;
}
////////////////////////////////////////
// Unicode version of SQLSetStmtAttr.
////////////////////////////////////////
// TODO(b/361047481): Add Integration Testcase for Unicode Support.
SQLRETURN SQL_API SQLSetStmtAttrW(SQLHSTMT statementHandle,
SQLINTEGER attribute, SQLPOINTER value,
SQLINTEGER valueStringLen) {
SQLRETURN rc = SQL_SUCCESS;
InitializeTracing("SQLSetStmtAttrW");
HandleLock lock(statementHandle, SQL_HANDLE_STMT);
if (!lock.isLocked()) {
HandleLockError(SQL_HANDLE_STMT, statementHandle, "SQLSetStmtAttrW");
return SQL_ERROR;
}
// Handle Unicode conversion of input parameters.
// Call to internal common function for SQLSetStmtAttr and SQLSetStmtAttrW
// in odbc_statement.h.
rc = ::google::cloud::odbc_bq_driver::SQLSetStmtAttrInternal(
statementHandle, attribute, value, valueStringLen);
// Handle Unicode conversion of output parameters.
return rc;
}
////////////////////////////////////////////////////////////////////////////////////////
// Returns the current setting of a statement attribute.