forked from mmottl/postgresql-ocaml
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpostgresql.ml
1244 lines (1015 loc) · 35.8 KB
/
postgresql.ml
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
(*
PostgreSQL-OCAML - OCaml-interface to the PostgreSQL database
Copyright (C) 2004- Markus Mottl
email: markus.mottl@gmail.com
WWW: http://www.ocaml.info
Copyright (C) 2001 Alain Frisch (version: postgres-20010808)
email: Alain.Frisch@ens.fr
WWW: http://www.eleves.ens.fr/home/frisch
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*)
open Printf
type oid = int
type large_object = int
exception Oid of oid
let invalid_oid = 0
module Error_field = Error_field
module Error_code = Error_code
module FFormat = struct
type t =
| TEXT
| BINARY
end
type ftype =
| BOOL
| BYTEA
| CHAR
| NAME
| INT8
| INT2
| INT2VECTOR
| INT4
| REGPROC
| TEXT
| OID
| TID
| XID
| CID
| OIDVECTOR
| JSON
| POINT
| LSEG
| PATH
| BOX
| POLYGON
| LINE
| FLOAT4
| FLOAT8
| ABSTIME
| RELTIME
| TINTERVAL
| UNKNOWN
| CIRCLE
| CASH
| MACADDR
| INET
| CIDR
| ACLITEM
| BPCHAR
| VARCHAR
| DATE
| TIME
| TIMESTAMP
| TIMESTAMPTZ
| INTERVAL
| TIMETZ
| BIT
| VARBIT
| NUMERIC
| REFCURSOR
| REGPROCEDURE
| REGOPER
| REGOPERATOR
| REGCLASS
| REGTYPE
| RECORD
| CSTRING
| ANY
| ANYARRAY
| VOID
| TRIGGER
| LANGUAGE_HANDLER
| INTERNAL
| OPAQUE
| ANYELEMENT
| JSONB
external ftype_of_oid : (oid [@untagged]) -> ftype
= "ftype_of_oid_stub_bc" "ftype_of_oid_stub"
external oid_of_ftype : ftype -> (oid [@untagged])
= "oid_of_ftype_stub_bc" "oid_of_ftype_stub" [@@noalloc]
let string_of_ftype = function
| BOOL -> "BOOL"
| BYTEA -> "BYTEA"
| CHAR -> "CHAR"
| NAME -> "NAME"
| INT8 -> "INT8"
| INT2 -> "INT2"
| INT2VECTOR -> "INT2VECTOR"
| INT4 -> "INT4"
| REGPROC -> "REGPROC"
| TEXT -> "TEXT"
| OID -> "OID"
| TID -> "TID"
| XID -> "XID"
| CID -> "CID"
| OIDVECTOR -> "OIDVECTOR"
| JSON -> "JSON"
| POINT -> "POINT"
| LSEG -> "LSEG"
| PATH -> "PATH"
| BOX -> "BOX"
| POLYGON -> "POLYGON"
| LINE -> "LINE"
| FLOAT4 -> "FLOAT4"
| FLOAT8 -> "FLOAT8"
| ABSTIME -> "ABSTIME"
| RELTIME -> "RELTIME"
| TINTERVAL -> "TINTERVAL"
| UNKNOWN -> "UNKNOWN"
| CIRCLE -> "CIRCLE"
| CASH -> "CASH"
| MACADDR -> "MACADDR"
| INET -> "INET"
| CIDR -> "CIDR"
| ACLITEM -> "ACLITEM"
| BPCHAR -> "BPCHAR"
| VARCHAR -> "VARCHAR"
| DATE -> "DATE"
| TIME -> "TIME"
| TIMESTAMP -> "TIMESTAMP"
| TIMESTAMPTZ -> "TIMESTAMPTZ"
| INTERVAL -> "INTERVAL"
| TIMETZ -> "TIMETZ"
| BIT -> "BIT"
| VARBIT -> "VARBIT"
| NUMERIC -> "NUMERIC"
| REFCURSOR -> "REFCURSOR"
| REGPROCEDURE -> "REGPROCEDURE"
| REGOPER -> "REGOPER"
| REGOPERATOR -> "REGOPERATOR"
| REGCLASS -> "REGCLASS"
| REGTYPE -> "REGTYPE"
| RECORD -> "RECORD"
| CSTRING -> "CSTRING"
| ANY -> "ANY"
| ANYARRAY -> "ANYARRAY"
| VOID -> "VOID"
| TRIGGER -> "TRIGGER"
| LANGUAGE_HANDLER -> "LANGUAGE_HANDLER"
| INTERNAL -> "INTERNAL"
| OPAQUE -> "OPAQUE"
| ANYELEMENT -> "ANYELEMENT"
| JSONB -> "JSONB"
let ftype_of_string = function
| "BOOL" -> BOOL
| "BYTEA" -> BYTEA
| "CHAR" -> CHAR
| "NAME" -> NAME
| "INT8" -> INT8
| "INT2" -> INT2
| "INT2VECTOR" -> INT2VECTOR
| "INT4" -> INT4
| "REGPROC" -> REGPROC
| "TEXT" -> TEXT
| "OID" -> OID
| "TID" -> TID
| "XID" -> XID
| "CID" -> CID
| "OIDVECTOR" -> OIDVECTOR
| "JSON" -> JSON
| "POINT" -> POINT
| "LSEG" -> LSEG
| "PATH" -> PATH
| "BOX" -> BOX
| "POLYGON" -> POLYGON
| "LINE" -> LINE
| "FLOAT4" -> FLOAT4
| "FLOAT8" -> FLOAT8
| "ABSTIME" -> ABSTIME
| "RELTIME" -> RELTIME
| "TINTERVAL" -> TINTERVAL
| "UNKNOWN" -> UNKNOWN
| "CIRCLE" -> CIRCLE
| "CASH" -> CASH
| "MACADDR" -> MACADDR
| "INET" -> INET
| "CIDR" -> CIDR
| "ACLITEM" -> ACLITEM
| "BPCHAR" -> BPCHAR
| "VARCHAR" -> VARCHAR
| "DATE" -> DATE
| "TIME" -> TIME
| "TIMESTAMP" -> TIMESTAMP
| "TIMESTAMPTZ" -> TIMESTAMPTZ
| "INTERVAL" -> INTERVAL
| "TIMETZ" -> TIMETZ
| "BIT" -> BIT
| "VARBIT" -> VARBIT
| "NUMERIC" -> NUMERIC
| "REFCURSOR" -> REFCURSOR
| "REGPROCEDURE" -> REGPROCEDURE
| "REGOPER" -> REGOPER
| "REGOPERATOR" -> REGOPERATOR
| "REGCLASS" -> REGCLASS
| "REGTYPE" -> REGTYPE
| "RECORD" -> RECORD
| "CSTRING" -> CSTRING
| "ANY" -> ANY
| "ANYARRAY" -> ANYARRAY
| "VOID" -> VOID
| "TRIGGER" -> TRIGGER
| "LANGUAGE_HANDLER" -> LANGUAGE_HANDLER
| "INTERNAL" -> INTERNAL
| "OPAQUE" -> OPAQUE
| "ANYELEMENT" -> ANYELEMENT
| "JSONB" -> JSONB
| str -> failwith ("ftype_of_string: unknown ftype: " ^ str)
external init : unit -> unit = "PQocaml_init"
let null = ""
let () =
Callback.register_exception "Postgresql.Oid" (Oid invalid_oid);
Callback.register "Postgresql.null" null;
init ()
type connection_status =
| Ok | Bad
| Connection_started
| Connection_made
| Connection_awaiting_response
| Connection_auth_ok
| Connection_setenv
| Connection_ssl_startup
type polling_status =
| Polling_failed
| Polling_reading
| Polling_writing
| Polling_ok
type flush_status =
| Successful
| Data_left_to_send
type conninfo_option =
{
cio_keyword : string;
cio_envvar : string option;
cio_compiled : string option;
cio_val : string option;
cio_label : string;
cio_dispchar : string;
cio_dispsize : int;
}
type result_status =
| Empty_query
| Command_ok
| Tuples_ok
| Copy_out
| Copy_in
| Bad_response
| Nonfatal_error
| Fatal_error
| Copy_both
| Single_tuple
external result_status : result_status -> string = "PQresStatus_stub"
type put_copy_result =
| Put_copy_queued
| Put_copy_not_queued
| Put_copy_error
type get_copy_result =
| Get_copy_data of string
| Get_copy_wait
| Get_copy_end
| Get_copy_error
type getline_result = EOF | LineRead | BufFull
type getline_async_result =
| EndOfData
| NoData
| DataRead of int
| PartDataRead of int
type seek_cmd =
| SEEK_SET
| SEEK_CUR
| SEEK_END
type error =
| Field_out_of_range of int * int
| Tuple_out_of_range of int * int
| Binary
| Connection_failure of string
| Unexpected_status of result_status * string * (result_status list)
| Cancel_failure of string
let string_of_error = function
| Field_out_of_range (i, n) ->
sprintf "Field number %i is out of range [0..%i]" i (n - 1)
| Tuple_out_of_range (i, n) ->
sprintf "Tuple number %i is out of range [0..%i]" i (n - 1)
| Binary -> sprintf "This function does not accept binary tuples"
| Connection_failure s -> "Connection failure: " ^ s
| Unexpected_status (s, msg, sl) ->
sprintf "Result status %s unexpected (expected status:%s); %s"
(result_status s) (String.concat "," (List.map result_status sl))
msg
| Cancel_failure s -> "Cancel failure: " ^ s
exception Error of error
module Notification = struct
type t = { name : string; pid : int; extra : string }
end (* Notification *)
module Stub = struct
(* Database Connection Functions *)
type connection
type result
external conn_isnull : connection -> bool = "PQconn_isnull" [@@noalloc]
external connect : string -> bool -> connection = "PQconnectdb_stub"
external finish : connection -> unit = "PQfinish_stub"
external reset : connection -> unit = "PQreset_stub"
external db : connection -> string = "PQdb_stub"
external user : connection -> string = "PQuser_stub"
external pass : connection -> string = "PQpass_stub"
external host : connection -> string = "PQhost_stub"
external port : connection -> string = "PQport_stub"
external tty : connection -> string = "PQtty_stub"
external options : connection -> string = "PQoptions_stub"
external connection_status :
connection -> connection_status = "PQstatus_stub" [@@noalloc]
external error_message : connection -> string = "PQerrorMessage_stub"
external backend_pid : connection -> (int [@untagged])
= "PQbackendPID_stub_bc" "PQbackendPID_stub" [@@noalloc]
external server_version : connection -> (int [@untagged])
= "PQserverVersion_stub_bc" "PQserverVersion_stub" [@@noalloc]
(* Command Execution Functions *)
external result_isnull : result -> bool = "PQres_isnull" [@@noalloc]
external exec_params :
connection -> string -> oid array -> string array -> bool array ->
bool -> result
= "PQexecParams_stub_bc" "PQexecParams_stub"
external prepare :
connection -> string -> string -> oid array -> result
= "PQprepare_stub"
external exec_prepared :
connection -> string -> string array -> bool array -> result
= "PQexecPrepared_stub"
external describe_prepared :
connection -> string -> result = "PQdescribePrepared_stub"
external result_status :
result -> result_status = "PQresultStatus_stub" [@@noalloc]
external result_error : result -> string = "PQresultErrorMessage_stub"
external result_error_field :
result -> Error_field.t -> string = "PQresultErrorField_stub"
external make_empty_res :
connection -> result_status -> result = "PQmakeEmptyPGresult_stub"
external ntuples : result -> (int [@untagged])
= "PQntuples_stub_bc" "PQntuples_stub" [@@noalloc]
external nparams : result -> (int [@untagged])
= "PQnparams_stub_bc" "PQnparams_stub"
external nfields : result -> (int [@untagged])
= "PQnfields_stub_bc" "PQnfields_stub" [@@noalloc]
external fname : result -> (int [@untagged]) -> string
= "PQfname_stub_bc" "PQfname_stub"
external fnumber : result -> string -> (int [@untagged])
= "PQfnumber_stub_bc" "PQfnumber_stub" [@@noalloc]
external fformat : result -> (int [@untagged]) -> FFormat.t
= "PQfformat_stub_bc" "PQfformat_stub" [@@noalloc]
external ftype : result -> (int [@untagged]) -> (oid [@untagged])
= "PQftype_stub_bc" "PQftype_stub" [@@noalloc]
external paramtype : result -> (int [@untagged]) -> (oid [@untagged])
= "PQparamtype_stub_bc" "PQparamtype_stub"
external fmod : result -> (int [@untagged]) -> (int [@untagged])
= "PQfmod_stub_bc" "PQfmod_stub" [@@noalloc]
external fsize : result -> (int [@untagged]) -> (int [@untagged])
= "PQfsize_stub_bc" "PQfsize_stub" [@@noalloc]
external binary_tuples : result -> bool = "PQbinaryTuples_stub" [@@noalloc]
external getvalue : result -> (int [@untagged]) -> (int [@untagged]) -> string
= "PQgetvalue_stub_bc" "PQgetvalue_stub"
external get_escaped_value :
result -> (int [@untagged]) -> (int [@untagged]) -> string
= "PQgetescval_stub_bc" "PQgetescval_stub"
external getisnull : result -> (int [@untagged]) -> (int [@untagged]) -> bool
= "PQgetisnull_stub_bc" "PQgetisnull_stub" [@@noalloc]
external getlength :
result -> (int [@untagged]) -> (int [@untagged]) -> (int [@untagged])
= "PQgetlength_stub_bc" "PQgetlength_stub" [@@noalloc]
external cmd_status : result -> string = "PQcmdStatus_stub"
external cmd_tuples : result -> string = "PQcmdTuples_stub"
external oid_value : result -> (oid [@untagged])
= "PQoidValue_stub_bc" "PQoidValue_stub" [@@noalloc]
(* Asynchronous Query Processing *)
external connect_poll :
connection -> polling_status = "PQconnectPoll_stub" [@@noalloc]
external reset_start : connection -> bool = "PQresetStart_stub" [@@noalloc]
external reset_poll :
connection -> polling_status = "PQresetPoll_stub" [@@noalloc]
external set_nonblocking : connection -> bool -> (int [@untagged])
= "PQsetnonblocking_stub_bc" "PQsetnonblocking_stub" [@@noalloc]
external is_nonblocking :
connection -> bool = "PQisnonblocking_stub" [@@noalloc]
external send_query_params :
connection -> string -> oid array -> string array -> bool array ->
(int [@untagged])
= "PQsendQueryParams_stub_bc" "PQsendQueryParams_stub"
external send_prepare :
connection -> string -> string -> oid array -> (int [@untagged])
= "PQsendPrepare_stub_bc" "PQsendPrepare_stub" [@@noalloc]
external send_query_prepared :
connection -> string -> string array -> bool array -> (int [@untagged])
= "PQsendQueryPrepared_stub_bc" "PQsendQueryPrepared_stub"
external send_describe_prepared : connection -> string -> (int [@untagged])
= "PQsendDescribePrepared_stub_bc" "PQsendDescribePrepared_stub"
external send_describe_portal : connection -> string -> (int [@untagged])
= "PQsendDescribePortal_stub_bc" "PQsendDescribePortal_stub"
external set_single_row_mode : connection -> (int [@untagged])
= "PQsetSingleRowMode_stub_bc" "PQsetSingleRowMode_stub"
external get_result : connection -> result = "PQgetResult_stub"
external consume_input : connection -> (int [@untagged])
= "PQconsumeInput_stub_bc" "PQconsumeInput_stub" [@@noalloc]
external is_busy : connection -> bool = "PQisBusy_stub"
external flush : connection -> (int [@untagged])
= "PQflush_stub_bc" "PQflush_stub" [@@noalloc]
external socket : connection -> (int [@untagged])
= "PQsocket_stub_bc" "PQsocket_stub" [@@noalloc]
external request_cancel : connection -> string option = "PQCancel_stub"
(* Asynchronous Notification *)
external notifies : connection -> Notification.t option = "PQnotifies_stub"
(* Functions Associated with the COPY Command *)
external put_copy_data :
connection -> string ->
(int [@untagged]) -> (int [@untagged]) -> (int [@untagged])
= "PQputCopyData_bc" "PQputCopyData_stub"
external put_copy_end :
connection -> string option -> (int [@untagged])
= "PQputCopyEnd_bc" "PQputCopyEnd_stub"
external get_copy_data :
connection -> (int [@untagged]) -> get_copy_result
= "PQgetCopyData_bc" "PQgetCopyData_stub"
external getline :
connection -> Bytes.t ->
(int [@untagged]) -> (int [@untagged]) -> (int [@untagged])
= "PQgetline_stub_bc" "PQgetline_stub"
external getline_async :
connection -> Bytes.t ->
(int [@untagged]) -> (int [@untagged]) -> (int [@untagged])
= "PQgetlineAsync_stub_bc" "PQgetlineAsync_stub" [@@noalloc]
external putline : connection -> string -> (int [@untagged])
= "PQputline_stub_bc" "PQputline_stub"
external putnbytes :
connection -> string ->
(int [@untagged]) -> (int [@untagged]) -> (int [@untagged])
= "PQputnbytes_stub_bc" "PQputnbytes_stub"
external endcopy : connection -> (int [@untagged])
= "PQendcopy_stub_bc" "PQendcopy_stub"
external escape_string_conn :
connection -> string ->
pos : (int [@untagged]) -> len : (int [@untagged]) -> string
= "PQescapeStringConn_stub_bc" "PQescapeStringConn_stub"
external escape_bytea_conn :
connection -> string ->
pos : (int [@untagged]) -> len : (int [@untagged]) -> string
= "PQescapeByteaConn_stub_bc" "PQescapeByteaConn_stub"
(* Control Functions *)
external set_notice_processor :
connection -> (string -> unit) -> unit = "PQsetNoticeProcessor_stub"
external set_notice_processor_num :
connection -> int -> unit = "PQsetNoticeProcessor_num"
(* Large objects *)
external lo_creat : connection -> (oid [@untagged])
= "lo_creat_stub_bc" "lo_creat_stub"
external lo_import : connection -> string -> (oid [@untagged])
= "lo_import_stub_bc" "lo_import_stub"
external lo_export :
connection -> (oid [@untagged]) -> string -> (int [@untagged])
= "lo_export_stub_bc" "lo_export_stub"
external lo_open :
connection -> (oid [@untagged]) -> (large_object [@untagged])
= "lo_open_stub_bc" "lo_open_stub"
external lo_close :
connection -> (large_object [@untagged]) -> (int [@untagged])
= "lo_close_stub_bc" "lo_close_stub"
external lo_tell :
connection -> (large_object [@untagged]) -> (int [@untagged])
= "lo_tell_stub_bc" "lo_tell_stub"
external lo_unlink : connection -> (oid [@untagged]) -> (oid [@untagged])
= "lo_unlink_stub_bc" "lo_unlink_stub"
external lo_read :
connection -> (large_object [@untagged]) ->
Bytes.t -> (int [@untagged]) -> (int [@untagged]) -> (int [@untagged])
= "lo_read_stub_bc" "lo_read_stub"
external lo_read_ba :
connection -> (large_object [@untagged]) ->
(char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t ->
(int [@untagged]) -> (int [@untagged]) -> (int [@untagged])
= "lo_read_ba_stub_bc" "lo_read_ba_stub"
external lo_write :
connection -> (large_object [@untagged]) ->
string -> (int [@untagged]) -> (int [@untagged]) -> (int [@untagged])
= "lo_write_stub_bc" "lo_write_stub"
external lo_write_ba :
connection -> (large_object [@untagged]) ->
(char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t ->
(int [@untagged]) -> (int [@untagged]) -> (int [@untagged])
= "lo_write_ba_stub_bc" "lo_write_ba_stub"
external lo_seek :
connection -> (large_object [@untagged]) ->
(int [@untagged]) -> seek_cmd -> (int [@untagged])
= "lo_lseek_stub_bc" "lo_lseek_stub"
end
(* Escaping *)
external unescape_bytea : string -> string = "PQunescapeBytea_stub"
(* Query results *)
class result res =
let nfields = Stub.nfields res in
let ntuples = Stub.ntuples res in
let nparams = lazy (Stub.nparams res) in
let check_field field =
if field < 0 || field >= nfields then
raise (Error (Field_out_of_range (field, nfields))) in
let check_param param =
let nparams = Lazy.force nparams in
if param < 0 || param >= nparams then
raise (Error (Field_out_of_range (param, nparams))) in
let check_tuple tuple =
if tuple < 0 || tuple >= ntuples then
raise (Error (Tuple_out_of_range (tuple, ntuples))) in
object
method status = Stub.result_status res
method error = Stub.result_error res
method error_field field_name = Stub.result_error_field res field_name
method error_code =
Error_code.of_sqlstate (Stub.result_error_field res Error_field.SQLSTATE)
method ntuples = ntuples
method nparams = Lazy.force nparams
method nfields = nfields
method binary_tuples = Stub.binary_tuples res
method fname field = check_field field; Stub.fname res field
method fnumber s =
let n = Stub.fnumber res s in
if n = -1 then raise Not_found else n
method fformat field =
check_field field;
Stub.fformat res field
method ftype field =
check_field field;
ftype_of_oid (Stub.ftype res field)
method ftype_oid field =
check_field field;
Stub.ftype res field
method paramtype field =
check_param field;
ftype_of_oid (Stub.paramtype res field)
method paramtype_oid field =
check_param field;
Stub.paramtype res field
method fmod field = check_field field; Stub.fmod res field
method fsize field = check_field field; Stub.fsize res field
method getvalue tuple field =
check_field field;
check_tuple tuple;
Stub.getvalue res tuple field
method get_escaped_value tuple field =
check_field field;
check_tuple tuple;
Stub.get_escaped_value res tuple field
method getisnull tuple field =
check_field field; check_tuple tuple;
Stub.getisnull res tuple field
method getlength tuple field =
check_field field; check_tuple tuple;
Stub.getlength res tuple field
method cmd_status = Stub.cmd_status res
method cmd_tuples = Stub.cmd_tuples res
method oid_value = Stub.oid_value res
method get_fnames = Array.init nfields (Stub.fname res)
method get_fnames_lst =
let lst_ref = ref [] in
for i = nfields - 1 downto 0 do
lst_ref := Stub.fname res i :: !lst_ref;
done;
!lst_ref
method get_tuple t = check_tuple t; Array.init nfields (Stub.getvalue res t)
method get_tuple_lst t =
check_tuple t;
let tpl_ref = ref [] in
for i = nfields - 1 downto 0 do
tpl_ref := Stub.getvalue res t i :: !tpl_ref;
done;
!tpl_ref
method get_all =
Array.init ntuples (fun t -> Array.init nfields (Stub.getvalue res t))
method get_all_lst =
let lst_ref = ref [] in
let nfields_1 = nfields - 1 in
for t = ntuples - 1 downto 0 do
let tpl_ref = ref [] in
for i = nfields_1 downto 0 do
tpl_ref := Stub.getvalue res t i :: !tpl_ref
done;
lst_ref := !tpl_ref :: !lst_ref
done;
!lst_ref
end
(* Connections *)
external conndefaults : unit -> conninfo_option array = "PQconndefaults_stub"
exception Finally of exn * exn
let protectx ~f x ~(finally : 'a -> unit) =
let res =
try f x
with exn ->
(try finally x with final_exn -> raise (Finally (exn, final_exn)));
raise exn
in
finally x;
res
class connection ?host ?hostaddr ?port ?dbname ?user ?password ?options ?tty
?requiressl ?conninfo ?(startonly = false) =
let conn_info =
match conninfo with
| Some conn_info -> conn_info
| None ->
let b = Buffer.create 512 in
let field name = function
| None -> ()
| Some x ->
Printf.bprintf b "%s='" name;
for i = 0 to String.length x - 1 do
if x.[i]='\''
then Buffer.add_string b "\\'"
else Buffer.add_char b x.[i]
done;
Buffer.add_string b "' " in
field "host" host;
field "hostaddr" hostaddr;
field "port" port;
field "dbname" dbname;
field "user" user;
field "password" password;
field "options" options;
field "tty" tty;
field "requiressl" requiressl;
Buffer.contents b in
fun () ->
let my_conn = Stub.connect conn_info startonly in
let () =
if Stub.connection_status my_conn = Bad then (
let s = Stub.error_message my_conn in
Stub.finish my_conn;
raise (Error (Connection_failure s)))
else Gc.finalise Stub.finish my_conn
in
let conn_mtx = Mutex.create () in
let conn_cnd = Condition.create () in
let conn_state = ref `Free in
let check_null () =
if Stub.conn_isnull my_conn then
failwith "Postgresql.check_null: connection already finished"
in
let wrap_mtx f =
Mutex.lock conn_mtx;
protectx conn_mtx
~f:(fun _ ->
check_null (); (* Check now to avoid blocking *)
f ())
~finally:Mutex.unlock
in
let wrap_conn ?(state = `Used) f =
wrap_mtx (fun () ->
while !conn_state <> `Free do Condition.wait conn_cnd conn_mtx done;
conn_state := state);
protectx conn_state
~f:(fun _ ->
check_null (); (* Check again in case the world has changed *)
f my_conn)
~finally:(fun _ ->
Mutex.lock conn_mtx;
conn_state := `Free;
Condition.signal conn_cnd;
Mutex.unlock conn_mtx)
in
let signal_error conn =
raise (Error (Connection_failure (Stub.error_message conn)))
in
let request_cancel () =
wrap_mtx (fun _ ->
match !conn_state with
| `Finishing | `Free -> ()
| `Used ->
match Stub.request_cancel my_conn with
| None -> ()
| Some err -> raise (Error (Cancel_failure err)))
in
let get_str_pos_len ~loc ?pos ?len str =
let str_len = String.length str in
match pos, len with
| None, None -> 0, str_len
| Some pos, _ when pos < 0 ->
invalid_arg (sprintf "Postgresql.%s: pos < 0" loc)
| _, Some len when len < 0 ->
invalid_arg (sprintf "Postgresql.%s: len < 0" loc)
| Some pos, None when pos > str_len ->
invalid_arg (sprintf "Postgresql.%s: pos > length(str)" loc)
| Some pos, None -> pos, str_len - pos
| None, Some len when len > str_len ->
invalid_arg (sprintf "Postgresql.%s: len > length(str)" loc)
| None, Some len -> 0, len
| Some pos, Some len when pos + len > str_len ->
invalid_arg (sprintf "Postgresql.%s: pos + len > length(str)" loc)
| Some pos, Some len -> pos, len
in
object (self)
(* Main routines *)
method finish = wrap_conn ~state:`Finishing Stub.finish
method try_reset =
wrap_conn (fun conn ->
if Stub.connection_status conn = Bad then (
Stub.reset conn;
if Stub.connection_status conn <> Ok then signal_error conn))
method reset = wrap_conn Stub.reset
(* Asynchronous Notification *)
method notifies = wrap_conn Stub.notifies
(* Control Functions *)
method set_notice_processor f =
wrap_conn (fun conn -> Stub.set_notice_processor conn f)
method set_notice_processing (h : [`Stderr | `Quiet]) =
let i = match h with `Stderr -> 0 | `Quiet -> 1 in
wrap_conn (fun conn -> Stub.set_notice_processor_num conn i)
(* Accessors *)
method db = wrap_conn Stub.db
method user = wrap_conn Stub.user
method pass = wrap_conn Stub.pass
method host = wrap_conn Stub.host
method port = wrap_conn Stub.port
method tty = wrap_conn Stub.tty
method options = wrap_conn Stub.options
method status = wrap_conn Stub.connection_status
method error_message = wrap_conn Stub.error_message
method backend_pid = wrap_conn Stub.backend_pid
method server_version =
let version =
wrap_conn (fun conn ->
let version = Stub.server_version conn in
if version <> 0 then version
else
let msg =
if Stub.connection_status conn = Bad
then "server_version failed because the connection was bad"
else "server_version failed for an unknown reason"
in
raise (Error (Connection_failure msg)))
in
let major = version / (100 * 100) in
let minor = (version / 100) mod 100 in
let revision = version mod 100 in
major, minor, revision
(* Commands and Queries *)
method empty_result status =
new result (wrap_conn (fun conn -> (Stub.make_empty_res conn status)))
method exec
?(expect = []) ?(param_types = [||]) ?(params = [||])
?(binary_params = [||]) ?(binary_result = false) query =
let r =
wrap_conn (fun conn ->
let r =
Stub.exec_params conn query param_types params
binary_params binary_result
in
if Stub.result_isnull r then signal_error conn
else r)
in
let res = new result r in
let stat = res#status in
if not (expect = []) && not (List.mem stat expect) then
raise (Error (Unexpected_status (stat, res#error, expect)))
else res
method prepare ?(param_types = [||]) stm_name query =
new result (
wrap_conn (fun conn ->
let r = Stub.prepare conn stm_name query param_types in
if Stub.result_isnull r then signal_error conn
else r))
method exec_prepared
?(expect = []) ?(params = [||]) ?(binary_params = [||]) stm_name =
let r =
wrap_conn (fun conn ->
let r = Stub.exec_prepared conn stm_name params binary_params in
if Stub.result_isnull r then signal_error conn
else r)
in
let res = new result r in
let stat = res#status in
if not (expect = []) && not (List.mem stat expect) then
raise (Error (Unexpected_status (stat, res#error, expect)))
else res
method describe_prepared query =
new result (
wrap_conn (fun conn ->
let r = Stub.describe_prepared conn query in
if Stub.result_isnull r then signal_error conn
else r))
method send_query
?(param_types = [||]) ?(params = [||]) ?(binary_params = [||]) query =
wrap_conn (fun conn ->
if Stub.send_query_params conn query param_types params binary_params
<> 1 then
signal_error conn)
method send_prepare ?(param_types = [||]) stm_name query =
wrap_conn (fun conn ->
if Stub.send_prepare conn stm_name query param_types <> 1 then
signal_error conn)
method send_query_prepared ?(params = [||]) ?(binary_params = [||]) stm_name =
wrap_conn (fun conn ->
if Stub.send_query_prepared conn stm_name params binary_params <> 1 then
signal_error conn)
method send_describe_prepared stm_name =
wrap_conn (fun conn ->
if Stub.send_describe_prepared conn stm_name <> 1 then signal_error conn)