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
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
|
@deftypemethod Array {public String} getBaseTypeName () @*throws SQLException
This method returns the name of the SQL type of the elements in this
array. This name is database specific.
@end deftypemethod
@deftypemethod Array {public int} getBaseType () @*throws SQLException
This method returns the JDBC type identifier of the elements in this
array. This will be one of the values defined in the @code{Types}
class.
@end deftypemethod
@deftypemethod Array {public Object} getArray () @*throws SQLException
This method returns the contents of this array. This object returned
will be an array of Java objects of the appropriate types.
@end deftypemethod
@deftypemethod Array {public Object} getArray (java.util.Map@w{ }@var{map}) @*throws SQLException
This method returns the contents of this array. The specified
@code{Map} will be used to override selected mappings between
SQL types and Java classes.
@end deftypemethod
@deftypemethod Array {public Object} getArray (long@w{ }@var{offset}, int@w{ }@var{count}) @*throws SQLException
This method returns a portion of this array starting at index
@code{offset} into the array and continuing for @code{length}
elements. Fewer than the requested number of elements will be
returned if the array does not contain the requested number of elements.
The object returned will be an array of Java objects of
the appropriate types.
@end deftypemethod
@deftypemethod Array {public Object} getArray (long@w{ }@var{index}, int@w{ }@var{count}, java.util.Map@w{ }@var{map}) @*throws SQLException
This method returns a portion of this array starting at index
@code{offset} into the array and continuing for @code{length}
elements. Fewer than the requested number of elements will be
returned if the array does not contain the requested number of elements.
The object returned will be an array of Java objects. The specified
@code{Map} will be used for overriding selected SQL type to
Java class mappings.
@end deftypemethod
@deftypemethod Array {public ResultSet} getResultSet () @*throws SQLException
This method returns the elements in the array as a @code{ResultSet}.
Each row of the result set will have two columns. The first will be
the index into the array of that row's contents. The second will be
the actual value of that array element.
@end deftypemethod
@deftypemethod Array {public ResultSet} getResultSet (java.util.Map@w{ }@var{map}) @*throws SQLException
This method returns the elements in the array as a @code{ResultSet}.
Each row of the result set will have two columns. The first will be
the index into the array of that row's contents. The second will be
the actual value of that array element. The specified @code{Map}
will be used to override selected default mappings of SQL types to
Java classes.
@end deftypemethod
@deftypemethod Array {public ResultSet} getResultSet (long@w{ }@var{index}, int@w{ }@var{count}) @*throws SQLException
This method returns a portion of the array as a @code{ResultSet}.
The returned portion will start at index @code{offset} into the
array and up to @code{length} elements will be returned.
Each row of the result set will have two columns. The first will be
the index into the array of that row's contents. The second will be
the actual value of that array element.
@end deftypemethod
@deftypemethod Array {public ResultSet} getResultSet (long@w{ }@var{index}, int@w{ }@var{count}, java.util.Map@w{ }@var{map}) @*throws SQLException
This method returns a portion of the array as a @code{ResultSet}.
The returned portion will start at index @code{offset} into the
array and up to @code{length} elements will be returned.
Each row of the result set will have two columns. The first will be
the index into the array of that row's contents. The second will be
the actual value of that array element. The specified @code{Map}
will be used to override selected default mappings of SQL types to
Java classes.
@end deftypemethod
@deftypemethod BatchUpdateException {public int} getUpdateCounts ()
This method returns the update count information for this error. If
not @code{null} this is an array of @code{int}'s that are
the update accounts for each command that was successfully executed.
The array elements are in the order that the commands were executed.
@end deftypemethod
@deftypemethod Blob {public long} length () @*throws SQLException
This method returns the number of bytes in the BLOB.
@end deftypemethod
@deftypemethod Blob {public byte} getBytes (long@w{ }@var{offset}, int@w{ }@var{length}) @*throws SQLException
This method returns up to the requested bytes of this BLOB as a
@code{byte} array.
@end deftypemethod
@deftypemethod Blob {public InputStream} getBinaryStream () @*throws SQLException
This method returns a stream that will read the bytes of the BLOB.
@end deftypemethod
@deftypemethod Blob {public long} position (byte[]@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException
This method returns the index into the BLOB at which the first instance
of the specified bytes occur. The searching starts at the specified
index into the BLOB.
@end deftypemethod
@deftypemethod Blob {public long} position (java.sql.Blob@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException
This method returns the index into the BLOB at which the first instance
of the specified pattern occurs. The searching starts at the specified
index into this BLOB. The bytes in the specified @code{Blob} are
used as the search pattern.
@end deftypemethod
@deftypemethod CallableStatement {public boolean} wasNull () @*throws SQLException
This method tests whether the value of the last parameter that was fetched
was actually a SQL NULL value.
@end deftypemethod
@deftypemethod CallableStatement {public String} getString (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{String}.
@end deftypemethod
@deftypemethod CallableStatement {public Object} getObject (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{Object}.
@end deftypemethod
@deftypemethod CallableStatement {public Object} getObject (int@w{ }@var{index}, java.util.Map@w{ }@var{map}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{Object}.
@end deftypemethod
@deftypemethod CallableStatement {public boolean} getBoolean (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{boolean}.
@end deftypemethod
@deftypemethod CallableStatement {public byte} getByte (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{byte}.
@end deftypemethod
@deftypemethod CallableStatement {public short} getShort (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{short}.
@end deftypemethod
@deftypemethod CallableStatement {public int} getInt (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{int}.
@end deftypemethod
@deftypemethod CallableStatement {public long} getLong (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{long}.
@end deftypemethod
@deftypemethod CallableStatement {public float} getFloat (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{float}.
@end deftypemethod
@deftypemethod CallableStatement {public double} getDouble (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{double}.
@end deftypemethod
@deftypemethod CallableStatement {public BigDecimal} getBigDecimal (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{BigDecimal}.
@end deftypemethod
@deftypemethod CallableStatement {public BigDecimal} getBigDecimal (int@w{ }@var{index}, int@w{ }@var{scale}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{BigDecimal}.
@end deftypemethod
@deftypemethod CallableStatement {public byte} getBytes (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
byte array.
@end deftypemethod
@deftypemethod CallableStatement {public Date} getDate (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{java.sql.Date}.
@end deftypemethod
@deftypemethod CallableStatement {public Date} getDate (int@w{ }@var{index}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{java.sql.Date}.
@end deftypemethod
@deftypemethod CallableStatement {public Time} getTime (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{java.sql.Time}.
@end deftypemethod
@deftypemethod CallableStatement {public Time} getTime (int@w{ }@var{index}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{java.sql.Time}.
@end deftypemethod
@deftypemethod CallableStatement {public Timestamp} getTimestamp (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{java.sql.Timestamp}.
@end deftypemethod
@deftypemethod CallableStatement {public Timestamp} getTimestamp (int@w{ }@var{index}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{java.sql.Timestamp}.
@end deftypemethod
@deftypemethod CallableStatement {public Ref} getRef (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{Ref}.
@end deftypemethod
@deftypemethod CallableStatement {public Blob} getBlob (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{Blob}.
@end deftypemethod
@deftypemethod CallableStatement {public Clob} getClob (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{Clob}.
@end deftypemethod
@deftypemethod CallableStatement {public Array} getArray (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified parameter as a Java
@code{Array}.
@end deftypemethod
@deftypemethod CallableStatement {public void} registerOutParameter (int@w{ }@var{index}, int@w{ }@var{type}) @*throws SQLException
This method registers the specified parameter as an output parameter
of the specified SQL type.
@end deftypemethod
@deftypemethod CallableStatement {public void} registerOutParameter (int@w{ }@var{index}, int@w{ }@var{type}, java.lang.String@w{ }@var{name}) @*throws SQLException
This method registers the specified parameter as an output parameter
of the specified SQL type.
@end deftypemethod
@deftypemethod CallableStatement {public void} registerOutParameter (int@w{ }@var{index}, int@w{ }@var{type}, int@w{ }@var{scale}) @*throws SQLException
This method registers the specified parameter as an output parameter
of the specified SQL type and scale.
@end deftypemethod
@deftypemethod Clob {public long} length () @*throws SQLException
This method returns the number of characters in the CLOB.
@end deftypemethod
@deftypemethod Clob {public String} getSubString (long@w{ }@var{offset}, int@w{ }@var{length}) @*throws SQLException
This method returns the specified portion of the CLOB as a
@code{String}.
@end deftypemethod
@deftypemethod Clob {public InputStream} getAsciiStream () @*throws SQLException
This method returns a byte stream that reads the contents of the
CLOB as a series of ASCII bytes.
@end deftypemethod
@deftypemethod Clob {public Reader} getCharacterStream () @*throws SQLException
This method returns a character stream that reads the contents of the
CLOB.
@end deftypemethod
@deftypemethod Clob {public long} position (java.lang.String@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException
This method returns the index into the CLOB of the first occurrence of
the specified character pattern (supplied by the caller as a
@code{String}). The search begins at the specified index.
@end deftypemethod
@deftypemethod Clob {public long} position (java.sql.Clob@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException
This method returns the index into the CLOB of the first occurrence of
the specified character pattern (supplied by the caller as a
@code{Clob}). The search begins at the specified index.
@end deftypemethod
@deftypemethod Connection {public Statement} createStatement () @*throws SQLException
This method creates a new SQL statement. The default result set type
and concurrency will be used.
@end deftypemethod
@deftypemethod Connection {public Statement} createStatement (int@w{ }@var{resultSetType}, int@w{ }@var{resultSetConcurrency}) @*throws SQLException
This method creates a new SQL statement with the specified type and
concurrency. Valid values for these parameters are specified in the
@code{ResultSet} class.
@end deftypemethod
@deftypemethod Connection {public PreparedStatement} prepareStatement (java.lang.String@w{ }@var{sql}) @*throws SQLException
This method creates a new @code{PreparedStatement} for the specified
SQL string. This method is designed for use with parameterized
statements. The default result set type and concurrency will be used.
@end deftypemethod
@deftypemethod Connection {public PreparedStatement} prepareStatement (java.lang.String@w{ }@var{sql}, int@w{ }@var{resultSetType}, int@w{ }@var{resultSetConcurrency}) @*throws SQLException
This method creates a new @code{PreparedStatement} for the specified
SQL string. This method is designed for use with parameterized
statements. The specified result set type and concurrency will be used.
Valid values for these parameters are specified in the
@code{ResultSet} class.
@end deftypemethod
@deftypemethod Connection {public CallableStatement} prepareCall (java.lang.String@w{ }@var{sql}) @*throws SQLException
This method creates a new @code{CallableStatement} for the
specified SQL string. Thie method is designed to be used with
stored procedures. The default result set type and concurrency
will be used.
@end deftypemethod
@deftypemethod Connection {public CallableStatement} prepareCall (java.lang.String@w{ }@var{sql}, int@w{ }@var{resultSetType}, int@w{ }@var{resultSetConcurrency}) @*throws SQLException
This method creates a new @code{CallableStatement} for the
specified SQL string. Thie method is designed to be used with
stored procedures. The specified result set type and concurrency
will be used. Valid values for these parameters are specified in the
@code{ResultSet} class.
@end deftypemethod
@deftypemethod Connection {public String} nativeSQL (java.lang.String@w{ }@var{sql}) @*throws SQLException
This method converts the specified generic SQL statement into the
native grammer of the database this object is connected to.
@end deftypemethod
@deftypemethod Connection {public boolean} getAutoCommit () @*throws SQLException
This method tests whether or not auto commit mode is currently enabled.
In auto commit mode, every SQL statement is committed its own transaction.
Otherwise a transaction must be explicitly committed or rolled back.
@end deftypemethod
@deftypemethod Connection {public void} setAutoCommit (boolean@w{ }@var{autoCommit}) @*throws SQLException
This method turns auto commit mode on or off. In auto commit mode,
every SQL statement is committed its own transaction. Otherwise a
transaction must be explicitly committed or rolled back.
@end deftypemethod
@deftypemethod Connection {public void} commit () @*throws SQLException
This method commits any SQL statements executed on this connection since
the last commit or rollback.
@end deftypemethod
@deftypemethod Connection {public void} rollback () @*throws SQLException
This method rolls back any SQL statements executed on this connection
since the last commit or rollback.
@end deftypemethod
@deftypemethod Connection {public void} close () @*throws SQLException
This method immediately closes this database connection.
@end deftypemethod
@deftypemethod Connection {public boolean} isClosed () @*throws SQLException
This method tests whether or not this connection has been closed.
@end deftypemethod
@deftypemethod Connection {public DatabaseMetaData} getMetaData () @*throws SQLException
This method returns the meta data for this database connection.
@end deftypemethod
@deftypemethod Connection {public boolean} isReadOnly () @*throws SQLException
This method tests whether or not this connection is in read only mode.
@end deftypemethod
@deftypemethod Connection {public void} setReadOnly (boolean@w{ }@var{readOnly}) @*throws SQLException
This method turns read only mode on or off. It may not be called while
a transaction is in progress.
@end deftypemethod
@deftypemethod Connection {public String} getCatalog () @*throws SQLException
This method returns the name of the catalog in use by this connection,
if any.
@end deftypemethod
@deftypemethod Connection {public void} setCatalog (java.lang.String@w{ }@var{catalog}) @*throws SQLException
This method sets the name of the catalog in use by this connection.
Note that this method does nothing if catalogs are not supported by
this database.
@end deftypemethod
@deftypemethod Connection {public int} getTransactionIsolation () @*throws SQLException
This method returns the current transaction isolation mode. This will
be one of the constants defined in this interface.
@end deftypemethod
@deftypemethod Connection {public void} setTransactionIsolation (int@w{ }@var{level}) @*throws SQLException
This method sets the current transaction isolation mode. This must
be one of the constants defined in this interface.
@end deftypemethod
@deftypemethod Connection {public SQLWarning} getWarnings () @*throws SQLException
This method returns the first warning that occurred on this connection,
if any. If there were any subsequence warnings, they will be chained
to the first one.
@end deftypemethod
@deftypemethod Connection {public void} clearWarnings () @*throws SQLException
This method clears all warnings that have occurred on this connection.
@end deftypemethod
@deftypemethod Connection {public Map} getTypeMap () @*throws SQLException
This method returns the mapping of SQL types to Java classes
currently in use by this connection. This mapping will have no
entries unless they have been manually added.
@end deftypemethod
@deftypemethod Connection {public void} setTypeMap (java.util.Map@w{ }@var{map}) @*throws SQLException
This method sets the mapping table for SQL types to Java classes.
Any entries in this map override the defaults.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} allProceduresAreCallable () @*throws SQLException
This method tests whether or not all the procedures returned by
the @code{getProcedures} method can be called by this user.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} allTablesAreSelectable () @*throws SQLException
This method tests whether or not all the table returned by the
@code{getTables} method can be selected by this user.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getURL () @*throws SQLException
This method returns the URL for this database.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getUserName () @*throws SQLException
This method returns the database username for this connection.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} isReadOnly () @*throws SQLException
This method tests whether or not the database is in read only mode.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} nullsAreSortedHigh () @*throws SQLException
This method tests whether or not NULL's sort as high values.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} nullsAreSortedLow () @*throws SQLException
This method tests whether or not NULL's sort as low values.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} nullsAreSortedAtStart () @*throws SQLException
This method test whether or not NULL's are sorted to the beginning
of the list regardless of ascending or descending sort order.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} nullsAreSortedAtEnd () @*throws SQLException
This method test whether or not NULL's are sorted to the end
of the list regardless of ascending or descending sort order.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getDatabaseProductName () @*throws SQLException
This method returns the name of the database product.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getDatabaseProductVersion () @*throws SQLException
This method returns the version of the database product.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getDriverName () @*throws SQLException
This method returns the name of the JDBC driver.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getDriverVersion () @*throws SQLException
This method returns the version of the JDBC driver.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getDriverMajorVersion ()
This method returns the major version number of the JDBC driver.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getDriverMinorVersion ()
This method returns the minor version number of the JDBC driver.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} usesLocalFiles () @*throws SQLException
This method tests whether or not the database uses local files to
store tables.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} usesLocalFilePerTable () @*throws SQLException
This method tests whether or not the database uses a separate file for
each table.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsMixedCaseIdentifiers () @*throws SQLException
This method tests whether or not the database supports identifiers
with mixed case.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} storesUpperCaseIdentifiers () @*throws SQLException
This method tests whether or not the database treats mixed case
identifiers as all upper case.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} storesLowerCaseIdentifiers () @*throws SQLException
This method tests whether or not the database treats mixed case
identifiers as all lower case.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} storesMixedCaseIdentifiers () @*throws SQLException
This method tests whether or not the database stores mixed case
identifers even if it treats them as case insensitive.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsMixedCaseQuotedIdentifiers () @*throws SQLException
This method tests whether or not the database supports quoted identifiers
with mixed case.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} storesUpperCaseQuotedIdentifiers () @*throws SQLException
This method tests whether or not the database treats mixed case
quoted identifiers as all upper case.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} storesLowerCaseQuotedIdentifiers () @*throws SQLException
This method tests whether or not the database treats mixed case
quoted identifiers as all lower case.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} storesMixedCaseQuotedIdentifiers () @*throws SQLException
This method tests whether or not the database stores mixed case
quoted identifers even if it treats them as case insensitive.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getIdentifierQuoteString () @*throws SQLException
This metohd returns the quote string for SQL identifiers.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getSQLKeywords () @*throws SQLException
This method returns a comma separated list of all the SQL keywords in
the database that are not in SQL92.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getNumericFunctions () @*throws SQLException
This method returns a comma separated list of math functions.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getStringFunctions () @*throws SQLException
This method returns a comma separated list of string functions.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getSystemFunctions () @*throws SQLException
This method returns a comma separated list of of system functions.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getTimeDateFunctions () @*throws SQLException
This method returns comma separated list of time/date functions.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getSearchStringEscape () @*throws SQLException
This method returns the string used to escape wildcards in search strings.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getExtraNameCharacters () @*throws SQLException
This methods returns non-standard characters that can appear in
unquoted identifiers.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsAlterTableWithAddColumn () @*throws SQLException
This method tests whether or not the database supports
"ALTER TABLE ADD COLUMN"
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsAlterTableWithDropColumn () @*throws SQLException
This method tests whether or not the database supports
"ALTER TABLE DROP COLUMN"
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsColumnAliasing () @*throws SQLException
This method tests whether or not column aliasing is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} nullPlusNonNullIsNull () @*throws SQLException
This method tests whether the concatenation of a NULL and non-NULL
value results in a NULL. This will always be true in fully JDBC compliant
drivers.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsConvert () @*throws SQLException
Tests whether or not CONVERT is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsConvert (int@w{ }@var{fromType}, int@w{ }@var{toType}) @*throws SQLException
This method tests whether or not CONVERT can be performed between the
specified types. The types are contants from @code{Types}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsTableCorrelationNames () @*throws SQLException
This method tests whether or not table correlation names are
supported. This will be always be @code{true} in a fully JDBC
compliant driver.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsDifferentTableCorrelationNames () @*throws SQLException
This method tests whether correlation names must be different from the
name of the table.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsExpressionsInOrderBy () @*throws SQLException
This method tests whether or not expressions are allowed in an
ORDER BY lists.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsOrderByUnrelated () @*throws SQLException
This method tests whether or ORDER BY on a non-selected column is
allowed.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsGroupBy () @*throws SQLException
This method tests whether or not GROUP BY is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsGroupByUnrelated () @*throws SQLException
This method tests whether GROUP BY on a non-selected column is
allowed.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsGroupByBeyondSelect () @*throws SQLException
This method tests whether or not a GROUP BY can add columns not in the
select if it includes all the columns in the select.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsLikeEscapeClause () @*throws SQLException
This method tests whether or not the escape character is supported in
LIKE expressions. A fully JDBC compliant driver will always return
@code{true}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsMultipleResultSets () @*throws SQLException
This method tests whether multiple result sets for a single statement are
supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsMultipleTransactions () @*throws SQLException
This method test whether or not multiple transactions may be open
at once, as long as they are on different connections.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsNonNullableColumns () @*throws SQLException
This method tests whether or not columns can be defined as NOT NULL. A
fully JDBC compliant driver always returns @code{true}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsMinimumSQLGrammar () @*throws SQLException
This method tests whether or not the minimum grammer for ODBC is supported.
A fully JDBC compliant driver will always return @code{true}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsCoreSQLGrammar () @*throws SQLException
This method tests whether or not the core grammer for ODBC is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsExtendedSQLGrammar () @*throws SQLException
This method tests whether or not the extended grammer for ODBC is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsANSI92EntryLevelSQL () @*throws SQLException
This method tests whether or not the ANSI92 entry level SQL
grammar is supported. A fully JDBC compliant drivers must return
@code{true}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsANSI92IntermediateSQL () @*throws SQLException
This method tests whether or not the ANSI92 intermediate SQL
grammar is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsANSI92FullSQL () @*throws SQLException
This method tests whether or not the ANSI92 full SQL
grammar is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsIntegrityEnhancementFacility () @*throws SQLException
This method tests whether or not the SQL integrity enhancement
facility is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsOuterJoins () @*throws SQLException
This method tests whether or not the database supports outer joins.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsFullOuterJoins () @*throws SQLException
This method tests whether or not the database supports full outer joins.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsLimitedOuterJoins () @*throws SQLException
This method tests whether or not the database supports limited outer joins.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getSchemaTerm () @*throws SQLException
This method returns the vendor's term for "schema".
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getProcedureTerm () @*throws SQLException
This method returns the vendor's term for "procedure".
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getCatalogTerm () @*throws SQLException
This method returns the vendor's term for "catalog".
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} isCatalogAtStart () @*throws SQLException
This method tests whether a catalog name appears at the beginning of
a fully qualified table name.
@end deftypemethod
@deftypemethod DatabaseMetaData {public String} getCatalogSeparator () @*throws SQLException
This method returns the separator between the catalog name and the
table name.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInDataManipulation () @*throws SQLException
This method tests whether a catalog name can appear in a data
manipulation statement.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInProcedureCalls () @*throws SQLException
This method tests whether a catalog name can appear in a procedure
call
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInTableDefinitions () @*throws SQLException
This method tests whether a catalog name can appear in a table definition.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInIndexDefinitions () @*throws SQLException
This method tests whether a catalog name can appear in an index definition.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSchemasInPrivilegeDefinitions () @*throws SQLException
This method tests whether a catalog name can appear in privilege definitions.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInDataManipulation () @*throws SQLException
This method tests whether a catalog name can appear in a data
manipulation statement.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInProcedureCalls () @*throws SQLException
This method tests whether a catalog name can appear in a procedure
call
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInTableDefinitions () @*throws SQLException
This method tests whether a catalog name can appear in a table definition.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInIndexDefinitions () @*throws SQLException
This method tests whether a catalog name can appear in an index definition.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInPrivilegeDefinitions () @*throws SQLException
This method tests whether a catalog name can appear in privilege definitions.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsPositionedDelete () @*throws SQLException
This method tests whether or not that database supports positioned
deletes.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsPositionedUpdate () @*throws SQLException
This method tests whether or not that database supports positioned
updates.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSelectForUpdate () @*throws SQLException
This method tests whether or not SELECT FOR UPDATE is supported by the
database.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsStoredProcedures () @*throws SQLException
This method tests whether or not stored procedures are supported on
this database.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInComparisons () @*throws SQLException
This method tests whether or not subqueries are allowed in comparisons.
A fully JDBC compliant driver will always return @code{true}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInExists () @*throws SQLException
This method tests whether or not subqueries are allowed in exists
expressions. A fully JDBC compliant driver will always return
@code{true}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInIns () @*throws SQLException
This method tests whether subqueries are allowed in IN statements.
A fully JDBC compliant driver will always return @code{true}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInQuantifieds () @*throws SQLException
This method tests whether or not subqueries are allowed in quantified
expressions. A fully JDBC compliant driver will always return
@code{true}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsCorrelatedSubqueries () @*throws SQLException
This method test whether or not correlated subqueries are allowed. A
fully JDBC compliant driver will always return @code{true}.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsUnion () @*throws SQLException
This method tests whether or not the UNION statement is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsUnionAll () @*throws SQLException
This method tests whether or not the UNION ALL statement is supported.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsOpenCursorsAcrossCommit () @*throws SQLException
This method tests whether or not the database supports cursors
remaining open across commits.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsOpenCursorsAcrossRollback () @*throws SQLException
This method tests whether or not the database supports cursors
remaining open across rollbacks.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsOpenStatementsAcrossCommit () @*throws SQLException
This method tests whether or not the database supports statements
remaining open across commits.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsOpenStatementsAcrossRollback () @*throws SQLException
This method tests whether or not the database supports statements
remaining open across rollbacks.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxBinaryLiteralLength () @*throws SQLException
This method returns the number of hex characters allowed in an inline
binary literal.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxCharLiteralLength () @*throws SQLException
This method returns the maximum length of a character literal.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxColumnNameLength () @*throws SQLException
This method returns the maximum length of a column name.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxColumnsInGroupBy () @*throws SQLException
This method returns the maximum number of columns in a GROUP BY statement.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxColumnsInIndex () @*throws SQLException
This method returns the maximum number of columns in an index.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxColumnsInOrderBy () @*throws SQLException
This method returns the maximum number of columns in an ORDER BY statement.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxColumnsInSelect () @*throws SQLException
This method returns the maximum number of columns in a SELECT statement.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxColumnsInTable () @*throws SQLException
This method returns the maximum number of columns in a table.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxConnections () @*throws SQLException
This method returns the maximum number of connections this client
can have to the database.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxCursorNameLength () @*throws SQLException
This method returns the maximum length of a cursor name.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxIndexLength () @*throws SQLException
This method returns the maximum length of an index.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxSchemaNameLength () @*throws SQLException
This method returns the maximum length of a schema name.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxProcedureNameLength () @*throws SQLException
This method returns the maximum length of a procedure name.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxCatalogNameLength () @*throws SQLException
This method returns the maximum length of a catalog name.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxRowSize () @*throws SQLException
This method returns the maximum size of a row in bytes.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} doesMaxRowSizeIncludeBlobs () @*throws SQLException
This method tests whether or not the maximum row size includes BLOB's
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxStatementLength () @*throws SQLException
This method includes the maximum length of a SQL statement.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxStatements () @*throws SQLException
This method returns the maximum number of statements that can be
active at any time.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxTableNameLength () @*throws SQLException
This method returns the maximum length of a table name.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxTablesInSelect () @*throws SQLException
This method returns the maximum number of tables that may be referenced
in a SELECT statement.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getMaxUserNameLength () @*throws SQLException
This method returns the maximum length of a user name.
@end deftypemethod
@deftypemethod DatabaseMetaData {public int} getDefaultTransactionIsolation () @*throws SQLException
This method returns the default transaction isolation level of the
database.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsTransactions () @*throws SQLException
This method tests whether or not the database supports transactions.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsTransactionIsolationLevel (int@w{ }@var{level}) @*throws SQLException
This method tests whether or not the database supports the specified
transaction isolation level.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsDataDefinitionAndDataManipulationTransactions () @*throws SQLException
This method tests whether or not DDL and DML statements allowed within
the same transaction.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsDataManipulationTransactionsOnly () @*throws SQLException
This method tests whether or not only DML statement are allowed
inside a transaction.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} dataDefinitionCausesTransactionCommit () @*throws SQLException
This method tests whether or not a DDL statement will cause the
current transaction to be automatically committed.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} dataDefinitionIgnoredInTransactions () @*throws SQLException
This method tests whether or not DDL statements are ignored in
transactions.
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getProcedures (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schemaPattern}, java.lang.String@w{ }@var{namePattern}) @*throws SQLException
This method returns a list of all the stored procedures matching the
specified pattern in the given schema and catalog. This is returned
a @code{ResultSet} with the following columns:
@itemize @bullet
@item
PROCEDURE_CAT - The catalog the procedure is in, which may be
@code{null}.
@item
PROCEDURE_SCHEM - The schema the procedures is in, which may be
@code{null}.
@item
PROCEDURE_NAME - The name of the procedure.
@item
Unused
@item
Unused
@item
Unused
@item
REMARKS - A description of the procedure
@item
PROCEDURE_TYPE - Indicates the return type of the procedure, which
is one of the contstants defined in this class
(@code{procedureResultUnknown}, @code{procedureNoResult}, or
@code{procedureReturnsResult}).
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getProcedureColumns (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schemaPattern}, java.lang.String@w{ }@var{namePattern}, java.lang.String@w{ }@var{columnPattern}) @*throws SQLException
This method returns a list of the parameter and result columns for
the requested stored procedures. This is returned in the form of a
@code{ResultSet} with the following columns:
@itemize @bullet
@item
PROCEDURE_CAT - The catalog the procedure is in, which may be
@code{null}.
@item
PROCEDURE_SCHEM - The schema the procedures is in, which may be
@code{null}.
@item
PROCEDURE_NAME - The name of the procedure.
@item
COLUMN_NAME - The name of the column
@item
COLUMN_TYPE - The type of the column, which will be one of the
contants defined in this class (@code{procedureColumnUnknown},
@code{procedureColumnIn}, @code{procedureColumnInOut},
@code{procedureColumnOut}, @code{procedureColumnReturn},
or @code{procedureColumnResult}).
@item
DATA_TYPE - The SQL type of the column. This is one of the constants
defined in @code{Types}.
@item
TYPE_NAME - The string name of the data type for this column.
@item
PRECISION - The precision of the column.
@item
LENGTH - The length of the column in bytes
@item
SCALE - The scale of the column.
@item
RADIX - The radix of the column.
@item
NULLABLE - Whether or not the column is NULLABLE. This is one of
the constants defined in this class (@code{procedureNoNulls},
@code{procedureNullable}, or @code{procedureNullableUnknown})
@item
REMARKS - A description of the column.
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getTables (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schemaPattern}, java.lang.String@w{ }@var{namePattern}, java.lang.String[]@w{ }@var{types}) @*throws SQLException
This method returns a list of the requested table as a
@code{ResultSet} with the following columns:
@itemize @bullet
@item
TABLE_CAT - The catalog the table is in, which may be @code{null}.
@item
TABLE_SCHEM - The schema the table is in, which may be @code{null}.
@item
TABLE_NAME - The name of the table.
@item
TABLE_TYPE - A string describing the table type. This will be one
of the values returned by the @code{getTableTypes()} method.
@item
REMARKS - Comments about the table.
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getSchemas () @*throws SQLException
This method returns the list of database schemas as a
@code{ResultSet}, with one column - TABLE_SCHEM - that is the
name of the schema.
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getCatalogs () @*throws SQLException
This method returns the list of database catalogs as a
@code{ResultSet} with one column - TABLE_CAT - that is the
name of the catalog.
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getTableTypes () @*throws SQLException
This method returns the list of database table types as a
@code{ResultSet} with one column - TABLE_TYPE - that is the
name of the table type.
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getColumns (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schemaPattern}, java.lang.String@w{ }@var{namePattern}, java.lang.String@w{ }@var{columnPattern}) @*throws SQLException
This method returns a list of the tables columns for
the requested tables. This is returned in the form of a
@code{ResultSet} with the following columns:
@itemize @bullet
@item
TABLE_CAT - The catalog the table is in, which may be
@code{null}.
@item
TABLE_SCHEM - The schema the tables is in, which may be
@code{null}.
@item
TABLE_NAME - The name of the table.
@item
COLUMN_NAME - The name of the column
@item
DATA_TYPE - The SQL type of the column. This is one of the constants
defined in @code{Types}.
@item
TYPE_NAME - The string name of the data type for this column.
@item
COLUMN_SIZE - The size of the column.
@item
Unused
@item
NUM_PREC_RADIX - The radix of the column.
@item
NULLABLE - Whether or not the column is NULLABLE. This is one of
the constants defined in this class (@code{tableNoNulls},
@code{tableNullable}, or @code{tableNullableUnknown})
@item
REMARKS - A description of the column.
@item
COLUMN_DEF - The default value for the column, may be @code{null}.
@item
SQL_DATA_TYPE - Unused
@item
SQL_DATETIME_SUB - Unused
@item
CHAR_OCTET_LENGTH - For character columns, the maximum number of bytes
in the column.
@item
ORDINAL_POSITION - The index of the column in the table.
@item
IS_NULLABLE - "NO" means no, "YES" means maybe, and an empty string
means unknown.
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getColumnPrivileges (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}, java.lang.String@w{ }@var{columnPattern}) @*throws SQLException
This method returns the access rights that have been granted to the
requested columns. This information is returned as a @code{ResultSet}
with the following columns:
@itemize @bullet
@item
TABLE_CAT - The catalog the table is in, which may be
@code{null}.
@item
TABLE_SCHEM - The schema the tables is in, which may be
@code{null}.
@item
TABLE_NAME - The name of the table.
@item
COLUMN_NAME - The name of the column.
@item
GRANTOR - The entity that granted the access.
@item
GRANTEE - The entity granted the access.
@item
PRIVILEGE - The name of the privilege granted.
@item
IS_GRANTABLE - "YES" if the grantee can grant the privilege to
others, "NO" if not, and @code{null} if unknown.
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getTablePrivileges (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException
This method returns the access rights that have been granted to the
requested tables. This information is returned as a @code{ResultSet}
with the following columns:
@itemize @bullet
@item
TABLE_CAT - The catalog the table is in, which may be
@code{null}.
@item
TABLE_SCHEM - The schema the tables is in, which may be
@code{null}.
@item
TABLE_NAME - The name of the table.
@item
GRANTOR - The entity that granted the access.
@item
GRANTEE - The entity granted the access.
@item
PRIVILEGE - The name of the privilege granted.
@item
IS_GRANTABLE - "YES" if the grantee can grant the privilege to
others, "NO" if not, and @code{null} if unknown.
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getBestRowIdentifier (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}, int@w{ }@var{scope}, boolean@w{ }@var{nullable}) @*throws SQLException
This method returns the best set of columns for uniquely identifying
a row. It returns this information as a @code{ResultSet} with
the following columns:
@itemize @bullet
@item
SCOPE - The scope of the results returned. This is one of the
constants defined in this class (@code{bestRowTemporary},
@code{bestRowTransaction}, or @code{bestRowSession}).
@item
COLUMN_NAME - The name of the column.
@item
DATA_TYPE - The SQL type of the column. This is one of the constants
defined in @code{Types}.
@item
TYPE_NAME - The string name of the data type for this column.
@item
COLUMN_SIZE - The precision of the columns
@item
BUFFER_LENGTH - Unused
@item
DECIMAL_DIGITS - The scale of the column.
@item
PSEUDO_COLUMN - Whether or not the best row identifier is a
pseudo_column. This is one of the constants defined in this class
(@code{bestRowUnknown}, @code{bestRowNotPseudo}, or
@code{bestRowPseudo}).
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getVersionColumns (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException
This method returns the set of columns that are automatically updated
when the row is update. It returns this information as a
@code{ResultSet} with the following columns:
@itemize @bullet
@item
SCOPE - Unused
@item
COLUMN_NAME - The name of the column.
@item
DATA_TYPE - The SQL type of the column. This is one of the constants
defined in @code{Types}.
@item
TYPE_NAME - The string name of the data type for this column.
@item
COLUMN_SIZE - The precision of the columns
@item
BUFFER_LENGTH - Unused
@item
DECIMAL_DIGITS - The scale of the column.
@item
PSEUDO_COLUMN - Whether or not the best row identifier is a
pseudo_column. This is one of the constants defined in this class
(@code{versionRowUnknown}, @code{versionRowNotPseudo}, or
@code{versionRowPseudo}).
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getPrimaryKeys (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException
This method returns a list of a table's primary key columns. These
are returned as a @code{ResultSet} with the following columns.
@itemize @bullet
@item
TABLE_CAT - The catalog of the table, which may be @code{null}.
@item
TABLE_SCHEM - The schema of the table, which may be @code{null}.
@item
TABLE_NAME - The name of the table.
@item
COLUMN_NAME - The name of the column.
@item
KEY_SEQ - The sequence number of the column within the primary key.
@item
PK_NAME - The name of the primary key, which may be @code{null}.
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getImportedKeys (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException
This method returns a list of the table's foreign keys. These are
returned as a @code{ResultSet} with the following columns:
@itemize @bullet
@item
PKTABLE_CAT - The catalog of the table the key was imported from.
@item
PKTABLE_SCHEM - The schema of the table the key was imported from.
@item
PKTABLE_NAME - The name of the table the key was imported from.
@item
PKCOLUMN_NAME - The name of the column that was imported.
@item
FKTABLE_CAT - The foreign key catalog name.
@item
FKTABLE_SCHEM - The foreign key schema name.
@item
FKTABLE_NAME - The foreign key table name.
@item
FKCOLUMN_NAME - The foreign key column name.
@item
KEY_SEQ - The sequence number of the column within the foreign key.
@item
UPDATE_RULE - How the foreign key behaves when the primary key is
updated. This is one of the constants defined in this class
(@code{importedNoAction}, @code{importedKeyCascade},
@code{importedKeySetNull}, @code{importedKeySetDefault}, or
@code{importedKeyRestrict}).
@item
DELETE_RULE - How the foreign key behaves when the primary key is
deleted. This is one of the constants defined in this class
(@code{importedNoAction}, @code{importedKeyCascade},
@code{importedKeySetNull}, or @code{importedKeySetDefault})
@item
FK_NAME - The name of the foreign key.
@item
PK_NAME - The name of the primary key.
@item
DEFERRABILITY - The deferrability value. This is one of the
constants defined in this table (@code{importedKeyInitiallyDeferred},
@code{importedKeyInitiallyImmediate}, or
@code{importedKeyNotDeferrable}).
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getExportedKeys (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}) @*throws SQLException
This method returns a list of the table's which use this table's
primary key as a foreign key. The information is
returned as a @code{ResultSet} with the following columns:
@itemize @bullet
@item
PKTABLE_CAT - The catalog of the table the key was imported from.
@item
PKTABLE_SCHEM - The schema of the table the key was imported from.
@item
PKTABLE_NAME - The name of the table the key was imported from.
@item
PKCOLUMN_NAME - The name of the column that was imported.
@item
FKTABLE_CAT - The foreign key catalog name.
@item
FKTABLE_SCHEM - The foreign key schema name.
@item
FKTABLE_NAME - The foreign key table name.
@item
FKCOLUMN_NAME - The foreign key column name.
@item
KEY_SEQ - The sequence number of the column within the foreign key.
@item
UPDATE_RULE - How the foreign key behaves when the primary key is
updated. This is one of the constants defined in this class
(@code{importedNoAction}, @code{importedKeyCascade},
@code{importedKeySetNull}, @code{importedKeySetDefault}, or
@code{importedKeyRestrict}).
@item
DELETE_RULE - How the foreign key behaves when the primary key is
deleted. This is one of the constants defined in this class
(@code{importedNoAction}, @code{importedKeyCascade},
@code{importedKeySetNull}, or @code{importedKeySetDefault})
@item
FK_NAME - The name of the foreign key.
@item
PK_NAME - The name of the primary key.
@item
DEFERRABILITY - The deferrability value. This is one of the
constants defined in this table (@code{importedKeyInitiallyDeferred},
@code{importedKeyInitiallyImmediate}, or
@code{importedKeyNotDeferrable}).
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getCrossReference (java.lang.String@w{ }@var{primCatalog}, java.lang.String@w{ }@var{primSchema}, java.lang.String@w{ }@var{primTable}, java.lang.String@w{ }@var{forCatalog}, java.lang.String@w{ }@var{forSchema}, java.lang.String@w{ }@var{forTable}) @*throws SQLException
This method returns a description of how one table imports another
table's primary key as a foreign key. The information is
returned as a @code{ResultSet} with the following columns:
@itemize @bullet
@item
PKTABLE_CAT - The catalog of the table the key was imported from.
@item
PKTABLE_SCHEM - The schema of the table the key was imported from.
@item
PKTABLE_NAME - The name of the table the key was imported from.
@item
PKCOLUMN_NAME - The name of the column that was imported.
@item
FKTABLE_CAT - The foreign key catalog name.
@item
FKTABLE_SCHEM - The foreign key schema name.
@item
FKTABLE_NAME - The foreign key table name.
@item
FKCOLUMN_NAME - The foreign key column name.
@item
KEY_SEQ - The sequence number of the column within the foreign key.
@item
UPDATE_RULE - How the foreign key behaves when the primary key is
updated. This is one of the constants defined in this class
(@code{importedNoAction}, @code{importedKeyCascade},
@code{importedKeySetNull}, @code{importedKeySetDefault}, or
@code{importedKeyRestrict}).
@item
DELETE_RULE - How the foreign key behaves when the primary key is
deleted. This is one of the constants defined in this class
(@code{importedNoAction}, @code{importedKeyCascade},
@code{importedKeySetNull}, or @code{importedKeySetDefault})
@item
FK_NAME - The name of the foreign key.
@item
PK_NAME - The name of the primary key.
@item
DEFERRABILITY - The deferrability value. This is one of the
constants defined in this table (@code{importedKeyInitiallyDeferred},
@code{importedKeyInitiallyImmediate}, or
@code{importedKeyNotDeferrable}).
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getTypeInfo () @*throws SQLException
This method returns a list of the SQL types supported by this
database. The information is returned as a @code{ResultSet}
with the following columns:
@itemize @bullet
@item
TYPE_NAME - The name of the data type.
@item
DATA_TYPE - A data type constant from @code{Types} for this
type.
@item
PRECISION - The maximum precision of this type.
@item
LITERAL_PREFIX - Prefix value used to quote a literal, which may be
@code{null}.
@item
LITERAL_SUFFIX - Suffix value used to quote a literal, which may be
@code{null}.
@item
CREATE_PARAMS - The parameters used to create the type, which may be
@code{null}.
@item
NULLABLE - Whether or not this type supports NULL values. This will
be one of the constants defined in this interface
(@code{typeNoNulls}, @code{typeNullable}, or
@code{typeNullableUnknown}).
@item
CASE_SENSITIVE - Whether or not the value is case sensitive.
@item
SEARCHABLE - Whether or not "LIKE" expressions are supported in
WHERE clauses for this type. This will be one of the constants defined
in this interface (@code{typePredNone}, @code{typePredChar},
@code{typePredBasic}, or @code{typeSearchable}).
@item
UNSIGNED_ATTRIBUTE - Is the value of this type unsigned.
@item
FIXED_PREC_SCALE - Whether or not this type can be used for money.
@item
AUTO_INCREMENT - Whether or not this type supports auto-incrementing.
@item
LOCAL_TYPE_NAME - A localized name for this data type.
@item
MINIMUM_SCALE - The minimum scale supported by this type.
@item
MAXIMUM_SCALE - The maximum scale supported by this type.
@item
SQL_DATA_TYPE - Unused.
@item
SQL_DATETIME_SUB - Unused.
@item
NUM_PREC_RADIX - The radix of this data type.
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getIndexInfo (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{table}, boolean@w{ }@var{unique}, boolean@w{ }@var{approx}) @*throws SQLException
This method returns information about a tables indices and statistics.
It is returned as a @code{ResultSet} with the following columns:
@itemize @bullet
@item
TABLE_CAT - The catalog of the table, which may be @code{null}.
@item
TABLE_SCHEM - The schema of the table, which may be @code{null}.
@item
TABLE_NAME - The name of the table.
@item
NON_UNIQUE - Are index values non-unique?
@item
INDEX_QUALIFIER The index catalog, which may be @code{null}
@item
INDEX_NAME - The name of the index.
@item
TYPE - The type of index, which will be one of the constants defined
in this interface (@code{tableIndexStatistic},
@code{tableIndexClustered}, @code{tableIndexHashed}, or
@code{tableIndexOther}).
@item
ORDINAL_POSITION - The sequence number of this column in the index.
This will be 0 when the index type is @code{tableIndexStatistic}.
@item
COLUMN_NAME - The name of this column in the index.
@item
ASC_OR_DESC - "A" for an ascending sort sequence, "D" for a
descending sort sequence or @code{null} if a sort sequence is not
supported.
@item
CARDINALITY - The number of unique rows in the index, or the number
of rows in the table if the index type is @code{tableIndexStatistic}.
@item
PAGES - The number of pages used for the index, or the number of pages
in the table if the index type is @code{tableIndexStatistic}.
@item
FILTER_CONDITION - The filter condition for this index, which may be
@code{null}.
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsResultSetType (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the datbase supports the specified
result type.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsResultSetConcurrency (int@w{ }@var{type}, int@w{ }@var{concur}) @*throws SQLException
This method tests whether the specified result set type and result set
concurrency type are supported by the database.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} ownUpdatesAreVisible (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the specified result set type sees its
own updates.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} ownDeletesAreVisible (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the specified result set type sees its
own deletes.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} ownInsertsAreVisible (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the specified result set type sees its
own inserts.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} othersUpdatesAreVisible (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the specified result set type sees
updates committed by others.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} othersDeletesAreVisible (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the specified result set type sees
deletes committed by others.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} othersInsertsAreVisible (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the specified result set type sees
inserts committed by others.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} updatesAreDetected (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the specified result set type can detect
a visible update by calling the @code{rowUpdated} method.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} deletesAreDetected (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the specified result set type can detect
a visible delete by calling the @code{rowUpdated} method.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} insertsAreDetected (int@w{ }@var{type}) @*throws SQLException
This method tests whether or not the specified result set type can detect
a visible insert by calling the @code{rowUpdated} method.
@end deftypemethod
@deftypemethod DatabaseMetaData {public boolean} supportsBatchUpdates () @*throws SQLException
This method tests whether or not the database supports batch updates.
@end deftypemethod
@deftypemethod DatabaseMetaData {public ResultSet} getUDTs (java.lang.String@w{ }@var{catalog}, java.lang.String@w{ }@var{schema}, java.lang.String@w{ }@var{typePattern}, int[]@w{ }@var{types}) @*throws SQLException
This method returns the list of user defined data types in use. These
are returned as a @code{ResultSet} with the following columns:
@itemize @bullet
@item
TYPE_CAT - The catalog name, which may be @code{null}.
@item
TYPE_SCEHM - The schema name, which may be @code{null}.
@item
TYPE_NAME - The user defined data type name.
@item
CLASS_NAME - The Java class name this type maps to.
@item
DATA_TYPE - A type identifer from @code{Types} for this type.
This will be one of @code{JAVA_OBJECT}, @code{STRUCT}, or
@code{DISTINCT}.
@item
REMARKS - Comments about this data type.
@end itemize
@end deftypemethod
@deftypemethod DatabaseMetaData {public Connection} getConnection () @*throws SQLException
This method returns the @code{Connection} object that was used
to generate the metadata in this object.
@end deftypemethod
@deftypemethod DataTruncation {public int} getIndex ()
This method returns the index of the column or parameter that was
truncated.
@end deftypemethod
@deftypemethod DataTruncation {public boolean} getParameter ()
This method determines whether or not it was a parameter that was
truncated.
@end deftypemethod
@deftypemethod DataTruncation {public boolean} getRead ()
This method determines whether or not it was a column that was
truncated.
@end deftypemethod
@deftypemethod DataTruncation {public int} getDataSize ()
This method returns the original size of the parameter or column that
was truncated.
@end deftypemethod
@deftypemethod DataTruncation {public int} getTransferSize ()
This method returns the size of the parameter or column after it was
truncated.
@end deftypemethod
@deftypemethod Date {public static Date} valueOf (java.lang.String@w{ }@var{str})
This method returns a new instance of this class by parsing a
date in JDBC format into a Java date.
@end deftypemethod
@deftypemethod Date {public String} toString ()
This method returns this date in JDBC format.
@end deftypemethod
@deftypemethod Driver {public int} getMajorVersion ()
This method returns the major version number of the driver.
@end deftypemethod
@deftypemethod Driver {public int} getMinorVersion ()
This method returns the minor version number of the driver.
@end deftypemethod
@deftypemethod Driver {public boolean} jdbcCompliant ()
This method tests whether or not the driver is JDBC compliant. This
method should only return @code{true} if the driver has been
certified as JDBC compliant.
@end deftypemethod
@deftypemethod Driver {public DriverPropertyInfo} getPropertyInfo (java.lang.String@w{ }@var{url}, java.util.Properties@w{ }@var{properties}) @*throws SQLException
This method returns an array of possible properties that could be
used to connect to the specified database.
@end deftypemethod
@deftypemethod Driver {public boolean} acceptsURL (java.lang.String@w{ }@var{url}) @*throws SQLException
This method tests whether or not the driver believes it can connect to
the specified database. The driver should only test whether it
understands and accepts the URL. It should not necessarily attempt to
probe the database for a connection.
@end deftypemethod
@deftypemethod Driver {public Connection} connect (java.lang.String@w{ }@var{url}, java.util.Properties@w{ }@var{properties}) @*throws SQLException
This method connects to the specified database using the connection
properties supplied. If the driver does not understand the database
URL, it should return @code{null} instead of throwing an
exception since the @code{DriverManager} will probe a driver
in this manner.
@end deftypemethod
@deftypemethod DriverManager {public static int} getLoginTimeout ()
This method returns the login timeout in use by JDBC drivers systemwide.
@end deftypemethod
@deftypemethod DriverManager {public static void} setLoginTimeout (int@w{ }@var{login_timeout})
This method set the login timeout used by JDBC drivers. This is a
system-wide parameter that applies to all drivers.
@end deftypemethod
@deftypemethod DriverManager {public static PrintWriter} getLogWriter ()
This method returns the log writer being used by all JDBC drivers.
This method should be used in place of the deprecated
@code{getLogStream} method.
@end deftypemethod
@deftypemethod DriverManager {public static void} setLogWriter (java.io.PrintWriter@w{ }@var{log_writer})
This method sets the log writer being used by JDBC drivers. This is a
system-wide parameter that affects all drivers. Note that since there
is no way to retrieve a @code{PrintStream} from a
@code{PrintWriter}, this method cannot set the log stream in
use by JDBC. Thus any older drivers may not see this setting.
@end deftypemethod
@deftypemethod DriverManager {public static PrintStream} getLogStream ()
This method returns the log stream in use by JDBC.
@end deftypemethod
@deftypemethod DriverManager {public static void} setLogStream (java.io.PrintStream@w{ }@var{log_stream})
This method sets the log stream in use by JDBC.
@end deftypemethod
@deftypemethod DriverManager {public static void} println (java.lang.String@w{ }@var{str})
This method prints the specified line to the log stream.
@end deftypemethod
@deftypemethod DriverManager {public static void} registerDriver (java.sql.Driver@w{ }@var{driver}) @*throws SQLException
This method registers a new driver with the manager. This is normally
called by the driver itself in a static initializer.
@end deftypemethod
@deftypemethod DriverManager {public static void} deregisterDriver (java.sql.Driver@w{ }@var{driver}) @*throws SQLException
This method de-registers a driver from the manager.
@end deftypemethod
@deftypemethod DriverManager {public static Enumeration} getDrivers ()
This method returns a list of all the currently registered JDBC drivers
that were loaded by the current @code{ClassLoader}.
@end deftypemethod
@deftypemethod DriverManager {public static Driver} getDriver (java.lang.String@w{ }@var{url}) @*throws SQLException
This method returns a driver that can connect to the specified
JDBC URL string. This will be selected from among drivers loaded
at initialization time and those drivers manually loaded by the
same class loader as the caller.
@end deftypemethod
@deftypemethod DriverManager {public static Connection} getConnection (java.lang.String@w{ }@var{url}) @*throws SQLException
This method attempts to return a connection to the specified
JDBC URL string.
@end deftypemethod
@deftypemethod DriverManager {public static Connection} getConnection (java.lang.String@w{ }@var{url}, java.lang.String@w{ }@var{user}, java.lang.String@w{ }@var{password}) @*throws SQLException
This method attempts to return a connection to the specified
JDBC URL string using the specified username and password.
@end deftypemethod
@deftypemethod DriverManager {public static Connection} getConnection (java.lang.String@w{ }@var{url}, java.util.Properties@w{ }@var{properties}) @*throws SQLException
This method attempts to return a connection to the specified
JDBC URL string using the specified connection properties.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setNull (int@w{ }@var{index}, int@w{ }@var{type}) @*throws SQLException
This method populates the specified parameter with a SQL NULL value
for the specified type.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setNull (int@w{ }@var{index}, int@w{ }@var{type}, java.lang.String@w{ }@var{name}) @*throws SQLException
This method populates the specified parameter with a SQL NULL value
for the specified type.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setBoolean (int@w{ }@var{index}, boolean@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{boolean} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setByte (int@w{ }@var{index}, byte@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{byte} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setShort (int@w{ }@var{index}, short@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{short} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setInt (int@w{ }@var{index}, int@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{int} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setLong (int@w{ }@var{index}, long@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{long} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setFloat (int@w{ }@var{index}, float@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{float} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setDouble (int@w{ }@var{index}, double@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{double} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setString (int@w{ }@var{index}, java.lang.String@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{String} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setBytes (int@w{ }@var{index}, byte[]@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{byte} array value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setBigDecimal (int@w{ }@var{index}, java.math.BigDecimal@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{java.math.BigDecimal} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setDate (int@w{ }@var{index}, java.sql.Date@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{java.sql.Date} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setDate (int@w{ }@var{index}, java.sql.Date@w{ }@var{value}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{java.sql.Date} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setTime (int@w{ }@var{index}, java.sql.Time@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{java.sql.Time} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setTime (int@w{ }@var{index}, java.sql.Time@w{ }@var{value}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{java.sql.Time} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setTimestamp (int@w{ }@var{index}, java.sql.Timestamp@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{java.sql.Timestamp} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setTimestamp (int@w{ }@var{index}, java.sql.Timestamp@w{ }@var{value}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{java.sql.Timestamp} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setAsciiStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method sets the specified parameter from the given Java
ASCII @code{InputStream} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setUnicodeStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method sets the specified parameter from the given Java
Unicode UTF-8 @code{InputStream} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setBinaryStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method sets the specified parameter from the given Java
binary @code{InputStream} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setCharacterStream (int@w{ }@var{index}, java.io.Reader@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method sets the specified parameter from the given Java
character @code{Reader} value.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setRef (int@w{ }@var{index}, java.sql.Ref@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{Ref} value. The default object type to SQL type mapping
will be used.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setBlob (int@w{ }@var{index}, java.sql.Blob@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{Blob} value. The default object type to SQL type mapping
will be used.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setClob (int@w{ }@var{index}, java.sql.Clob@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{Clob} value. The default object type to SQL type mapping
will be used.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setArray (int@w{ }@var{index}, java.sql.Array@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{Array} value. The default object type to SQL type mapping
will be used.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{Object} value. The default object type to SQL type mapping
will be used.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}, int@w{ }@var{type}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{Object} value. The specified SQL object type will be used.
@end deftypemethod
@deftypemethod PreparedStatement {public void} setObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}, int@w{ }@var{type}, int@w{ }@var{scale}) @*throws SQLException
This method sets the specified parameter from the given Java
@code{Object} value. The specified SQL object type will be used.
@end deftypemethod
@deftypemethod PreparedStatement {public void} addBatch () @*throws SQLException
This method adds a set of parameters to the batch for JDBC 2.0.
@end deftypemethod
@deftypemethod PreparedStatement {public void} clearParameters () @*throws SQLException
This method clears all of the input parameter that have been
set on this statement.
@end deftypemethod
@deftypemethod PreparedStatement {public ResultSetMetaData} getMetaData () @*throws SQLException
This method returns meta data for the result set from this statement.
@end deftypemethod
@deftypemethod PreparedStatement {public boolean} execute () @*throws SQLException
This method executes a prepared SQL query.
Some prepared statements return multiple results; the execute method
handles these complex statements as well as the simpler form of
statements handled by executeQuery and executeUpdate.
@end deftypemethod
@deftypemethod PreparedStatement {public ResultSet} executeQuery () @*throws SQLException
This method executes a prepared SQL query and returns its ResultSet.
@end deftypemethod
@deftypemethod PreparedStatement {public int} executeUpdate () @*throws SQLException
This method executes an SQL INSERT, UPDATE or DELETE statement. SQL
statements that return nothing such as SQL DDL statements can be executed.
@end deftypemethod
@deftypemethod Ref {public String} getBaseTypeName () @*throws SQLException
This method returns the fully qualified name of the SQL structured
type of the referenced item.
@end deftypemethod
@deftypemethod ResultSet {public boolean} next () @*throws SQLException
This method advances to the next row in the result set. Any streams
open on the current row are closed automatically.
@end deftypemethod
@deftypemethod ResultSet {public boolean} previous () @*throws SQLException
This method moves the current position to the previous row in the
result set.
@end deftypemethod
@deftypemethod ResultSet {public void} close () @*throws SQLException
This method closes the result set and frees any associated resources.
@end deftypemethod
@deftypemethod ResultSet {public boolean} wasNull () @*throws SQLException
This method tests whether the value of the last column that was fetched
was actually a SQL NULL value.
@end deftypemethod
@deftypemethod ResultSet {public String} getString (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{String}.
@end deftypemethod
@deftypemethod ResultSet {public Object} getObject (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{Object}.
@end deftypemethod
@deftypemethod ResultSet {public boolean} getBoolean (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{boolean}.
@end deftypemethod
@deftypemethod ResultSet {public byte} getByte (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{byte}.
@end deftypemethod
@deftypemethod ResultSet {public short} getShort (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{short}.
@end deftypemethod
@deftypemethod ResultSet {public int} getInt (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{int}.
@end deftypemethod
@deftypemethod ResultSet {public long} getLong (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{long}.
@end deftypemethod
@deftypemethod ResultSet {public float} getFloat (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{float}.
@end deftypemethod
@deftypemethod ResultSet {public double} getDouble (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{double}.
@end deftypemethod
@deftypemethod ResultSet {public BigDecimal} getBigDecimal (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{BigDecimal}.
@end deftypemethod
@deftypemethod ResultSet {public BigDecimal} getBigDecimal (int@w{ }@var{index}, int@w{ }@var{scale}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{BigDecimal}.
@end deftypemethod
@deftypemethod ResultSet {public byte} getBytes (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
byte array.
@end deftypemethod
@deftypemethod ResultSet {public Date} getDate (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{java.sql.Date}.
@end deftypemethod
@deftypemethod ResultSet {public Time} getTime (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{java.sql.Time}.
@end deftypemethod
@deftypemethod ResultSet {public Timestamp} getTimestamp (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{java.sql.Timestamp}.
@end deftypemethod
@deftypemethod ResultSet {public InputStream} getAsciiStream (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as an ASCII
stream. Note that all the data from this stream must be read before
fetching the value of any other column. Please also be aware that
calling @code{next()} or @code{close()} on this result set
will close this stream as well.
@end deftypemethod
@deftypemethod ResultSet {public InputStream} getUnicodeStream (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a Unicode UTF-8
stream. Note that all the data from this stream must be read before
fetching the value of any other column. Please also be aware that
calling @code{next()} or @code{close()} on this result set
will close this stream as well.
@end deftypemethod
@deftypemethod ResultSet {public InputStream} getBinaryStream (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a raw byte
stream. Note that all the data from this stream must be read before
fetching the value of any other column. Please also be aware that
calling @code{next()} or @code{close()} on this result set
will close this stream as well.
@end deftypemethod
@deftypemethod ResultSet {public Reader} getCharacterStream (int@w{ }@var{index}) @*throws SQLException
This method returns the value of the specified column as a character
stream. Note that all the data from this stream must be read before
fetching the value of any other column. Please also be aware that
calling @code{next()} or @code{close()} on this result set
will close this stream as well.
@end deftypemethod
@deftypemethod ResultSet {public String} getString (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{String}.
@end deftypemethod
@deftypemethod ResultSet {public Object} getObject (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{Object}.
@end deftypemethod
@deftypemethod ResultSet {public boolean} getBoolean (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{boolean}.
@end deftypemethod
@deftypemethod ResultSet {public byte} getByte (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{byte}.
@end deftypemethod
@deftypemethod ResultSet {public short} getShort (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{short}.
@end deftypemethod
@deftypemethod ResultSet {public int} getInt (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{int}.
@end deftypemethod
@deftypemethod ResultSet {public long} getLong (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{long}.
@end deftypemethod
@deftypemethod ResultSet {public float} getFloat (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{float}.
@end deftypemethod
@deftypemethod ResultSet {public double} getDouble (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{double}.
@end deftypemethod
@deftypemethod ResultSet {public BigDecimal} getBigDecimal (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{BigDecimal}.
@end deftypemethod
@deftypemethod ResultSet {public BigDecimal} getBigDecimal (java.lang.String@w{ }@var{column}, int@w{ }@var{scale}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{BigDecimal}.
@end deftypemethod
@deftypemethod ResultSet {public byte} getBytes (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
byte array.
@end deftypemethod
@deftypemethod ResultSet {public Date} getDate (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{java.sql.Date}.
@end deftypemethod
@deftypemethod ResultSet {public Time} getTime (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{java.sql.Time}.
@end deftypemethod
@deftypemethod ResultSet {public Timestamp} getTimestamp (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{java.sql.Timestamp}.
@end deftypemethod
@deftypemethod ResultSet {public InputStream} getAsciiStream (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as an ASCII
stream. Note that all the data from this stream must be read before
fetching the value of any other column. Please also be aware that
calling @code{next()} or @code{close()} on this result set
will close this stream as well.
@end deftypemethod
@deftypemethod ResultSet {public InputStream} getUnicodeStream (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a Unicode UTF-8
stream. Note that all the data from this stream must be read before
fetching the value of any other column. Please also be aware that
calling @code{next()} or @code{close()} on this result set
will close this stream as well.
@end deftypemethod
@deftypemethod ResultSet {public InputStream} getBinaryStream (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a raw byte
stream. Note that all the data from this stream must be read before
fetching the value of any other column. Please also be aware that
calling @code{next()} or @code{close()} on this result set
will close this stream as well.
@end deftypemethod
@deftypemethod ResultSet {public Reader} getCharacterStream (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the value of the specified column as a character
stream. Note that all the data from this stream must be read before
fetching the value of any other column. Please also be aware that
calling @code{next()} or @code{close()} on this result set
will close this stream as well.
@end deftypemethod
@deftypemethod ResultSet {public SQLWarning} getWarnings () @*throws SQLException
This method returns the first SQL warning associated with this result
set. Any additional warnings will be chained to this one.
@end deftypemethod
@deftypemethod ResultSet {public void} clearWarnings () @*throws SQLException
This method clears all warnings associated with this result set.
@end deftypemethod
@deftypemethod ResultSet {public String} getCursorName () @*throws SQLException
This method returns the name of the database cursor used by this
result set.
@end deftypemethod
@deftypemethod ResultSet {public ResultSetMetaData} getMetaData () @*throws SQLException
This method returns data about the columns returned as part of the
result set as a @code{ResultSetMetaData} instance.
@end deftypemethod
@deftypemethod ResultSet {public int} findColumn (java.lang.String@w{ }@var{column}) @*throws SQLException
This method returns the column index of the specified named column.
@end deftypemethod
@deftypemethod ResultSet {public boolean} isBeforeFirst () @*throws SQLException
This method tests whether or not the cursor is before the first row
in the result set.
@end deftypemethod
@deftypemethod ResultSet {public boolean} isAfterLast () @*throws SQLException
This method tests whether or not the cursor is after the last row
in the result set.
@end deftypemethod
@deftypemethod ResultSet {public boolean} isFirst () @*throws SQLException
This method tests whether or not the cursor is positioned on the first
row in the result set.
@end deftypemethod
@deftypemethod ResultSet {public boolean} isLast () @*throws SQLException
This method tests whether or not the cursor is on the last row
in the result set.
@end deftypemethod
@deftypemethod ResultSet {public void} beforeFirst () @*throws SQLException
This method repositions the cursor to before the first row in the
result set.
@end deftypemethod
@deftypemethod ResultSet {public void} afterLast () @*throws SQLException
This method repositions the cursor to after the last row in the result
set.
@end deftypemethod
@deftypemethod ResultSet {public boolean} first () @*throws SQLException
This method repositions the cursor on the first row in the
result set.
@end deftypemethod
@deftypemethod ResultSet {public boolean} last () @*throws SQLException
This method repositions the cursor on the last row in the result
set.
@end deftypemethod
@deftypemethod ResultSet {public int} getRow () @*throws SQLException
This method returns the current row number in the cursor. Numbering
begins at index 1.
@end deftypemethod
@deftypemethod ResultSet {public boolean} absolute (int@w{ }@var{row}) @*throws SQLException
This method positions the result set to the specified absolute row.
Positive numbers are row offsets from the beginning of the result
set (numbering starts from row 1) and negative numbers are row offsets
from the end of the result set (numbering starts from -1).
@end deftypemethod
@deftypemethod ResultSet {public boolean} relative (int@w{ }@var{row}) @*throws SQLException
This method moves the result set position relative to the current row.
The offset can be positive or negative.
@end deftypemethod
@deftypemethod ResultSet {public void} setFetchDirection (int@w{ }@var{direction}) @*throws SQLException
This method provides a hint to the driver about which direction the
result set will be processed in.
@end deftypemethod
@deftypemethod ResultSet {public int} getFetchDirection () @*throws SQLException
This method returns the current fetch direction for this result set.
@end deftypemethod
@deftypemethod ResultSet {public void} setFetchSize (int@w{ }@var{rows}) @*throws SQLException
This method provides a hint to the driver about how many rows at a
time it should fetch from the database.
@end deftypemethod
@deftypemethod ResultSet {public int} getFetchSize () @*throws SQLException
This method returns the current number of rows that will be fetched
from the database at a time.
@end deftypemethod
@deftypemethod ResultSet {public int} getType () @*throws SQLException
This method returns the result set type of this result set. This will
be one of the TYPE_* constants defined in this interface.
@end deftypemethod
@deftypemethod ResultSet {public int} getConcurrency () @*throws SQLException
This method returns the concurrency type of this result set. This will
be one of the CONCUR_* constants defined in this interface.
@end deftypemethod
@deftypemethod ResultSet {public boolean} rowUpdated () @*throws SQLException
This method tests whether or not the current row in the result set
has been updated. Updates must be visible in order of this method to
detect the update.
@end deftypemethod
@deftypemethod ResultSet {public boolean} rowInserted () @*throws SQLException
This method tests whether or not the current row in the result set
has been inserted. Inserts must be visible in order of this method to
detect the insert.
@end deftypemethod
@deftypemethod ResultSet {public boolean} rowDeleted () @*throws SQLException
This method tests whether or not the current row in the result set
has been deleted. Deletes must be visible in order of this method to
detect the deletion.
@end deftypemethod
@deftypemethod ResultSet {public void} updateNull (int@w{ }@var{index}) @*throws SQLException
This method updates the specified column to have a NULL value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateBoolean (int@w{ }@var{index}, boolean@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a boolean value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateByte (int@w{ }@var{index}, byte@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a byte value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateShort (int@w{ }@var{index}, short@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a short value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateInt (int@w{ }@var{index}, int@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have an int value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateLong (int@w{ }@var{index}, long@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a long value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateFloat (int@w{ }@var{index}, float@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a float value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateDouble (int@w{ }@var{index}, double@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a double value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateBigDecimal (int@w{ }@var{index}, java.math.BigDecimal@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a BigDecimal value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateString (int@w{ }@var{index}, java.lang.String@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a String value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateBytes (int@w{ }@var{index}, byte[]@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a byte array value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateDate (int@w{ }@var{index}, java.sql.Date@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a java.sql.Date value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateTime (int@w{ }@var{index}, java.sql.Time@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a java.sql.Time value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateTimestamp (int@w{ }@var{index}, java.sql.Timestamp@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a java.sql.Timestamp value.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateAsciiStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method updates the specified column from an ASCII text stream.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateBinaryStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method updates the specified column from a binary stream.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateCharacterStream (int@w{ }@var{index}, java.io.Reader@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method updates the specified column from a character stream.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have an Object value.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}, int@w{ }@var{scale}) @*throws SQLException
This method updates the specified column to have an Object value.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateNull (java.lang.String@w{ }@var{name}) @*throws SQLException
This method updates the specified column to have a NULL value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateBoolean (java.lang.String@w{ }@var{name}, boolean@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a boolean value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateByte (java.lang.String@w{ }@var{name}, byte@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a byte value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateShort (java.lang.String@w{ }@var{name}, short@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a short value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateInt (java.lang.String@w{ }@var{name}, int@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have an int value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateLong (java.lang.String@w{ }@var{name}, long@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a long value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateFloat (java.lang.String@w{ }@var{name}, float@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a float value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateDouble (java.lang.String@w{ }@var{name}, double@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a double value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateBigDecimal (java.lang.String@w{ }@var{name}, java.math.BigDecimal@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a BigDecimal value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateString (java.lang.String@w{ }@var{name}, java.lang.String@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a String value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateBytes (java.lang.String@w{ }@var{name}, byte[]@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a byte array value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateDate (java.lang.String@w{ }@var{name}, java.sql.Date@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a java.sql.Date value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateTime (java.lang.String@w{ }@var{name}, java.sql.Time@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a java.sql.Time value. This
does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateTimestamp (java.lang.String@w{ }@var{name}, java.sql.Timestamp@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have a java.sql.Timestamp value.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateAsciiStream (java.lang.String@w{ }@var{name}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method updates the specified column from an ASCII text stream.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateBinaryStream (java.lang.String@w{ }@var{name}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method updates the specified column from a binary stream.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateCharacterStream (java.lang.String@w{ }@var{name}, java.io.Reader@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
This method updates the specified column from a character stream.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateObject (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{value}) @*throws SQLException
This method updates the specified column to have an Object value.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} updateObject (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{value}, int@w{ }@var{scale}) @*throws SQLException
This method updates the specified column to have an Object value.
This does not update the actual database. @code{updateRow} must be
called in order to do that.
@end deftypemethod
@deftypemethod ResultSet {public void} insertRow () @*throws SQLException
This method inserts the current row into the database. The result set
must be positioned on the insert row in order to call this method
successfully.
@end deftypemethod
@deftypemethod ResultSet {public void} updateRow () @*throws SQLException
This method updates the current row in the database.
@end deftypemethod
@deftypemethod ResultSet {public void} deleteRow () @*throws SQLException
This method deletes the current row in the database.
@end deftypemethod
@deftypemethod ResultSet {public void} refreshRow () @*throws SQLException
This method refreshes the contents of the current row from the database.
@end deftypemethod
@deftypemethod ResultSet {public void} cancelRowUpdates () @*throws SQLException
This method cancels any changes that have been made to a row. If
the @code{rowUpdate} method has been called, then the changes
cannot be undone.
@end deftypemethod
@deftypemethod ResultSet {public void} moveToInsertRow () @*throws SQLException
This method positions the result set to the "insert row", which allows
a new row to be inserted into the database from the result set.
@end deftypemethod
@deftypemethod ResultSet {public void} moveToCurrentRow () @*throws SQLException
This method moves the result set position from the insert row back to
the current row that was selected prior to moving to the insert row.
@end deftypemethod
@deftypemethod ResultSet {public Statement} getStatement () @*throws SQLException
This method returns a the @code{Statement} that was used to
produce this result set.
@end deftypemethod
@deftypemethod ResultSet {public Object} getObject (int@w{ }@var{index}, java.util.Map@w{ }@var{map}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{Object} using the specified SQL type to Java type map.
@end deftypemethod
@deftypemethod ResultSet {public Ref} getRef (int@w{ }@var{index}) @*throws SQLException
This method returns a @code{Ref} for the specified column which
represents the structured type for the column.
@end deftypemethod
@deftypemethod ResultSet {public Blob} getBlob (int@w{ }@var{index}) @*throws SQLException
This method returns the specified column value as a BLOB.
@end deftypemethod
@deftypemethod ResultSet {public Clob} getClob (int@w{ }@var{index}) @*throws SQLException
This method returns the specified column value as a CLOB.
@end deftypemethod
@deftypemethod ResultSet {public Array} getArray (int@w{ }@var{index}) @*throws SQLException
This method returns the specified column value as an @code{Array}.
@end deftypemethod
@deftypemethod ResultSet {public Object} getObject (java.lang.String@w{ }@var{name}, java.util.Map@w{ }@var{map}) @*throws SQLException
This method returns the value of the specified column as a Java
@code{Object} using the specified SQL type to Java type map.
@end deftypemethod
@deftypemethod ResultSet {public Ref} getRef (java.lang.String@w{ }@var{name}) @*throws SQLException
This method returns a @code{Ref} for the specified column which
represents the structured type for the column.
@end deftypemethod
@deftypemethod ResultSet {public Blob} getBlob (java.lang.String@w{ }@var{name}) @*throws SQLException
This method returns the specified column value as a BLOB.
@end deftypemethod
@deftypemethod ResultSet {public Clob} getClob (java.lang.String@w{ }@var{name}) @*throws SQLException
This method returns the specified column value as a CLOB.
@end deftypemethod
@deftypemethod ResultSet {public Array} getArray (java.lang.String@w{ }@var{name}) @*throws SQLException
This method returns the specified column value as an @code{Array}.
@end deftypemethod
@deftypemethod ResultSet {public Date} getDate (int@w{ }@var{index}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
This method returns the specified column value as a
@code{java.sql.Date}. The specified @code{Calendar} is used
to generate a value for the date if the database does not support
timezones.
@end deftypemethod
@deftypemethod ResultSet {public Time} getTime (int@w{ }@var{index}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
This method returns the specified column value as a
@code{java.sql.Time}. The specified @code{Calendar} is used
to generate a value for the time if the database does not support
timezones.
@end deftypemethod
@deftypemethod ResultSet {public Timestamp} getTimestamp (int@w{ }@var{index}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
This method returns the specified column value as a
@code{java.sql.Timestamp}. The specified @code{Calendar} is used
to generate a value for the timestamp if the database does not support
timezones.
@end deftypemethod
@deftypemethod ResultSet {public Date} getDate (java.lang.String@w{ }@var{name}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
This method returns the specified column value as a
@code{java.sql.Date}. The specified @code{Calendar} is used
to generate a value for the date if the database does not support
timezones.
@end deftypemethod
@deftypemethod ResultSet {public Time} getTime (java.lang.String@w{ }@var{name}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
This method returns the specified column value as a
@code{java.sql.Time}. The specified @code{Calendar} is used
to generate a value for the time if the database does not support
timezones.
@end deftypemethod
@deftypemethod ResultSet {public Timestamp} getTimestamp (java.lang.String@w{ }@var{name}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
This method returns the specified column value as a
@code{java.sql.Timestamp}. The specified @code{Calendar} is used
to generate a value for the timestamp if the database does not support
timezones.
@end deftypemethod
@deftypemethod ResultSetMetaData {public int} getColumnCount () @*throws SQLException
This method returns the number of columns in the result set.
@end deftypemethod
@deftypemethod ResultSetMetaData {public boolean} isAutoIncrement (int@w{ }@var{index}) @*throws SQLException
This method test whether or not the column is an auto-increment column.
Auto-increment columns are read-only.
@end deftypemethod
@deftypemethod ResultSetMetaData {public boolean} isCaseSensitive (int@w{ }@var{index}) @*throws SQLException
This method tests whether or not a column is case sensitive in its values.
@end deftypemethod
@deftypemethod ResultSetMetaData {public boolean} isSearchable (int@w{ }@var{index}) @*throws SQLException
This method tests whether not the specified column can be used in
a WHERE clause.
@end deftypemethod
@deftypemethod ResultSetMetaData {public boolean} isCurrency (int@w{ }@var{index}) @*throws SQLException
This method tests whether or not the column stores a monetary value.
@end deftypemethod
@deftypemethod ResultSetMetaData {public int} isNullable (int@w{ }@var{index}) @*throws SQLException
This method returns a value indicating whether or not the specified
column may contain a NULL value.
@end deftypemethod
@deftypemethod ResultSetMetaData {public boolean} isSigned (int@w{ }@var{index}) @*throws SQLException
This method tests whether or not the value of the specified column
is signed or unsigned.
@end deftypemethod
@deftypemethod ResultSetMetaData {public int} getColumnDisplaySize (int@w{ }@var{index}) @*throws SQLException
This method returns the maximum number of characters that can be used
to display a value in this column.
@end deftypemethod
@deftypemethod ResultSetMetaData {public String} getColumnLabel (int@w{ }@var{index}) @*throws SQLException
This method returns a string that should be used as a caption for this
column for user display purposes.
@end deftypemethod
@deftypemethod ResultSetMetaData {public String} getColumnName (int@w{ }@var{index}) @*throws SQLException
This method returns the name of the specified column.
@end deftypemethod
@deftypemethod ResultSetMetaData {public String} getSchemaName (int@w{ }@var{index}) @*throws SQLException
This method returns the name of the schema that contains the specified
column.
@end deftypemethod
@deftypemethod ResultSetMetaData {public int} getPrecision (int@w{ }@var{index}) @*throws SQLException
This method returns the precision of the specified column, which is the
number of decimal digits it contains.
@end deftypemethod
@deftypemethod ResultSetMetaData {public int} getScale (int@w{ }@var{index}) @*throws SQLException
This method returns the scale of the specified column, which is the
number of digits to the right of the decimal point.
@end deftypemethod
@deftypemethod ResultSetMetaData {public String} getTableName (int@w{ }@var{index}) @*throws SQLException
This method returns the name of the table containing the specified
column.
@end deftypemethod
@deftypemethod ResultSetMetaData {public String} getCatalogName (int@w{ }@var{index}) @*throws SQLException
This method returns the name of the catalog containing the specified
column.
@end deftypemethod
@deftypemethod ResultSetMetaData {public int} getColumnType (int@w{ }@var{index}) @*throws SQLException
This method returns the SQL type of the specified column. This will
be one of the constants from @code{Types}.
@end deftypemethod
@deftypemethod ResultSetMetaData {public String} getColumnTypeName (int@w{ }@var{index}) @*throws SQLException
This method returns the name of the SQL type for this column.
@end deftypemethod
@deftypemethod ResultSetMetaData {public boolean} isReadOnly (int@w{ }@var{index}) @*throws SQLException
This method tests whether or not the specified column is read only.
@end deftypemethod
@deftypemethod ResultSetMetaData {public boolean} isWritable (int@w{ }@var{index}) @*throws SQLException
This method tests whether or not the column may be writable. This
does not guarantee that a write will be successful.
@end deftypemethod
@deftypemethod ResultSetMetaData {public boolean} isDefinitelyWritable (int@w{ }@var{index}) @*throws SQLException
This method tests whether or not the column is writable. This
does guarantee that a write will be successful.
@end deftypemethod
@deftypemethod ResultSetMetaData {public String} getColumnClassName (int@w{ }@var{index}) @*throws SQLException
This method returns the name of the Java class which will be used to
create objects representing the data in this column.
@end deftypemethod
@deftypemethod SQLData {public String} getSQLTypeName () @*throws SQLException
This method returns the user defined datatype name for this object.
@end deftypemethod
@deftypemethod SQLData {public void} readSQL (java.sql.SQLInput@w{ }@var{stream}, java.lang.String@w{ }@var{name}) @*throws SQLException
This method populates the data in the object from the specified stream.
@end deftypemethod
@deftypemethod SQLData {public void} writeSQL (java.sql.SQLOutput@w{ }@var{stream}) @*throws SQLException
This method writes the data in this object to the specified stream.
@end deftypemethod
@deftypemethod SQLException {public String} getSQLState ()
This method returns the SQLState information associated with this
error. The value returned is a @code{String} which is formatted
using the XOPEN SQL state conventions.
@end deftypemethod
@deftypemethod SQLException {public int} getErrorCode ()
This method returns the vendor specific error code associated with
this error.
@end deftypemethod
@deftypemethod SQLException {public SQLException} getNextException ()
This method returns the exception that is chained to this object.
@end deftypemethod
@deftypemethod SQLException {public void} setNextException (java.sql.SQLException@w{ }@var{e})
This method adds a new exception to the end of the chain of exceptions
that are chained to this object.
@end deftypemethod
@deftypemethod SQLInput {public String} readString () @*throws SQLException
This method reads the next item from the stream a Java
@code{String}.
@end deftypemethod
@deftypemethod SQLInput {public boolean} readBoolean () @*throws SQLException
This method reads the next item from the stream a Java
@code{boolean}.
@end deftypemethod
@deftypemethod SQLInput {public byte} readByte () @*throws SQLException
This method reads the next item from the stream a Java
@code{byte}.
@end deftypemethod
@deftypemethod SQLInput {public short} readShort () @*throws SQLException
This method reads the next item from the stream a Java
@code{short}.
@end deftypemethod
@deftypemethod SQLInput {public int} readInt () @*throws SQLException
This method reads the next item from the stream a Java
@code{int}.
@end deftypemethod
@deftypemethod SQLInput {public long} readLong () @*throws SQLException
This method reads the next item from the stream a Java
@code{long}.
@end deftypemethod
@deftypemethod SQLInput {public float} readFloat () @*throws SQLException
This method reads the next item from the stream a Java
@code{float}.
@end deftypemethod
@deftypemethod SQLInput {public double} readDouble () @*throws SQLException
This method reads the next item from the stream a Java
@code{double}.
@end deftypemethod
@deftypemethod SQLInput {public BigDecimal} readBigDecimal () @*throws SQLException
This method reads the next item from the stream a Java
@code{BigDecimal}.
@end deftypemethod
@deftypemethod SQLInput {public byte} readBytes () @*throws SQLException
This method reads the next item from the stream a Java
byte array
@end deftypemethod
@deftypemethod SQLInput {public Date} readDate () @*throws SQLException
This method reads the next item from the stream a Java
@code{java.sql.Date}.
@end deftypemethod
@deftypemethod SQLInput {public Time} readTime () @*throws SQLException
This method reads the next item from the stream a Java
@code{java.sql.Time}.
@end deftypemethod
@deftypemethod SQLInput {public Timestamp} readTimestamp () @*throws SQLException
This method reads the next item from the stream a Java
@code{java.sql.Timestamp}.
@end deftypemethod
@deftypemethod SQLInput {public InputStream} readAsciiStream () @*throws SQLException
This method reads the next item from the stream a ASCII text
@code{InputStream}.
@end deftypemethod
@deftypemethod SQLInput {public InputStream} readBinaryStream () @*throws SQLException
This method reads the next item from the stream a binary
@code{InputStream}.
@end deftypemethod
@deftypemethod SQLInput {public Reader} readCharacterStream () @*throws SQLException
This method reads the next item from the stream a character
@code{Reader}.
@end deftypemethod
@deftypemethod SQLInput {public Object} readObject () @*throws SQLException
This method reads the next item from the stream a Java
@code{Object}.
@end deftypemethod
@deftypemethod SQLInput {public Ref} readRef () @*throws SQLException
This method reads the next item from the stream a Java SQL
@code{Ref}.
@end deftypemethod
@deftypemethod SQLInput {public Blob} readBlob () @*throws SQLException
This method reads the next item from the stream a Java SQL
@code{Blob}.
@end deftypemethod
@deftypemethod SQLInput {public Clob} readClob () @*throws SQLException
This method reads the next item from the stream a Java SQL
@code{Clob}.
@end deftypemethod
@deftypemethod SQLInput {public Array} readArray () @*throws SQLException
This method reads the next item from the stream a Java SQL
@code{Array}.
@end deftypemethod
@deftypemethod SQLInput {public boolean} wasNull () @*throws SQLException
This method tests whether or not the last value read was a SQL
NULL value.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeString (java.lang.String@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{String}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeBoolean (boolean@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{boolean}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeByte (byte@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{byte}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeShort (short@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{short}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeInt (int@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{int}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeLong (long@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{long}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeFloat (float@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{float}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeDouble (double@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{double}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeBigDecimal (java.math.BigDecimal@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{BigDecimal}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeBytes (byte[]@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{byte} array
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeDate (java.sql.Date@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{java.sql.Date}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeTime (java.sql.Time@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{java.sql.Time}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeTimestamp (java.sql.Timestamp@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{java.sql.Timestamp}
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeCharacterStream (java.io.Reader@w{ }@var{value}) @*throws SQLException
This method writes the specified Java character stream
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeBinaryStream (java.io.InputStream@w{ }@var{value}) @*throws SQLException
This method writes the specified uninterpreted binary byte stream
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeAsciiStream (java.io.InputStream@w{ }@var{value}) @*throws SQLException
This method writes the specified ASCII text stream
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeObject (java.sql.SQLData@w{ }@var{value}) @*throws SQLException
This method writes the specified Java @code{SQLData} object
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeRef (java.sql.Ref@w{ }@var{value}) @*throws SQLException
This method writes the specified Java SQL @code{Ref} object
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeBlob (java.sql.Blob@w{ }@var{value}) @*throws SQLException
This method writes the specified Java SQL @code{Blob} object
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeClob (java.sql.Clob@w{ }@var{value}) @*throws SQLException
This method writes the specified Java SQL @code{Clob} object
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeStruct (java.sql.Struct@w{ }@var{value}) @*throws SQLException
This method writes the specified Java SQL @code{Struct} object
to the SQL stream.
@end deftypemethod
@deftypemethod SQLOutput {public void} writeArray (java.sql.Array@w{ }@var{value}) @*throws SQLException
This method writes the specified Java SQL @code{Array} object
to the SQL stream.
@end deftypemethod
@deftypemethod SQLWarning {public SQLWarning} getNextWarning ()
This method returns the exception that is chained to this object.
@end deftypemethod
@deftypemethod SQLWarning {public void} setNextWarning (java.sql.SQLWarning@w{ }@var{e})
This method adds a new exception to the end of the chain of exceptions
that are chained to this object.
@end deftypemethod
@deftypemethod Statement {public ResultSet} executeQuery (java.lang.String@w{ }@var{sql}) @*throws SQLException
This method executes the specified SQL SELECT statement and returns a
(possibly empty) @code{ResultSet} with the results of the query.
@end deftypemethod
@deftypemethod Statement {public int} executeUpdate (java.lang.String@w{ }@var{sql}) @*throws SQLException
This method executes the specified SQL INSERT, UPDATE, or DELETE statement
and returns the number of rows affected, which may be 0.
@end deftypemethod
@deftypemethod Statement {public void} close () @*throws SQLException
This method closes the statement and frees any associated resources.
@end deftypemethod
@deftypemethod Statement {public int} getMaxFieldSize () @*throws SQLException
This method returns the maximum length of any column value in bytes.
@end deftypemethod
@deftypemethod Statement {public void} setMaxFieldSize (int@w{ }@var{maxsize}) @*throws SQLException
This method sets the limit for the maximum length of any column in bytes.
@end deftypemethod
@deftypemethod Statement {public int} getMaxRows () @*throws SQLException
This method returns the maximum possible number of rows in a result set.
@end deftypemethod
@deftypemethod Statement {public void} setMaxRows (int@w{ }@var{maxrows}) @*throws SQLException
This method sets the maximum number of rows that can be present in a
result set.
@end deftypemethod
@deftypemethod Statement {public void} setEscapeProcessing (boolean@w{ }@var{esacpe}) @*throws SQLException
This method sets the local escape processing mode on or off. The
default value is on.
@end deftypemethod
@deftypemethod Statement {public int} getQueryTimeout () @*throws SQLException
The method returns the number of seconds a statement may be in process
before timing out. A value of 0 means there is no timeout.
@end deftypemethod
@deftypemethod Statement {public void} setQueryTimeout (int@w{ }@var{timeout}) @*throws SQLException
This method sets the number of seconds a statement may be in process
before timing out. A value of 0 means there is no timeout.
@end deftypemethod
@deftypemethod Statement {public void} cancel () @*throws SQLException
This method cancels an outstanding statement, if the database supports
that operation.
@end deftypemethod
@deftypemethod Statement {public SQLWarning} getWarnings () @*throws SQLException
This method returns the first SQL warning attached to this statement.
Subsequent warnings will be chained to this one.
@end deftypemethod
@deftypemethod Statement {public void} clearWarnings () @*throws SQLException
This method clears any SQL warnings that have been attached to this
statement.
@end deftypemethod
@deftypemethod Statement {public void} setCursorName (java.lang.String@w{ }@var{name}) @*throws SQLException
This method sets the cursor name that will be used by the result set.
@end deftypemethod
@deftypemethod Statement {public boolean} execute (java.lang.String@w{ }@var{sql}) @*throws SQLException
This method executes an arbitrary SQL statement of any time. The
methods @code{getResultSet}, @code{getMoreResults} and
@code{getUpdateCount} retrieve the results.
@end deftypemethod
@deftypemethod Statement {public ResultSet} getResultSet () @*throws SQLException
This method returns the result set of the SQL statement that was
executed. This should be called only once per result set returned.
@end deftypemethod
@deftypemethod Statement {public int} getUpdateCount () @*throws SQLException
This method returns the update count of the SQL statement that was
executed. This should be called only once per executed SQL statement.
@end deftypemethod
@deftypemethod Statement {public boolean} getMoreResults () @*throws SQLException
This method advances the result set pointer to the next result set,
which can then be retrieved using @code{getResultSet}
@end deftypemethod
@deftypemethod Statement {public int} getFetchDirection () @*throws SQLException
This method returns the current direction that the driver thinks the
result set will be accessed int.
@end deftypemethod
@deftypemethod Statement {public void} setFetchDirection (int@w{ }@var{direction}) @*throws SQLException
This method informs the driver which direction the result set will
be accessed in.
@end deftypemethod
@deftypemethod Statement {public int} getFetchSize () @*throws SQLException
This method returns the number of rows the driver believes should be
fetched from the database at a time.
@end deftypemethod
@deftypemethod Statement {public void} setFetchSize (int@w{ }@var{numrows}) @*throws SQLException
This method informs the driver how many rows it should fetch from the
database at a time.
@end deftypemethod
@deftypemethod Statement {public int} getResultSetConcurrency () @*throws SQLException
This method returns the concurrency type of the result set for this
statement. This will be one of the concurrency types defined in
@code{ResultSet}.
@end deftypemethod
@deftypemethod Statement {public int} getResultSetType () @*throws SQLException
This method returns the result set type for this statement. This will
be one of the result set types defined in @code{ResultSet}.
@end deftypemethod
@deftypemethod Statement {public void} addBatch (java.lang.String@w{ }@var{sql}) @*throws SQLException
This method adds a SQL statement to a SQL batch. A driver is not
required to implement this method.
@end deftypemethod
@deftypemethod Statement {public void} clearBatch () @*throws SQLException
This method clears out any SQL statements that have been populated in
the current batch. A driver is not required to implement this method.
@end deftypemethod
@deftypemethod Statement {public int} executeBatch () @*throws SQLException
This method executes the SQL batch and returns an array of update
counts - one for each SQL statement in the batch - ordered in the same
order the statements were added to the batch. A driver is not required
to implement this method.
@end deftypemethod
@deftypemethod Statement {public Connection} getConnection () @*throws SQLException
This method returns the @code{Connection} instance that was
used to create this object.
@end deftypemethod
@deftypemethod Struct {public String} getSQLTypeName () @*throws SQLException
This method returns the name of the SQL structured type for this
object.
@end deftypemethod
@deftypemethod Struct {public Object} getAttributes () @*throws SQLException
This method returns the attributes of this SQL structured type.
@end deftypemethod
@deftypemethod Struct {public Object} getAttributes (java.util.Map@w{ }@var{map}) @*throws SQLException
This method returns the attributes of this SQL structured type.
The specified map of type mappings overrides the default mappings.
@end deftypemethod
@deftypemethod Time {public static Time} valueOf (java.lang.String@w{ }@var{str})
This method returns a new instance of this class by parsing a
date in JDBC format into a Java date.
@end deftypemethod
@deftypemethod Time {public String} toString ()
This method returns this date in JDBC format.
@end deftypemethod
@deftypemethod Timestamp {public static Timestamp} valueOf (java.lang.String@w{ }@var{str})
This method returns a new instance of this class by parsing a
date in JDBC format into a Java date.
@end deftypemethod
@deftypemethod Timestamp {public String} toString ()
This method returns this date in JDBC format.
@end deftypemethod
@deftypemethod Timestamp {public int} getNanos ()
This method returns the nanosecond value for this object.
@end deftypemethod
@deftypemethod Timestamp {public void} setNanos (int@w{ }@var{nanos})
This method sets the nanosecond value for this object.
@end deftypemethod
@deftypemethod Timestamp {public boolean} before (java.sql.Timestamp@w{ }@var{ts})
This methods tests whether this object is earlier than the specified
object.
@end deftypemethod
@deftypemethod Timestamp {public boolean} after (java.sql.Timestamp@w{ }@var{ts})
This methods tests whether this object is later than the specified
object.
@end deftypemethod
@deftypemethod Timestamp {public boolean} equals (java.lang.Object@w{ }@var{obj})
This method these the specified @code{Object} for equality
against this object. This will be true if an only if the specified
object is an instance of @code{Timestamp} and has the same
time value fields.
@end deftypemethod
@deftypemethod Timestamp {public boolean} equals (java.sql.Timestamp@w{ }@var{ts})
This method tests the specified timestamp for equality against this
object. This will be true if and only if the specified object is
not @code{null} and contains all the same time value fields
as this object.
@end deftypemethod
|