1 @deftypemethod Array {public String} getBaseTypeName () @*throws SQLException
2 This method returns the name of the SQL type of the elements in this
3 array. This name is database specific.
5 @deftypemethod Array {public int} getBaseType () @*throws SQLException
6 This method returns the JDBC type identifier of the elements in this
7 array. This will be one of the values defined in the @code{Types}
10 @deftypemethod Array {public Object} getArray () @*throws SQLException
11 This method returns the contents of this array. This object returned
12 will be an array of Java objects of the appropriate types.
14 @deftypemethod Array {public Object} getArray (java.util.Map@w{ }@var{map}) @*throws SQLException
15 This method returns the contents of this array. The specified
16 @code{Map} will be used to override selected mappings between
17 SQL types and Java classes.
19 @deftypemethod Array {public Object} getArray (long@w{ }@var{offset}, int@w{ }@var{count}) @*throws SQLException
20 This method returns a portion of this array starting at index
21 @code{offset} into the array and continuing for @code{length}
22 elements. Fewer than the requested number of elements will be
23 returned if the array does not contain the requested number of elements.
24 The object returned will be an array of Java objects of
25 the appropriate types.
27 @deftypemethod Array {public Object} getArray (long@w{ }@var{index}, int@w{ }@var{count}, java.util.Map@w{ }@var{map}) @*throws SQLException
28 This method returns a portion of this array starting at index
29 @code{offset} into the array and continuing for @code{length}
30 elements. Fewer than the requested number of elements will be
31 returned if the array does not contain the requested number of elements.
32 The object returned will be an array of Java objects. The specified
33 @code{Map} will be used for overriding selected SQL type to
36 @deftypemethod Array {public ResultSet} getResultSet () @*throws SQLException
37 This method returns the elements in the array as a @code{ResultSet}.
38 Each row of the result set will have two columns. The first will be
39 the index into the array of that row's contents. The second will be
40 the actual value of that array element.
42 @deftypemethod Array {public ResultSet} getResultSet (java.util.Map@w{ }@var{map}) @*throws SQLException
43 This method returns the elements in the array as a @code{ResultSet}.
44 Each row of the result set will have two columns. The first will be
45 the index into the array of that row's contents. The second will be
46 the actual value of that array element. The specified @code{Map}
47 will be used to override selected default mappings of SQL types to
50 @deftypemethod Array {public ResultSet} getResultSet (long@w{ }@var{index}, int@w{ }@var{count}) @*throws SQLException
51 This method returns a portion of the array as a @code{ResultSet}.
52 The returned portion will start at index @code{offset} into the
53 array and up to @code{length} elements will be returned.
57 Each row of the result set will have two columns. The first will be
58 the index into the array of that row's contents. The second will be
59 the actual value of that array element.
61 @deftypemethod Array {public ResultSet} getResultSet (long@w{ }@var{index}, int@w{ }@var{count}, java.util.Map@w{ }@var{map}) @*throws SQLException
62 This method returns a portion of the array as a @code{ResultSet}.
63 The returned portion will start at index @code{offset} into the
64 array and up to @code{length} elements will be returned.
68 Each row of the result set will have two columns. The first will be
69 the index into the array of that row's contents. The second will be
70 the actual value of that array element. The specified @code{Map}
71 will be used to override selected default mappings of SQL types to
74 @deftypemethod BatchUpdateException {public int} getUpdateCounts ()
75 This method returns the update count information for this error. If
76 not @code{null} this is an array of @code{int}'s that are
77 the update accounts for each command that was successfully executed.
78 The array elements are in the order that the commands were executed.
80 @deftypemethod Blob {public long} length () @*throws SQLException
81 This method returns the number of bytes in the BLOB.
83 @deftypemethod Blob {public byte} getBytes (long@w{ }@var{offset}, int@w{ }@var{length}) @*throws SQLException
84 This method returns up to the requested bytes of this BLOB as a
87 @deftypemethod Blob {public InputStream} getBinaryStream () @*throws SQLException
88 This method returns a stream that will read the bytes of the BLOB.
90 @deftypemethod Blob {public long} position (byte[]@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException
91 This method returns the index into the BLOB at which the first instance
92 of the specified bytes occur. The searching starts at the specified
95 @deftypemethod Blob {public long} position (java.sql.Blob@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException
96 This method returns the index into the BLOB at which the first instance
97 of the specified pattern occurs. The searching starts at the specified
98 index into this BLOB. The bytes in the specified @code{Blob} are
99 used as the search pattern.
101 @deftypemethod CallableStatement {public boolean} wasNull () @*throws SQLException
102 This method tests whether the value of the last parameter that was fetched
103 was actually a SQL NULL value.
105 @deftypemethod CallableStatement {public String} getString (int@w{ }@var{index}) @*throws SQLException
106 This method returns the value of the specified parameter as a Java
109 @deftypemethod CallableStatement {public Object} getObject (int@w{ }@var{index}) @*throws SQLException
110 This method returns the value of the specified parameter as a Java
113 @deftypemethod CallableStatement {public Object} getObject (int@w{ }@var{index}, java.util.Map@w{ }@var{map}) @*throws SQLException
114 This method returns the value of the specified parameter as a Java
117 @deftypemethod CallableStatement {public boolean} getBoolean (int@w{ }@var{index}) @*throws SQLException
118 This method returns the value of the specified parameter as a Java
121 @deftypemethod CallableStatement {public byte} getByte (int@w{ }@var{index}) @*throws SQLException
122 This method returns the value of the specified parameter as a Java
125 @deftypemethod CallableStatement {public short} getShort (int@w{ }@var{index}) @*throws SQLException
126 This method returns the value of the specified parameter as a Java
129 @deftypemethod CallableStatement {public int} getInt (int@w{ }@var{index}) @*throws SQLException
130 This method returns the value of the specified parameter as a Java
133 @deftypemethod CallableStatement {public long} getLong (int@w{ }@var{index}) @*throws SQLException
134 This method returns the value of the specified parameter as a Java
137 @deftypemethod CallableStatement {public float} getFloat (int@w{ }@var{index}) @*throws SQLException
138 This method returns the value of the specified parameter as a Java
141 @deftypemethod CallableStatement {public double} getDouble (int@w{ }@var{index}) @*throws SQLException
142 This method returns the value of the specified parameter as a Java
145 @deftypemethod CallableStatement {public BigDecimal} getBigDecimal (int@w{ }@var{index}) @*throws SQLException
146 This method returns the value of the specified parameter as a Java
149 @deftypemethod CallableStatement {public BigDecimal} getBigDecimal (int@w{ }@var{index}, int@w{ }@var{scale}) @*throws SQLException
150 This method returns the value of the specified parameter as a Java
153 @deftypemethod CallableStatement {public byte} getBytes (int@w{ }@var{index}) @*throws SQLException
154 This method returns the value of the specified parameter as a Java
157 @deftypemethod CallableStatement {public Date} getDate (int@w{ }@var{index}) @*throws SQLException
158 This method returns the value of the specified parameter as a Java
159 @code{java.sql.Date}.
161 @deftypemethod CallableStatement {public Date} getDate (int@w{ }@var{index}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
162 This method returns the value of the specified parameter as a Java
163 @code{java.sql.Date}.
165 @deftypemethod CallableStatement {public Time} getTime (int@w{ }@var{index}) @*throws SQLException
166 This method returns the value of the specified parameter as a Java
167 @code{java.sql.Time}.
169 @deftypemethod CallableStatement {public Time} getTime (int@w{ }@var{index}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
170 This method returns the value of the specified parameter as a Java
171 @code{java.sql.Time}.
173 @deftypemethod CallableStatement {public Timestamp} getTimestamp (int@w{ }@var{index}) @*throws SQLException
174 This method returns the value of the specified parameter as a Java
175 @code{java.sql.Timestamp}.
177 @deftypemethod CallableStatement {public Timestamp} getTimestamp (int@w{ }@var{index}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
178 This method returns the value of the specified parameter as a Java
179 @code{java.sql.Timestamp}.
181 @deftypemethod CallableStatement {public Ref} getRef (int@w{ }@var{index}) @*throws SQLException
182 This method returns the value of the specified parameter as a Java
185 @deftypemethod CallableStatement {public Blob} getBlob (int@w{ }@var{index}) @*throws SQLException
186 This method returns the value of the specified parameter as a Java
189 @deftypemethod CallableStatement {public Clob} getClob (int@w{ }@var{index}) @*throws SQLException
190 This method returns the value of the specified parameter as a Java
193 @deftypemethod CallableStatement {public Array} getArray (int@w{ }@var{index}) @*throws SQLException
194 This method returns the value of the specified parameter as a Java
197 @deftypemethod CallableStatement {public void} registerOutParameter (int@w{ }@var{index}, int@w{ }@var{type}) @*throws SQLException
198 This method registers the specified parameter as an output parameter
199 of the specified SQL type.
201 @deftypemethod CallableStatement {public void} registerOutParameter (int@w{ }@var{index}, int@w{ }@var{type}, java.lang.String@w{ }@var{name}) @*throws SQLException
202 This method registers the specified parameter as an output parameter
203 of the specified SQL type.
205 @deftypemethod CallableStatement {public void} registerOutParameter (int@w{ }@var{index}, int@w{ }@var{type}, int@w{ }@var{scale}) @*throws SQLException
206 This method registers the specified parameter as an output parameter
207 of the specified SQL type and scale.
209 @deftypemethod Clob {public long} length () @*throws SQLException
210 This method returns the number of characters in the CLOB.
212 @deftypemethod Clob {public String} getSubString (long@w{ }@var{offset}, int@w{ }@var{length}) @*throws SQLException
213 This method returns the specified portion of the CLOB as a
216 @deftypemethod Clob {public InputStream} getAsciiStream () @*throws SQLException
217 This method returns a byte stream that reads the contents of the
218 CLOB as a series of ASCII bytes.
220 @deftypemethod Clob {public Reader} getCharacterStream () @*throws SQLException
221 This method returns a character stream that reads the contents of the
224 @deftypemethod Clob {public long} position (java.lang.String@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException
225 This method returns the index into the CLOB of the first occurrence of
226 the specified character pattern (supplied by the caller as a
227 @code{String}). The search begins at the specified index.
229 @deftypemethod Clob {public long} position (java.sql.Clob@w{ }@var{pattern}, long@w{ }@var{offset}) @*throws SQLException
230 This method returns the index into the CLOB of the first occurrence of
231 the specified character pattern (supplied by the caller as a
232 @code{Clob}). The search begins at the specified index.
234 @deftypemethod Connection {public Statement} createStatement () @*throws SQLException
235 This method creates a new SQL statement. The default result set type
236 and concurrency will be used.
238 @deftypemethod Connection {public Statement} createStatement (int@w{ }@var{resultSetType}, int@w{ }@var{resultSetConcurrency}) @*throws SQLException
239 This method creates a new SQL statement with the specified type and
240 concurrency. Valid values for these parameters are specified in the
241 @code{ResultSet} class.
243 @deftypemethod Connection {public PreparedStatement} prepareStatement (java.lang.String@w{ }@var{sql}) @*throws SQLException
244 This method creates a new @code{PreparedStatement} for the specified
245 SQL string. This method is designed for use with parameterized
246 statements. The default result set type and concurrency will be used.
248 @deftypemethod Connection {public PreparedStatement} prepareStatement (java.lang.String@w{ }@var{sql}, int@w{ }@var{resultSetType}, int@w{ }@var{resultSetConcurrency}) @*throws SQLException
249 This method creates a new @code{PreparedStatement} for the specified
250 SQL string. This method is designed for use with parameterized
251 statements. The specified result set type and concurrency will be used.
252 Valid values for these parameters are specified in the
253 @code{ResultSet} class.
255 @deftypemethod Connection {public CallableStatement} prepareCall (java.lang.String@w{ }@var{sql}) @*throws SQLException
256 This method creates a new @code{CallableStatement} for the
257 specified SQL string. Thie method is designed to be used with
258 stored procedures. The default result set type and concurrency
261 @deftypemethod Connection {public CallableStatement} prepareCall (java.lang.String@w{ }@var{sql}, int@w{ }@var{resultSetType}, int@w{ }@var{resultSetConcurrency}) @*throws SQLException
262 This method creates a new @code{CallableStatement} for the
263 specified SQL string. Thie method is designed to be used with
264 stored procedures. The specified result set type and concurrency
265 will be used. Valid values for these parameters are specified in the
266 @code{ResultSet} class.
268 @deftypemethod Connection {public String} nativeSQL (java.lang.String@w{ }@var{sql}) @*throws SQLException
269 This method converts the specified generic SQL statement into the
270 native grammer of the database this object is connected to.
272 @deftypemethod Connection {public boolean} getAutoCommit () @*throws SQLException
273 This method tests whether or not auto commit mode is currently enabled.
274 In auto commit mode, every SQL statement is committed its own transaction.
275 Otherwise a transaction must be explicitly committed or rolled back.
277 @deftypemethod Connection {public void} setAutoCommit (boolean@w{ }@var{autoCommit}) @*throws SQLException
278 This method turns auto commit mode on or off. In auto commit mode,
279 every SQL statement is committed its own transaction. Otherwise a
280 transaction must be explicitly committed or rolled back.
282 @deftypemethod Connection {public void} commit () @*throws SQLException
283 This method commits any SQL statements executed on this connection since
284 the last commit or rollback.
286 @deftypemethod Connection {public void} rollback () @*throws SQLException
287 This method rolls back any SQL statements executed on this connection
288 since the last commit or rollback.
290 @deftypemethod Connection {public void} close () @*throws SQLException
291 This method immediately closes this database connection.
293 @deftypemethod Connection {public boolean} isClosed () @*throws SQLException
294 This method tests whether or not this connection has been closed.
296 @deftypemethod Connection {public DatabaseMetaData} getMetaData () @*throws SQLException
297 This method returns the meta data for this database connection.
299 @deftypemethod Connection {public boolean} isReadOnly () @*throws SQLException
300 This method tests whether or not this connection is in read only mode.
302 @deftypemethod Connection {public void} setReadOnly (boolean@w{ }@var{readOnly}) @*throws SQLException
303 This method turns read only mode on or off. It may not be called while
304 a transaction is in progress.
306 @deftypemethod Connection {public String} getCatalog () @*throws SQLException
307 This method returns the name of the catalog in use by this connection,
310 @deftypemethod Connection {public void} setCatalog (java.lang.String@w{ }@var{catalog}) @*throws SQLException
311 This method sets the name of the catalog in use by this connection.
312 Note that this method does nothing if catalogs are not supported by
315 @deftypemethod Connection {public int} getTransactionIsolation () @*throws SQLException
316 This method returns the current transaction isolation mode. This will
317 be one of the constants defined in this interface.
319 @deftypemethod Connection {public void} setTransactionIsolation (int@w{ }@var{level}) @*throws SQLException
320 This method sets the current transaction isolation mode. This must
321 be one of the constants defined in this interface.
323 @deftypemethod Connection {public SQLWarning} getWarnings () @*throws SQLException
324 This method returns the first warning that occurred on this connection,
325 if any. If there were any subsequence warnings, they will be chained
328 @deftypemethod Connection {public void} clearWarnings () @*throws SQLException
329 This method clears all warnings that have occurred on this connection.
331 @deftypemethod Connection {public Map} getTypeMap () @*throws SQLException
332 This method returns the mapping of SQL types to Java classes
333 currently in use by this connection. This mapping will have no
334 entries unless they have been manually added.
336 @deftypemethod Connection {public void} setTypeMap (java.util.Map@w{ }@var{map}) @*throws SQLException
337 This method sets the mapping table for SQL types to Java classes.
338 Any entries in this map override the defaults.
340 @deftypemethod DatabaseMetaData {public boolean} allProceduresAreCallable () @*throws SQLException
341 This method tests whether or not all the procedures returned by
342 the @code{getProcedures} method can be called by this user.
344 @deftypemethod DatabaseMetaData {public boolean} allTablesAreSelectable () @*throws SQLException
345 This method tests whether or not all the table returned by the
346 @code{getTables} method can be selected by this user.
348 @deftypemethod DatabaseMetaData {public String} getURL () @*throws SQLException
349 This method returns the URL for this database.
351 @deftypemethod DatabaseMetaData {public String} getUserName () @*throws SQLException
352 This method returns the database username for this connection.
354 @deftypemethod DatabaseMetaData {public boolean} isReadOnly () @*throws SQLException
355 This method tests whether or not the database is in read only mode.
357 @deftypemethod DatabaseMetaData {public boolean} nullsAreSortedHigh () @*throws SQLException
358 This method tests whether or not NULL's sort as high values.
360 @deftypemethod DatabaseMetaData {public boolean} nullsAreSortedLow () @*throws SQLException
361 This method tests whether or not NULL's sort as low values.
363 @deftypemethod DatabaseMetaData {public boolean} nullsAreSortedAtStart () @*throws SQLException
364 This method test whether or not NULL's are sorted to the beginning
365 of the list regardless of ascending or descending sort order.
367 @deftypemethod DatabaseMetaData {public boolean} nullsAreSortedAtEnd () @*throws SQLException
368 This method test whether or not NULL's are sorted to the end
369 of the list regardless of ascending or descending sort order.
371 @deftypemethod DatabaseMetaData {public String} getDatabaseProductName () @*throws SQLException
372 This method returns the name of the database product.
374 @deftypemethod DatabaseMetaData {public String} getDatabaseProductVersion () @*throws SQLException
375 This method returns the version of the database product.
377 @deftypemethod DatabaseMetaData {public String} getDriverName () @*throws SQLException
378 This method returns the name of the JDBC driver.
380 @deftypemethod DatabaseMetaData {public String} getDriverVersion () @*throws SQLException
381 This method returns the version of the JDBC driver.
383 @deftypemethod DatabaseMetaData {public int} getDriverMajorVersion ()
384 This method returns the major version number of the JDBC driver.
386 @deftypemethod DatabaseMetaData {public int} getDriverMinorVersion ()
387 This method returns the minor version number of the JDBC driver.
389 @deftypemethod DatabaseMetaData {public boolean} usesLocalFiles () @*throws SQLException
390 This method tests whether or not the database uses local files to
393 @deftypemethod DatabaseMetaData {public boolean} usesLocalFilePerTable () @*throws SQLException
394 This method tests whether or not the database uses a separate file for
397 @deftypemethod DatabaseMetaData {public boolean} supportsMixedCaseIdentifiers () @*throws SQLException
398 This method tests whether or not the database supports identifiers
401 @deftypemethod DatabaseMetaData {public boolean} storesUpperCaseIdentifiers () @*throws SQLException
402 This method tests whether or not the database treats mixed case
403 identifiers as all upper case.
405 @deftypemethod DatabaseMetaData {public boolean} storesLowerCaseIdentifiers () @*throws SQLException
406 This method tests whether or not the database treats mixed case
407 identifiers as all lower case.
409 @deftypemethod DatabaseMetaData {public boolean} storesMixedCaseIdentifiers () @*throws SQLException
410 This method tests whether or not the database stores mixed case
411 identifers even if it treats them as case insensitive.
413 @deftypemethod DatabaseMetaData {public boolean} supportsMixedCaseQuotedIdentifiers () @*throws SQLException
414 This method tests whether or not the database supports quoted identifiers
417 @deftypemethod DatabaseMetaData {public boolean} storesUpperCaseQuotedIdentifiers () @*throws SQLException
418 This method tests whether or not the database treats mixed case
419 quoted identifiers as all upper case.
421 @deftypemethod DatabaseMetaData {public boolean} storesLowerCaseQuotedIdentifiers () @*throws SQLException
422 This method tests whether or not the database treats mixed case
423 quoted identifiers as all lower case.
425 @deftypemethod DatabaseMetaData {public boolean} storesMixedCaseQuotedIdentifiers () @*throws SQLException
426 This method tests whether or not the database stores mixed case
427 quoted identifers even if it treats them as case insensitive.
429 @deftypemethod DatabaseMetaData {public String} getIdentifierQuoteString () @*throws SQLException
430 This metohd returns the quote string for SQL identifiers.
432 @deftypemethod DatabaseMetaData {public String} getSQLKeywords () @*throws SQLException
433 This method returns a comma separated list of all the SQL keywords in
434 the database that are not in SQL92.
436 @deftypemethod DatabaseMetaData {public String} getNumericFunctions () @*throws SQLException
437 This method returns a comma separated list of math functions.
439 @deftypemethod DatabaseMetaData {public String} getStringFunctions () @*throws SQLException
440 This method returns a comma separated list of string functions.
442 @deftypemethod DatabaseMetaData {public String} getSystemFunctions () @*throws SQLException
443 This method returns a comma separated list of of system functions.
445 @deftypemethod DatabaseMetaData {public String} getTimeDateFunctions () @*throws SQLException
446 This method returns comma separated list of time/date functions.
448 @deftypemethod DatabaseMetaData {public String} getSearchStringEscape () @*throws SQLException
449 This method returns the string used to escape wildcards in search strings.
451 @deftypemethod DatabaseMetaData {public String} getExtraNameCharacters () @*throws SQLException
452 This methods returns non-standard characters that can appear in
453 unquoted identifiers.
455 @deftypemethod DatabaseMetaData {public boolean} supportsAlterTableWithAddColumn () @*throws SQLException
456 This method tests whether or not the database supports
457 "ALTER TABLE ADD COLUMN"
459 @deftypemethod DatabaseMetaData {public boolean} supportsAlterTableWithDropColumn () @*throws SQLException
460 This method tests whether or not the database supports
461 "ALTER TABLE DROP COLUMN"
463 @deftypemethod DatabaseMetaData {public boolean} supportsColumnAliasing () @*throws SQLException
464 This method tests whether or not column aliasing is supported.
466 @deftypemethod DatabaseMetaData {public boolean} nullPlusNonNullIsNull () @*throws SQLException
467 This method tests whether the concatenation of a NULL and non-NULL
468 value results in a NULL. This will always be true in fully JDBC compliant
471 @deftypemethod DatabaseMetaData {public boolean} supportsConvert () @*throws SQLException
472 Tests whether or not CONVERT is supported.
474 @deftypemethod DatabaseMetaData {public boolean} supportsConvert (int@w{ }@var{fromType}, int@w{ }@var{toType}) @*throws SQLException
475 This method tests whether or not CONVERT can be performed between the
476 specified types. The types are contants from @code{Types}.
478 @deftypemethod DatabaseMetaData {public boolean} supportsTableCorrelationNames () @*throws SQLException
479 This method tests whether or not table correlation names are
480 supported. This will be always be @code{true} in a fully JDBC
483 @deftypemethod DatabaseMetaData {public boolean} supportsDifferentTableCorrelationNames () @*throws SQLException
484 This method tests whether correlation names must be different from the
487 @deftypemethod DatabaseMetaData {public boolean} supportsExpressionsInOrderBy () @*throws SQLException
488 This method tests whether or not expressions are allowed in an
491 @deftypemethod DatabaseMetaData {public boolean} supportsOrderByUnrelated () @*throws SQLException
492 This method tests whether or ORDER BY on a non-selected column is
495 @deftypemethod DatabaseMetaData {public boolean} supportsGroupBy () @*throws SQLException
496 This method tests whether or not GROUP BY is supported.
498 @deftypemethod DatabaseMetaData {public boolean} supportsGroupByUnrelated () @*throws SQLException
499 This method tests whether GROUP BY on a non-selected column is
502 @deftypemethod DatabaseMetaData {public boolean} supportsGroupByBeyondSelect () @*throws SQLException
503 This method tests whether or not a GROUP BY can add columns not in the
504 select if it includes all the columns in the select.
506 @deftypemethod DatabaseMetaData {public boolean} supportsLikeEscapeClause () @*throws SQLException
507 This method tests whether or not the escape character is supported in
508 LIKE expressions. A fully JDBC compliant driver will always return
511 @deftypemethod DatabaseMetaData {public boolean} supportsMultipleResultSets () @*throws SQLException
512 This method tests whether multiple result sets for a single statement are
515 @deftypemethod DatabaseMetaData {public boolean} supportsMultipleTransactions () @*throws SQLException
516 This method test whether or not multiple transactions may be open
517 at once, as long as they are on different connections.
519 @deftypemethod DatabaseMetaData {public boolean} supportsNonNullableColumns () @*throws SQLException
520 This method tests whether or not columns can be defined as NOT NULL. A
521 fully JDBC compliant driver always returns @code{true}.
523 @deftypemethod DatabaseMetaData {public boolean} supportsMinimumSQLGrammar () @*throws SQLException
524 This method tests whether or not the minimum grammer for ODBC is supported.
525 A fully JDBC compliant driver will always return @code{true}.
527 @deftypemethod DatabaseMetaData {public boolean} supportsCoreSQLGrammar () @*throws SQLException
528 This method tests whether or not the core grammer for ODBC is supported.
530 @deftypemethod DatabaseMetaData {public boolean} supportsExtendedSQLGrammar () @*throws SQLException
531 This method tests whether or not the extended grammer for ODBC is supported.
533 @deftypemethod DatabaseMetaData {public boolean} supportsANSI92EntryLevelSQL () @*throws SQLException
534 This method tests whether or not the ANSI92 entry level SQL
535 grammar is supported. A fully JDBC compliant drivers must return
538 @deftypemethod DatabaseMetaData {public boolean} supportsANSI92IntermediateSQL () @*throws SQLException
539 This method tests whether or not the ANSI92 intermediate SQL
540 grammar is supported.
542 @deftypemethod DatabaseMetaData {public boolean} supportsANSI92FullSQL () @*throws SQLException
543 This method tests whether or not the ANSI92 full SQL
544 grammar is supported.
546 @deftypemethod DatabaseMetaData {public boolean} supportsIntegrityEnhancementFacility () @*throws SQLException
547 This method tests whether or not the SQL integrity enhancement
548 facility is supported.
550 @deftypemethod DatabaseMetaData {public boolean} supportsOuterJoins () @*throws SQLException
551 This method tests whether or not the database supports outer joins.
553 @deftypemethod DatabaseMetaData {public boolean} supportsFullOuterJoins () @*throws SQLException
554 This method tests whether or not the database supports full outer joins.
556 @deftypemethod DatabaseMetaData {public boolean} supportsLimitedOuterJoins () @*throws SQLException
557 This method tests whether or not the database supports limited outer joins.
559 @deftypemethod DatabaseMetaData {public String} getSchemaTerm () @*throws SQLException
560 This method returns the vendor's term for "schema".
562 @deftypemethod DatabaseMetaData {public String} getProcedureTerm () @*throws SQLException
563 This method returns the vendor's term for "procedure".
565 @deftypemethod DatabaseMetaData {public String} getCatalogTerm () @*throws SQLException
566 This method returns the vendor's term for "catalog".
568 @deftypemethod DatabaseMetaData {public boolean} isCatalogAtStart () @*throws SQLException
569 This method tests whether a catalog name appears at the beginning of
570 a fully qualified table name.
572 @deftypemethod DatabaseMetaData {public String} getCatalogSeparator () @*throws SQLException
573 This method returns the separator between the catalog name and the
576 @deftypemethod DatabaseMetaData {public boolean} supportsSchemasInDataManipulation () @*throws SQLException
577 This method tests whether a catalog name can appear in a data
578 manipulation statement.
580 @deftypemethod DatabaseMetaData {public boolean} supportsSchemasInProcedureCalls () @*throws SQLException
581 This method tests whether a catalog name can appear in a procedure
584 @deftypemethod DatabaseMetaData {public boolean} supportsSchemasInTableDefinitions () @*throws SQLException
585 This method tests whether a catalog name can appear in a table definition.
587 @deftypemethod DatabaseMetaData {public boolean} supportsSchemasInIndexDefinitions () @*throws SQLException
588 This method tests whether a catalog name can appear in an index definition.
590 @deftypemethod DatabaseMetaData {public boolean} supportsSchemasInPrivilegeDefinitions () @*throws SQLException
591 This method tests whether a catalog name can appear in privilege definitions.
593 @deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInDataManipulation () @*throws SQLException
594 This method tests whether a catalog name can appear in a data
595 manipulation statement.
597 @deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInProcedureCalls () @*throws SQLException
598 This method tests whether a catalog name can appear in a procedure
601 @deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInTableDefinitions () @*throws SQLException
602 This method tests whether a catalog name can appear in a table definition.
604 @deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInIndexDefinitions () @*throws SQLException
605 This method tests whether a catalog name can appear in an index definition.
607 @deftypemethod DatabaseMetaData {public boolean} supportsCatalogsInPrivilegeDefinitions () @*throws SQLException
608 This method tests whether a catalog name can appear in privilege definitions.
610 @deftypemethod DatabaseMetaData {public boolean} supportsPositionedDelete () @*throws SQLException
611 This method tests whether or not that database supports positioned
614 @deftypemethod DatabaseMetaData {public boolean} supportsPositionedUpdate () @*throws SQLException
615 This method tests whether or not that database supports positioned
618 @deftypemethod DatabaseMetaData {public boolean} supportsSelectForUpdate () @*throws SQLException
619 This method tests whether or not SELECT FOR UPDATE is supported by the
622 @deftypemethod DatabaseMetaData {public boolean} supportsStoredProcedures () @*throws SQLException
623 This method tests whether or not stored procedures are supported on
626 @deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInComparisons () @*throws SQLException
627 This method tests whether or not subqueries are allowed in comparisons.
628 A fully JDBC compliant driver will always return @code{true}.
630 @deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInExists () @*throws SQLException
631 This method tests whether or not subqueries are allowed in exists
632 expressions. A fully JDBC compliant driver will always return
635 @deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInIns () @*throws SQLException
636 This method tests whether subqueries are allowed in IN statements.
637 A fully JDBC compliant driver will always return @code{true}.
639 @deftypemethod DatabaseMetaData {public boolean} supportsSubqueriesInQuantifieds () @*throws SQLException
640 This method tests whether or not subqueries are allowed in quantified
641 expressions. A fully JDBC compliant driver will always return
644 @deftypemethod DatabaseMetaData {public boolean} supportsCorrelatedSubqueries () @*throws SQLException
645 This method test whether or not correlated subqueries are allowed. A
646 fully JDBC compliant driver will always return @code{true}.
648 @deftypemethod DatabaseMetaData {public boolean} supportsUnion () @*throws SQLException
649 This method tests whether or not the UNION statement is supported.
651 @deftypemethod DatabaseMetaData {public boolean} supportsUnionAll () @*throws SQLException
652 This method tests whether or not the UNION ALL statement is supported.
654 @deftypemethod DatabaseMetaData {public boolean} supportsOpenCursorsAcrossCommit () @*throws SQLException
655 This method tests whether or not the database supports cursors
656 remaining open across commits.
658 @deftypemethod DatabaseMetaData {public boolean} supportsOpenCursorsAcrossRollback () @*throws SQLException
659 This method tests whether or not the database supports cursors
660 remaining open across rollbacks.
662 @deftypemethod DatabaseMetaData {public boolean} supportsOpenStatementsAcrossCommit () @*throws SQLException
663 This method tests whether or not the database supports statements
664 remaining open across commits.
666 @deftypemethod DatabaseMetaData {public boolean} supportsOpenStatementsAcrossRollback () @*throws SQLException
667 This method tests whether or not the database supports statements
668 remaining open across rollbacks.
670 @deftypemethod DatabaseMetaData {public int} getMaxBinaryLiteralLength () @*throws SQLException
671 This method returns the number of hex characters allowed in an inline
674 @deftypemethod DatabaseMetaData {public int} getMaxCharLiteralLength () @*throws SQLException
675 This method returns the maximum length of a character literal.
677 @deftypemethod DatabaseMetaData {public int} getMaxColumnNameLength () @*throws SQLException
678 This method returns the maximum length of a column name.
680 @deftypemethod DatabaseMetaData {public int} getMaxColumnsInGroupBy () @*throws SQLException
681 This method returns the maximum number of columns in a GROUP BY statement.
683 @deftypemethod DatabaseMetaData {public int} getMaxColumnsInIndex () @*throws SQLException
684 This method returns the maximum number of columns in an index.
686 @deftypemethod DatabaseMetaData {public int} getMaxColumnsInOrderBy () @*throws SQLException
687 This method returns the maximum number of columns in an ORDER BY statement.
689 @deftypemethod DatabaseMetaData {public int} getMaxColumnsInSelect () @*throws SQLException
690 This method returns the maximum number of columns in a SELECT statement.
692 @deftypemethod DatabaseMetaData {public int} getMaxColumnsInTable () @*throws SQLException
693 This method returns the maximum number of columns in a table.
695 @deftypemethod DatabaseMetaData {public int} getMaxConnections () @*throws SQLException
696 This method returns the maximum number of connections this client
697 can have to the database.
699 @deftypemethod DatabaseMetaData {public int} getMaxCursorNameLength () @*throws SQLException
700 This method returns the maximum length of a cursor name.
702 @deftypemethod DatabaseMetaData {public int} getMaxIndexLength () @*throws SQLException
703 This method returns the maximum length of an index.
705 @deftypemethod DatabaseMetaData {public int} getMaxSchemaNameLength () @*throws SQLException
706 This method returns the maximum length of a schema name.
708 @deftypemethod DatabaseMetaData {public int} getMaxProcedureNameLength () @*throws SQLException
709 This method returns the maximum length of a procedure name.
711 @deftypemethod DatabaseMetaData {public int} getMaxCatalogNameLength () @*throws SQLException
712 This method returns the maximum length of a catalog name.
714 @deftypemethod DatabaseMetaData {public int} getMaxRowSize () @*throws SQLException
715 This method returns the maximum size of a row in bytes.
717 @deftypemethod DatabaseMetaData {public boolean} doesMaxRowSizeIncludeBlobs () @*throws SQLException
718 This method tests whether or not the maximum row size includes BLOB's
720 @deftypemethod DatabaseMetaData {public int} getMaxStatementLength () @*throws SQLException
721 This method includes the maximum length of a SQL statement.
723 @deftypemethod DatabaseMetaData {public int} getMaxStatements () @*throws SQLException
724 This method returns the maximum number of statements that can be
727 @deftypemethod DatabaseMetaData {public int} getMaxTableNameLength () @*throws SQLException
728 This method returns the maximum length of a table name.
730 @deftypemethod DatabaseMetaData {public int} getMaxTablesInSelect () @*throws SQLException
731 This method returns the maximum number of tables that may be referenced
732 in a SELECT statement.
734 @deftypemethod DatabaseMetaData {public int} getMaxUserNameLength () @*throws SQLException
735 This method returns the maximum length of a user name.
737 @deftypemethod DatabaseMetaData {public int} getDefaultTransactionIsolation () @*throws SQLException
738 This method returns the default transaction isolation level of the
741 @deftypemethod DatabaseMetaData {public boolean} supportsTransactions () @*throws SQLException
742 This method tests whether or not the database supports transactions.
744 @deftypemethod DatabaseMetaData {public boolean} supportsTransactionIsolationLevel (int@w{ }@var{level}) @*throws SQLException
745 This method tests whether or not the database supports the specified
746 transaction isolation level.
748 @deftypemethod DatabaseMetaData {public boolean} supportsDataDefinitionAndDataManipulationTransactions () @*throws SQLException
749 This method tests whether or not DDL and DML statements allowed within
750 the same transaction.
752 @deftypemethod DatabaseMetaData {public boolean} supportsDataManipulationTransactionsOnly () @*throws SQLException
753 This method tests whether or not only DML statement are allowed
754 inside a transaction.
756 @deftypemethod DatabaseMetaData {public boolean} dataDefinitionCausesTransactionCommit () @*throws SQLException
757 This method tests whether or not a DDL statement will cause the
758 current transaction to be automatically committed.
760 @deftypemethod DatabaseMetaData {public boolean} dataDefinitionIgnoredInTransactions () @*throws SQLException
761 This method tests whether or not DDL statements are ignored in
764 @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
765 This method returns a list of all the stored procedures matching the
766 specified pattern in the given schema and catalog. This is returned
767 a @code{ResultSet} with the following columns:
776 PROCEDURE_CAT - The catalog the procedure is in, which may be
780 PROCEDURE_SCHEM - The schema the procedures is in, which may be
784 PROCEDURE_NAME - The name of the procedure.
796 REMARKS - A description of the procedure
799 PROCEDURE_TYPE - Indicates the return type of the procedure, which
800 is one of the contstants defined in this class
801 (@code{procedureResultUnknown}, @code{procedureNoResult}, or
802 @code{procedureReturnsResult}).
807 @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
808 This method returns a list of the parameter and result columns for
809 the requested stored procedures. This is returned in the form of a
810 @code{ResultSet} with the following columns:
819 PROCEDURE_CAT - The catalog the procedure is in, which may be
823 PROCEDURE_SCHEM - The schema the procedures is in, which may be
827 PROCEDURE_NAME - The name of the procedure.
830 COLUMN_NAME - The name of the column
833 COLUMN_TYPE - The type of the column, which will be one of the
834 contants defined in this class (@code{procedureColumnUnknown},
835 @code{procedureColumnIn}, @code{procedureColumnInOut},
836 @code{procedureColumnOut}, @code{procedureColumnReturn},
837 or @code{procedureColumnResult}).
840 DATA_TYPE - The SQL type of the column. This is one of the constants
841 defined in @code{Types}.
844 TYPE_NAME - The string name of the data type for this column.
847 PRECISION - The precision of the column.
850 LENGTH - The length of the column in bytes
853 SCALE - The scale of the column.
856 RADIX - The radix of the column.
859 NULLABLE - Whether or not the column is NULLABLE. This is one of
860 the constants defined in this class (@code{procedureNoNulls},
861 @code{procedureNullable}, or @code{procedureNullableUnknown})
864 REMARKS - A description of the column.
869 @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
870 This method returns a list of the requested table as a
871 @code{ResultSet} with the following columns:
880 TABLE_CAT - The catalog the table is in, which may be @code{null}.
883 TABLE_SCHEM - The schema the table is in, which may be @code{null}.
886 TABLE_NAME - The name of the table.
889 TABLE_TYPE - A string describing the table type. This will be one
890 of the values returned by the @code{getTableTypes()} method.
893 REMARKS - Comments about the table.
898 @deftypemethod DatabaseMetaData {public ResultSet} getSchemas () @*throws SQLException
899 This method returns the list of database schemas as a
900 @code{ResultSet}, with one column - TABLE_SCHEM - that is the
903 @deftypemethod DatabaseMetaData {public ResultSet} getCatalogs () @*throws SQLException
904 This method returns the list of database catalogs as a
905 @code{ResultSet} with one column - TABLE_CAT - that is the
908 @deftypemethod DatabaseMetaData {public ResultSet} getTableTypes () @*throws SQLException
909 This method returns the list of database table types as a
910 @code{ResultSet} with one column - TABLE_TYPE - that is the
911 name of the table type.
913 @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
914 This method returns a list of the tables columns for
915 the requested tables. This is returned in the form of a
916 @code{ResultSet} with the following columns:
925 TABLE_CAT - The catalog the table is in, which may be
929 TABLE_SCHEM - The schema the tables is in, which may be
933 TABLE_NAME - The name of the table.
936 COLUMN_NAME - The name of the column
939 DATA_TYPE - The SQL type of the column. This is one of the constants
940 defined in @code{Types}.
943 TYPE_NAME - The string name of the data type for this column.
946 COLUMN_SIZE - The size of the column.
952 NUM_PREC_RADIX - The radix of the column.
955 NULLABLE - Whether or not the column is NULLABLE. This is one of
956 the constants defined in this class (@code{tableNoNulls},
957 @code{tableNullable}, or @code{tableNullableUnknown})
960 REMARKS - A description of the column.
963 COLUMN_DEF - The default value for the column, may be @code{null}.
966 SQL_DATA_TYPE - Unused
969 SQL_DATETIME_SUB - Unused
972 CHAR_OCTET_LENGTH - For character columns, the maximum number of bytes
976 ORDINAL_POSITION - The index of the column in the table.
979 IS_NULLABLE - "NO" means no, "YES" means maybe, and an empty string
985 @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
986 This method returns the access rights that have been granted to the
987 requested columns. This information is returned as a @code{ResultSet}
988 with the following columns:
997 TABLE_CAT - The catalog the table is in, which may be
1001 TABLE_SCHEM - The schema the tables is in, which may be
1005 TABLE_NAME - The name of the table.
1008 COLUMN_NAME - The name of the column.
1011 GRANTOR - The entity that granted the access.
1014 GRANTEE - The entity granted the access.
1017 PRIVILEGE - The name of the privilege granted.
1020 IS_GRANTABLE - "YES" if the grantee can grant the privilege to
1021 others, "NO" if not, and @code{null} if unknown.
1026 @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
1027 This method returns the access rights that have been granted to the
1028 requested tables. This information is returned as a @code{ResultSet}
1029 with the following columns:
1038 TABLE_CAT - The catalog the table is in, which may be
1042 TABLE_SCHEM - The schema the tables is in, which may be
1046 TABLE_NAME - The name of the table.
1049 GRANTOR - The entity that granted the access.
1052 GRANTEE - The entity granted the access.
1055 PRIVILEGE - The name of the privilege granted.
1058 IS_GRANTABLE - "YES" if the grantee can grant the privilege to
1059 others, "NO" if not, and @code{null} if unknown.
1064 @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
1065 This method returns the best set of columns for uniquely identifying
1066 a row. It returns this information as a @code{ResultSet} with
1067 the following columns:
1076 SCOPE - The scope of the results returned. This is one of the
1077 constants defined in this class (@code{bestRowTemporary},
1078 @code{bestRowTransaction}, or @code{bestRowSession}).
1081 COLUMN_NAME - The name of the column.
1084 DATA_TYPE - The SQL type of the column. This is one of the constants
1085 defined in @code{Types}.
1088 TYPE_NAME - The string name of the data type for this column.
1091 COLUMN_SIZE - The precision of the columns
1094 BUFFER_LENGTH - Unused
1097 DECIMAL_DIGITS - The scale of the column.
1100 PSEUDO_COLUMN - Whether or not the best row identifier is a
1101 pseudo_column. This is one of the constants defined in this class
1102 (@code{bestRowUnknown}, @code{bestRowNotPseudo}, or
1103 @code{bestRowPseudo}).
1108 @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
1109 This method returns the set of columns that are automatically updated
1110 when the row is update. It returns this information as a
1111 @code{ResultSet} with the following columns:
1123 COLUMN_NAME - The name of the column.
1126 DATA_TYPE - The SQL type of the column. This is one of the constants
1127 defined in @code{Types}.
1130 TYPE_NAME - The string name of the data type for this column.
1133 COLUMN_SIZE - The precision of the columns
1136 BUFFER_LENGTH - Unused
1139 DECIMAL_DIGITS - The scale of the column.
1142 PSEUDO_COLUMN - Whether or not the best row identifier is a
1143 pseudo_column. This is one of the constants defined in this class
1144 (@code{versionRowUnknown}, @code{versionRowNotPseudo}, or
1145 @code{versionRowPseudo}).
1150 @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
1151 This method returns a list of a table's primary key columns. These
1152 are returned as a @code{ResultSet} with the following columns.
1161 TABLE_CAT - The catalog of the table, which may be @code{null}.
1164 TABLE_SCHEM - The schema of the table, which may be @code{null}.
1167 TABLE_NAME - The name of the table.
1170 COLUMN_NAME - The name of the column.
1173 KEY_SEQ - The sequence number of the column within the primary key.
1176 PK_NAME - The name of the primary key, which may be @code{null}.
1181 @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
1182 This method returns a list of the table's foreign keys. These are
1183 returned as a @code{ResultSet} with the following columns:
1192 PKTABLE_CAT - The catalog of the table the key was imported from.
1195 PKTABLE_SCHEM - The schema of the table the key was imported from.
1198 PKTABLE_NAME - The name of the table the key was imported from.
1201 PKCOLUMN_NAME - The name of the column that was imported.
1204 FKTABLE_CAT - The foreign key catalog name.
1207 FKTABLE_SCHEM - The foreign key schema name.
1210 FKTABLE_NAME - The foreign key table name.
1213 FKCOLUMN_NAME - The foreign key column name.
1216 KEY_SEQ - The sequence number of the column within the foreign key.
1219 UPDATE_RULE - How the foreign key behaves when the primary key is
1220 updated. This is one of the constants defined in this class
1221 (@code{importedNoAction}, @code{importedKeyCascade},
1222 @code{importedKeySetNull}, @code{importedKeySetDefault}, or
1223 @code{importedKeyRestrict}).
1226 DELETE_RULE - How the foreign key behaves when the primary key is
1227 deleted. This is one of the constants defined in this class
1228 (@code{importedNoAction}, @code{importedKeyCascade},
1229 @code{importedKeySetNull}, or @code{importedKeySetDefault})
1232 FK_NAME - The name of the foreign key.
1235 PK_NAME - The name of the primary key.
1238 DEFERRABILITY - The deferrability value. This is one of the
1239 constants defined in this table (@code{importedKeyInitiallyDeferred},
1240 @code{importedKeyInitiallyImmediate}, or
1241 @code{importedKeyNotDeferrable}).
1246 @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
1247 This method returns a list of the table's which use this table's
1248 primary key as a foreign key. The information is
1249 returned as a @code{ResultSet} with the following columns:
1258 PKTABLE_CAT - The catalog of the table the key was imported from.
1261 PKTABLE_SCHEM - The schema of the table the key was imported from.
1264 PKTABLE_NAME - The name of the table the key was imported from.
1267 PKCOLUMN_NAME - The name of the column that was imported.
1270 FKTABLE_CAT - The foreign key catalog name.
1273 FKTABLE_SCHEM - The foreign key schema name.
1276 FKTABLE_NAME - The foreign key table name.
1279 FKCOLUMN_NAME - The foreign key column name.
1282 KEY_SEQ - The sequence number of the column within the foreign key.
1285 UPDATE_RULE - How the foreign key behaves when the primary key is
1286 updated. This is one of the constants defined in this class
1287 (@code{importedNoAction}, @code{importedKeyCascade},
1288 @code{importedKeySetNull}, @code{importedKeySetDefault}, or
1289 @code{importedKeyRestrict}).
1292 DELETE_RULE - How the foreign key behaves when the primary key is
1293 deleted. This is one of the constants defined in this class
1294 (@code{importedNoAction}, @code{importedKeyCascade},
1295 @code{importedKeySetNull}, or @code{importedKeySetDefault})
1298 FK_NAME - The name of the foreign key.
1301 PK_NAME - The name of the primary key.
1304 DEFERRABILITY - The deferrability value. This is one of the
1305 constants defined in this table (@code{importedKeyInitiallyDeferred},
1306 @code{importedKeyInitiallyImmediate}, or
1307 @code{importedKeyNotDeferrable}).
1312 @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
1313 This method returns a description of how one table imports another
1314 table's primary key as a foreign key. The information is
1315 returned as a @code{ResultSet} with the following columns:
1324 PKTABLE_CAT - The catalog of the table the key was imported from.
1327 PKTABLE_SCHEM - The schema of the table the key was imported from.
1330 PKTABLE_NAME - The name of the table the key was imported from.
1333 PKCOLUMN_NAME - The name of the column that was imported.
1336 FKTABLE_CAT - The foreign key catalog name.
1339 FKTABLE_SCHEM - The foreign key schema name.
1342 FKTABLE_NAME - The foreign key table name.
1345 FKCOLUMN_NAME - The foreign key column name.
1348 KEY_SEQ - The sequence number of the column within the foreign key.
1351 UPDATE_RULE - How the foreign key behaves when the primary key is
1352 updated. This is one of the constants defined in this class
1353 (@code{importedNoAction}, @code{importedKeyCascade},
1354 @code{importedKeySetNull}, @code{importedKeySetDefault}, or
1355 @code{importedKeyRestrict}).
1358 DELETE_RULE - How the foreign key behaves when the primary key is
1359 deleted. This is one of the constants defined in this class
1360 (@code{importedNoAction}, @code{importedKeyCascade},
1361 @code{importedKeySetNull}, or @code{importedKeySetDefault})
1364 FK_NAME - The name of the foreign key.
1367 PK_NAME - The name of the primary key.
1370 DEFERRABILITY - The deferrability value. This is one of the
1371 constants defined in this table (@code{importedKeyInitiallyDeferred},
1372 @code{importedKeyInitiallyImmediate}, or
1373 @code{importedKeyNotDeferrable}).
1378 @deftypemethod DatabaseMetaData {public ResultSet} getTypeInfo () @*throws SQLException
1379 This method returns a list of the SQL types supported by this
1380 database. The information is returned as a @code{ResultSet}
1381 with the following columns:
1390 TYPE_NAME - The name of the data type.
1393 DATA_TYPE - A data type constant from @code{Types} for this
1397 PRECISION - The maximum precision of this type.
1400 LITERAL_PREFIX - Prefix value used to quote a literal, which may be
1404 LITERAL_SUFFIX - Suffix value used to quote a literal, which may be
1408 CREATE_PARAMS - The parameters used to create the type, which may be
1412 NULLABLE - Whether or not this type supports NULL values. This will
1413 be one of the constants defined in this interface
1414 (@code{typeNoNulls}, @code{typeNullable}, or
1415 @code{typeNullableUnknown}).
1418 CASE_SENSITIVE - Whether or not the value is case sensitive.
1421 SEARCHABLE - Whether or not "LIKE" expressions are supported in
1422 WHERE clauses for this type. This will be one of the constants defined
1423 in this interface (@code{typePredNone}, @code{typePredChar},
1424 @code{typePredBasic}, or @code{typeSearchable}).
1427 UNSIGNED_ATTRIBUTE - Is the value of this type unsigned.
1430 FIXED_PREC_SCALE - Whether or not this type can be used for money.
1433 AUTO_INCREMENT - Whether or not this type supports auto-incrementing.
1436 LOCAL_TYPE_NAME - A localized name for this data type.
1439 MINIMUM_SCALE - The minimum scale supported by this type.
1442 MAXIMUM_SCALE - The maximum scale supported by this type.
1445 SQL_DATA_TYPE - Unused.
1448 SQL_DATETIME_SUB - Unused.
1451 NUM_PREC_RADIX - The radix of this data type.
1456 @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
1457 This method returns information about a tables indices and statistics.
1458 It is returned as a @code{ResultSet} with the following columns:
1467 TABLE_CAT - The catalog of the table, which may be @code{null}.
1470 TABLE_SCHEM - The schema of the table, which may be @code{null}.
1473 TABLE_NAME - The name of the table.
1476 NON_UNIQUE - Are index values non-unique?
1479 INDEX_QUALIFIER The index catalog, which may be @code{null}
1482 INDEX_NAME - The name of the index.
1485 TYPE - The type of index, which will be one of the constants defined
1486 in this interface (@code{tableIndexStatistic},
1487 @code{tableIndexClustered}, @code{tableIndexHashed}, or
1488 @code{tableIndexOther}).
1491 ORDINAL_POSITION - The sequence number of this column in the index.
1492 This will be 0 when the index type is @code{tableIndexStatistic}.
1495 COLUMN_NAME - The name of this column in the index.
1498 ASC_OR_DESC - "A" for an ascending sort sequence, "D" for a
1499 descending sort sequence or @code{null} if a sort sequence is not
1503 CARDINALITY - The number of unique rows in the index, or the number
1504 of rows in the table if the index type is @code{tableIndexStatistic}.
1507 PAGES - The number of pages used for the index, or the number of pages
1508 in the table if the index type is @code{tableIndexStatistic}.
1511 FILTER_CONDITION - The filter condition for this index, which may be
1517 @deftypemethod DatabaseMetaData {public boolean} supportsResultSetType (int@w{ }@var{type}) @*throws SQLException
1518 This method tests whether or not the datbase supports the specified
1521 @deftypemethod DatabaseMetaData {public boolean} supportsResultSetConcurrency (int@w{ }@var{type}, int@w{ }@var{concur}) @*throws SQLException
1522 This method tests whether the specified result set type and result set
1523 concurrency type are supported by the database.
1525 @deftypemethod DatabaseMetaData {public boolean} ownUpdatesAreVisible (int@w{ }@var{type}) @*throws SQLException
1526 This method tests whether or not the specified result set type sees its
1529 @deftypemethod DatabaseMetaData {public boolean} ownDeletesAreVisible (int@w{ }@var{type}) @*throws SQLException
1530 This method tests whether or not the specified result set type sees its
1533 @deftypemethod DatabaseMetaData {public boolean} ownInsertsAreVisible (int@w{ }@var{type}) @*throws SQLException
1534 This method tests whether or not the specified result set type sees its
1537 @deftypemethod DatabaseMetaData {public boolean} othersUpdatesAreVisible (int@w{ }@var{type}) @*throws SQLException
1538 This method tests whether or not the specified result set type sees
1539 updates committed by others.
1541 @deftypemethod DatabaseMetaData {public boolean} othersDeletesAreVisible (int@w{ }@var{type}) @*throws SQLException
1542 This method tests whether or not the specified result set type sees
1543 deletes committed by others.
1545 @deftypemethod DatabaseMetaData {public boolean} othersInsertsAreVisible (int@w{ }@var{type}) @*throws SQLException
1546 This method tests whether or not the specified result set type sees
1547 inserts committed by others.
1549 @deftypemethod DatabaseMetaData {public boolean} updatesAreDetected (int@w{ }@var{type}) @*throws SQLException
1550 This method tests whether or not the specified result set type can detect
1551 a visible update by calling the @code{rowUpdated} method.
1553 @deftypemethod DatabaseMetaData {public boolean} deletesAreDetected (int@w{ }@var{type}) @*throws SQLException
1554 This method tests whether or not the specified result set type can detect
1555 a visible delete by calling the @code{rowUpdated} method.
1557 @deftypemethod DatabaseMetaData {public boolean} insertsAreDetected (int@w{ }@var{type}) @*throws SQLException
1558 This method tests whether or not the specified result set type can detect
1559 a visible insert by calling the @code{rowUpdated} method.
1561 @deftypemethod DatabaseMetaData {public boolean} supportsBatchUpdates () @*throws SQLException
1562 This method tests whether or not the database supports batch updates.
1564 @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
1565 This method returns the list of user defined data types in use. These
1566 are returned as a @code{ResultSet} with the following columns:
1575 TYPE_CAT - The catalog name, which may be @code{null}.
1578 TYPE_SCEHM - The schema name, which may be @code{null}.
1581 TYPE_NAME - The user defined data type name.
1584 CLASS_NAME - The Java class name this type maps to.
1587 DATA_TYPE - A type identifer from @code{Types} for this type.
1588 This will be one of @code{JAVA_OBJECT}, @code{STRUCT}, or
1592 REMARKS - Comments about this data type.
1597 @deftypemethod DatabaseMetaData {public Connection} getConnection () @*throws SQLException
1598 This method returns the @code{Connection} object that was used
1599 to generate the metadata in this object.
1601 @deftypemethod DataTruncation {public int} getIndex ()
1602 This method returns the index of the column or parameter that was
1605 @deftypemethod DataTruncation {public boolean} getParameter ()
1606 This method determines whether or not it was a parameter that was
1609 @deftypemethod DataTruncation {public boolean} getRead ()
1610 This method determines whether or not it was a column that was
1613 @deftypemethod DataTruncation {public int} getDataSize ()
1614 This method returns the original size of the parameter or column that
1617 @deftypemethod DataTruncation {public int} getTransferSize ()
1618 This method returns the size of the parameter or column after it was
1621 @deftypemethod Date {public static Date} valueOf (java.lang.String@w{ }@var{str})
1622 This method returns a new instance of this class by parsing a
1623 date in JDBC format into a Java date.
1625 @deftypemethod Date {public String} toString ()
1626 This method returns this date in JDBC format.
1628 @deftypemethod Driver {public int} getMajorVersion ()
1629 This method returns the major version number of the driver.
1631 @deftypemethod Driver {public int} getMinorVersion ()
1632 This method returns the minor version number of the driver.
1634 @deftypemethod Driver {public boolean} jdbcCompliant ()
1635 This method tests whether or not the driver is JDBC compliant. This
1636 method should only return @code{true} if the driver has been
1637 certified as JDBC compliant.
1639 @deftypemethod Driver {public DriverPropertyInfo} getPropertyInfo (java.lang.String@w{ }@var{url}, java.util.Properties@w{ }@var{properties}) @*throws SQLException
1640 This method returns an array of possible properties that could be
1641 used to connect to the specified database.
1643 @deftypemethod Driver {public boolean} acceptsURL (java.lang.String@w{ }@var{url}) @*throws SQLException
1644 This method tests whether or not the driver believes it can connect to
1645 the specified database. The driver should only test whether it
1646 understands and accepts the URL. It should not necessarily attempt to
1647 probe the database for a connection.
1649 @deftypemethod Driver {public Connection} connect (java.lang.String@w{ }@var{url}, java.util.Properties@w{ }@var{properties}) @*throws SQLException
1650 This method connects to the specified database using the connection
1651 properties supplied. If the driver does not understand the database
1652 URL, it should return @code{null} instead of throwing an
1653 exception since the @code{DriverManager} will probe a driver
1656 @deftypemethod DriverManager {public static int} getLoginTimeout ()
1657 This method returns the login timeout in use by JDBC drivers systemwide.
1659 @deftypemethod DriverManager {public static void} setLoginTimeout (int@w{ }@var{login_timeout})
1660 This method set the login timeout used by JDBC drivers. This is a
1661 system-wide parameter that applies to all drivers.
1663 @deftypemethod DriverManager {public static PrintWriter} getLogWriter ()
1664 This method returns the log writer being used by all JDBC drivers.
1665 This method should be used in place of the deprecated
1666 @code{getLogStream} method.
1668 @deftypemethod DriverManager {public static void} setLogWriter (java.io.PrintWriter@w{ }@var{log_writer})
1669 This method sets the log writer being used by JDBC drivers. This is a
1670 system-wide parameter that affects all drivers. Note that since there
1671 is no way to retrieve a @code{PrintStream} from a
1672 @code{PrintWriter}, this method cannot set the log stream in
1673 use by JDBC. Thus any older drivers may not see this setting.
1675 @deftypemethod DriverManager {public static PrintStream} getLogStream ()
1676 This method returns the log stream in use by JDBC.
1678 @deftypemethod DriverManager {public static void} setLogStream (java.io.PrintStream@w{ }@var{log_stream})
1679 This method sets the log stream in use by JDBC.
1681 @deftypemethod DriverManager {public static void} println (java.lang.String@w{ }@var{str})
1682 This method prints the specified line to the log stream.
1684 @deftypemethod DriverManager {public static void} registerDriver (java.sql.Driver@w{ }@var{driver}) @*throws SQLException
1685 This method registers a new driver with the manager. This is normally
1686 called by the driver itself in a static initializer.
1688 @deftypemethod DriverManager {public static void} deregisterDriver (java.sql.Driver@w{ }@var{driver}) @*throws SQLException
1689 This method de-registers a driver from the manager.
1691 @deftypemethod DriverManager {public static Enumeration} getDrivers ()
1692 This method returns a list of all the currently registered JDBC drivers
1693 that were loaded by the current @code{ClassLoader}.
1695 @deftypemethod DriverManager {public static Driver} getDriver (java.lang.String@w{ }@var{url}) @*throws SQLException
1696 This method returns a driver that can connect to the specified
1697 JDBC URL string. This will be selected from among drivers loaded
1698 at initialization time and those drivers manually loaded by the
1699 same class loader as the caller.
1701 @deftypemethod DriverManager {public static Connection} getConnection (java.lang.String@w{ }@var{url}) @*throws SQLException
1702 This method attempts to return a connection to the specified
1705 @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
1706 This method attempts to return a connection to the specified
1707 JDBC URL string using the specified username and password.
1709 @deftypemethod DriverManager {public static Connection} getConnection (java.lang.String@w{ }@var{url}, java.util.Properties@w{ }@var{properties}) @*throws SQLException
1710 This method attempts to return a connection to the specified
1711 JDBC URL string using the specified connection properties.
1713 @deftypemethod PreparedStatement {public void} setNull (int@w{ }@var{index}, int@w{ }@var{type}) @*throws SQLException
1714 This method populates the specified parameter with a SQL NULL value
1715 for the specified type.
1717 @deftypemethod PreparedStatement {public void} setNull (int@w{ }@var{index}, int@w{ }@var{type}, java.lang.String@w{ }@var{name}) @*throws SQLException
1718 This method populates the specified parameter with a SQL NULL value
1719 for the specified type.
1721 @deftypemethod PreparedStatement {public void} setBoolean (int@w{ }@var{index}, boolean@w{ }@var{value}) @*throws SQLException
1722 This method sets the specified parameter from the given Java
1723 @code{boolean} value.
1725 @deftypemethod PreparedStatement {public void} setByte (int@w{ }@var{index}, byte@w{ }@var{value}) @*throws SQLException
1726 This method sets the specified parameter from the given Java
1729 @deftypemethod PreparedStatement {public void} setShort (int@w{ }@var{index}, short@w{ }@var{value}) @*throws SQLException
1730 This method sets the specified parameter from the given Java
1733 @deftypemethod PreparedStatement {public void} setInt (int@w{ }@var{index}, int@w{ }@var{value}) @*throws SQLException
1734 This method sets the specified parameter from the given Java
1737 @deftypemethod PreparedStatement {public void} setLong (int@w{ }@var{index}, long@w{ }@var{value}) @*throws SQLException
1738 This method sets the specified parameter from the given Java
1741 @deftypemethod PreparedStatement {public void} setFloat (int@w{ }@var{index}, float@w{ }@var{value}) @*throws SQLException
1742 This method sets the specified parameter from the given Java
1745 @deftypemethod PreparedStatement {public void} setDouble (int@w{ }@var{index}, double@w{ }@var{value}) @*throws SQLException
1746 This method sets the specified parameter from the given Java
1747 @code{double} value.
1749 @deftypemethod PreparedStatement {public void} setString (int@w{ }@var{index}, java.lang.String@w{ }@var{value}) @*throws SQLException
1750 This method sets the specified parameter from the given Java
1751 @code{String} value.
1753 @deftypemethod PreparedStatement {public void} setBytes (int@w{ }@var{index}, byte[]@w{ }@var{value}) @*throws SQLException
1754 This method sets the specified parameter from the given Java
1755 @code{byte} array value.
1757 @deftypemethod PreparedStatement {public void} setBigDecimal (int@w{ }@var{index}, java.math.BigDecimal@w{ }@var{value}) @*throws SQLException
1758 This method sets the specified parameter from the given Java
1759 @code{java.math.BigDecimal} value.
1761 @deftypemethod PreparedStatement {public void} setDate (int@w{ }@var{index}, java.sql.Date@w{ }@var{value}) @*throws SQLException
1762 This method sets the specified parameter from the given Java
1763 @code{java.sql.Date} value.
1765 @deftypemethod PreparedStatement {public void} setDate (int@w{ }@var{index}, java.sql.Date@w{ }@var{value}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
1766 This method sets the specified parameter from the given Java
1767 @code{java.sql.Date} value.
1769 @deftypemethod PreparedStatement {public void} setTime (int@w{ }@var{index}, java.sql.Time@w{ }@var{value}) @*throws SQLException
1770 This method sets the specified parameter from the given Java
1771 @code{java.sql.Time} value.
1773 @deftypemethod PreparedStatement {public void} setTime (int@w{ }@var{index}, java.sql.Time@w{ }@var{value}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
1774 This method sets the specified parameter from the given Java
1775 @code{java.sql.Time} value.
1777 @deftypemethod PreparedStatement {public void} setTimestamp (int@w{ }@var{index}, java.sql.Timestamp@w{ }@var{value}) @*throws SQLException
1778 This method sets the specified parameter from the given Java
1779 @code{java.sql.Timestamp} value.
1781 @deftypemethod PreparedStatement {public void} setTimestamp (int@w{ }@var{index}, java.sql.Timestamp@w{ }@var{value}, java.util.Calendar@w{ }@var{calendar}) @*throws SQLException
1782 This method sets the specified parameter from the given Java
1783 @code{java.sql.Timestamp} value.
1785 @deftypemethod PreparedStatement {public void} setAsciiStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
1786 This method sets the specified parameter from the given Java
1787 ASCII @code{InputStream} value.
1789 @deftypemethod PreparedStatement {public void} setUnicodeStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
1790 This method sets the specified parameter from the given Java
1791 Unicode UTF-8 @code{InputStream} value.
1793 @deftypemethod PreparedStatement {public void} setBinaryStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
1794 This method sets the specified parameter from the given Java
1795 binary @code{InputStream} value.
1797 @deftypemethod PreparedStatement {public void} setCharacterStream (int@w{ }@var{index}, java.io.Reader@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
1798 This method sets the specified parameter from the given Java
1799 character @code{Reader} value.
1801 @deftypemethod PreparedStatement {public void} setRef (int@w{ }@var{index}, java.sql.Ref@w{ }@var{value}) @*throws SQLException
1802 This method sets the specified parameter from the given Java
1803 @code{Ref} value. The default object type to SQL type mapping
1806 @deftypemethod PreparedStatement {public void} setBlob (int@w{ }@var{index}, java.sql.Blob@w{ }@var{value}) @*throws SQLException
1807 This method sets the specified parameter from the given Java
1808 @code{Blob} value. The default object type to SQL type mapping
1811 @deftypemethod PreparedStatement {public void} setClob (int@w{ }@var{index}, java.sql.Clob@w{ }@var{value}) @*throws SQLException
1812 This method sets the specified parameter from the given Java
1813 @code{Clob} value. The default object type to SQL type mapping
1816 @deftypemethod PreparedStatement {public void} setArray (int@w{ }@var{index}, java.sql.Array@w{ }@var{value}) @*throws SQLException
1817 This method sets the specified parameter from the given Java
1818 @code{Array} value. The default object type to SQL type mapping
1821 @deftypemethod PreparedStatement {public void} setObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}) @*throws SQLException
1822 This method sets the specified parameter from the given Java
1823 @code{Object} value. The default object type to SQL type mapping
1826 @deftypemethod PreparedStatement {public void} setObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}, int@w{ }@var{type}) @*throws SQLException
1827 This method sets the specified parameter from the given Java
1828 @code{Object} value. The specified SQL object type will be used.
1830 @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
1831 This method sets the specified parameter from the given Java
1832 @code{Object} value. The specified SQL object type will be used.
1834 @deftypemethod PreparedStatement {public void} addBatch () @*throws SQLException
1835 This method adds a set of parameters to the batch for JDBC 2.0.
1837 @deftypemethod PreparedStatement {public void} clearParameters () @*throws SQLException
1838 This method clears all of the input parameter that have been
1839 set on this statement.
1841 @deftypemethod PreparedStatement {public ResultSetMetaData} getMetaData () @*throws SQLException
1842 This method returns meta data for the result set from this statement.
1844 @deftypemethod PreparedStatement {public boolean} execute () @*throws SQLException
1845 This method executes a prepared SQL query.
1846 Some prepared statements return multiple results; the execute method
1847 handles these complex statements as well as the simpler form of
1848 statements handled by executeQuery and executeUpdate.
1850 @deftypemethod PreparedStatement {public ResultSet} executeQuery () @*throws SQLException
1851 This method executes a prepared SQL query and returns its ResultSet.
1853 @deftypemethod PreparedStatement {public int} executeUpdate () @*throws SQLException
1854 This method executes an SQL INSERT, UPDATE or DELETE statement. SQL
1855 statements that return nothing such as SQL DDL statements can be executed.
1857 @deftypemethod Ref {public String} getBaseTypeName () @*throws SQLException
1858 This method returns the fully qualified name of the SQL structured
1859 type of the referenced item.
1861 @deftypemethod ResultSet {public boolean} next () @*throws SQLException
1862 This method advances to the next row in the result set. Any streams
1863 open on the current row are closed automatically.
1865 @deftypemethod ResultSet {public boolean} previous () @*throws SQLException
1866 This method moves the current position to the previous row in the
1869 @deftypemethod ResultSet {public void} close () @*throws SQLException
1870 This method closes the result set and frees any associated resources.
1872 @deftypemethod ResultSet {public boolean} wasNull () @*throws SQLException
1873 This method tests whether the value of the last column that was fetched
1874 was actually a SQL NULL value.
1876 @deftypemethod ResultSet {public String} getString (int@w{ }@var{index}) @*throws SQLException
1877 This method returns the value of the specified column as a Java
1880 @deftypemethod ResultSet {public Object} getObject (int@w{ }@var{index}) @*throws SQLException
1881 This method returns the value of the specified column as a Java
1884 @deftypemethod ResultSet {public boolean} getBoolean (int@w{ }@var{index}) @*throws SQLException
1885 This method returns the value of the specified column as a Java
1888 @deftypemethod ResultSet {public byte} getByte (int@w{ }@var{index}) @*throws SQLException
1889 This method returns the value of the specified column as a Java
1892 @deftypemethod ResultSet {public short} getShort (int@w{ }@var{index}) @*throws SQLException
1893 This method returns the value of the specified column as a Java
1896 @deftypemethod ResultSet {public int} getInt (int@w{ }@var{index}) @*throws SQLException
1897 This method returns the value of the specified column as a Java
1900 @deftypemethod ResultSet {public long} getLong (int@w{ }@var{index}) @*throws SQLException
1901 This method returns the value of the specified column as a Java
1904 @deftypemethod ResultSet {public float} getFloat (int@w{ }@var{index}) @*throws SQLException
1905 This method returns the value of the specified column as a Java
1908 @deftypemethod ResultSet {public double} getDouble (int@w{ }@var{index}) @*throws SQLException
1909 This method returns the value of the specified column as a Java
1912 @deftypemethod ResultSet {public BigDecimal} getBigDecimal (int@w{ }@var{index}) @*throws SQLException
1913 This method returns the value of the specified column as a Java
1916 @deftypemethod ResultSet {public BigDecimal} getBigDecimal (int@w{ }@var{index}, int@w{ }@var{scale}) @*throws SQLException
1917 This method returns the value of the specified column as a Java
1920 @deftypemethod ResultSet {public byte} getBytes (int@w{ }@var{index}) @*throws SQLException
1921 This method returns the value of the specified column as a Java
1924 @deftypemethod ResultSet {public Date} getDate (int@w{ }@var{index}) @*throws SQLException
1925 This method returns the value of the specified column as a Java
1926 @code{java.sql.Date}.
1928 @deftypemethod ResultSet {public Time} getTime (int@w{ }@var{index}) @*throws SQLException
1929 This method returns the value of the specified column as a Java
1930 @code{java.sql.Time}.
1932 @deftypemethod ResultSet {public Timestamp} getTimestamp (int@w{ }@var{index}) @*throws SQLException
1933 This method returns the value of the specified column as a Java
1934 @code{java.sql.Timestamp}.
1936 @deftypemethod ResultSet {public InputStream} getAsciiStream (int@w{ }@var{index}) @*throws SQLException
1937 This method returns the value of the specified column as an ASCII
1938 stream. Note that all the data from this stream must be read before
1939 fetching the value of any other column. Please also be aware that
1940 calling @code{next()} or @code{close()} on this result set
1941 will close this stream as well.
1943 @deftypemethod ResultSet {public InputStream} getUnicodeStream (int@w{ }@var{index}) @*throws SQLException
1944 This method returns the value of the specified column as a Unicode UTF-8
1945 stream. Note that all the data from this stream must be read before
1946 fetching the value of any other column. Please also be aware that
1947 calling @code{next()} or @code{close()} on this result set
1948 will close this stream as well.
1950 @deftypemethod ResultSet {public InputStream} getBinaryStream (int@w{ }@var{index}) @*throws SQLException
1951 This method returns the value of the specified column as a raw byte
1952 stream. Note that all the data from this stream must be read before
1953 fetching the value of any other column. Please also be aware that
1954 calling @code{next()} or @code{close()} on this result set
1955 will close this stream as well.
1957 @deftypemethod ResultSet {public Reader} getCharacterStream (int@w{ }@var{index}) @*throws SQLException
1958 This method returns the value of the specified column as a character
1959 stream. Note that all the data from this stream must be read before
1960 fetching the value of any other column. Please also be aware that
1961 calling @code{next()} or @code{close()} on this result set
1962 will close this stream as well.
1964 @deftypemethod ResultSet {public String} getString (java.lang.String@w{ }@var{column}) @*throws SQLException
1965 This method returns the value of the specified column as a Java
1968 @deftypemethod ResultSet {public Object} getObject (java.lang.String@w{ }@var{column}) @*throws SQLException
1969 This method returns the value of the specified column as a Java
1972 @deftypemethod ResultSet {public boolean} getBoolean (java.lang.String@w{ }@var{column}) @*throws SQLException
1973 This method returns the value of the specified column as a Java
1976 @deftypemethod ResultSet {public byte} getByte (java.lang.String@w{ }@var{column}) @*throws SQLException
1977 This method returns the value of the specified column as a Java
1980 @deftypemethod ResultSet {public short} getShort (java.lang.String@w{ }@var{column}) @*throws SQLException
1981 This method returns the value of the specified column as a Java
1984 @deftypemethod ResultSet {public int} getInt (java.lang.String@w{ }@var{column}) @*throws SQLException
1985 This method returns the value of the specified column as a Java
1988 @deftypemethod ResultSet {public long} getLong (java.lang.String@w{ }@var{column}) @*throws SQLException
1989 This method returns the value of the specified column as a Java
1992 @deftypemethod ResultSet {public float} getFloat (java.lang.String@w{ }@var{column}) @*throws SQLException
1993 This method returns the value of the specified column as a Java
1996 @deftypemethod ResultSet {public double} getDouble (java.lang.String@w{ }@var{column}) @*throws SQLException
1997 This method returns the value of the specified column as a Java
2000 @deftypemethod ResultSet {public BigDecimal} getBigDecimal (java.lang.String@w{ }@var{column}) @*throws SQLException
2001 This method returns the value of the specified column as a Java
2004 @deftypemethod ResultSet {public BigDecimal} getBigDecimal (java.lang.String@w{ }@var{column}, int@w{ }@var{scale}) @*throws SQLException
2005 This method returns the value of the specified column as a Java
2008 @deftypemethod ResultSet {public byte} getBytes (java.lang.String@w{ }@var{column}) @*throws SQLException
2009 This method returns the value of the specified column as a Java
2012 @deftypemethod ResultSet {public Date} getDate (java.lang.String@w{ }@var{column}) @*throws SQLException
2013 This method returns the value of the specified column as a Java
2014 @code{java.sql.Date}.
2016 @deftypemethod ResultSet {public Time} getTime (java.lang.String@w{ }@var{column}) @*throws SQLException
2017 This method returns the value of the specified column as a Java
2018 @code{java.sql.Time}.
2020 @deftypemethod ResultSet {public Timestamp} getTimestamp (java.lang.String@w{ }@var{column}) @*throws SQLException
2021 This method returns the value of the specified column as a Java
2022 @code{java.sql.Timestamp}.
2024 @deftypemethod ResultSet {public InputStream} getAsciiStream (java.lang.String@w{ }@var{column}) @*throws SQLException
2025 This method returns the value of the specified column as an ASCII
2026 stream. Note that all the data from this stream must be read before
2027 fetching the value of any other column. Please also be aware that
2028 calling @code{next()} or @code{close()} on this result set
2029 will close this stream as well.
2031 @deftypemethod ResultSet {public InputStream} getUnicodeStream (java.lang.String@w{ }@var{column}) @*throws SQLException
2032 This method returns the value of the specified column as a Unicode UTF-8
2033 stream. Note that all the data from this stream must be read before
2034 fetching the value of any other column. Please also be aware that
2035 calling @code{next()} or @code{close()} on this result set
2036 will close this stream as well.
2038 @deftypemethod ResultSet {public InputStream} getBinaryStream (java.lang.String@w{ }@var{column}) @*throws SQLException
2039 This method returns the value of the specified column as a raw byte
2040 stream. Note that all the data from this stream must be read before
2041 fetching the value of any other column. Please also be aware that
2042 calling @code{next()} or @code{close()} on this result set
2043 will close this stream as well.
2045 @deftypemethod ResultSet {public Reader} getCharacterStream (java.lang.String@w{ }@var{column}) @*throws SQLException
2046 This method returns the value of the specified column as a character
2047 stream. Note that all the data from this stream must be read before
2048 fetching the value of any other column. Please also be aware that
2049 calling @code{next()} or @code{close()} on this result set
2050 will close this stream as well.
2052 @deftypemethod ResultSet {public SQLWarning} getWarnings () @*throws SQLException
2053 This method returns the first SQL warning associated with this result
2054 set. Any additional warnings will be chained to this one.
2056 @deftypemethod ResultSet {public void} clearWarnings () @*throws SQLException
2057 This method clears all warnings associated with this result set.
2059 @deftypemethod ResultSet {public String} getCursorName () @*throws SQLException
2060 This method returns the name of the database cursor used by this
2063 @deftypemethod ResultSet {public ResultSetMetaData} getMetaData () @*throws SQLException
2064 This method returns data about the columns returned as part of the
2065 result set as a @code{ResultSetMetaData} instance.
2067 @deftypemethod ResultSet {public int} findColumn (java.lang.String@w{ }@var{column}) @*throws SQLException
2068 This method returns the column index of the specified named column.
2070 @deftypemethod ResultSet {public boolean} isBeforeFirst () @*throws SQLException
2071 This method tests whether or not the cursor is before the first row
2074 @deftypemethod ResultSet {public boolean} isAfterLast () @*throws SQLException
2075 This method tests whether or not the cursor is after the last row
2078 @deftypemethod ResultSet {public boolean} isFirst () @*throws SQLException
2079 This method tests whether or not the cursor is positioned on the first
2080 row in the result set.
2082 @deftypemethod ResultSet {public boolean} isLast () @*throws SQLException
2083 This method tests whether or not the cursor is on the last row
2086 @deftypemethod ResultSet {public void} beforeFirst () @*throws SQLException
2087 This method repositions the cursor to before the first row in the
2090 @deftypemethod ResultSet {public void} afterLast () @*throws SQLException
2091 This method repositions the cursor to after the last row in the result
2094 @deftypemethod ResultSet {public boolean} first () @*throws SQLException
2095 This method repositions the cursor on the first row in the
2098 @deftypemethod ResultSet {public boolean} last () @*throws SQLException
2099 This method repositions the cursor on the last row in the result
2102 @deftypemethod ResultSet {public int} getRow () @*throws SQLException
2103 This method returns the current row number in the cursor. Numbering
2106 @deftypemethod ResultSet {public boolean} absolute (int@w{ }@var{row}) @*throws SQLException
2107 This method positions the result set to the specified absolute row.
2108 Positive numbers are row offsets from the beginning of the result
2109 set (numbering starts from row 1) and negative numbers are row offsets
2110 from the end of the result set (numbering starts from -1).
2112 @deftypemethod ResultSet {public boolean} relative (int@w{ }@var{row}) @*throws SQLException
2113 This method moves the result set position relative to the current row.
2114 The offset can be positive or negative.
2116 @deftypemethod ResultSet {public void} setFetchDirection (int@w{ }@var{direction}) @*throws SQLException
2117 This method provides a hint to the driver about which direction the
2118 result set will be processed in.
2120 @deftypemethod ResultSet {public int} getFetchDirection () @*throws SQLException
2121 This method returns the current fetch direction for this result set.
2123 @deftypemethod ResultSet {public void} setFetchSize (int@w{ }@var{rows}) @*throws SQLException
2124 This method provides a hint to the driver about how many rows at a
2125 time it should fetch from the database.
2127 @deftypemethod ResultSet {public int} getFetchSize () @*throws SQLException
2128 This method returns the current number of rows that will be fetched
2129 from the database at a time.
2131 @deftypemethod ResultSet {public int} getType () @*throws SQLException
2132 This method returns the result set type of this result set. This will
2133 be one of the TYPE_* constants defined in this interface.
2135 @deftypemethod ResultSet {public int} getConcurrency () @*throws SQLException
2136 This method returns the concurrency type of this result set. This will
2137 be one of the CONCUR_* constants defined in this interface.
2139 @deftypemethod ResultSet {public boolean} rowUpdated () @*throws SQLException
2140 This method tests whether or not the current row in the result set
2141 has been updated. Updates must be visible in order of this method to
2144 @deftypemethod ResultSet {public boolean} rowInserted () @*throws SQLException
2145 This method tests whether or not the current row in the result set
2146 has been inserted. Inserts must be visible in order of this method to
2149 @deftypemethod ResultSet {public boolean} rowDeleted () @*throws SQLException
2150 This method tests whether or not the current row in the result set
2151 has been deleted. Deletes must be visible in order of this method to
2152 detect the deletion.
2154 @deftypemethod ResultSet {public void} updateNull (int@w{ }@var{index}) @*throws SQLException
2155 This method updates the specified column to have a NULL value. This
2156 does not update the actual database. @code{updateRow} must be
2157 called in order to do that.
2159 @deftypemethod ResultSet {public void} updateBoolean (int@w{ }@var{index}, boolean@w{ }@var{value}) @*throws SQLException
2160 This method updates the specified column to have a boolean value. This
2161 does not update the actual database. @code{updateRow} must be
2162 called in order to do that.
2164 @deftypemethod ResultSet {public void} updateByte (int@w{ }@var{index}, byte@w{ }@var{value}) @*throws SQLException
2165 This method updates the specified column to have a byte value. This
2166 does not update the actual database. @code{updateRow} must be
2167 called in order to do that.
2169 @deftypemethod ResultSet {public void} updateShort (int@w{ }@var{index}, short@w{ }@var{value}) @*throws SQLException
2170 This method updates the specified column to have a short value. This
2171 does not update the actual database. @code{updateRow} must be
2172 called in order to do that.
2174 @deftypemethod ResultSet {public void} updateInt (int@w{ }@var{index}, int@w{ }@var{value}) @*throws SQLException
2175 This method updates the specified column to have an int value. This
2176 does not update the actual database. @code{updateRow} must be
2177 called in order to do that.
2179 @deftypemethod ResultSet {public void} updateLong (int@w{ }@var{index}, long@w{ }@var{value}) @*throws SQLException
2180 This method updates the specified column to have a long value. This
2181 does not update the actual database. @code{updateRow} must be
2182 called in order to do that.
2184 @deftypemethod ResultSet {public void} updateFloat (int@w{ }@var{index}, float@w{ }@var{value}) @*throws SQLException
2185 This method updates the specified column to have a float value. This
2186 does not update the actual database. @code{updateRow} must be
2187 called in order to do that.
2189 @deftypemethod ResultSet {public void} updateDouble (int@w{ }@var{index}, double@w{ }@var{value}) @*throws SQLException
2190 This method updates the specified column to have a double value. This
2191 does not update the actual database. @code{updateRow} must be
2192 called in order to do that.
2194 @deftypemethod ResultSet {public void} updateBigDecimal (int@w{ }@var{index}, java.math.BigDecimal@w{ }@var{value}) @*throws SQLException
2195 This method updates the specified column to have a BigDecimal value. This
2196 does not update the actual database. @code{updateRow} must be
2197 called in order to do that.
2199 @deftypemethod ResultSet {public void} updateString (int@w{ }@var{index}, java.lang.String@w{ }@var{value}) @*throws SQLException
2200 This method updates the specified column to have a String value. This
2201 does not update the actual database. @code{updateRow} must be
2202 called in order to do that.
2204 @deftypemethod ResultSet {public void} updateBytes (int@w{ }@var{index}, byte[]@w{ }@var{value}) @*throws SQLException
2205 This method updates the specified column to have a byte array value. This
2206 does not update the actual database. @code{updateRow} must be
2207 called in order to do that.
2209 @deftypemethod ResultSet {public void} updateDate (int@w{ }@var{index}, java.sql.Date@w{ }@var{value}) @*throws SQLException
2210 This method updates the specified column to have a java.sql.Date value. This
2211 does not update the actual database. @code{updateRow} must be
2212 called in order to do that.
2214 @deftypemethod ResultSet {public void} updateTime (int@w{ }@var{index}, java.sql.Time@w{ }@var{value}) @*throws SQLException
2215 This method updates the specified column to have a java.sql.Time value. This
2216 does not update the actual database. @code{updateRow} must be
2217 called in order to do that.
2219 @deftypemethod ResultSet {public void} updateTimestamp (int@w{ }@var{index}, java.sql.Timestamp@w{ }@var{value}) @*throws SQLException
2220 This method updates the specified column to have a java.sql.Timestamp value.
2221 This does not update the actual database. @code{updateRow} must be
2222 called in order to do that.
2224 @deftypemethod ResultSet {public void} updateAsciiStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
2225 This method updates the specified column from an ASCII text stream.
2226 This does not update the actual database. @code{updateRow} must be
2227 called in order to do that.
2229 @deftypemethod ResultSet {public void} updateBinaryStream (int@w{ }@var{index}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
2230 This method updates the specified column from a binary stream.
2231 This does not update the actual database. @code{updateRow} must be
2232 called in order to do that.
2234 @deftypemethod ResultSet {public void} updateCharacterStream (int@w{ }@var{index}, java.io.Reader@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
2235 This method updates the specified column from a character stream.
2236 This does not update the actual database. @code{updateRow} must be
2237 called in order to do that.
2239 @deftypemethod ResultSet {public void} updateObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}) @*throws SQLException
2240 This method updates the specified column to have an Object value.
2241 This does not update the actual database. @code{updateRow} must be
2242 called in order to do that.
2244 @deftypemethod ResultSet {public void} updateObject (int@w{ }@var{index}, java.lang.Object@w{ }@var{value}, int@w{ }@var{scale}) @*throws SQLException
2245 This method updates the specified column to have an Object value.
2246 This does not update the actual database. @code{updateRow} must be
2247 called in order to do that.
2249 @deftypemethod ResultSet {public void} updateNull (java.lang.String@w{ }@var{name}) @*throws SQLException
2250 This method updates the specified column to have a NULL value. This
2251 does not update the actual database. @code{updateRow} must be
2252 called in order to do that.
2254 @deftypemethod ResultSet {public void} updateBoolean (java.lang.String@w{ }@var{name}, boolean@w{ }@var{value}) @*throws SQLException
2255 This method updates the specified column to have a boolean value. This
2256 does not update the actual database. @code{updateRow} must be
2257 called in order to do that.
2259 @deftypemethod ResultSet {public void} updateByte (java.lang.String@w{ }@var{name}, byte@w{ }@var{value}) @*throws SQLException
2260 This method updates the specified column to have a byte value. This
2261 does not update the actual database. @code{updateRow} must be
2262 called in order to do that.
2264 @deftypemethod ResultSet {public void} updateShort (java.lang.String@w{ }@var{name}, short@w{ }@var{value}) @*throws SQLException
2265 This method updates the specified column to have a short value. This
2266 does not update the actual database. @code{updateRow} must be
2267 called in order to do that.
2269 @deftypemethod ResultSet {public void} updateInt (java.lang.String@w{ }@var{name}, int@w{ }@var{value}) @*throws SQLException
2270 This method updates the specified column to have an int value. This
2271 does not update the actual database. @code{updateRow} must be
2272 called in order to do that.
2274 @deftypemethod ResultSet {public void} updateLong (java.lang.String@w{ }@var{name}, long@w{ }@var{value}) @*throws SQLException
2275 This method updates the specified column to have a long value. This
2276 does not update the actual database. @code{updateRow} must be
2277 called in order to do that.
2279 @deftypemethod ResultSet {public void} updateFloat (java.lang.String@w{ }@var{name}, float@w{ }@var{value}) @*throws SQLException
2280 This method updates the specified column to have a float value. This
2281 does not update the actual database. @code{updateRow} must be
2282 called in order to do that.
2284 @deftypemethod ResultSet {public void} updateDouble (java.lang.String@w{ }@var{name}, double@w{ }@var{value}) @*throws SQLException
2285 This method updates the specified column to have a double value. This
2286 does not update the actual database. @code{updateRow} must be
2287 called in order to do that.
2289 @deftypemethod ResultSet {public void} updateBigDecimal (java.lang.String@w{ }@var{name}, java.math.BigDecimal@w{ }@var{value}) @*throws SQLException
2290 This method updates the specified column to have a BigDecimal value. This
2291 does not update the actual database. @code{updateRow} must be
2292 called in order to do that.
2294 @deftypemethod ResultSet {public void} updateString (java.lang.String@w{ }@var{name}, java.lang.String@w{ }@var{value}) @*throws SQLException
2295 This method updates the specified column to have a String value. This
2296 does not update the actual database. @code{updateRow} must be
2297 called in order to do that.
2299 @deftypemethod ResultSet {public void} updateBytes (java.lang.String@w{ }@var{name}, byte[]@w{ }@var{value}) @*throws SQLException
2300 This method updates the specified column to have a byte array value. This
2301 does not update the actual database. @code{updateRow} must be
2302 called in order to do that.
2304 @deftypemethod ResultSet {public void} updateDate (java.lang.String@w{ }@var{name}, java.sql.Date@w{ }@var{value}) @*throws SQLException
2305 This method updates the specified column to have a java.sql.Date value. This
2306 does not update the actual database. @code{updateRow} must be
2307 called in order to do that.
2309 @deftypemethod ResultSet {public void} updateTime (java.lang.String@w{ }@var{name}, java.sql.Time@w{ }@var{value}) @*throws SQLException
2310 This method updates the specified column to have a java.sql.Time value. This
2311 does not update the actual database. @code{updateRow} must be
2312 called in order to do that.
2314 @deftypemethod ResultSet {public void} updateTimestamp (java.lang.String@w{ }@var{name}, java.sql.Timestamp@w{ }@var{value}) @*throws SQLException
2315 This method updates the specified column to have a java.sql.Timestamp value.
2316 This does not update the actual database. @code{updateRow} must be
2317 called in order to do that.
2319 @deftypemethod ResultSet {public void} updateAsciiStream (java.lang.String@w{ }@var{name}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
2320 This method updates the specified column from an ASCII text stream.
2321 This does not update the actual database. @code{updateRow} must be
2322 called in order to do that.
2324 @deftypemethod ResultSet {public void} updateBinaryStream (java.lang.String@w{ }@var{name}, java.io.InputStream@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
2325 This method updates the specified column from a binary stream.
2326 This does not update the actual database. @code{updateRow} must be
2327 called in order to do that.
2329 @deftypemethod ResultSet {public void} updateCharacterStream (java.lang.String@w{ }@var{name}, java.io.Reader@w{ }@var{value}, int@w{ }@var{length}) @*throws SQLException
2330 This method updates the specified column from a character stream.
2331 This does not update the actual database. @code{updateRow} must be
2332 called in order to do that.
2334 @deftypemethod ResultSet {public void} updateObject (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{value}) @*throws SQLException
2335 This method updates the specified column to have an Object value.
2336 This does not update the actual database. @code{updateRow} must be
2337 called in order to do that.
2339 @deftypemethod ResultSet {public void} updateObject (java.lang.String@w{ }@var{name}, java.lang.Object@w{ }@var{value}, int@w{ }@var{scale}) @*throws SQLException
2340 This method updates the specified column to have an Object value.
2341 This does not update the actual database. @code{updateRow} must be
2342 called in order to do that.
2344 @deftypemethod ResultSet {public void} insertRow () @*throws SQLException
2345 This method inserts the current row into the database. The result set
2346 must be positioned on the insert row in order to call this method
2349 @deftypemethod ResultSet {public void} updateRow () @*throws SQLException
2350 This method updates the current row in the database.
2352 @deftypemethod ResultSet {public void} deleteRow () @*throws SQLException
2353 This method deletes the current row in the database.
2355 @deftypemethod ResultSet {public void} refreshRow () @*throws SQLException
2356 This method refreshes the contents of the current row from the database.
2358 @deftypemethod ResultSet {public void} cancelRowUpdates () @*throws SQLException
2359 This method cancels any changes that have been made to a row. If
2360 the @code{rowUpdate} method has been called, then the changes
2363 @deftypemethod ResultSet {public void} moveToInsertRow () @*throws SQLException
2364 This method positions the result set to the "insert row", which allows
2365 a new row to be inserted into the database from the result set.
2367 @deftypemethod ResultSet {public void} moveToCurrentRow () @*throws SQLException
2368 This method moves the result set position from the insert row back to
2369 the current row that was selected prior to moving to the insert row.
2371 @deftypemethod ResultSet {public Statement} getStatement () @*throws SQLException
2372 This method returns a the @code{Statement} that was used to
2373 produce this result set.
2375 @deftypemethod ResultSet {public Object} getObject (int@w{ }@var{index}, java.util.Map@w{ }@var{map}) @*throws SQLException
2376 This method returns the value of the specified column as a Java
2377 @code{Object} using the specified SQL type to Java type map.
2379 @deftypemethod ResultSet {public Ref} getRef (int@w{ }@var{index}) @*throws SQLException
2380 This method returns a @code{Ref} for the specified column which
2381 represents the structured type for the column.
2383 @deftypemethod ResultSet {public Blob} getBlob (int@w{ }@var{index}) @*throws SQLException
2384 This method returns the specified column value as a BLOB.
2386 @deftypemethod ResultSet {public Clob} getClob (int@w{ }@var{index}) @*throws SQLException
2387 This method returns the specified column value as a CLOB.
2389 @deftypemethod ResultSet {public Array} getArray (int@w{ }@var{index}) @*throws SQLException
2390 This method returns the specified column value as an @code{Array}.
2392 @deftypemethod ResultSet {public Object} getObject (java.lang.String@w{ }@var{name}, java.util.Map@w{ }@var{map}) @*throws SQLException
2393 This method returns the value of the specified column as a Java
2394 @code{Object} using the specified SQL type to Java type map.
2396 @deftypemethod ResultSet {public Ref} getRef (java.lang.String@w{ }@var{name}) @*throws SQLException
2397 This method returns a @code{Ref} for the specified column which
2398 represents the structured type for the column.
2400 @deftypemethod ResultSet {public Blob} getBlob (java.lang.String@w{ }@var{name}) @*throws SQLException
2401 This method returns the specified column value as a BLOB.
2403 @deftypemethod ResultSet {public Clob} getClob (java.lang.String@w{ }@var{name}) @*throws SQLException
2404 This method returns the specified column value as a CLOB.
2406 @deftypemethod ResultSet {public Array} getArray (java.lang.String@w{ }@var{name}) @*throws SQLException
2407 This method returns the specified column value as an @code{Array}.
2409 @deftypemethod ResultSet {public Date} getDate (int@w{ }@var{index}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
2410 This method returns the specified column value as a
2411 @code{java.sql.Date}. The specified @code{Calendar} is used
2412 to generate a value for the date if the database does not support
2415 @deftypemethod ResultSet {public Time} getTime (int@w{ }@var{index}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
2416 This method returns the specified column value as a
2417 @code{java.sql.Time}. The specified @code{Calendar} is used
2418 to generate a value for the time if the database does not support
2421 @deftypemethod ResultSet {public Timestamp} getTimestamp (int@w{ }@var{index}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
2422 This method returns the specified column value as a
2423 @code{java.sql.Timestamp}. The specified @code{Calendar} is used
2424 to generate a value for the timestamp if the database does not support
2427 @deftypemethod ResultSet {public Date} getDate (java.lang.String@w{ }@var{name}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
2428 This method returns the specified column value as a
2429 @code{java.sql.Date}. The specified @code{Calendar} is used
2430 to generate a value for the date if the database does not support
2433 @deftypemethod ResultSet {public Time} getTime (java.lang.String@w{ }@var{name}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
2434 This method returns the specified column value as a
2435 @code{java.sql.Time}. The specified @code{Calendar} is used
2436 to generate a value for the time if the database does not support
2439 @deftypemethod ResultSet {public Timestamp} getTimestamp (java.lang.String@w{ }@var{name}, java.util.Calendar@w{ }@var{cal}) @*throws SQLException
2440 This method returns the specified column value as a
2441 @code{java.sql.Timestamp}. The specified @code{Calendar} is used
2442 to generate a value for the timestamp if the database does not support
2445 @deftypemethod ResultSetMetaData {public int} getColumnCount () @*throws SQLException
2446 This method returns the number of columns in the result set.
2448 @deftypemethod ResultSetMetaData {public boolean} isAutoIncrement (int@w{ }@var{index}) @*throws SQLException
2449 This method test whether or not the column is an auto-increment column.
2450 Auto-increment columns are read-only.
2452 @deftypemethod ResultSetMetaData {public boolean} isCaseSensitive (int@w{ }@var{index}) @*throws SQLException
2453 This method tests whether or not a column is case sensitive in its values.
2455 @deftypemethod ResultSetMetaData {public boolean} isSearchable (int@w{ }@var{index}) @*throws SQLException
2456 This method tests whether not the specified column can be used in
2459 @deftypemethod ResultSetMetaData {public boolean} isCurrency (int@w{ }@var{index}) @*throws SQLException
2460 This method tests whether or not the column stores a monetary value.
2462 @deftypemethod ResultSetMetaData {public int} isNullable (int@w{ }@var{index}) @*throws SQLException
2463 This method returns a value indicating whether or not the specified
2464 column may contain a NULL value.
2466 @deftypemethod ResultSetMetaData {public boolean} isSigned (int@w{ }@var{index}) @*throws SQLException
2467 This method tests whether or not the value of the specified column
2468 is signed or unsigned.
2470 @deftypemethod ResultSetMetaData {public int} getColumnDisplaySize (int@w{ }@var{index}) @*throws SQLException
2471 This method returns the maximum number of characters that can be used
2472 to display a value in this column.
2474 @deftypemethod ResultSetMetaData {public String} getColumnLabel (int@w{ }@var{index}) @*throws SQLException
2475 This method returns a string that should be used as a caption for this
2476 column for user display purposes.
2478 @deftypemethod ResultSetMetaData {public String} getColumnName (int@w{ }@var{index}) @*throws SQLException
2479 This method returns the name of the specified column.
2481 @deftypemethod ResultSetMetaData {public String} getSchemaName (int@w{ }@var{index}) @*throws SQLException
2482 This method returns the name of the schema that contains the specified
2485 @deftypemethod ResultSetMetaData {public int} getPrecision (int@w{ }@var{index}) @*throws SQLException
2486 This method returns the precision of the specified column, which is the
2487 number of decimal digits it contains.
2489 @deftypemethod ResultSetMetaData {public int} getScale (int@w{ }@var{index}) @*throws SQLException
2490 This method returns the scale of the specified column, which is the
2491 number of digits to the right of the decimal point.
2493 @deftypemethod ResultSetMetaData {public String} getTableName (int@w{ }@var{index}) @*throws SQLException
2494 This method returns the name of the table containing the specified
2497 @deftypemethod ResultSetMetaData {public String} getCatalogName (int@w{ }@var{index}) @*throws SQLException
2498 This method returns the name of the catalog containing the specified
2501 @deftypemethod ResultSetMetaData {public int} getColumnType (int@w{ }@var{index}) @*throws SQLException
2502 This method returns the SQL type of the specified column. This will
2503 be one of the constants from @code{Types}.
2505 @deftypemethod ResultSetMetaData {public String} getColumnTypeName (int@w{ }@var{index}) @*throws SQLException
2506 This method returns the name of the SQL type for this column.
2508 @deftypemethod ResultSetMetaData {public boolean} isReadOnly (int@w{ }@var{index}) @*throws SQLException
2509 This method tests whether or not the specified column is read only.
2511 @deftypemethod ResultSetMetaData {public boolean} isWritable (int@w{ }@var{index}) @*throws SQLException
2512 This method tests whether or not the column may be writable. This
2513 does not guarantee that a write will be successful.
2515 @deftypemethod ResultSetMetaData {public boolean} isDefinitelyWritable (int@w{ }@var{index}) @*throws SQLException
2516 This method tests whether or not the column is writable. This
2517 does guarantee that a write will be successful.
2519 @deftypemethod ResultSetMetaData {public String} getColumnClassName (int@w{ }@var{index}) @*throws SQLException
2520 This method returns the name of the Java class which will be used to
2521 create objects representing the data in this column.
2523 @deftypemethod SQLData {public String} getSQLTypeName () @*throws SQLException
2524 This method returns the user defined datatype name for this object.
2526 @deftypemethod SQLData {public void} readSQL (java.sql.SQLInput@w{ }@var{stream}, java.lang.String@w{ }@var{name}) @*throws SQLException
2527 This method populates the data in the object from the specified stream.
2529 @deftypemethod SQLData {public void} writeSQL (java.sql.SQLOutput@w{ }@var{stream}) @*throws SQLException
2530 This method writes the data in this object to the specified stream.
2532 @deftypemethod SQLException {public String} getSQLState ()
2533 This method returns the SQLState information associated with this
2534 error. The value returned is a @code{String} which is formatted
2535 using the XOPEN SQL state conventions.
2537 @deftypemethod SQLException {public int} getErrorCode ()
2538 This method returns the vendor specific error code associated with
2541 @deftypemethod SQLException {public SQLException} getNextException ()
2542 This method returns the exception that is chained to this object.
2544 @deftypemethod SQLException {public void} setNextException (java.sql.SQLException@w{ }@var{e})
2545 This method adds a new exception to the end of the chain of exceptions
2546 that are chained to this object.
2548 @deftypemethod SQLInput {public String} readString () @*throws SQLException
2549 This method reads the next item from the stream a Java
2552 @deftypemethod SQLInput {public boolean} readBoolean () @*throws SQLException
2553 This method reads the next item from the stream a Java
2556 @deftypemethod SQLInput {public byte} readByte () @*throws SQLException
2557 This method reads the next item from the stream a Java
2560 @deftypemethod SQLInput {public short} readShort () @*throws SQLException
2561 This method reads the next item from the stream a Java
2564 @deftypemethod SQLInput {public int} readInt () @*throws SQLException
2565 This method reads the next item from the stream a Java
2568 @deftypemethod SQLInput {public long} readLong () @*throws SQLException
2569 This method reads the next item from the stream a Java
2572 @deftypemethod SQLInput {public float} readFloat () @*throws SQLException
2573 This method reads the next item from the stream a Java
2576 @deftypemethod SQLInput {public double} readDouble () @*throws SQLException
2577 This method reads the next item from the stream a Java
2580 @deftypemethod SQLInput {public BigDecimal} readBigDecimal () @*throws SQLException
2581 This method reads the next item from the stream a Java
2584 @deftypemethod SQLInput {public byte} readBytes () @*throws SQLException
2585 This method reads the next item from the stream a Java
2588 @deftypemethod SQLInput {public Date} readDate () @*throws SQLException
2589 This method reads the next item from the stream a Java
2590 @code{java.sql.Date}.
2592 @deftypemethod SQLInput {public Time} readTime () @*throws SQLException
2593 This method reads the next item from the stream a Java
2594 @code{java.sql.Time}.
2596 @deftypemethod SQLInput {public Timestamp} readTimestamp () @*throws SQLException
2597 This method reads the next item from the stream a Java
2598 @code{java.sql.Timestamp}.
2600 @deftypemethod SQLInput {public InputStream} readAsciiStream () @*throws SQLException
2601 This method reads the next item from the stream a ASCII text
2604 @deftypemethod SQLInput {public InputStream} readBinaryStream () @*throws SQLException
2605 This method reads the next item from the stream a binary
2608 @deftypemethod SQLInput {public Reader} readCharacterStream () @*throws SQLException
2609 This method reads the next item from the stream a character
2612 @deftypemethod SQLInput {public Object} readObject () @*throws SQLException
2613 This method reads the next item from the stream a Java
2616 @deftypemethod SQLInput {public Ref} readRef () @*throws SQLException
2617 This method reads the next item from the stream a Java SQL
2620 @deftypemethod SQLInput {public Blob} readBlob () @*throws SQLException
2621 This method reads the next item from the stream a Java SQL
2624 @deftypemethod SQLInput {public Clob} readClob () @*throws SQLException
2625 This method reads the next item from the stream a Java SQL
2628 @deftypemethod SQLInput {public Array} readArray () @*throws SQLException
2629 This method reads the next item from the stream a Java SQL
2632 @deftypemethod SQLInput {public boolean} wasNull () @*throws SQLException
2633 This method tests whether or not the last value read was a SQL
2636 @deftypemethod SQLOutput {public void} writeString (java.lang.String@w{ }@var{value}) @*throws SQLException
2637 This method writes the specified Java @code{String}
2640 @deftypemethod SQLOutput {public void} writeBoolean (boolean@w{ }@var{value}) @*throws SQLException
2641 This method writes the specified Java @code{boolean}
2644 @deftypemethod SQLOutput {public void} writeByte (byte@w{ }@var{value}) @*throws SQLException
2645 This method writes the specified Java @code{byte}
2648 @deftypemethod SQLOutput {public void} writeShort (short@w{ }@var{value}) @*throws SQLException
2649 This method writes the specified Java @code{short}
2652 @deftypemethod SQLOutput {public void} writeInt (int@w{ }@var{value}) @*throws SQLException
2653 This method writes the specified Java @code{int}
2656 @deftypemethod SQLOutput {public void} writeLong (long@w{ }@var{value}) @*throws SQLException
2657 This method writes the specified Java @code{long}
2660 @deftypemethod SQLOutput {public void} writeFloat (float@w{ }@var{value}) @*throws SQLException
2661 This method writes the specified Java @code{float}
2664 @deftypemethod SQLOutput {public void} writeDouble (double@w{ }@var{value}) @*throws SQLException
2665 This method writes the specified Java @code{double}
2668 @deftypemethod SQLOutput {public void} writeBigDecimal (java.math.BigDecimal@w{ }@var{value}) @*throws SQLException
2669 This method writes the specified Java @code{BigDecimal}
2672 @deftypemethod SQLOutput {public void} writeBytes (byte[]@w{ }@var{value}) @*throws SQLException
2673 This method writes the specified Java @code{byte} array
2676 @deftypemethod SQLOutput {public void} writeDate (java.sql.Date@w{ }@var{value}) @*throws SQLException
2677 This method writes the specified Java @code{java.sql.Date}
2680 @deftypemethod SQLOutput {public void} writeTime (java.sql.Time@w{ }@var{value}) @*throws SQLException
2681 This method writes the specified Java @code{java.sql.Time}
2684 @deftypemethod SQLOutput {public void} writeTimestamp (java.sql.Timestamp@w{ }@var{value}) @*throws SQLException
2685 This method writes the specified Java @code{java.sql.Timestamp}
2688 @deftypemethod SQLOutput {public void} writeCharacterStream (java.io.Reader@w{ }@var{value}) @*throws SQLException
2689 This method writes the specified Java character stream
2692 @deftypemethod SQLOutput {public void} writeBinaryStream (java.io.InputStream@w{ }@var{value}) @*throws SQLException
2693 This method writes the specified uninterpreted binary byte stream
2696 @deftypemethod SQLOutput {public void} writeAsciiStream (java.io.InputStream@w{ }@var{value}) @*throws SQLException
2697 This method writes the specified ASCII text stream
2700 @deftypemethod SQLOutput {public void} writeObject (java.sql.SQLData@w{ }@var{value}) @*throws SQLException
2701 This method writes the specified Java @code{SQLData} object
2704 @deftypemethod SQLOutput {public void} writeRef (java.sql.Ref@w{ }@var{value}) @*throws SQLException
2705 This method writes the specified Java SQL @code{Ref} object
2708 @deftypemethod SQLOutput {public void} writeBlob (java.sql.Blob@w{ }@var{value}) @*throws SQLException
2709 This method writes the specified Java SQL @code{Blob} object
2712 @deftypemethod SQLOutput {public void} writeClob (java.sql.Clob@w{ }@var{value}) @*throws SQLException
2713 This method writes the specified Java SQL @code{Clob} object
2716 @deftypemethod SQLOutput {public void} writeStruct (java.sql.Struct@w{ }@var{value}) @*throws SQLException
2717 This method writes the specified Java SQL @code{Struct} object
2720 @deftypemethod SQLOutput {public void} writeArray (java.sql.Array@w{ }@var{value}) @*throws SQLException
2721 This method writes the specified Java SQL @code{Array} object
2724 @deftypemethod SQLWarning {public SQLWarning} getNextWarning ()
2725 This method returns the exception that is chained to this object.
2727 @deftypemethod SQLWarning {public void} setNextWarning (java.sql.SQLWarning@w{ }@var{e})
2728 This method adds a new exception to the end of the chain of exceptions
2729 that are chained to this object.
2731 @deftypemethod Statement {public ResultSet} executeQuery (java.lang.String@w{ }@var{sql}) @*throws SQLException
2732 This method executes the specified SQL SELECT statement and returns a
2733 (possibly empty) @code{ResultSet} with the results of the query.
2735 @deftypemethod Statement {public int} executeUpdate (java.lang.String@w{ }@var{sql}) @*throws SQLException
2736 This method executes the specified SQL INSERT, UPDATE, or DELETE statement
2737 and returns the number of rows affected, which may be 0.
2739 @deftypemethod Statement {public void} close () @*throws SQLException
2740 This method closes the statement and frees any associated resources.
2742 @deftypemethod Statement {public int} getMaxFieldSize () @*throws SQLException
2743 This method returns the maximum length of any column value in bytes.
2745 @deftypemethod Statement {public void} setMaxFieldSize (int@w{ }@var{maxsize}) @*throws SQLException
2746 This method sets the limit for the maximum length of any column in bytes.
2748 @deftypemethod Statement {public int} getMaxRows () @*throws SQLException
2749 This method returns the maximum possible number of rows in a result set.
2751 @deftypemethod Statement {public void} setMaxRows (int@w{ }@var{maxrows}) @*throws SQLException
2752 This method sets the maximum number of rows that can be present in a
2755 @deftypemethod Statement {public void} setEscapeProcessing (boolean@w{ }@var{esacpe}) @*throws SQLException
2756 This method sets the local escape processing mode on or off. The
2757 default value is on.
2759 @deftypemethod Statement {public int} getQueryTimeout () @*throws SQLException
2760 The method returns the number of seconds a statement may be in process
2761 before timing out. A value of 0 means there is no timeout.
2763 @deftypemethod Statement {public void} setQueryTimeout (int@w{ }@var{timeout}) @*throws SQLException
2764 This method sets the number of seconds a statement may be in process
2765 before timing out. A value of 0 means there is no timeout.
2767 @deftypemethod Statement {public void} cancel () @*throws SQLException
2768 This method cancels an outstanding statement, if the database supports
2771 @deftypemethod Statement {public SQLWarning} getWarnings () @*throws SQLException
2772 This method returns the first SQL warning attached to this statement.
2773 Subsequent warnings will be chained to this one.
2775 @deftypemethod Statement {public void} clearWarnings () @*throws SQLException
2776 This method clears any SQL warnings that have been attached to this
2779 @deftypemethod Statement {public void} setCursorName (java.lang.String@w{ }@var{name}) @*throws SQLException
2780 This method sets the cursor name that will be used by the result set.
2782 @deftypemethod Statement {public boolean} execute (java.lang.String@w{ }@var{sql}) @*throws SQLException
2783 This method executes an arbitrary SQL statement of any time. The
2784 methods @code{getResultSet}, @code{getMoreResults} and
2785 @code{getUpdateCount} retrieve the results.
2787 @deftypemethod Statement {public ResultSet} getResultSet () @*throws SQLException
2788 This method returns the result set of the SQL statement that was
2789 executed. This should be called only once per result set returned.
2791 @deftypemethod Statement {public int} getUpdateCount () @*throws SQLException
2792 This method returns the update count of the SQL statement that was
2793 executed. This should be called only once per executed SQL statement.
2795 @deftypemethod Statement {public boolean} getMoreResults () @*throws SQLException
2796 This method advances the result set pointer to the next result set,
2797 which can then be retrieved using @code{getResultSet}
2799 @deftypemethod Statement {public int} getFetchDirection () @*throws SQLException
2800 This method returns the current direction that the driver thinks the
2801 result set will be accessed int.
2803 @deftypemethod Statement {public void} setFetchDirection (int@w{ }@var{direction}) @*throws SQLException
2804 This method informs the driver which direction the result set will
2807 @deftypemethod Statement {public int} getFetchSize () @*throws SQLException
2808 This method returns the number of rows the driver believes should be
2809 fetched from the database at a time.
2811 @deftypemethod Statement {public void} setFetchSize (int@w{ }@var{numrows}) @*throws SQLException
2812 This method informs the driver how many rows it should fetch from the
2815 @deftypemethod Statement {public int} getResultSetConcurrency () @*throws SQLException
2816 This method returns the concurrency type of the result set for this
2817 statement. This will be one of the concurrency types defined in
2820 @deftypemethod Statement {public int} getResultSetType () @*throws SQLException
2821 This method returns the result set type for this statement. This will
2822 be one of the result set types defined in @code{ResultSet}.
2824 @deftypemethod Statement {public void} addBatch (java.lang.String@w{ }@var{sql}) @*throws SQLException
2825 This method adds a SQL statement to a SQL batch. A driver is not
2826 required to implement this method.
2828 @deftypemethod Statement {public void} clearBatch () @*throws SQLException
2829 This method clears out any SQL statements that have been populated in
2830 the current batch. A driver is not required to implement this method.
2832 @deftypemethod Statement {public int} executeBatch () @*throws SQLException
2833 This method executes the SQL batch and returns an array of update
2834 counts - one for each SQL statement in the batch - ordered in the same
2835 order the statements were added to the batch. A driver is not required
2836 to implement this method.
2838 @deftypemethod Statement {public Connection} getConnection () @*throws SQLException
2839 This method returns the @code{Connection} instance that was
2840 used to create this object.
2842 @deftypemethod Struct {public String} getSQLTypeName () @*throws SQLException
2843 This method returns the name of the SQL structured type for this
2846 @deftypemethod Struct {public Object} getAttributes () @*throws SQLException
2847 This method returns the attributes of this SQL structured type.
2849 @deftypemethod Struct {public Object} getAttributes (java.util.Map@w{ }@var{map}) @*throws SQLException
2850 This method returns the attributes of this SQL structured type.
2851 The specified map of type mappings overrides the default mappings.
2853 @deftypemethod Time {public static Time} valueOf (java.lang.String@w{ }@var{str})
2854 This method returns a new instance of this class by parsing a
2855 date in JDBC format into a Java date.
2857 @deftypemethod Time {public String} toString ()
2858 This method returns this date in JDBC format.
2860 @deftypemethod Timestamp {public static Timestamp} valueOf (java.lang.String@w{ }@var{str})
2861 This method returns a new instance of this class by parsing a
2862 date in JDBC format into a Java date.
2864 @deftypemethod Timestamp {public String} toString ()
2865 This method returns this date in JDBC format.
2867 @deftypemethod Timestamp {public int} getNanos ()
2868 This method returns the nanosecond value for this object.
2870 @deftypemethod Timestamp {public void} setNanos (int@w{ }@var{nanos})
2871 This method sets the nanosecond value for this object.
2873 @deftypemethod Timestamp {public boolean} before (java.sql.Timestamp@w{ }@var{ts})
2874 This methods tests whether this object is earlier than the specified
2877 @deftypemethod Timestamp {public boolean} after (java.sql.Timestamp@w{ }@var{ts})
2878 This methods tests whether this object is later than the specified
2881 @deftypemethod Timestamp {public boolean} equals (java.lang.Object@w{ }@var{obj})
2882 This method these the specified @code{Object} for equality
2883 against this object. This will be true if an only if the specified
2884 object is an instance of @code{Timestamp} and has the same
2887 @deftypemethod Timestamp {public boolean} equals (java.sql.Timestamp@w{ }@var{ts})
2888 This method tests the specified timestamp for equality against this
2889 object. This will be true if and only if the specified object is
2890 not @code{null} and contains all the same time value fields