This repository has been archived by the owner on Jan 9, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathconnector.cpp
1489 lines (1351 loc) · 54.8 KB
/
connector.cpp
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
/* SQream C++ Connector
* Originally by - Benny Van-Zuiden, Jeremy Chetboul, 2018
*/
#include "connector.h"
#include "socket.hpp"
#include "json.hpp"
#include <exception>
/// Macro to format and throw errors
#define THROW_GENERAL_ERROR(MSG) throw std::string(__FILE__":")+std::to_string(__LINE__)+std::string(" in ")+std::string(__func__)+std::string("(): ")+std::string(MSG)
#define THROW_SQREAM_ERROR(MSG) throw std::string(__FILE__":")+std::to_string(__LINE__)+std::string(" in ")+std::string(__func__)+std::string("() returned error from SQream: ")+std::string(MSG)
// Easy prints for debugging
#define ping puts("ping");
#define puts(str) puts(str);
#define putss(str) puts(str.c_str());
#define putj(jsn) puts(jsn.dump().c_str());
///Linux-Windows snprintf variant
#ifdef __linux__
#define SNPRINTF snprintf
#else
#define SNPRINTF _snprintf
#endif
using json = nlohmann::json;
template<typename ...Args> void sqream::MESSAGES::format(std::vector<char> &output,const char input[],Args...args) {
/// <i>sqream connector JSON message formatter</i><br>
/// <b>input:</b>
/// <ul>
/// <li><tt>std::vector &output</tt>:  output buffer</li>
/// <li><tt>const charf input[]</tt>:  input cstring</li>
/// <li><tt>Args...args</tt>:  variadic input for MESSAGE arguments</li>
/// </ul>
/// This function is basically a snprintf wrapper.
const size_t I=1+SNPRINTF(nullptr,0,input,args...);
output.resize(I);
SNPRINTF(output.data(),I,input,args...);
output.pop_back();
}
/// <i>ERR_HANDLE macro removes redundant code to check the validity of a server response</i><br>
#define ERR_HANDLE(VALUE,JSON_TYPE)\
{\
if(reply_json.contains(#VALUE)) return reply_json[#VALUE];\
else if(reply_json.contains("error")) THROW_SQREAM_ERROR(reply_json["error"]);\
else THROW_GENERAL_ERROR("an unknown error occured");\
}
/// <i>ERR_HANDLE_STR macro removes redundant code to check the validity of a server response in case the expected response is cstring</i><br>
#define ERR_HANDLE_STR(VALUE)\
{\
if(reply_json.contains(#VALUE)) return !(reply_json[#VALUE] == #VALUE);\
else if(reply_json.contains("error")) THROW_SQREAM_ERROR(reply_json["error"]);\
else THROW_GENERAL_ERROR("an unknown error occured");\
}
bool verify_response(json& reply_json, std::string value) {
if(reply_json.contains(value))
return (reply_json[value] == value);
else if(reply_json.contains("error")) {
THROW_SQREAM_ERROR(reply_json["error"]);
}else {
puts("verify else clause");
putss(value)
puts(reply_json.dump().c_str());
THROW_GENERAL_ERROR("an unknown error occured");
}
}
static void rxtx(sqream::connector *conn, json& reply_json,const char input[]) ///< <h3>Method to send and receive formatted messages</h3>
{
/// <i>Routine to perform a send and receive of formatted JSON messages</i><br>
/// <b>input:</b>
/// <ul>
/// <li>sqream::connector *conn:  Pointer to SQream low level connector type</li>
/// <li>json &reply_json:  JSON reply message from sqreamd</li>
/// <li>const char input[]:  JSON message to sqreamd</li>
/// </ul>
std::vector<char> reply_msg;
conn->write(input,strlen(input),sqream::HEADER::HEADER_JSON);
conn->read(reply_msg);
// add catch error - https://github.com/nlohmann/json/blob/develop/doc/examples/parse_error.cpp
reply_json = json::parse(std::string(reply_msg.begin(),reply_msg.end()).c_str()); // THROW_GENERAL_ERROR("could not parse server response");
}
template<typename ...Args>
void rxtx(sqream::connector *conn, json& reply_json,const char input[],Args...args) ///< <h3>Method to send and receive unformatted messages</h3>
{
/// <i>Routine to perform a send and receive of unformatted JSON messages</i><br>
/// <b>input:</b>
/// <ul>
/// <li>sqream::connector *conn:  Pointer to SQream low level connector type</li>
/// <li>json &reply_json:  JSON reply message from sqreamd</li>
/// <li>const char input[]:  JSON message to sqreamd</li>
/// <li>Args..args:  variadic argument to format the unformatted JSON messages</li>
/// </ul>
std::vector<char> reply_msg,msg;
sqream::MESSAGES::format(msg,input,args...);
conn->write(msg.data(),msg.size(),sqream::HEADER::HEADER_JSON);
conn->read(reply_msg);
// add catch error - https://github.com/nlohmann/json/blob/develop/doc/examples/parse_error.cpp
reply_json = json::parse(std::string(reply_msg.begin(),reply_msg.end()).c_str()); //THROW_GENERAL_ERROR("could not parse server response");
}
// --- Connector object ----
// -------------------------
sqream::connector::connector() {
/// <i>Trivial connector constructor</i><br>
/// <i>ensure the socket is null pointer on object creation</i><br>
socket=nullptr;
}
sqream::connector::~connector() {
/// <i>Connector destructor that automatically disconnects</i><br>
if(socket) {
int bytes_written;
const size_t data_size=strlen(MESSAGES::closeConnection);
const size_t block_size=HEADER::SIZE+sizeof(data_size);
std::vector<char> pillow(block_size+data_size);
memcpy(pillow.data(),HEADER::HEADER_JSON,HEADER::SIZE);
memcpy(&pillow[HEADER::SIZE],&data_size,sizeof(data_size));
memcpy(&pillow[block_size],MESSAGES::closeConnection,data_size);
socket->SockWriteChunk(pillow.data(),data_size+block_size,bytes_written);
/// <i>ensure a disconnect on object destruction</i><br>
/// <i>disconnect from a sqreamd session</i><br>
socket->SockClose();
delete socket;
socket=nullptr;
}
}
void sqream::connector::connect_socket(const std::string &ipv4,int port,bool ssl) {
/// <i>connect to a sqreamd session</i><br>
/// <b>input:</b>
/// <ul>
/// <li>const std::string &ipv4:  ipv4 address of the sqreamd</li>
/// <li>int port:  port of the sqreamd</li>
/// </ul>
if(socket) {
socket->SockClose();
delete socket;
socket=nullptr;
}
socket=new(std::nothrow) TSocketClient(ipv4.c_str(),port,ssl);
if(socket->SockCreateAndConnect()==false) {
socket=nullptr;
THROW_GENERAL_ERROR("unable to create socket");
}
}
void sqream::connector::read(std::vector<char> &data) {
/// <i>read data sent by sqreamd</i><br>
/// <b>input:</b>
/// <ul>
/// <li>std::vector<char> &data:  output buffer (automatically resized)</li>
/// </ul>
if(socket) {
char header[10];
uint64_t data_size;
int bytes_read;
if(!socket->SockReadChunk(header,bytes_read,sizeof(header))) THROW_GENERAL_ERROR("socket failed to read header");
if(header[0]!=HEADER::PROTOCOL_VERSION) THROW_GENERAL_ERROR("protocol version mismatch");
memcpy(&data_size,&header[2],sizeof(uint64_t));
data.resize(data_size);
if(!socket->SockReadChunk((char*)data.data(),bytes_read,data_size)) THROW_GENERAL_ERROR("socket failed to read content");
}
else
THROW_GENERAL_ERROR("not connected");
}
void sqream::connector::write(const char *data,const uint64_t data_size,const uint8_t msg_type[HEADER::SIZE]) {
/// <i>read data sent by sqreamd</i><br>
/// <b>input:</b>
/// <ul>
/// <li>const char *data:  pointer to data to be written</li>
/// <li>const size_t data_size:  size of data to be written</li>
/// <li>const uint8_t msg_type[HEADER::SIZE]: message type indicator</li>
/// </ul>
if(socket) {
if(data_size<CONSTS::MAX_SIZE) {
int bytes_written;
if(!memcmp((const char*)msg_type,HEADER::HEADER_JSON,HEADER::SIZE)) {
const size_t block_size=HEADER::SIZE+sizeof(data_size);
std::vector<char> pillow(block_size+data_size);
memcpy(pillow.data(),msg_type,HEADER::SIZE);
memcpy(&pillow[HEADER::SIZE],&data_size,sizeof(data_size));
memcpy(&pillow[block_size],data,data_size);
if(!socket->SockWriteChunk(pillow.data(),data_size+block_size,bytes_written)) THROW_GENERAL_ERROR("socket failed to write message block");
}
else {
if(!socket->SockWriteChunk(msg_type,HEADER::SIZE,bytes_written)) THROW_GENERAL_ERROR("socket failed to write header");
if(!socket->SockWriteChunk(&data_size,sizeof(data_size),bytes_written)) THROW_GENERAL_ERROR("socket failed to write binary data size");
if(!socket->SockWriteChunk(data,data_size,bytes_written)) THROW_GENERAL_ERROR("socket failed to write binary data");
}
}
else THROW_GENERAL_ERROR("binary data overflow");
}
else THROW_GENERAL_ERROR("not connected");
}
bool sqream::connector::connect(const std::string &ipv4,int port,bool ssl,const std::string &username,const std::string &password,const std::string &database,const std::string &service) {
/// <i>Connector routine that connects to a given ipv4, port, database on sqreamd</i><br>
/// <b>input:</b>
/// <ul>
/// <li>const std::string &ipv4:  ipv4 of sqreamd</li>
/// <li>int port:  port of sqreamd</li>
/// <li>bool ssl:  connect with an SSL session</li>
/// <li>const std::string &username:  username</li>
/// <li>const std::string &password:  password</li>
/// <li>const std::string &database:  database name</li>
/// </ul>
/// <b>return</b>(uint32_t):  connection_id
connect_socket(ipv4,port,ssl);
json reply_json;
rxtx(this, reply_json, MESSAGES::connectDatabase, service.c_str(), username.c_str(), password.c_str(), database.c_str());
ipv4_=ipv4;
port_=port;
ssl_=ssl;
username_=username;
password_=password;
database_=database;
service_=service;
var_encoding_= "ascii";
if(reply_json.contains("varcharEncoding"))
var_encoding_ = reply_json["varcharEncoding"]; // std::string var_encoding_
if(reply_json.contains("connectionId")) {
connection_id_ = reply_json["connectionId"]; // uint32_t connection_id_
return true;
}
else
return false;
}
bool sqream::connector::reconnect(const std::string &ipv4,int port,int listener_id) {
connect_socket(ipv4,port,ssl_);
json reply_json;
rxtx(this, reply_json,MESSAGES::reconnectDatabase,database_.c_str(),service_.c_str(),connection_id_,username_.c_str(),password_.c_str(),listener_id);
return reply_json.contains("databaseConnected");
}
bool sqream::connector::open_statement() {
/// <i>Connector routine that opens a new statement on sqreamd</i><br>
/// <b>return</b>(uint32_t):  statement_id
json reply_json;
rxtx(this, reply_json,MESSAGES::getStatementId);
if(reply_json.contains("statementId")) {
statement_id_=reply_json["statementId"];
return true;
}
else
return false;
}
bool sqream::connector::prepare_statement(std::string sqlQuery,int chunk_size) {
/// <i>Connector routine that prepares a statement on sqreamd</i><br>
/// <b>input:</b>
/// <ul>
/// <li>std::string sqlQuery:  sql query string (this is the actual sql query)</li>
/// <li>int chunk_size:  this parameter is unparsed</li>
/// </ul>
/// <b>return</b>(bool):  success from server
json reply_json, prepare_json;
prepare_json["prepareStatement"] = sqlQuery;
prepare_json["chunkSize"] = chunk_size;
rxtx(this, reply_json, prepare_json.dump().c_str());
if(reply_json.contains("reconnect") and (reply_json["reconnect"] == true)) {
if((reply_json.contains("port") or reply_json.contains("port_ssl")) and reply_json.contains("ip") and reply_json.contains("listener_id")) {
const int port = ssl_ ? reply_json["port_ssl"] : reply_json["port"];
if(reconnect(reply_json["ip"], port, reply_json["listener_id"]));
else THROW_GENERAL_ERROR("reconnection failed");
}
else THROW_GENERAL_ERROR("could not parse reconnection message");
rxtx(this, reply_json, MESSAGES::reconstructStatement,statement_id_);
// ERR_HANDLE_STR(statementReconstructed)
return verify_response(reply_json, "statementReconstructed");
}
else {
ERR_HANDLE(statementPrepared,GetBool)
}
}
sqream::CONSTS::statement_type sqream::connector::metadata_query(std::vector<column> &columns_metadata_in,std::vector<column> &columns_metadata_out)
{
/// <i>Connector routine that retrieves the metadata the statement is going to read/write</i><br>
/// <b>input:</b>
/// <ul>
/// <li>std::vector<column> & columns_metadata_in:  metadata container on input table (for network instert)</li>
/// <li>std::vector<column> & columns_metadata_out:  metadata container on output table (for any select)</li>
/// </ul>
/// <b>return</b>(sqream::CONSTS::statement type): statement type
/// statement type can be either unset,select,insert or direct:
/// unset is returned when a statement fails
/// select is returned when a statement requires an output buffer
/// insert is returned when a statement requires an input buffer
/// direct is returned when a statement does not requires input nor output
columns_metadata_out.clear();
columns_metadata_in.clear();
CONSTS::statement_type retval=CONSTS::statement_type::unset;
json queryTypeOut_reply_json;
rxtx(this, queryTypeOut_reply_json,MESSAGES::queryTypeOut);
if(queryTypeOut_reply_json.contains("queryTypeNamed") and queryTypeOut_reply_json["queryTypeNamed"].is_array() and queryTypeOut_reply_json["queryTypeNamed"].size())
{
retval=CONSTS::statement_type::select;
columns_metadata_out.resize(queryTypeOut_reply_json["queryTypeNamed"].size());
const json &out_array = queryTypeOut_reply_json["queryTypeNamed"];
auto out_size = out_array.size();
for(json::size_type i=0; i<out_size ;i++)
{
uint8_t checksum=0;
if(out_array[i].contains("isTrueVarChar")) columns_metadata_out[i].is_true_varchar = out_array[i]["isTrueVarChar"], checksum|=1;
if(out_array[i].contains("nullable")) columns_metadata_out[i].nullable = out_array[i]["nullable"], checksum|=2;
if(out_array[i].contains("name")) columns_metadata_out[i].name=std::string(out_array[i]["name"]), checksum|=4;
if(out_array[i].contains("type") and out_array[i]["type"].is_array() and out_array[i]["type"].size()==3)
{
columns_metadata_out[i].type=std::string(out_array[i]["type"][0]);
columns_metadata_out[i].size=out_array[i]["type"][1];
columns_metadata_out[i].scale=out_array[i]["type"][2];
checksum|=8;
}
if(checksum!=15) THROW_GENERAL_ERROR("could not parse metadata out");
}
}
else
{
json queryTypeIn_reply_json;
rxtx(this, queryTypeIn_reply_json,MESSAGES::queryTypeIn);
if(queryTypeIn_reply_json.contains("queryType") and queryTypeIn_reply_json["queryType"].is_array() and queryTypeIn_reply_json["queryType"].size())
{
retval=CONSTS::statement_type::insert;
columns_metadata_in.resize(queryTypeIn_reply_json["queryType"].size());
const json &in_array = queryTypeIn_reply_json["queryType"];
for(size_t i=0; i<in_array.size(); i++)
{
uint8_t checksum=0;
if(in_array[i].contains("isTrueVarChar")) columns_metadata_in[i].is_true_varchar = in_array[i]["isTrueVarChar"], checksum|=1;
if(in_array[i].contains("nullable")) columns_metadata_in[i].nullable = in_array[i]["nullable"], checksum|=2;
if(in_array[i].contains("type") and in_array[i]["type"].is_array() and in_array[i]["type"].size()==3)
{
columns_metadata_in[i].type=std::string(in_array[i]["type"][0]);
columns_metadata_in[i].size=in_array[i]["type"][1];
columns_metadata_in[i].scale=in_array[i]["type"][2];
checksum|=4;
}
if(checksum!=7) THROW_GENERAL_ERROR("could not parse metadata in");
}
}
else retval=CONSTS::statement_type::direct;
}
return retval;
}
bool sqream::connector::execute()
{
/// <i>Connector routine that tells the server to execute a statement</i><br>
/// <b>return</b>(bool):  success response from sqreamd
json reply_json;
rxtx(this, reply_json,MESSAGES::execute);
// ERR_HANDLE_STR(executed)
bool res = verify_response(reply_json, "executed");
return res;
// puts ("execute end");
}
size_t sqream::connector::fetch(std::vector<char> &binary_data,std::vector<uint64_t> &column_sizes,size_t min_size)
{
/// <i>Connector routine that retrieves serialized output data from the server</i><br>
/// <b>input:</b>
/// <ul>
/// <li>std::vector<char> &binary_data:  retrieved data buffer</li>
/// <li>size_t min_size=1:  keep retrieving until at least size of bytes is retrieved (default value is 1)</li>
/// </ul>
/// <b>return</b>(size_t):  number of rows
json reply_json;
binary_data.resize(0);
column_sizes.resize(0);
size_t row_count=0;
while(binary_data.size()<min_size)
{
rxtx(this, reply_json,MESSAGES::fetch);
if(reply_json.contains("colSzs") and reply_json.contains("rows"))
{
if(reply_json["colSzs"].is_array() and reply_json["colSzs"].size())
{
row_count += int(reply_json["rows"]);
const json &array = reply_json["colSzs"];
const auto I = array.size();
if(column_sizes.size() != I) column_sizes.resize(I);
size_t binary_size=0;
for(json::size_type i=0; i<I ;i++) {
binary_size += column_sizes[i] = array[i];
}
if(binary_size>0)
{
std::vector<char> temp(binary_size);
read(temp);
binary_data.insert(binary_data.end(),temp.begin(),temp.end());
}
else break;
}
else break;
}
else if(reply_json.contains("error")) THROW_SQREAM_ERROR(reply_json["error"]);
else THROW_GENERAL_ERROR("sqream::connector::fetch: an unknown error occured");
}
return row_count;
}
void sqream::connector::put(std::vector<char> &binary_data,size_t rows)
{
/// <i>Connector routine that sends serialized input data to the server</i><br>
/// <b>input:</b>
/// <ul>
/// <li>std::vector<char> &binary_data:  input data buffer</li>
/// <li>size_t rows:  number of rows that the input data buffer contains</li>
/// </ul>
std::vector<char> msg,reply_msg;
json reply_json;
MESSAGES::format(msg,MESSAGES::put,rows);
write(msg.data(),msg.size(),HEADER::HEADER_JSON);
write(binary_data.data(),binary_data.size(),HEADER::HEADER_BINARY);
read(reply_msg);
reply_json = json::parse(std::string(reply_msg.begin(),reply_msg.end()).c_str());
if(reply_json.contains("putted") and (reply_json["putted"] == "putted"))
return;
else if(reply_json.contains("error"))
THROW_SQREAM_ERROR(reply_json["error"]);
else
THROW_GENERAL_ERROR("sqream::connector::put: an unknown error occured");
}
bool sqream::connector::close_statement()
{
/// <i>Connector routine that closes a statement indicating it will not be used again</i><br>
/// <b>return</b>(bool):  success response from sqreamd
json reply_json;
rxtx(this, reply_json,MESSAGES::closeStatement);
// ERR_HANDLE_STR(statementClosed)
return verify_response(reply_json, "statementClosed");
}
#undef ERR_HANDLE
#undef ERR_HANDLE_STR
// ---- Driver object
// -------------------
sqream::driver::driver() {
/// <i>Trivial connector constructor</i><br>
statement_type_=CONSTS::unset;
sqc_=nullptr;
buffer_switch_th.reset(nullptr);
buffer_.reserve(CONSTS::MIN_PUT_SIZE);
//*
#ifndef __linux__
sqc_->socket->SockInitLib();
#endif
//*/
}
sqream::driver::~driver()
{
/// <i>Destructor that closes a statement if available and disconnects from sqreamd</i><br>
if(buffer_switch_th) {
//std::printf("Ending previous buff switch\n");
(*buffer_switch_th).get();
buffer_switch_th.reset(nullptr);
}
if(state_>0 and state_<7 and sqc_->socket) {
int bytes_read_write;
const size_t data_size=strlen(MESSAGES::closeStatement);
const size_t block_size=HEADER::SIZE+sizeof(data_size);
std::vector<char> pillow(block_size+data_size);
memcpy(pillow.data(),HEADER::HEADER_JSON,HEADER::SIZE);
memcpy(&pillow[HEADER::SIZE],&data_size,sizeof(data_size));
memcpy(&pillow[block_size],MESSAGES::closeStatement,data_size);
sqc_->socket->SockWriteChunk(pillow.data(),data_size+block_size,bytes_read_write);
char header[10];
uint64_t data_size_out;
sqc_->socket->SockReadChunk(header,bytes_read_write,sizeof(header));
memcpy(&data_size_out,&header[2],sizeof(uint64_t));
std::vector<char> data(data_size);
sqc_->socket->SockReadChunk((char*)data.data(),bytes_read_write,data_size);
}
disconnect();
#ifndef __linux__
sqc_->socket->SockFinalizeLib();
#endif
}
bool sqream::driver::connect(const std::string &ipv4,int port,bool ssl,const std::string &username,const std::string &password,const std::string &database,const std::string &service) {
/// <i>Connector routine that connects to a given ipv4, port, database on sqreamd</i><br>
/// <b>input:</b>
/// <ul>
/// <li>const std::string &ipv4:  ipv4 of sqreamd</li>
/// <li>int port:  port of sqreamd</li>
/// <li>bool ssl:  connect with an SSL session</li>
/// <li>const std::string &username:  username</li>
/// <li>const std::string &password:  password</li>
/// <li>const std::string &database:  database name</li>
/// </ul>
/// <b>return</b>(bool):  successful
if(sqc_)
disconnect();
sqc_=new(std::nothrow) connector;
if(!sqc_)
THROW_GENERAL_ERROR("error creating connection");
return sqc_->connect(ipv4,port,ssl,username,password,database,service);
}
void sqream::driver::disconnect() {
/// <i>Disconnect from sqreamd</i><br>
if(sqc_) {
delete sqc_;
sqc_=nullptr;
}
}
/// Standard error: thrown if socket does not exist
#define TC(X) if(!X) THROW_GENERAL_ERROR("sqream driver is not connected");
/// Standard error: thrown if function is called when it is not supposed to yet
#define CS(X) if(state_!=X) THROW_GENERAL_ERROR("protocol order violation");
/// Standard error: thrown if a non existing column is set
#define CI(X) if(X>=metadata_input_.size()) THROW_GENERAL_ERROR("input column does not exist in query");
/// Standard error: thrown if a non existing column is getten
#define CO(X) if(X>=metadata_output_.size()) THROW_GENERAL_ERROR("output column does not exist query");
/// Combinator of TC and CS macros
#define TCCS(X,Y) TC(X) CS(Y)
/// Combinator of TC, CS and CO macros
#define TCCSCO(X,Y,Z) TC(X) CS(Y) CO(Z)
/// Combinator of TC, CS and CI macros
#define TCCSCI(X,Y,Z) TC(X) CS(Y) CI(Z)
size_t sqream::driver::flat_size_() {
/// <i>Size of the flat buffer when a unflat pbuffer is converted to it</i><br>
/// <b>return</b>(size_t):  size of flat buffer
size_t retval=0;
for(std::vector<std::vector<char>> &cols:pbuffer_[curr_buff_idx]) for(std::vector<char> &col:cols) retval+=col.size();
return retval;
}
void sqream::driver::init_pbuffer_(const std::vector<column> &metadata) {
/// <i>Initialize the unflat pbuffer based on a metadata vector</i><br>
/// <b>input:</b>
/// <ul>
/// <li>std::vector<column> &metadata:  metadata vector</li>
/// </ul>
for(size_t idx=0; idx < CONSTS::BUFF_COUNT; idx++) {
pbuffer_[idx].clear();
const size_t I = metadata.size();
pbuffer_[idx].resize(I);
for (size_t i = 0; i < I; i++) {
size_t blocks = 1;
if (metadata[i].nullable) blocks++;
if (metadata[i].is_true_varchar) blocks++;
pbuffer_[idx][i].resize(blocks);
}
blob_shift_[idx].resize(I);
for (size_t i = 0; i < I; i++) blob_shift_[idx][i].fill(0);
}
}
void sqream::driver::flatten_(std::vector<std::vector<std::vector<char>>> &buff_to_flatten) {
/// <i>Append unflat pbuffer to flat buffer</i><br>
for(std::vector<std::vector<char>> &cols:buff_to_flatten) for(std::vector<char> &col:cols) buffer_.insert(buffer_.end(),col.begin(),col.end());
}
void sqream::driver::unflatten_() {
/// <i>Append flat buffer to unflat pbuffer</i><br>
size_t pos=0,k=0;
const size_t I=pbuffer_[curr_buff_idx].size();
for(size_t i=0;i<I;i++)
{
const size_t J=pbuffer_[curr_buff_idx][i].size();
for(size_t j=0;j<J;j++)
{
const size_t size=column_sizes_[k++];
pbuffer_[curr_buff_idx][i][j].resize(size);
memcpy(pbuffer_[curr_buff_idx][i][j].data(),buffer_.data()+pos,size);
pos+=size;
}
}
}
void sqream::driver::reset_pbuffer_(const std::vector<column> &metadata) {
for(auto &cols:(pbuffer_[curr_buff_idx])) for(auto &col:cols) col.clear();
const size_t I=metadata.size();
blob_shift_[curr_buff_idx].clear();
blob_shift_[curr_buff_idx].resize(I);
for(size_t i=0;i<I;i++) blob_shift_[curr_buff_idx][i].fill(0);
}
void sqream::driver::put_buff(size_t row_cnt, int buff_idx) {
std::unique_lock<std::mutex> lock(buff_switch_mut);
//std::printf("Will switch from buffer '%d'\n", buff_idx);
flatten_(pbuffer_[buff_idx]);
sqc_->put(buffer_, row_cnt);
//std::printf("put(%ld)\n", ++put_cnt);
buffer_.clear();
}
void sqream::driver::new_query(const std::string &sql_query) {
/// <i>This function creates a new statement and deduces its type and metadata</i><br>
/// <b>input:</b>
/// <ul>
/// <li>const std::string &sql_query:  SQream SQL Query</li>
/// </ul>
TC(sqc_)
state_=0;
row_count_=0;
current_row_=0;
curr_buff_idx = 0;
buffer_.clear();
column_sizes_.clear();
colck_.clear();
sqc_->open_statement();
if(!sqc_->prepare_statement(sql_query,57/*Grothendieck prime*/)) THROW_GENERAL_ERROR("error preparing statement");
state_|=1;
}
bool sqream::driver::execute_query() {
/// <i>This function tells the sqreamd server to start executing the newly generated query</i><br>
/// This function can only be executed after a valid new_query() call<br>
/// <b>input:</b>
/// <ul>
/// <li>const std::string &sql_query:  SQream SQL Query</li>
/// </ul>
TCCS(sqc_,1)
if(sqc_->execute()) {
statement_type_=sqc_->metadata_query(metadata_input_,metadata_output_);
switch(statement_type_) {
case CONSTS::insert: {
init_pbuffer_(metadata_input_);
colck_.resize(metadata_input_.size(),0);
}
break;
case CONSTS::select: init_pbuffer_(metadata_output_); break;
default: break;
}
state_|=2;
return true;
}
else
THROW_GENERAL_ERROR("failed to execute query");
}
bool sqream::driver::next_query_row(const size_t min_put_size) {
/// <i>This driver retrieves or sends data per row</i><br>
/// This function can only be executed after a execute_query() call<br>
/// <b>input:</b>
/// <ul>
/// <li>const size_t &min_put_size:  minimal size of the binary data black to be sent</li>
/// </ul>
TCCS(sqc_,3)
switch(statement_type_) {
case CONSTS::insert:
{
size_t sum=0;
for(uint8_t p:colck_) if(p>0) sum++;
if(sum!=metadata_input_.size()) THROW_GENERAL_ERROR("some columns are unitialized");
for(uint8_t &p:colck_) p=0;
if(flat_size_()>=min_put_size)
{
if(buffer_switch_th)
{
//std::printf("Ending previous buff switch\n");
(*buffer_switch_th).get();
buffer_switch_th.reset(nullptr);
}
//The launch::async policy here is crucial to be sure it runs right away asynchronously instead of potentially being deferred
buffer_switch_th.reset(new std::future<void>(std::async(std::launch::async,&sqream::driver::put_buff, this, ++row_count_, curr_buff_idx.load())));
curr_buff_idx = (curr_buff_idx+1)%CONSTS::BUFF_COUNT;
reset_pbuffer_(metadata_input_);
row_count_=0;
}
else row_count_++;
return true;
}
case CONSTS::select:
{
if(++current_row_<row_count_) return true;
else
{
column_sizes_.clear();
row_count_=sqc_->fetch(buffer_,column_sizes_);
if(row_count_)
{
current_row_=0;
init_pbuffer_(metadata_output_);
unflatten_();
buffer_.clear();
return true;
}
else
{
state_|=4;
return false;
}
}
}
default:
{
state_|=4;
return false;
}
}
}
bool sqream::driver::finish_query() {
/// <i>This driver retrieves or sends data per row</i><br>
/// This function can only be executed after a execute_query() call
if(state_==3) state_|=4;
TCCS(sqc_,7)
if(statement_type_==CONSTS::insert) {
if(buffer_switch_th) {
//std::printf("Ending previous buff switch\n");
(*buffer_switch_th).get();
buffer_switch_th.reset(nullptr);
}
if(flat_size_()) {
put_buff(row_count_, curr_buff_idx.load());
}
}
state_|=8;
return sqc_->close_statement();
}
bool sqream::driver::is_null(const size_t col)
{
/// <i>check if a value is nullefied</i><br>
/// <b>input:</b>
/// <ul>
/// <li>const size_t &col:  column index</li>
/// </ul>
/// <b>return</b>(bool):  value
TCCSCO(sqc_,3,col)
if(!is_nullable(col)) THROW_GENERAL_ERROR("column is not nullable");
bool retval;
memcpy(&retval,pbuffer_[curr_buff_idx][col][0].data()+current_row_,sizeof(retval));
if(metadata_output_[col].type == "ftBlob" && retval == true)
{
const size_t idx=current_row_%2;
blob_shift_[curr_buff_idx][col][1-idx]=blob_shift_[curr_buff_idx][col][idx];
}
return retval;
}
bool sqream::driver::is_nullable(const size_t col)
{
/// <i>check if a value is nullified</i><br>
/// <b>input:</b>
/// <ul>
/// <li>const size_t &col:  column index</li>
/// </ul>
/// <b>return</b>(bool):  value
switch(statement_type_)
{
case CONSTS::insert:
{
TCCSCI(sqc_,3,col)
return metadata_input_[col].nullable;
}
case CONSTS::select:
{
TCCSCO(sqc_,3,col)
return metadata_output_[col].nullable;
}
default: THROW_GENERAL_ERROR("statement does not support metadata queries");
}
}
/*!
\def GET_FIXED_TYPES(X,Y,Z)
<i>This macro implements all <b>get</b> functions for fixed types</i>
<b>input:</b>
<ul>
<li>\a X:  SQream type name</li>
<li>\a Y:  THROW type name</li>
<li>\a Z:  C++ type name</li>
</ul>
*/
#define GET_FIXED_TYPES(X,Y,Z)\
{\
TCCSCO(sqc_,3,col)\
if(metadata_output_[col].type!=#X) THROW_GENERAL_ERROR("column is not of type "#Y);\
const size_t id=metadata_output_[col].nullable?1:0;\
const size_t shift=metadata_output_[col].size*current_row_;\
Z retval;\
memcpy(&retval,pbuffer_[curr_buff_idx][col][id].data()+shift,sizeof(retval));\
return retval;\
}
bool sqream::driver::get_bool(const size_t col) GET_FIXED_TYPES(ftBool,bool,bool)
///< <i>retrieve a boolean type value from a column by index</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(bool):  value
uint8_t sqream::driver::get_ubyte(const size_t col) GET_FIXED_TYPES(ftUByte,UByte,uint8_t)
///< <i>retrieve a unsigned byte type value from a column by index</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(uint8_t):  value
int16_t sqream::driver::get_short(const size_t col) GET_FIXED_TYPES(ftShort,short,int16_t)
///< <i>retrieve a short type value from a column by index</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(int16_t):  value
int32_t sqream::driver::get_int(const size_t col) GET_FIXED_TYPES(ftInt,int,int32_t)
///< <i>retrieve a int type value from a column by index</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(int32_t):  value
int64_t sqream::driver::get_long(const size_t col) GET_FIXED_TYPES(ftLong,long,int64_t)
///< <i>retrieve a long type value from a column by index</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(int64_t):  value
float sqream::driver::get_float(const size_t col) GET_FIXED_TYPES(ftFloat,float,float)
///< <i>retrieve a float type value from a column by index</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(float):  value
double sqream::driver::get_double(const size_t col) GET_FIXED_TYPES(ftDouble,double,double)
///< <i>retrieve a double type value from a column by index</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(double):  value
uint32_t sqream::driver::get_date(const size_t col) GET_FIXED_TYPES(ftDate,date,uint32_t)
///< <i>retrieve a date type value from a column by index</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(uint32_t):  value
uint64_t sqream::driver::get_datetime(const size_t col) GET_FIXED_TYPES(ftDateTime,datetime,uint64_t)
///< <i>retrieve a datetime type value from a column by index</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(uint64_t):  value
#undef GET_FIXED_TYPES
std::string sqream::driver::get_varchar(const size_t col)
{
/// <i>retrieve a varchar type value from a column by index</i><br>
/// <b>input:</b>
/// <ul>
/// <li>const size_t &col:  column index</li>
/// </ul>
/// <b>return</b>(std::string):  value
TCCSCO(sqc_,3,col)
if(metadata_output_[col].type!="ftVarchar") THROW_GENERAL_ERROR("column is not of type varchar");
const size_t id=metadata_output_[col].nullable?1:0;
const size_t size=metadata_output_[col].size;
const size_t shift=metadata_output_[col].size*current_row_;
std::string retval;
retval.resize(size);
memcpy(const_cast<char*>(retval.data()),pbuffer_[curr_buff_idx][col][id].data()+shift,size);
return retval;
}
std::string sqream::driver::get_nvarchar(const size_t col)
{
/// <i>retrieve a nvarchar type value from a column by index</i><br>
/// <b>input:</b>
/// <ul>
/// <li>const size_t &col:  column index</li>
/// </ul>
/// <b>return</b>(std::string):  value
TCCSCO(sqc_,3,col)
if(metadata_output_[col].type!="ftBlob") THROW_GENERAL_ERROR("column is not of type nvarchar");
const size_t ids=metadata_output_[col].nullable?1:0;
const size_t idn=ids+1;
const size_t shift=4*current_row_;
const size_t idx=current_row_%2;
int nvarchar_size_container;
memcpy(&nvarchar_size_container,pbuffer_[curr_buff_idx][col][ids].data()+shift,sizeof(nvarchar_size_container));
std::string retval;
retval.resize(nvarchar_size_container);
memcpy(const_cast<char*>(retval.data()),pbuffer_[curr_buff_idx][col][idn].data()+blob_shift_[curr_buff_idx][col][idx],nvarchar_size_container);
blob_shift_[curr_buff_idx][col][1-idx]=blob_shift_[curr_buff_idx][col][idx]+nvarchar_size_container;
return retval;
}
/*!
\def NAMED_GETS(X)
<i>This macro implements all <b>get</b> calls by column name</i>
<b>input:</b>
<ul>
<li>\a X:  function name by column index</li>
</ul>
*/
#define NAMED_GETS(X)\
{\
const size_t I=metadata_output_.size();\
for(size_t i=0;i<I;i++) if(metadata_output_[i].name==col_name) return X(i);\
THROW_GENERAL_ERROR("column name not found");\
}
bool sqream::driver::is_nullable(const std::string &col_name) NAMED_GETS(is_nullable)
///< <i>retrieve if column is nullable by name</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(bool):  value
bool sqream::driver::is_null(const std::string &col_name) NAMED_GETS(is_null)
///< <i>retrieve if column value is null by name</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(bool):  value
bool sqream::driver::get_bool(const std::string &col_name) NAMED_GETS(get_bool)
///< <i>retrieve a bool type value from a column by name</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(bool):  value
uint8_t sqream::driver::get_ubyte(const std::string &col_name) NAMED_GETS(get_ubyte)
///< <i>retrieve a ubyte type value from a column by name</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(uint8_t):  value
int16_t sqream::driver::get_short(const std::string &col_name) NAMED_GETS(get_short)
///< <i>retrieve a short type value from a column by name</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>
///< </ul>
///< <b>return</b>(int16_t):  value
int32_t sqream::driver::get_int(const std::string &col_name) NAMED_GETS(get_int)
///< <i>retrieve a int type value from a column by name</i><br>
///< <b>input:</b>
///< <ul>
///< <li>const size_t &col:  column index</li>