-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDatabaseMetaData.java
More file actions
3655 lines (3407 loc) · 156 KB
/
DatabaseMetaData.java
File metadata and controls
3655 lines (3407 loc) · 156 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 1996, 2010, Oracle and/or its affiliates. All rights reserved.
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package java.sql;
/**
* Comprehensive information about the database as a whole.
* <P>
* This interface is implemented by driver vendors to let users know the capabilities
* of a Database Management System (DBMS) in combination with
* the driver based on JDBC<sup><font size=-2>TM</font></sup> technology
* ("JDBC driver") that is used with it. Different relational DBMSs often support
* different features, implement features in different ways, and use different
* data types. In addition, a driver may implement a feature on top of what the
* DBMS offers. Information returned by methods in this interface applies
* to the capabilities of a particular driver and a particular DBMS working
* together. Note that as used in this documentation, the term "database" is
* used generically to refer to both the driver and DBMS.
* <P>
* A user for this interface is commonly a tool that needs to discover how to
* deal with the underlying DBMS. This is especially true for applications
* that are intended to be used with more than one DBMS. For example, a tool might use the method
* <code>getTypeInfo</code> to find out what data types can be used in a
* <code>CREATE TABLE</code> statement. Or a user might call the method
* <code>supportsCorrelatedSubqueries</code> to see if it is possible to use
* a correlated subquery or <code>supportsBatchUpdates</code> to see if it is
* possible to use batch updates.
* <P>
* Some <code>DatabaseMetaData</code> methods return lists of information
* in the form of <code>ResultSet</code> objects.
* Regular <code>ResultSet</code> methods, such as
* <code>getString</code> and <code>getInt</code>, can be used
* to retrieve the data from these <code>ResultSet</code> objects. If
* a given form of metadata is not available, an empty <code>ResultSet</code>
* will be returned. Additional columns beyond the columns defined to be
* returned by the <code>ResultSet</code> object for a given method
* can be defined by the JDBC driver vendor and must be accessed
* by their <B>column label</B>.
* <P>
* Some <code>DatabaseMetaData</code> methods take arguments that are
* String patterns. These arguments all have names such as fooPattern.
* Within a pattern String, "%" means match any substring of 0 or more
* characters, and "_" means match any one character. Only metadata
* entries matching the search pattern are returned. If a search pattern
* argument is set to <code>null</code>, that argument's criterion will
* be dropped from the search.
* <P>
*/
public interface DatabaseMetaData extends Wrapper {
//----------------------------------------------------------------------
// First, a variety of minor information about the target database.
/**
* Retrieves whether the current user can call all the procedures
* returned by the method <code>getProcedures</code>.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean allProceduresAreCallable() throws SQLException;
/**
* Retrieves whether the current user can use all the tables returned
* by the method <code>getTables</code> in a <code>SELECT</code>
* statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean allTablesAreSelectable() throws SQLException;
/**
* Retrieves the URL for this DBMS.
*
* @return the URL for this DBMS or <code>null</code> if it cannot be
* generated
* @exception SQLException if a database access error occurs
*/
String getURL() throws SQLException;
/**
* Retrieves the user name as known to this database.
*
* @return the database user name
* @exception SQLException if a database access error occurs
*/
String getUserName() throws SQLException;
/**
* Retrieves whether this database is in read-only mode.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean isReadOnly() throws SQLException;
/**
* Retrieves whether <code>NULL</code> values are sorted high.
* Sorted high means that <code>NULL</code> values
* sort higher than any other value in a domain. In an ascending order,
* if this method returns <code>true</code>, <code>NULL</code> values
* will appear at the end. By contrast, the method
* <code>nullsAreSortedAtEnd</code> indicates whether <code>NULL</code> values
* are sorted at the end regardless of sort order.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean nullsAreSortedHigh() throws SQLException;
/**
* Retrieves whether <code>NULL</code> values are sorted low.
* Sorted low means that <code>NULL</code> values
* sort lower than any other value in a domain. In an ascending order,
* if this method returns <code>true</code>, <code>NULL</code> values
* will appear at the beginning. By contrast, the method
* <code>nullsAreSortedAtStart</code> indicates whether <code>NULL</code> values
* are sorted at the beginning regardless of sort order.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean nullsAreSortedLow() throws SQLException;
/**
* Retrieves whether <code>NULL</code> values are sorted at the start regardless
* of sort order.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean nullsAreSortedAtStart() throws SQLException;
/**
* Retrieves whether <code>NULL</code> values are sorted at the end regardless of
* sort order.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean nullsAreSortedAtEnd() throws SQLException;
/**
* Retrieves the name of this database product.
*
* @return database product name
* @exception SQLException if a database access error occurs
*/
String getDatabaseProductName() throws SQLException;
/**
* Retrieves the version number of this database product.
*
* @return database version number
* @exception SQLException if a database access error occurs
*/
String getDatabaseProductVersion() throws SQLException;
/**
* Retrieves the name of this JDBC driver.
*
* @return JDBC driver name
* @exception SQLException if a database access error occurs
*/
String getDriverName() throws SQLException;
/**
* Retrieves the version number of this JDBC driver as a <code>String</code>.
*
* @return JDBC driver version
* @exception SQLException if a database access error occurs
*/
String getDriverVersion() throws SQLException;
/**
* Retrieves this JDBC driver's major version number.
*
* @return JDBC driver major version
*/
int getDriverMajorVersion();
/**
* Retrieves this JDBC driver's minor version number.
*
* @return JDBC driver minor version number
*/
int getDriverMinorVersion();
/**
* Retrieves whether this database stores tables in a local file.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean usesLocalFiles() throws SQLException;
/**
* Retrieves whether this database uses a file for each table.
*
* @return <code>true</code> if this database uses a local file for each table;
* <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean usesLocalFilePerTable() throws SQLException;
/**
* Retrieves whether this database treats mixed case unquoted SQL identifiers as
* case sensitive and as a result stores them in mixed case.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsMixedCaseIdentifiers() throws SQLException;
/**
* Retrieves whether this database treats mixed case unquoted SQL identifiers as
* case insensitive and stores them in upper case.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean storesUpperCaseIdentifiers() throws SQLException;
/**
* Retrieves whether this database treats mixed case unquoted SQL identifiers as
* case insensitive and stores them in lower case.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean storesLowerCaseIdentifiers() throws SQLException;
/**
* Retrieves whether this database treats mixed case unquoted SQL identifiers as
* case insensitive and stores them in mixed case.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean storesMixedCaseIdentifiers() throws SQLException;
/**
* Retrieves whether this database treats mixed case quoted SQL identifiers as
* case sensitive and as a result stores them in mixed case.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsMixedCaseQuotedIdentifiers() throws SQLException;
/**
* Retrieves whether this database treats mixed case quoted SQL identifiers as
* case insensitive and stores them in upper case.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean storesUpperCaseQuotedIdentifiers() throws SQLException;
/**
* Retrieves whether this database treats mixed case quoted SQL identifiers as
* case insensitive and stores them in lower case.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean storesLowerCaseQuotedIdentifiers() throws SQLException;
/**
* Retrieves whether this database treats mixed case quoted SQL identifiers as
* case insensitive and stores them in mixed case.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean storesMixedCaseQuotedIdentifiers() throws SQLException;
/**
* Retrieves the string used to quote SQL identifiers.
* This method returns a space " " if identifier quoting is not supported.
*
* @return the quoting string or a space if quoting is not supported
* @exception SQLException if a database access error occurs
*/
String getIdentifierQuoteString() throws SQLException;
/**
* Retrieves a comma-separated list of all of this database's SQL keywords
* that are NOT also SQL:2003 keywords.
*
* @return the list of this database's keywords that are not also
* SQL:2003 keywords
* @exception SQLException if a database access error occurs
*/
String getSQLKeywords() throws SQLException;
/**
* Retrieves a comma-separated list of math functions available with
* this database. These are the Open /Open CLI math function names used in
* the JDBC function escape clause.
*
* @return the list of math functions supported by this database
* @exception SQLException if a database access error occurs
*/
String getNumericFunctions() throws SQLException;
/**
* Retrieves a comma-separated list of string functions available with
* this database. These are the Open Group CLI string function names used
* in the JDBC function escape clause.
*
* @return the list of string functions supported by this database
* @exception SQLException if a database access error occurs
*/
String getStringFunctions() throws SQLException;
/**
* Retrieves a comma-separated list of system functions available with
* this database. These are the Open Group CLI system function names used
* in the JDBC function escape clause.
*
* @return a list of system functions supported by this database
* @exception SQLException if a database access error occurs
*/
String getSystemFunctions() throws SQLException;
/**
* Retrieves a comma-separated list of the time and date functions available
* with this database.
*
* @return the list of time and date functions supported by this database
* @exception SQLException if a database access error occurs
*/
String getTimeDateFunctions() throws SQLException;
/**
* Retrieves the string that can be used to escape wildcard characters.
* This is the string that can be used to escape '_' or '%' in
* the catalog search parameters that are a pattern (and therefore use one
* of the wildcard characters).
*
* <P>The '_' character represents any single character;
* the '%' character represents any sequence of zero or
* more characters.
*
* @return the string used to escape wildcard characters
* @exception SQLException if a database access error occurs
*/
String getSearchStringEscape() throws SQLException;
/**
* Retrieves all the "extra" characters that can be used in unquoted
* identifier names (those beyond a-z, A-Z, 0-9 and _).
*
* @return the string containing the extra characters
* @exception SQLException if a database access error occurs
*/
String getExtraNameCharacters() throws SQLException;
//--------------------------------------------------------------------
// Functions describing which features are supported.
/**
* Retrieves whether this database supports <code>ALTER TABLE</code>
* with add column.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsAlterTableWithAddColumn() throws SQLException;
/**
* Retrieves whether this database supports <code>ALTER TABLE</code>
* with drop column.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsAlterTableWithDropColumn() throws SQLException;
/**
* Retrieves whether this database supports column aliasing.
*
* <P>If so, the SQL AS clause can be used to provide names for
* computed columns or to provide alias names for columns as
* required.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsColumnAliasing() throws SQLException;
/**
* Retrieves whether this database supports concatenations between
* <code>NULL</code> and non-<code>NULL</code> values being
* <code>NULL</code>.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean nullPlusNonNullIsNull() throws SQLException;
/**
* Retrieves whether this database supports the JDBC scalar function
* <code>CONVERT</code> for the conversion of one JDBC type to another.
* The JDBC types are the generic SQL data types defined
* in <code>java.sql.Types</code>.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsConvert() throws SQLException;
/**
* Retrieves whether this database supports the JDBC scalar function
* <code>CONVERT</code> for conversions between the JDBC types <i>fromType</i>
* and <i>toType</i>. The JDBC types are the generic SQL data types defined
* in <code>java.sql.Types</code>.
*
* @param fromType the type to convert from; one of the type codes from
* the class <code>java.sql.Types</code>
* @param toType the type to convert to; one of the type codes from
* the class <code>java.sql.Types</code>
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
* @see Types
*/
boolean supportsConvert(int fromType, int toType) throws SQLException;
/**
* Retrieves whether this database supports table correlation names.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsTableCorrelationNames() throws SQLException;
/**
* Retrieves whether, when table correlation names are supported, they
* are restricted to being different from the names of the tables.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsDifferentTableCorrelationNames() throws SQLException;
/**
* Retrieves whether this database supports expressions in
* <code>ORDER BY</code> lists.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsExpressionsInOrderBy() throws SQLException;
/**
* Retrieves whether this database supports using a column that is
* not in the <code>SELECT</code> statement in an
* <code>ORDER BY</code> clause.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsOrderByUnrelated() throws SQLException;
/**
* Retrieves whether this database supports some form of
* <code>GROUP BY</code> clause.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsGroupBy() throws SQLException;
/**
* Retrieves whether this database supports using a column that is
* not in the <code>SELECT</code> statement in a
* <code>GROUP BY</code> clause.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsGroupByUnrelated() throws SQLException;
/**
* Retrieves whether this database supports using columns not included in
* the <code>SELECT</code> statement in a <code>GROUP BY</code> clause
* provided that all of the columns in the <code>SELECT</code> statement
* are included in the <code>GROUP BY</code> clause.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsGroupByBeyondSelect() throws SQLException;
/**
* Retrieves whether this database supports specifying a
* <code>LIKE</code> escape clause.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsLikeEscapeClause() throws SQLException;
/**
* Retrieves whether this database supports getting multiple
* <code>ResultSet</code> objects from a single call to the
* method <code>execute</code>.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsMultipleResultSets() throws SQLException;
/**
* Retrieves whether this database allows having multiple
* transactions open at once (on different connections).
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsMultipleTransactions() throws SQLException;
/**
* Retrieves whether columns in this database may be defined as non-nullable.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsNonNullableColumns() throws SQLException;
/**
* Retrieves whether this database supports the ODBC Minimum SQL grammar.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsMinimumSQLGrammar() throws SQLException;
/**
* Retrieves whether this database supports the ODBC Core SQL grammar.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsCoreSQLGrammar() throws SQLException;
/**
* Retrieves whether this database supports the ODBC Extended SQL grammar.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsExtendedSQLGrammar() throws SQLException;
/**
* Retrieves whether this database supports the ANSI92 entry level SQL
* grammar.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsANSI92EntryLevelSQL() throws SQLException;
/**
* Retrieves whether this database supports the ANSI92 intermediate SQL grammar supported.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsANSI92IntermediateSQL() throws SQLException;
/**
* Retrieves whether this database supports the ANSI92 full SQL grammar supported.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsANSI92FullSQL() throws SQLException;
/**
* Retrieves whether this database supports the SQL Integrity
* Enhancement Facility.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsIntegrityEnhancementFacility() throws SQLException;
/**
* Retrieves whether this database supports some form of outer join.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsOuterJoins() throws SQLException;
/**
* Retrieves whether this database supports full nested outer joins.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsFullOuterJoins() throws SQLException;
/**
* Retrieves whether this database provides limited support for outer
* joins. (This will be <code>true</code> if the method
* <code>supportsFullOuterJoins</code> returns <code>true</code>).
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsLimitedOuterJoins() throws SQLException;
/**
* Retrieves the database vendor's preferred term for "schema".
*
* @return the vendor term for "schema"
* @exception SQLException if a database access error occurs
*/
String getSchemaTerm() throws SQLException;
/**
* Retrieves the database vendor's preferred term for "procedure".
*
* @return the vendor term for "procedure"
* @exception SQLException if a database access error occurs
*/
String getProcedureTerm() throws SQLException;
/**
* Retrieves the database vendor's preferred term for "catalog".
*
* @return the vendor term for "catalog"
* @exception SQLException if a database access error occurs
*/
String getCatalogTerm() throws SQLException;
/**
* Retrieves whether a catalog appears at the start of a fully qualified
* table name. If not, the catalog appears at the end.
*
* @return <code>true</code> if the catalog name appears at the beginning
* of a fully qualified table name; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean isCatalogAtStart() throws SQLException;
/**
* Retrieves the <code>String</code> that this database uses as the
* separator between a catalog and table name.
*
* @return the separator string
* @exception SQLException if a database access error occurs
*/
String getCatalogSeparator() throws SQLException;
/**
* Retrieves whether a schema name can be used in a data manipulation statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSchemasInDataManipulation() throws SQLException;
/**
* Retrieves whether a schema name can be used in a procedure call statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSchemasInProcedureCalls() throws SQLException;
/**
* Retrieves whether a schema name can be used in a table definition statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSchemasInTableDefinitions() throws SQLException;
/**
* Retrieves whether a schema name can be used in an index definition statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSchemasInIndexDefinitions() throws SQLException;
/**
* Retrieves whether a schema name can be used in a privilege definition statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSchemasInPrivilegeDefinitions() throws SQLException;
/**
* Retrieves whether a catalog name can be used in a data manipulation statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsCatalogsInDataManipulation() throws SQLException;
/**
* Retrieves whether a catalog name can be used in a procedure call statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsCatalogsInProcedureCalls() throws SQLException;
/**
* Retrieves whether a catalog name can be used in a table definition statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsCatalogsInTableDefinitions() throws SQLException;
/**
* Retrieves whether a catalog name can be used in an index definition statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsCatalogsInIndexDefinitions() throws SQLException;
/**
* Retrieves whether a catalog name can be used in a privilege definition statement.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsCatalogsInPrivilegeDefinitions() throws SQLException;
/**
* Retrieves whether this database supports positioned <code>DELETE</code>
* statements.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsPositionedDelete() throws SQLException;
/**
* Retrieves whether this database supports positioned <code>UPDATE</code>
* statements.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsPositionedUpdate() throws SQLException;
/**
* Retrieves whether this database supports <code>SELECT FOR UPDATE</code>
* statements.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSelectForUpdate() throws SQLException;
/**
* Retrieves whether this database supports stored procedure calls
* that use the stored procedure escape syntax.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsStoredProcedures() throws SQLException;
/**
* Retrieves whether this database supports subqueries in comparison
* expressions.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSubqueriesInComparisons() throws SQLException;
/**
* Retrieves whether this database supports subqueries in
* <code>EXISTS</code> expressions.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSubqueriesInExists() throws SQLException;
/**
* Retrieves whether this database supports subqueries in
* <code>IN</code> expressions.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSubqueriesInIns() throws SQLException;
/**
* Retrieves whether this database supports subqueries in quantified
* expressions.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsSubqueriesInQuantifieds() throws SQLException;
/**
* Retrieves whether this database supports correlated subqueries.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsCorrelatedSubqueries() throws SQLException;
/**
* Retrieves whether this database supports SQL <code>UNION</code>.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsUnion() throws SQLException;
/**
* Retrieves whether this database supports SQL <code>UNION ALL</code>.
*
* @return <code>true</code> if so; <code>false</code> otherwise
* @exception SQLException if a database access error occurs
*/
boolean supportsUnionAll() throws SQLException;
/**
* Retrieves whether this database supports keeping cursors open
* across commits.
*
* @return <code>true</code> if cursors always remain open;
* <code>false</code> if they might not remain open
* @exception SQLException if a database access error occurs
*/
boolean supportsOpenCursorsAcrossCommit() throws SQLException;
/**
* Retrieves whether this database supports keeping cursors open
* across rollbacks.
*
* @return <code>true</code> if cursors always remain open;
* <code>false</code> if they might not remain open
* @exception SQLException if a database access error occurs
*/
boolean supportsOpenCursorsAcrossRollback() throws SQLException;
/**
* Retrieves whether this database supports keeping statements open
* across commits.
*
* @return <code>true</code> if statements always remain open;
* <code>false</code> if they might not remain open
* @exception SQLException if a database access error occurs
*/
boolean supportsOpenStatementsAcrossCommit() throws SQLException;
/**
* Retrieves whether this database supports keeping statements open
* across rollbacks.
*
* @return <code>true</code> if statements always remain open;
* <code>false</code> if they might not remain open
* @exception SQLException if a database access error occurs
*/
boolean supportsOpenStatementsAcrossRollback() throws SQLException;
//----------------------------------------------------------------------
// The following group of methods exposes various limitations
// based on the target database with the current driver.
// Unless otherwise specified, a result of zero means there is no
// limit, or the limit is not known.
/**
* Retrieves the maximum number of hex characters this database allows in an
* inline binary literal.
*
* @return max the maximum length (in hex characters) for a binary literal;
* a result of zero means that there is no limit or the limit
* is not known
* @exception SQLException if a database access error occurs
*/
int getMaxBinaryLiteralLength() throws SQLException;
/**
* Retrieves the maximum number of characters this database allows
* for a character literal.
*
* @return the maximum number of characters allowed for a character literal;
* a result of zero means that there is no limit or the limit is
* not known
* @exception SQLException if a database access error occurs
*/
int getMaxCharLiteralLength() throws SQLException;
/**
* Retrieves the maximum number of characters this database allows
* for a column name.
*
* @return the maximum number of characters allowed for a column name;
* a result of zero means that there is no limit or the limit
* is not known
* @exception SQLException if a database access error occurs
*/
int getMaxColumnNameLength() throws SQLException;
/**
* Retrieves the maximum number of columns this database allows in a
* <code>GROUP BY</code> clause.
*
* @return the maximum number of columns allowed;
* a result of zero means that there is no limit or the limit
* is not known
* @exception SQLException if a database access error occurs
*/
int getMaxColumnsInGroupBy() throws SQLException;
/**
* Retrieves the maximum number of columns this database allows in an index.
*
* @return the maximum number of columns allowed;
* a result of zero means that there is no limit or the limit
* is not known
* @exception SQLException if a database access error occurs
*/
int getMaxColumnsInIndex() throws SQLException;
/**
* Retrieves the maximum number of columns this database allows in an
* <code>ORDER BY</code> clause.
*
* @return the maximum number of columns allowed;
* a result of zero means that there is no limit or the limit
* is not known
* @exception SQLException if a database access error occurs
*/
int getMaxColumnsInOrderBy() throws SQLException;
/**
* Retrieves the maximum number of columns this database allows in a
* <code>SELECT</code> list.
*
* @return the maximum number of columns allowed;
* a result of zero means that there is no limit or the limit
* is not known
* @exception SQLException if a database access error occurs
*/
int getMaxColumnsInSelect() throws SQLException;
/**
* Retrieves the maximum number of columns this database allows in a table.
*
* @return the maximum number of columns allowed;
* a result of zero means that there is no limit or the limit
* is not known
* @exception SQLException if a database access error occurs
*/
int getMaxColumnsInTable() throws SQLException;
/**
* Retrieves the maximum number of concurrent connections to this
* database that are possible.
*
* @return the maximum number of active connections possible at one time;
* a result of zero means that there is no limit or the limit
* is not known