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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
|
<html>
<head>
<title>firstworks Programming with SQL Relay using the Ruby API</title>
<link href="../css/styles.css" rel="stylesheet">
</head>
<body>
<span class="heading1">Programming with SQL Relay using the Ruby API</span><br><br>
<ul>
<li><a href="#session">Establishing a Sessions</a></li>
<li><a href="#query">Executing Queries</a></li>
<li><a href="#commit">Commits and Rollbacks</a></li>
<li><a href="#temptables">Temporary Tables</a></li>
<li><a href="#errors">Catching Errors</a></li>
<li><a href="#bindvars">Substitution and Bind Variables</a></li>
<li><a href="#rebinding">Re-Binding and Re-Executing</a></li>
<li><a href="#fields">Accessing Fields in the Result Set</a></li>
<li><a href="#largeresultsets">Dealing With Large Result Sets</a></li>
<li><a href="#cursors">Cursors</a></li>
<li><a href="#columns">Getting Column Information</a></li>
<li><a href="#storedprocedures">Stored Procedures</a></li>
<li><a href="#caching">Caching The Result Set</a></li>
<li><a href="#suspending">Suspending and Resuming Sessions</a></li>
</ul>
<a name="session"></a>
<span class="heading2">Establishing a Session</span><br><br>
<p>To use SQL Relay, you have to identify the connection that you intend to
use.</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
... execute some queries ...
</PRE>
</blockquote>
<p>After calling the constructor, a session is established when the first
query, ping() or identify() is run.</p>
<p>For the duration of the session, the client stays connected to a database
connection daemon. While one client is connected, no other client can connect.
Care should be taken to minimize the length of a session.</p>
<p>If you're using a transactional database, ending a session has a catch.
Database connection daemons can be configured to send either a commit or
rollback at the end of a session if DML queries were executed during the
session with no commit or rollback. Program accordingly.</p>
<a name="query"></a>
<span class="heading2">Executing Queries</span><br><br>
<p>Call sendQuery() or sendFileQuery() to run a query.</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_table</FONT><FONT color=#6858c8>"</FONT>)
... <B><FONT color=#a02828>do</FONT></B> some stuff that takes a short time ...
cur.sendFileQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>/usr/local/myprogram/sql</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>myquery.sql</FONT><FONT color=#6858c8>"</FONT>)
con.endSession()
... <B><FONT color=#a02828>do</FONT></B> some stuff that takes a long time ...
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_other_table</FONT><FONT color=#6858c8>"</FONT>)
con.endSession()
... process the result set ...
</PRE>
</blockquote>
<p>Note the call to endSession() after the call to sendFileQuery(). Since the
program does some stuff that takes a long time between that query and the next,
ending the session there allows another client an opportunity to use that
database connection while your client is busy. The next call to sendQuery()
establishes another session. Since the program does some stuff that takes a
short time between the first two queries, it's OK to leave the session open
between them.</p>
<a name="commit"></a>
<span class="heading2">Commits and Rollbacks</span><br><br>
<p>If you need to execute a commit or rollback, you should use the commit()
and rollback() methods of the SQLRConnection class rather than sending a
"commit" or "rollback" query. There are two reasons for this. First, it's
much more efficient to call the methods. Second, if you're writing code that
can run on transactional or non-transactional databases, some non-transactional
databases will throw errors if they receive a "commit" or "rollback" query, but
by calling the commit() and rollback() methods you instruct the database
connection daemon to call the commit and rollback API methods for that database
rather than issuing them as queries. If the API's have no commit or rollback
methods, the calls do nothing and the database throws no error. This is
especially important when using SQL Relay with ODBC.</p>
<p>You can also turn Autocommit on or off with the autoCommitOn() and
autoCommitOff() methods of the SQLRConnection class. When Autocommit is on,
the database performs a commit after each successful DML or DDL query. When
Autocommit is off, the database commits when the client instructs it to, or
(by default) when a client disconnects. For databases that don't support
Autocommit, autoCommitOn() and autoCommitOff() have no effect.</p>
<a name="temptables"></a>
<span class="heading2">Temporary Tables</span><br><br>
<p>Some databases support temporary tables. That is, tables which are
automatically dropped or truncated when an application closes it's connection
to the database or when a transaction is committed or rolled back.</p>
<p>For databases which drop or truncate tables when a transaction is committed
or rolled back, temporary tables work naturally.</p>
<p>However, for databases which drop or truncate tables when an application
closes it's connection to the database, there is an issue. Since SQL Relay
maintains persistent database connections, when an application disconnects from
SQL Relay, the connection between SQL Relay and the database remains, so
the database does not know to drop or truncate the table. To remedy this
situation, SQL Relay parses each query to see if it created a temporary table,
keeps a list of temporary tables and drops (or truncates them) when the
application disconnects from SQL Relay. Since each database has slightly
different syntax for creating a temporary table, SQL Relay parses each query
according to the rules for that database.</p>
<p>In effect, temporary tables should work when an application connects to
SQL Relay in the same manner that they would work if the application connected
directly to the database.</p>
<a name="errors"></a>
<span class="heading2">Catching Errors</span><br><br>
<p>If your call to sendQuery() or sendFileQuery() returns a 0, the query failed.
You can find out why by calling errorMessage().</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
<B><FONT color=#a02828> if</FONT></B> !cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_nonexistant_table</FONT><FONT color=#6858c8>"</FONT>) <B><FONT color=#a02828>then</FONT></B>
puts cur.errorMessage()
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
<B><FONT color=#a02828>end</FONT></B>
</PRE>
</blockquote>
<a name="bindvars"></a>
<span class="heading2">Substitution and Bind Variables</span><br><br>
<p>Programs rarely execute fixed queries. More often than not, some part
of the query is dynamically generated. The SQL Relay API provides methods for
making substitutions and binds in those queries.</p>
<p>For a detailed discussion of substitutions and binds, see
<a href="binds.html">this document</a>.</p>
<p>Rather than just calling sendQuery() you call prepareQuery(),
substitution(), inputBind() and executeQuery(). If you using queries
stored in a file, you can call prepareFileQuery() instead of prepareQuery().</p>
<p>When passing a floating point number in as a bind or substitution variable,
you have to supply precision and scale for the number. See
<a href="precisionscale.html">this page</a> for a discussion of precision and
scale.</p>
<blockquote>
<pre>
<font color="#a020f0">require</font>(<font color="#6a5acd">'</font><font color="#ff00ff">sqlrelay</font><font color="#6a5acd">'</font>)
con=<font color="#008b8b">SQLRConnection</font>.new(<font color="#6a5acd">"</font><font color="#ff00ff">host</font><font color="#6a5acd">"</font>,<font color="#ff00ff">9000</font>,<font color="#6a5acd">""</font>,<font color="#6a5acd">"</font><font color="#ff00ff">user</font><font color="#6a5acd">"</font>,<font color="#6a5acd">"</font><font color="#ff00ff">password</font><font color="#6a5acd">"</font>,<font color="#ff00ff">0</font>,<font color="#ff00ff">1</font>)
cur=<font color="#008b8b">SQLRCursor</font>.new(con)
cur.prepareQuery(<font color="#6a5acd">"</font><font color="#ff00ff">select * from mytable $(whereclause)</font><font color="#6a5acd">"</font>)
cur.substitution(<font color="#6a5acd">"</font><font color="#ff00ff">whereclause</font><font color="#6a5acd">"</font>,<font color="#6a5acd">"</font><font color="#ff00ff">where stringcol=:stringval and integercol>:integerval and floatcol>floatval</font><font color="#6a5acd">"</font>)
cur.inputBind(<font color="#6a5acd">"</font><font color="#ff00ff">stringval</font><font color="#6a5acd">"</font>,<font color="#6a5acd">"</font><font color="#ff00ff">true</font><font color="#6a5acd">"</font>)
cur.inputBind(<font color="#6a5acd">"</font><font color="#ff00ff">integerval</font><font color="#6a5acd">"</font>,<font color="#ff00ff">10</font>)
cur.inputBind(<font color="#6a5acd">"</font><font color="#ff00ff">floatval</font><font color="#6a5acd">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>)
cur.executeQuery()
... process the result set ...
</pre>
</blockquote>
<p>If you are curious how many bind variables have been declared in a query,
you can call countBindVariables() after preparing the query.</p>
<p>If you're using a database with an embedded procedural language, you may
want to retrieve data from function calls. To facilitate this, SQL Relay
provides methods for defining and retrieving output bind variables.</p>
<blockquote>
<pre>
<font color="#a020f0">require</font>(<font color="#6a5acd">'</font><font color="#ff00ff">sqlrelay</font><font color="#6a5acd">'</font>)
con=<font color="#008b8b">SQLRConnection</font>.new(<font color="#6a5acd">"</font><font color="#ff00ff">host</font><font color="#6a5acd">"</font>,<font color="#ff00ff">9000</font>,<font color="#6a5acd">""</font>,<font color="#6a5acd">"</font><font color="#ff00ff">user</font><font color="#6a5acd">"</font>,<font color="#6a5acd">"</font><font color="#ff00ff">password</font><font color="#6a5acd">"</font>,<font color="#ff00ff">0</font>,<font color="#ff00ff">1</font>)
cur=<font color="#008b8b">SQLRCursor</font>.new(con)
cur.prepareQuery(<font color="#6a5acd">"</font><font color="#ff00ff">begin :result1:=addTwoIntegers(:integer1,:integer2); :result2=addTwoFloats(:float1,:float2); :result3=convertToString(:integer3); end;</font><font color="#6a5acd">"</font>)
cur.inputBind(<font color="#6a5acd">"</font><font color="#ff00ff">integer1</font><font color="#6a5acd">"</font>,<font color="#ff00ff">10</font>)
cur.inputBind(<font color="#6a5acd">"</font><font color="#ff00ff">integer2</font><font color="#6a5acd">"</font>,<font color="#ff00ff">20</font>)
cur.inputBind(<font color="#6a5acd">"</font><font color="#ff00ff">float1</font><font color="#6a5acd">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>)
cur.inputBind(<font color="#6a5acd">"</font><font color="#ff00ff">float2</font><font color="#6a5acd">"</font>,<font color="#ff00ff">2.2</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>)
cur.inputBind(<font color="#6a5acd">"</font><font color="#ff00ff">integer3</font><font color="#6a5acd">"</font>,<font color="#ff00ff">30</font>)
cur.defineOutputBindInteger(<font color="#6a5acd">"</font><font color="#ff00ff">result1</font><font color="#6a5acd">"</font>)
cur.defineOutputBindDouble(<font color="#6a5acd">"</font><font color="#ff00ff">result2</font><font color="#6a5acd">"</font>)
cur.defineOutputBindString(<font color="#6a5acd">"</font><font color="#ff00ff">result3</font><font color="#6a5acd">"</font>,<font color="#ff00ff">100</font>)
cur.executeQuery()
result1=cur.getOutputBindInteger(<font color="#6a5acd">"</font><font color="#ff00ff">result1</font><font color="#6a5acd">"</font>)
result2=cur.getOutputBindDouble(<font color="#6a5acd">"</font><font color="#ff00ff">result2</font><font color="#6a5acd">"</font>)
result3=cur.getOutputBindString(<font color="#6a5acd">"</font><font color="#ff00ff">result3</font><font color="#6a5acd">"</font>)
con.endSession()
... <font color="#a52a2a"><b>do</b></font> something with the result ...
</pre>
</blockquote>
<p>The getOutputBindString() method returns a NULL value as an empty string.
If you would it to come back as a NULL instead, you can call the
getNullsAsNulls() method. To revert to the default behavior, you can
call getNullsAsEmptyStrings().</p>
<p>If you are using Oracle 8i or higher, you can insert data into BLOB
and CLOB columns using the inputBindBlob(), inputBindClob() methods.</p>
<blockquote>
<pre>
<font color="#a020f0">require</font>(<font color="#6a5acd">'</font><font color="#ff00ff">sqlrelay</font><font color="#6a5acd">'</font>)
con=<font color="#008b8b">SQLRConnection</font>.new(<font color="#6a5acd">"</font><font color="#ff00ff">host</font><font color="#6a5acd">"</font>,<font color="#ff00ff">9000</font>,<font color="#6a5acd">""</font>,<font color="#6a5acd">"</font><font color="#ff00ff">user</font><font color="#6a5acd">"</font>,<font color="#6a5acd">"</font><font color="#ff00ff">password</font><font color="#6a5acd">"</font>,<font color="#ff00ff">0</font>,<font color="#ff00ff">1</font>)
cur=<font color="#008b8b">SQLRCursor</font>.new(con)
cur.executeQuery(<font color="#6a5acd">"</font><font color="#ff00ff">create table images (image blob, description clob)</font><font color="#6a5acd">"</font>)
imagedata=<font color="#6a5acd">""</font>
imagelength=<font color="#6a5acd">""</font>
... read an image from a file into imagedata <font color="#a52a2a"><b>and</b></font> the length of the
file into imagelength ...
description=<font color="#6a5acd">""</font>
desclength=<font color="#6a5acd">""</font>
... read a description from a file into description <font color="#a52a2a"><b>and</b></font> the length of
the file into desclength ...
cur.prepareQuery(<font color="#6a5acd">"</font><font color="#ff00ff">insert into images values (:image,:desc)</font><font color="#6a5acd">"</font>)
cur.inputBindBlob(<font color="#6a5acd">"</font><font color="#ff00ff">image</font><font color="#6a5acd">"</font>,imagedata,imagelength)
cur.inputBindClob(<font color="#6a5acd">"</font><font color="#ff00ff">desc</font><font color="#6a5acd">"</font>,description,desclength)
cur.executeQuery()
</pre>
</blockquote>
<p>Likewise, with Oracle 8i, you can retreive BLOB or CLOB data using
defineOutputBindBlob()/getOutputBindBlob() and
defineOutputBindClob()/getOutputBindClob().</p>
<blockquote>
<pre>
<font color="#a020f0">require</font>(<font color="#6a5acd">'</font><font color="#ff00ff">sqlrelay</font><font color="#6a5acd">'</font>)
con=<font color="#008b8b">SQLRConnection</font>.new(<font color="#6a5acd">"</font><font color="#ff00ff">host</font><font color="#6a5acd">"</font>,<font color="#ff00ff">9000</font>,<font color="#6a5acd">""</font>,<font color="#6a5acd">"</font><font color="#ff00ff">user</font><font color="#6a5acd">"</font>,<font color="#6a5acd">"</font><font color="#ff00ff">password</font><font color="#6a5acd">"</font>,<font color="#ff00ff">0</font>,<font color="#ff00ff">1</font>)
cur=<font color="#008b8b">SQLRCursor</font>.new(con)
cur->prepareQuery(<font color="#6a5acd">"</font><font color="#ff00ff">begin select image into :image from images; select description into :desc from images; end;</font><font color="#6a5acd">"</font>)
cur->defineOutputBindBlob(<font color="#6a5acd">"</font><font color="#ff00ff">image</font><font color="#6a5acd">"</font>)
cur->defineOutputBindClob(<font color="#6a5acd">"</font><font color="#ff00ff">desc</font><font color="#6a5acd">"</font>)
cur->executeQuery()
image=cur->getOutputBindBlob(<font color="#6a5acd">"</font><font color="#ff00ff">image</font><font color="#6a5acd">"</font>)
imagelength=cur->getOutputBindLength(<font color="#6a5acd">"</font><font color="#ff00ff">image</font><font color="#6a5acd">"</font>)
desc=cur->getOutputBindClob(<font color="#6a5acd">"</font><font color="#ff00ff">desc</font><font color="#6a5acd">"</font>)
desclength=cur->getOutputBindLength(<font color="#6a5acd">"</font><font color="#ff00ff">desc</font><font color="#6a5acd">"</font>)
con->endSession()
... <font color="#a52a2a"><b>do</b></font> something with image <font color="#a52a2a"><b>and</b></font> desc ...
</pre>
</blockquote>
<p>Sometimes it's convenient to bind a bunch of variables that may or may not
actually be in the query. For example, if you are building a web based
application, it may be easy to just bind all the form variables/values from the
previous page, even though some of them don't appear in the query. Databases
usually generate errors in this case. Calling validateBinds() just prior to
calling executeQuery() causes the API to check the query for each bind variable
before actually binding it, preventing those kinds of errors, however there is
a performance cost associated with calling validateBinds().</p>
<a name="rebinding"></a>
<span class="heading2">Re-Binding and Re-Execution</span><br><br>
<p>Another feature of the prepare/bind/execute paradigm is the ability to
prepare, bind and execute a query once, then re-bind and re-execute the query
over and over without re-preparing it. If your backend database natively
supports this paradigm, you can reap a substantial performance improvement.</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(<FONT color=#6858c8>$con</FONT>)
cur.prepareQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from mytable where mycolumn>:value</FONT><FONT color=#6858c8>"</FONT>)
cur.inputBind(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>value</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>1</FONT>)
cur.executeQuery()
... process the result set ...
cur.clearBinds()
cur.inputBind(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>value</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>5</FONT>)
cur.executeQuery()
... process the result set ...
cur.clearBinds()
cur.inputBind(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>value</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>10</FONT>)
cur.executeQuery()
... process the result set ...
</PRE>
</blockquote>
<a name="fields"></a>
<span class="heading2">Accessing Fields in the Result Set</span><br><br>
<p>The rowCount(), colCount() and getField() methods are useful for processing
result sets.</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_table</FONT><FONT color=#6858c8>"</FONT>)
con.endSession()
<B><FONT color=#a02828>for</FONT></B> row <B><FONT color=#a02828>in</FONT></B> <FONT color=#f800f8>0</FONT>..cur.rowCount()-<FONT color=#f800f8>1</FONT> <B><FONT color=#a02828>do</FONT></B>
<B><FONT color=#a02828>for</FONT></B> col <B><FONT color=#a02828>in</FONT></B> <FONT color=#f800f8>0</FONT>..cur.colCount()-<FONT color=#f800f8>1</FONT> <B><FONT color=#a02828>do</FONT></B>
puts cur.getField(row,col)
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>,</FONT><FONT color=#6858c8>"</FONT>
<B><FONT color=#a02828>end</FONT></B>
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
<B><FONT color=#a02828>end</FONT></B>
</PRE>
</blockquote>
<p>The getField() method returns a string. If you would like to get a field as
a long or double, you can use getFieldAsLong() and getFieldAsDouble().</p>
<p>You can also use getRow() or getRowHash() to get the entire row or
getRowRange() to get a range of rows.</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_table</FONT><FONT color=#6858c8>"</FONT>)
con.endSession()
<B><FONT color=#a02828>for</FONT></B> row <B><FONT color=#a02828>in</FONT></B> <FONT color=#f800f8>0</FONT>..cur.rowCount()-<FONT color=#f800f8>1</FONT> <B><FONT color=#a02828>do</FONT></B>
rowarray=cur.getRow(row)
<B><FONT color=#a02828>for</FONT></B> col <B><FONT color=#a02828>in</FONT></B> <FONT color=#f800f8>0</FONT>..cur.colCount() <B><FONT color=#a02828>do</FONT></B>
puts rowarray[col]
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>,</FONT><FONT color=#6858c8>"</FONT>
<B><FONT color=#a02828>end</FONT></B>
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
<B><FONT color=#a02828>end</FONT></B>
</PRE>
</blockquote>
<p>The getField(), getRow() and getRowHash() methods return NULL fields
as empty strings. If you would like them to come back as nil's instead, you
can call the getNullsAsNils() method. To revert to the default behavior, you
can call getNullsAsEmptyStrings().</p>
<p>If you want to access the result set, but don't care about the
column information (column names, types or sizes) and don't mind getting
fields by their numeric index instead of by name, you can call the
dontGetColumnInfo() method prior to executing your query. This can result
in a performance improvement, especially when many queries with small
result sets are executed in rapid succession. You can call getColumnInfo()
again later to turn off this feature.</p>
<a name="largeresultsets"></a>
<span class="heading2">Dealing With Large Result Sets</span><br><br>
<p>SQL Relay normally buffers the entire result set. This can speed things up
at the cost of memory. With large enough result sets, it makes sense to buffer the result set in chunks instead of all at once.</p>
<p>Use setResultSetBufferSize() to set the number of rows to buffer at a time.
Calls to getRow(), getRowRange(), getRowHash() and getField() cause the
chunk containing the requested field to be fetched. Rows in that chunk are
accessible but rows before it are not.</p>
<p>For example, if you setResultSetBufferSize(5) and execute a query that
returns 20 rows, rows 0-4 are available at once, then rows 5-9, then 10-14,
then 15-19. When rows 5-9 are available, getField(0,0) will return NULL and
getField(11,0) will cause rows 10-14 to be fetched and return the requested
value.</p>
<p>When buffering the result set in chunks, don't end the session until after
you're done with the result set.</p>
<p>If you call setResultSetBufferSize() and forget what you set it to, you
can always call getResultSetBufferSize().</p>
<p>When buffering a result set in chunks, the rowCount() method returns
the number of rows returned so far. The firstRowIndex() method returns the
index of the first row of the currently buffered chunk.
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
cur.setResultSetBufferSize(<FONT color=#f800f8>5</FONT>)
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_table</FONT><FONT color=#6858c8>"</FONT>)
done=<FONT color=#f800f8>0</FONT>
row=<FONT color=#f800f8>0</FONT>
<B><FONT color=#a02828> while</FONT></B> done!=0 <B><FONT color=#a02828>do</FONT></B>
<B><FONT color=#a02828>for</FONT></B> col <B><FONT color=#a02828>in</FONT></B> <FONT color=#f800f8>0</FONT>..cur.colCount()-<FONT color=#f800f8>1</FONT> <B><FONT color=#a02828>do</FONT></B>
<B><FONT color=#a02828> if</FONT></B> field=cur.getField(row,col) <B><FONT color=#a02828>then</FONT></B>
puts field
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>,</FONT><FONT color=#6858c8>"</FONT>
<B><FONT color=#a02828>else</FONT></B>
done=<FONT color=#f800f8>1</FONT>
<B><FONT color=#a02828>end</FONT></B>
<B><FONT color=#a02828>end</FONT></B>
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
row++
<B><FONT color=#a02828>end</FONT></B>
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_other_table</FONT><FONT color=#6858c8>"</FONT>)
... process this querys result set <B><FONT color=#a02828>in</FONT></B> chunks also ...
cur.setResultSetBufferSize(<FONT color=#f800f8>0</FONT>)
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_third_table</FONT><FONT color=#6858c8>"</FONT>)
... process this querys result set all at once ...
con.endSession()
</PRE>
</blockquote>
<a name="cursors"></a>
<span class="heading2">Cursors</span><br><br>
<p>Cursors make it possible to execute queries while processing the result
set of another query. You can select rows from a table in one query, then
iterate through it's result set, inserting rows into another table, using only
1 database connection for both operations.</p>
<p>For example:</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cursor1=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
cursor2=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
cursor1.setResultSetBufferSize(<FONT color=#f800f8>10</FONT>)
cursor1.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_huge_table</FONT><FONT color=#6858c8>"</FONT>)
index=<FONT color=#f800f8>0</FONT>
<B><FONT color=#a02828>while</FONT></B> cursor1.endOfResultSet()!=1 <B><FONT color=#a02828>do</FONT></B>
cursor2.prepareQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>insert into my_other_table values (:1,:2,:3)</FONT><FONT color=#6858c8>"</FONT>)
cursor2.inputBind(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>1</FONT><FONT color=#6858c8>"</FONT>,cursor1.getField(index,<FONT color=#f800f8>1</FONT>))
cursor2.inputBind(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>2</FONT><FONT color=#6858c8>"</FONT>,cursor1.getField(index,<FONT color=#f800f8>2</FONT>))
cursor2.inputBind(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>3</FONT><FONT color=#6858c8>"</FONT>,cursor1.getField(index,<FONT color=#f800f8>3</FONT>))
cursor2.executeQuery()
<B><FONT color=#a02828>end</FONT></B>
</PRE>
</blockquote>
<p>Prior to SQL Relay version 0.25, you would have had to buffer the first
result set or use 2 database connections instead of just 1.</p>
<p>If you are using stored procedures with Oracle 8i or higher, a stored
procedure can execute a query and return a cursor. A cursor bind variable can
then retrieve that cursor. Your program can retrieve the result set from the
cursor. All of this can be accomplished using defineOutputBindCursor(),
getOutputBindCursor() and fetchFromOutputBindCursor().</p>
<blockquote>
PL/SQL Procedure:<br>
<pre>
<font color="#6858c8">FUNCTION</font> sp_mytable <font color="#6858c8">RETURN</font> types.cursorType
l_cursor types.cursorType;
<font color="#6858c8">BEGIN</font>
OPEN l_cursor <font color="#6858c8">FOR</font> <font color="#a02828"><b>SELECT</b></font> * <font color="#6858c8">FROM</font> mytable;
<font color="#6858c8">RETURN</font> l_cursor;
<font color="#6858c8">END</font>;
</pre>
<br>
Program code:
<pre>
<font color="#a020f0">require</font>(<font color="#6858c8">'</font><font color="#f800f8">sqlrelay</font><font color="#6858c8">'</font>)
con=<font color="#6858c8">SQLRConnection</font>.new(<font color="#6858c8">"</font><font color="#f800f8">host</font><font color="#6858c8">"</font>,<font color="#f800f8">9000</font>,<font color="#6858c8">""</font>,<font color="#6858c8">"</font><font color="#f800f8">user</font><font color="#6858c8">"</font>,<font color="#6858c8">"</font><font color="#f800f8">password</font><font color="#6858c8">"</font>,<font color="#f800f8">0</font>,<font color="#f800f8">1</font>)
cur=<font color="#6858c8">SQLRCursor</font>.new(con)
cur.prepareQuery(<font color="#6858c8">"</font><font color="#f800f8">begin :curs:=sp_mytable end;</font><font color="#6858c8">"</font>)
cur.defineOutputBindCursor(<font color="#6858c8">"</font><font color="#f800f8">curs</font><font color="#6858c8">"</font>)
cur.executeQuery()
bindcur=cur.getOutputBindCursor(<font color="#6858c8">"</font><font color="#f800f8">curs</font><font color="#6858c8">"</font>)
bindcur.fetchFromBindCursor()
<font color="#0000f8"># print fields from table</font>
<font color="#a02828"><b>for</b></font> i <font color="#a02828"><b>in</b></font> <font color="#f800f8">0</font>..bindcur.rowCount()-<font color="#f800f8">1</font> <font color="#a02828"><b>do</b></font>
<font color="#a02828"><b>for</b></font> j <font color="#a02828"><b>in</b></font> <font color="#f800f8">0</font>..bindcur.colCount()-<font color="#f800f8">1</font> <font color="#a02828"><b>do</b></font>
puts bindcur.getField(i,j)
puts <font color="#6858c8">"</font><font color="#f800f8">, </font><font color="#6858c8">"</font>
<font color="#a02828"><b>end</b></font>
puts <font color="#6858c8">"</font><font color="#6858c8">\n</font><font color="#6858c8">"</font>
<font color="#a02828"><b>end</b></font>
</pre>
</blockquote>
<p>The number of cursors simultaneously available per-connection is set at
compile time and defaults to 5.</p>
<a name="columns"></a>
<span class="heading2">Getting Column Information</span><br><br>
<p>For each column, the API supports getting the name, type and length of each
field. All databases support these attributes. The API also supports
getting the precision, scale (see <a href="precisionscale.html">this page</a>
for a discussion of precision and scale), length of the longest field, and
whether the
column is nullable, the primary key, unique, part of a key, unsigned,
zero-filled, binary, or an auto-incrementing field. However, not all databases
support these attributes. If a database doesn't support an attribute, it is
always returned as false.</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_table</FONT><FONT color=#6858c8>"</FONT>)
con.endSession()
<B><FONT color=#a02828>for</FONT></B> i <B><FONT color=#a02828>in</FONT></B> <FONT color=#f800f8>0</FONT>..cur.colCount()-<FONT color=#f800f8>1</FONT> <B><FONT color=#a02828>do</FONT></B>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Name: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnName(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Type: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnType(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Length: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnLength(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Precision: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnPrecision(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Scale: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnScale(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Longest Field: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getLongest(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Nullable: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnIsNullable(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Primary Key: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnIsPrimaryKey(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Unique: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnIsUnique(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Part Of Key: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnIsPartOfKey(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Unsigned: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnIsUnsigned(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Zero Filled: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnIsZeroFilled(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Binary: </FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnIsBinary(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>Auto Increment:</FONT><FONT color=#6858c8>"</FONT>
puts cur.getColumnIsAutoIncrement(i)
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
<B><FONT color=#a02828>end</FONT></B>
</PRE>
</blockquote>
<p>Some databases force column names to upper case, others force column names
to lower case, and others still support mixed-case column names. Sometimes,
when migrating between databases, you can run into trouble. You can use
upperCaseColumnNames() and lowerCaseColumnNames() to cause column names to be
converted to upper or lower case, or you can use mixedCaseColumnNames() to
cause column names to be returned in the same case as they are defined in the
database.</p>
<blockquote>
<pre>
<font color="#a020f0">require</font>(<font color="#6858c8">'</font><font color="#f800f8">sqlrelay</font><font color="#6858c8">'</font>)
con=<font color="#6858c8">SQLRConnection</font>.new(<font color="#6858c8">"</font><font color="#f800f8">host</font><font color="#6858c8">"</font>,<font color="#f800f8">9000</font>,<font color="#6858c8">""</font>,<font color="#6858c8">"</font><font color="#f800f8">user</font><font color="#6858c8">"</font>,<font color="#6858c8">"</font><font color="#f800f8">password</font><font color="#6858c8">"</font>,<font color="#f800f8">0</font>,<font color="#f800f8">1</font>)
cur=<font color="#6858c8">SQLRCursor</font>.new(con)
<font color="#0000f8"># column names will be forced to upper case</font>
cur.upperCaseColumnNames()
cur.sendQuery(<font color="#6858c8">"</font><font color="#f800f8">select * from my_table</font><font color="#6858c8">"</font>)
con.endSession()
<font color="#a02828"><b>for</b></font> i <font color="#a02828"><b>in</b></font> <font color="#f800f8">0</font>..cur.colCount()-<font color="#f800f8">1</font> <font color="#a02828"><b>do</b></font>
puts <font color="#6858c8">"</font><font color="#f800f8">Name: </font><font color="#6858c8">"</font>
puts cur.getColumnName(i)
puts <font color="#6858c8">"</font><font color="#6858c8">\n</font><font color="#6858c8">"</font>
<font color="#a02828"><b>end</b></font>
<font color="#0000f8"># column names will be forced to lower case</font>
cur.lowerCaseColumnNames()
cur.sendQuery(<font color="#6858c8">"</font><font color="#f800f8">select * from my_table</font><font color="#6858c8">"</font>)
con.endSession()
<font color="#a02828"><b>for</b></font> i <font color="#a02828"><b>in</b></font> <font color="#f800f8">0</font>..cur.colCount()-<font color="#f800f8">1</font> <font color="#a02828"><b>do</b></font>
puts <font color="#6858c8">"</font><font color="#f800f8">Name: </font><font color="#6858c8">"</font>
puts cur.getColumnName(i)
puts <font color="#6858c8">"</font><font color="#6858c8">\n</font><font color="#6858c8">"</font>
<font color="#a02828"><b>end</b></font>
<font color="#0000f8"># column names will be the same as they are in the database</font>
cur.mixedCaseColumnNames()
cur.sendQuery(<font color="#6858c8">"</font><font color="#f800f8">select * from my_table</font><font color="#6858c8">"</font>)
con.endSession()
<font color="#a02828"><b>for</b></font> i <font color="#a02828"><b>in</b></font> <font color="#f800f8">0</font>..cur.colCount()-<font color="#f800f8">1</font> <font color="#a02828"><b>do</b></font>
puts <font color="#6858c8">"</font><font color="#f800f8">Name: </font><font color="#6858c8">"</font>
puts cur.getColumnName(i)
puts <font color="#6858c8">"</font><font color="#6858c8">\n</font><font color="#6858c8">"</font>
<font color="#a02828"><b>end</b></font>
</pre>
</blockquote>
<a name="storedprocedures"></a>
<span class="heading2">Stored Procedures</span><br><br>
<p>Many databases support stored procedures. Stored procedures are sets of
queries and procedural code that are executed inside of the database itself.
For example, a stored procedure may select rows from one table, iterate through
the result set and, based on the values in each row, insert, update or delete
rows in other tables. A client program could do this as well, but a stored
procedure is generally more efficient because queries and result sets don't
have to be sent back and forth between the client and database. Also, stored
procedures are generally stored in the database in a compiled state, while
queries may have to be re-parsed and re-compiled each time they are sent.</p>
<p>While many databases support stored procedures. The syntax for creating
and executing stored procedures varies greatly between databases.</p>
<p>SQL Relay supports stored procedures for most databases, but there are
some caveats. Stored procedures are not currently supported when using FreeTDS
against Sybase or Microsoft SQL Server. Blob/Clob bind variables are only
supported in Oracle 8i or higher. Sybase stored procedures must use varchar
output parameters.</p>
<p>Stored procedures typically take input paramters from client programs through
input bind variables and return values back to client programs either through
bind variables or result sets. Stored procedures can be broken down into
several categories, based on the values that they return. Some stored
procedures don't return any values, some return a single value, some return
multiple values and some return entire result sets.</p>
<span class="heading3">No Values</span><br>
<p>Some stored procedures don't return any values. Below are examples,
illustrating how to create, execute and drop this kind of stored procedure for
each database that SQL Relay supports.</p>
<span class="heading4">Oracle</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc(in1 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>number</b></font>, in2 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>number</b></font>, in3 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>varchar2</b></font>) <font color="#6b59ce">is</font>
<font color="#6b59ce">begin</font>
<font color="#a52829"><b>insert</b></font> <font color="#6b59ce">into</font> mytable <font color="#6b59ce">values</font> (in1,in2,in3);
<font color="#6b59ce">end</font>;
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">begin testproc(:in1,:in2,:in3); end;</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">Sybase and Microsoft SQL Server</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc @in1 int, @in2 <font color="#298a52"><b>float</b></font>, @in3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>) <font color="#6b59ce">as</font>
<font color="#a52829"><b>insert</b></font> <font color="#6b59ce">into</font> mytable <font color="#6b59ce">values</font> (@in1,@in2,@in3)
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">exec testproc</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">Interbase and Firebird</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc(in1 <font color="#298a52"><b>integer</b></font>, in2 <font color="#298a52"><b>float</b></font>, in3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>)) <font color="#6b59ce">as</font>
<font color="#6b59ce">begin</font>
<font color="#a52829"><b>insert</b></font> <font color="#6b59ce">into</font> mytable <font color="#6b59ce">values</font> (in1,in2,in3);
suspend;
<font color="#6b59ce">end</font>;
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">execute procedure testproc ?, ?, ?</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">DB2</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc(<font color="#a52829"><b>in</b></font> in1 int, <font color="#a52829"><b>in</b></font> in2 double, <font color="#a52829"><b>in</b></font> in3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>)) language sql
<font color="#6b59ce">begin</font>
<font color="#a52829"><b>insert</b></font> <font color="#6b59ce">into</font> mytable <font color="#6b59ce">values</font> (in1,in2,in3);
<font color="#6b59ce">end</font>;
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">call testproc(?,?,?)</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">Postgresql</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">function</font> testproc(int,<font color="#298a52"><b>float</b></font>,<font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>)) returns void <font color="#6b59ce">as</font> '
<font color="#6b59ce">begin</font>
<font color="#a52829"><b>insert</b></font> <font color="#6b59ce">into</font> mytable <font color="#6b59ce">values</font> ($<font color="#ff00ff">1</font>,$<font color="#ff00ff">2</font>,$<font color="#ff00ff">3</font>);
<font color="#6b59ce">return</font>;
<font color="#6b59ce">end</font>;' language plpgsql
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">select testproc(:in1,:in2,:in3)</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<br><span class="heading3">Single Values</span><br>
<p>Some stored procedures return single values. Below are examples,
illustrating how to create, execute and drop this kind of stored procedure for
each database that SQL Relay supports.</p>
<span class="heading4">Oracle</span><br>
<p>In Oracle, stored procedures can return values through output parameters or
as return values of the procedure itself.</p>
<p>Here is an example where the procedure itself returns a value. Note that
Oracle calls these functions.</p>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">function</font> testproc(in1 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>number</b></font>, in2 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>number</b></font>, in3 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>varchar2</b></font>) returns <font color="#298a52"><b>number</b></font> <font color="#6b59ce">is</font>
<font color="#6b59ce">begin</font>
<font color="#6b59ce">return</font> in1;
<font color="#6b59ce">end</font>;
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">select testproc(:in1,:in2,:in3) from dual</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
result=cur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">0</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">function</font> testproc
</pre>
</blockquote>
<p>Here is an example where the value is returned through an output
parameter.</p>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc(in1 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>number</b></font>, in2 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>number</b></font>, in3 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>varchar2</b></font>, out1 <font color="#a52829"><b>out</b></font> <font color="#298a52"><b>number</b></font>) <font color="#6b59ce">as</font>
<font color="#6b59ce">begin</font>
out1:=in1;
<font color="#6b59ce">end</font>;
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">begin testproc(:in1,:in2,:in3,:out1); end;</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.defineOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">out1</font><font color="#6b59ce">"</font>);
cur.executeQuery();
result=cur.getOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">out1</font><font color="#6b59ce">"</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">Sybase and Microsoft SQL Server</span><br>
<p>In Sybase and Microsoft SQL Server, stored procedures return values
through output parameters rather than as return values of the procedure
itself.</p>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc @in1 int, @in2 <font color="#298a52"><b>float</b></font>, @in3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>), @out1 int output <font color="#6b59ce">as</font>
<font color="#a52829"><b>select</b></font> @out1=@in1
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">exec testproc</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.defineOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">out1</font><font color="#6b59ce">"</font>);
cur.executeQuery();
result=cur.getOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">out1</font><font color="#6b59ce">"</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">Interbase and Firebird</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc(in1 <font color="#298a52"><b>integer</b></font>, in2 <font color="#298a52"><b>float</b></font>, in3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>)) returns (out1 <font color="#298a52"><b>integer</b></font>) <font color="#6b59ce">as</font>
<font color="#6b59ce">begin</font>
out1=in1;
suspend;
<font color="#6b59ce">end</font>;
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">select * from testproc(?,?,?)</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
result=cur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">0</font>);
</pre>
</blockquote>
<p>Alternatively, you can run a query like the following and receive the result
using an output bind variable. Note that in Interbase/Firebird, input and
output bind variable indices are distict from one another. The index of the
output bind variable is 1 rather than 4, even though there were 3 input bind
variables.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">execute procedure testproc ?, ?, ?</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.defineOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>);
cur.executeQuery();
result=cur.getOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">DB2</span><br>
<p>In DB2, stored procedures return values through output parameters rather
than as return values of the procedure itself.</p>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc(<font color="#a52829"><b>in</b></font> in1 int, <font color="#a52829"><b>in</b></font> in2 double, <font color="#a52829"><b>in</b></font> in3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>), <font color="#a52829"><b>out</b></font> out1 int) language sql
<font color="#6b59ce">begin</font>
<font color="#a52829"><b>set</b></font> out1 = in1;
<font color="#6b59ce">end</font>
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">call testproc(?,?,?,?)</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.defineOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">4</font><font color="#6b59ce">"</font>);
cur.executeQuery();
result=cur.getOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">4</font><font color="#6b59ce">"</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">Postgresql</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">function</font> testfunc(int,<font color="#298a52"><b>float</b></font>,<font color="#298a52"><b>char</b></font>(<font color="#ff00ff">20</font>)) returns int <font color="#6b59ce">as</font> '
declare
in1 int;
in2 <font color="#298a52"><b>float</b></font>;
in3 <font color="#298a52"><b>char</b></font>(<font color="#ff00ff">20</font>);
<font color="#6b59ce">begin</font>
in1:=$<font color="#ff00ff">1</font>;
<font color="#6b59ce">return</font>;
<font color="#6b59ce">end</font>;
' language plpgsql
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">select * from testfunc(:in1,:in2,:in3)</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">4</font>,<font color="#ff00ff">2</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
result=cur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">0</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">function</font> testfunc(int,<font color="#298a52"><b>float</b></font>,<font color="#298a52"><b>char</b></font>(<font color="#ff00ff">20</font>))
</pre>
</blockquote>
<br><span class="heading3">Multiple Values</span><br>
<p>Some stored procedures return multiple values. Below are examples,
illustrating how to create, execute and drop this kind of stored procedure for
each database that SQL Relay supports.</p>
<span class="heading4">Oracle</span><br>
<p>In Oracle, stored procedures can return values through output parameters or
as return values of the procedure itself. If a procedure needs to return
multiple values, it can return one of them as the return value of the procedure
itself, but the rest must be returned through output parameters.</p>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc(in1 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>number</b></font>, in2 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>number</b></font>, in3 <font color="#a52829"><b>in</b></font> <font color="#298a52"><b>varchar2</b></font>, out1 <font color="#a52829"><b>out</b></font> <font color="#298a52"><b>number</b></font>, out2 <font color="#a52829"><b>out</b></font> <font color="#298a52"><b>number</b></font>, out3 <font color="#a52829"><b>out</b></font> <font color="#298a52"><b>varchar2</b></font>) <font color="#6b59ce">is</font>
<font color="#6b59ce">begin</font>
out1:=in1;
out2:=in2;
out3:=in3;
<font color="#6b59ce">end</font>;
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">begin testproc(:in1,:in2,:in3,:out1,:out2,:out3); end;</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.defineOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">out1</font><font color="#6b59ce">"</font>);
cur.defineOutputBindDouble(<font color="#6b59ce">"</font><font color="#ff00ff">out2</font><font color="#6b59ce">"</font>);
cur.defineOutputBindString(<font color="#6b59ce">"</font><font color="#ff00ff">out3</font><font color="#6b59ce">"</font>,<font color="#ff00ff">20</font>);
cur.executeQuery();
out1=cur.getOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">out1</font><font color="#6b59ce">"</font>);
out2=cur.getOutputBindDouble(<font color="#6b59ce">"</font><font color="#ff00ff">out2</font><font color="#6b59ce">"</font>);
out3=cur.getOutputBindString(<font color="#6b59ce">"</font><font color="#ff00ff">out3</font><font color="#6b59ce">"</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">Sybase and Microsoft SQL Server</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc @in1 int, @in2 <font color="#298a52"><b>float</b></font>, @in3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>), @out1 int output, @out2 int output, @out3 int output <font color="#6b59ce">as</font>
<font color="#a52829"><b>select</b></font> @out1=@in1,
@out2=@in2,
@out3=@in3
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">exec testproc</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.defineOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">out1</font><font color="#6b59ce">"</font>);
cur.defineOutputBindDouble(<font color="#6b59ce">"</font><font color="#ff00ff">out2</font><font color="#6b59ce">"</font>);
cur.defineOutputBindString(<font color="#6b59ce">"</font><font color="#ff00ff">out3</font><font color="#6b59ce">"</font>,<font color="#ff00ff">20</font>);
cur.executeQuery();
out1=cur.getOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">out1</font><font color="#6b59ce">"</font>);
out2=cur.getOutputBindDouble(<font color="#6b59ce">"</font><font color="#ff00ff">out2</font><font color="#6b59ce">"</font>);
out3=cur.getOutputBindString(<font color="#6b59ce">"</font><font color="#ff00ff">out3</font><font color="#6b59ce">"</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">Interbase and Firebird</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc(in1 <font color="#298a52"><b>integer</b></font>, in2 <font color="#298a52"><b>float</b></font>, in3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>)) returns (out1 <font color="#298a52"><b>integer</b></font>, out2 <font color="#298a52"><b>float</b></font>, out3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>)) <font color="#6b59ce">as</font>
<font color="#6b59ce">begin</font>
out1=in1;
out2=in2;
out3=in3;
suspend;
<font color="#6b59ce">end</font>;
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">select * from testproc(?,?,?)</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
out1=cur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">0</font>);
out2=cur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">1</font>);
out3=cur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">2</font>);
</pre>
</blockquote>
<p>Alternatively, you can run a query like the following and receive the result
using a output bind variables. Note that in Interbase/Firebird, input and
output bind variable indices are distict from one another. The index of the
first output bind variable is 1 rather than 4, even though there were 3 input
bind variables.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">execute procedure testproc ?, ?, ?</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.defineOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>);
cur.defineOutputBindDouble(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>);
cur.defineOutputBindString(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>,<font color="#ff00ff">20</font>);
cur.executeQuery();
out1=cur.getOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>);
out2=cur.getOutputBindDouble(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>);
out3=cur.getOutputBindString(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">DB2</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">procedure</font> testproc(<font color="#a52829"><b>in</b></font> in1 int, <font color="#a52829"><b>in</b></font> in2 double, <font color="#a52829"><b>in</b></font> in3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>), <font color="#a52829"><b>out</b></font> out1 int, <font color="#a52829"><b>out</b></font> out2 double, <font color="#a52829"><b>out</b></font> out3 <font color="#298a52"><b>varchar</b></font>(<font color="#ff00ff">20</font>)) language sql
<font color="#6b59ce">begin</font>
<font color="#a52829"><b>set</b></font> out1 = in1;
<font color="#a52829"><b>set</b></font> out2 = in2;
<font color="#a52829"><b>set</b></font> out3 = in3;
<font color="#6b59ce">end</font>
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">call testproc(?,?,?,?,?,?)</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">2</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.defineOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">4</font><font color="#6b59ce">"</font>);
cur.defineOutputBindDouble(<font color="#6b59ce">"</font><font color="#ff00ff">5</font><font color="#6b59ce">"</font>);
cur.defineOutputBindString(<font color="#6b59ce">"</font><font color="#ff00ff">6</font><font color="#6b59ce">"</font>,<font color="#ff00ff">25</font>);
cur.executeQuery();
out1=cur.getOutputBindInteger(<font color="#6b59ce">"</font><font color="#ff00ff">4</font><font color="#6b59ce">"</font>);
out2=cur.getOutputBindDouble(<font color="#6b59ce">"</font><font color="#ff00ff">5</font><font color="#6b59ce">"</font>);
out3=cur.getOutputBindString(<font color="#6b59ce">"</font><font color="#ff00ff">6</font><font color="#6b59ce">"</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">procedure</font> testproc
</pre>
</blockquote>
<span class="heading4">Postgresql</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">function</font> testfunc(int,<font color="#298a52"><b>float</b></font>,<font color="#298a52"><b>char</b></font>(<font color="#ff00ff">20</font>)) returns record <font color="#6b59ce">as</font> '
declare
output record;
<font color="#6b59ce">begin</font>
<font color="#a52829"><b>select</b></font> $<font color="#ff00ff">1</font>,$<font color="#ff00ff">2</font>,$<font color="#ff00ff">3</font> <font color="#6b59ce">into</font> output;
<font color="#6b59ce">return</font> output;
<font color="#6b59ce">end</font>;
' language plpgsql
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">select * from testfunc(:in1,:in2,:in3) as (col1 int, col2 float, col3 char(20))</font><font color="#6b59ce">"</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in1</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in2</font><font color="#6b59ce">"</font>,<font color="#ff00ff">1.1</font>,<font color="#ff00ff">4</font>,<font color="#ff00ff">2</font>);
cur.inputBind(<font color="#6b59ce">"</font><font color="#ff00ff">in3</font><font color="#6b59ce">"</font>,<font color="#6b59ce">"</font><font color="#ff00ff">hello</font><font color="#6b59ce">"</font>);
cur.executeQuery();
out1=cur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">0</font>);
out2=cur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">1</font>);
out3=cur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">2</font>);
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">function</font> testfunc(int,<font color="#298a52"><b>float</b></font>,<font color="#298a52"><b>char</b></font>(<font color="#ff00ff">20</font>))
</pre>
</blockquote>
<br><span class="heading3">Result Sets</span><br>
<p>Some stored procedures return entire result sets. Below are examples,
illustrating how to create, execute and drop this kind of stored procedure for
each database that SQL Relay supports.</p>
<span class="heading4">Oracle</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#a52829"><b>or</b></font> replace package types <font color="#6b59ce">as</font>
<font color="#6b59ce">type</font> cursorType <font color="#6b59ce">is</font> ref <font color="#6b59ce">cursor</font>;
<font color="#6b59ce">end</font>;
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">function</font> testproc <font color="#6b59ce">return</font> types.cursortype <font color="#6b59ce">is</font>
l_cursor types.cursorType;
<font color="#6b59ce">begin</font>
open l_cursor <font color="#6b59ce">for</font> <font color="#a52829"><b>select</b></font> * <font color="#6b59ce">from</font> mytable;
<font color="#6b59ce">return</font> l_cursor;
<font color="#6b59ce">end</font>;
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.prepareQuery(<font color="#6b59ce">"</font><font color="#ff00ff">begin :curs:=testproc; end;</font><font color="#6b59ce">"</font>);
cur.defineOutputBindCursor(<font color="#6b59ce">"</font><font color="#ff00ff">curs</font><font color="#6b59ce">"</font>);
cur.executeQuery();
bindcur=cur.getOutputBindCursor(<font color="#6b59ce">"</font><font color="#ff00ff">curs</font><font color="#6b59ce">"</font>);
bindcur.fetchFromBindCursor();
field00=bindcur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">0</font>);
field01=bindcur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">1</font>);
field02=bindcur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">2</font>);
field10=bindcur.getField(<font color="#ff00ff">1</font>,<font color="#ff00ff">0</font>);
field11=bindcur.getField(<font color="#ff00ff">1</font>,<font color="#ff00ff">1</font>);
field12=bindcur.getField(<font color="#ff00ff">1</font>,<font color="#ff00ff">2</font>);
...
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">function</font> testproc
<font color="#a52829"><b>drop</b></font> package types
</pre>
</blockquote>
<span class="heading4">Sybase and Microsoft SQL Server</span><br>
<p>Stored procedures in Sybase and Microsoft SQL Server can return a result
set if the last command in the procedure is a select query, however SQL Relay
doesn't currently support stored procedures that return result sets.</p>
<span class="heading4">Interbase and Firebird</span><br>
<p>Stored procedures in Interbase and Firebird can return a result set if a
select query in the procedure selects values into the output parameters and
then issues a suspend command, however SQL Relay doesn't currently support
stored procedures that return result sets.</p>
<span class="heading4">DB2</span><br>
<p>Stored procedures in DB2 can return a result set if the procedure is declared
to return one, however SQL Relay doesn't currently support stored procedures
that return result sets.</p>
<span class="heading4">Postgresql</span><br>
<p>To create the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>create</b></font> <font color="#6b59ce">function</font> testfunc() returns setof record <font color="#6b59ce">as</font> '
declare output record;
<font color="#6b59ce">begin</font>
<font color="#6b59ce">for</font> output <font color="#a52829"><b>in</b></font> <font color="#a52829"><b>select</b></font> * <font color="#6b59ce">from</font> mytable <font color="#6b59ce">loop</font>
<font color="#6b59ce">return</font> next output;
<font color="#6b59ce">end</font> <font color="#6b59ce">loop</font>;
<font color="#6b59ce">return</font>;
<font color="#6b59ce">end</font>;
' language plpgsql
</pre>
</blockquote>
<p>To execute the stored procedure from an SQL Relay program, use code like the
following.</p>
<blockquote>
<pre>
cur.sendQuery(<font color="#6b59ce">"</font><font color="#ff00ff">select * from testfunc() as (testint int, testfloat float, testchar char(40))</font><font color="#6b59ce">"</font>);
field00=bindcur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">0</font>);
field01=bindcur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">1</font>);
field02=bindcur.getField(<font color="#ff00ff">0</font>,<font color="#ff00ff">2</font>);
field10=bindcur.getField(<font color="#ff00ff">1</font>,<font color="#ff00ff">0</font>);
field11=bindcur.getField(<font color="#ff00ff">1</font>,<font color="#ff00ff">1</font>);
field12=bindcur.getField(<font color="#ff00ff">1</font>,<font color="#ff00ff">2</font>);
...
</pre>
</blockquote>
<p>To drop the stored procedure, run a query like the following.</p>
<blockquote>
<pre>
<font color="#a52829"><b>drop</b></font> <font color="#6b59ce">function</font> testfunc
</pre>
</blockquote>
<a name="caching"></a>
<span class="heading2">Caching The Result Set</span><br><br>
<p>Say you're writing a web-based report where a query with a huge result set
is executed and 20 rows are displayed per page. Rather than rerunning the
query for every page every time and dumping all but the 20 rows you want to
display, you can run the query once, cache the result set to a local file and
just open the file for each page of the report.</p>
<p>First CGI:</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
... generate a unique file name ...
cur.cacheToFile(filename)
cur.setCacheTtl(<FONT color=#f800f8>600</FONT>)
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>select * from my_table</FONT><FONT color=#6858c8>"</FONT>)
con.endSession()
cur.cacheOff()
... pass the filename to the <B><FONT color=#a02828>next</FONT></B> page ...
</PRE>
</blockquote>
<p>Second CGI:</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
... get the filename from the previous page ...
... get the page to display from the previous page ...
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
cur.openCachedResultSet(filename)
con.endSession()
<B><FONT color=#a02828>for</FONT></B> row <B><FONT color=#a02828>in</FONT></B> pagetodisplay*<FONT color=#f800f8>20</FONT>..((pagetodisplay+<FONT color=#f800f8>1</FONT>)*<FONT color=#f800f8>20</FONT>)-<FONT color=#f800f8>1</FONT> <B><FONT color=#a02828>do</FONT></B>
<B><FONT color=#a02828>for</FONT></B> col <B><FONT color=#a02828>in</FONT></B> <FONT color=#f800f8>0</FONT>..cur.colCount()-<FONT color=#f800f8>1</FONT> <B><FONT color=#a02828>do</FONT></B>
puts cur.getField(row,col)
puts <FONT color=#6858c8>"</FONT><FONT color=#f800f8>,</FONT><FONT color=#6858c8>"</FONT>
<B><FONT color=#a02828>end</FONT></B>
puts <FONT color=#6858c8>"</FONT><FONT color=#6858c8>\n</FONT><FONT color=#6858c8>"</FONT>
<B><FONT color=#a02828>end</FONT></B>
</PRE>
</blockquote>
<a name="suspending"></a>
<span class="heading2">Suspending and Resuming Sessions</span><br><br>
<p>Sometimes web-based applications need a single database transaction to span
multiple pages. Since SQL Relay sessions can be suspended and resumed, this
is possible.</p>
<p>First CGI:</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>insert into my_table values (1,2,3)</FONT><FONT color=#6858c8>"</FONT>)
cur.suspendResultSet()
con.suspendSession()
rs=cur.getResultSetId()
port=con.getConnectionPort()
socket=con.getConnectionSocket()
... pass the rs, port <B><FONT color=#a02828>and</FONT></B> socket to the <B><FONT color=#a02828>next</FONT></B> page ...
</PRE>
</blockquote>
<p>Second CGI:</p>
<blockquote>
<PRE>
<FONT color=#a020f0>require</FONT>(<FONT color=#6858c8>'</FONT><FONT color=#f800f8>sqlrelay</FONT><FONT color=#6858c8>'</FONT>)
... get port <B><FONT color=#a02828>and</FONT></B> socket from previous page ...
con=<FONT color=#6858c8>SQLRConnection</FONT>.new(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>host</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>9000</FONT>,<FONT color=#6858c8>""</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>user</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#6858c8>"</FONT><FONT color=#f800f8>password</FONT><FONT color=#6858c8>"</FONT>,<FONT color=#f800f8>0</FONT>,<FONT color=#f800f8>1</FONT>)
cur=<FONT color=#6858c8>SQLRCursor</FONT>.new(con)
con.resumeSession(port,socket)
cur.resumeResultSet(rs)
cur.sendQuery(<FONT color=#6858c8>"</FONT><FONT color=#f800f8>commit</FONT><FONT color=#6858c8>"</FONT>)
con.endSession()
</PRE>
</blockquote>
<p>You can also distribute the processing of a result set across a series of
CGI's using suspended sessions. If you're buffering a result set in chunks
instead of all at once and suspend a session, when you resume the session you
can continue to retrieve rows from the result set.</p>
<p>Similarly, if you're buffering a result set in chunks, caching that
result set and suspend your session. When you resume the session, you can
continue caching the result set. You must use resumeCachedResultSet()
instead of resumeResultSet() however.</p>
</body>
</html>
|
