jdk-sandbox: comparison jdk/src/share/classes/java/sql/DatabaseMetaData.java

equal deleted inserted replaced

-:874f52171965
+:a4ae668f6125
 /*
-* Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights reserved.
+* Copyright (c) 1996, 2010, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 *ordinal position of the column in the result set starting from 1.  If there are
 *multiple result sets, the column ordinal positions are implementation
 * defined.
 *  <LI><B>IS_NULLABLE</B> String  => ISO rules are used to determine the nullability for a column.
 *       <UL>
-*       <LI> YES           --- if the parameter can include NULLs
+*       <LI> YES           --- if the column can include NULLs
-*       <LI> NO            --- if the parameter cannot include NULLs
+*       <LI> NO            --- if the column cannot include NULLs
 *       <LI> empty string  --- if the nullability for the
-* parameter is unknown
+* column is unknown
 *       </UL>
 *  <LI><B>SPECIFIC_NAME</B> String  => the name which uniquely identifies this procedure within its schema.
 *  </OL>
 *
 * <P><B>Note:</B> Some databases may not return the column
 *       maximum number of bytes in the column
 *  <LI><B>ORDINAL_POSITION</B> int => index of column in table
 *      (starting at 1)
 *  <LI><B>IS_NULLABLE</B> String  => ISO rules are used to determine the nullability for a column.
 *       <UL>
-*       <LI> YES           --- if the parameter can include NULLs
+*       <LI> YES           --- if the column can include NULLs
-*       <LI> NO            --- if the parameter cannot include NULLs
+*       <LI> NO            --- if the column cannot include NULLs
 *       <LI> empty string  --- if the nullability for the
-* parameter is unknown
+* column is unknown
 *       </UL>
-*  <LI><B>SCOPE_CATLOG</B> String => catalog of table that is the scope
+*  <LI><B>SCOPE_CATALOG</B> String => catalog of table that is the scope
 *      of a reference attribute (<code>null</code> if DATA_TYPE isn't REF)
 *  <LI><B>SCOPE_SCHEMA</B> String => schema of table that is the scope
 *      of a reference attribute (<code>null</code> if the DATA_TYPE isn't REF)
 *  <LI><B>SCOPE_TABLE</B> String => table name that this the scope
-*      of a reference attribure (<code>null</code> if the DATA_TYPE isn't REF)
+*      of a reference attribute (<code>null</code> if the DATA_TYPE isn't REF)
 *  <LI><B>SOURCE_DATA_TYPE</B> short => source type of a distinct type or user-generated
 *      Ref type, SQL type from java.sql.Types (<code>null</code> if DATA_TYPE
 *      isn't DISTINCT or user-generated REF)
 *   <LI><B>IS_AUTOINCREMENT</B> String  => Indicates whether this column is auto incremented
 *       <UL>
 *       <LI> YES           --- if the column is auto incremented
 *       <LI> NO            --- if the column is not auto incremented
 *       <LI> empty string  --- if it cannot be determined whether the column is auto incremented
-* parameter is unknown
+*       </UL>
+*   <LI><B>IS_GENERATEDCOLUMN</B> String  => Indicates whether this is a generated column
+*       <UL>
+*       <LI> YES           --- if this a generated column
+*       <LI> NO            --- if this not a generated column
+*       <LI> empty string  --- if it cannot be determined whether this is a generated column
 *       </UL>
 *  </OL>
 *
-* <p>The COLUMN_SIZE column the specified column size for the given column.
+* <p>The COLUMN_SIZE column specifies the column size for the given column.
 * For numeric data, this is the maximum precision.  For character data, this is the length in characters.
 * For datetime datatypes, this is the length in characters of the String representation (assuming the
 * maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes.  For the ROWID datatype,
 * this is the length in bytes. Null is returned for data types where the
 * column size is not applicable.
 /**
 * Retrieves whether this database supports statement pooling.
 *
 * @return <code>true</code> if so; <code>false</code> otherwise
-* @throws SQLExcpetion if a database access error occurs
+* @throws SQLException if a database access error occurs
 * @since 1.4
 */
 boolean supportsStatementPooling() throws SQLException;
 //------------------------- JDBC 4.0 -----------------------------------
 * <code>getFunctions</code>.
 * @since 1.6
 */
 int functionReturnsTable    = 2;
+//--------------------------JDBC 4.1 -----------------------------
+/**
+* Retrieves a description of the pseudo or hidden columns available
+* in a given table within the specified catalog and schema.
+* Psuedo or hidden columns may not always be stored within
+* a table and are not visible in a ResultSet unless they are
+* specified in the query's outermost SELECT list. Psuedo or hidden
+* columns may not necessarily be able to be modified. If there are
+* no pseudo or hidden columns, an empty ResultSet is returned.
+*
+* <P>Only column descriptions matching the catalog, schema, table
+* and column name criteria are returned.  They are ordered by
+* <code>TABLE_CAT</code>,<code>TABLE_SCHEM</code>, <code>TABLE_NAME</code>
+* and <code>COLUMN_NAME</code>.
+*
+* <P>Each column description has the following columns:
+*  <OL>
+*  <LI><B>TABLE_CAT</B> String => table catalog (may be <code>null</code>)
+*  <LI><B>TABLE_SCHEM</B> String => table schema (may be <code>null</code>)
+*  <LI><B>TABLE_NAME</B> String => table name
+*  <LI><B>COLUMN_NAME</B> String => column name
+*  <LI><B>DATA_TYPE</B> int => SQL type from java.sql.Types
+*  <LI><B>COLUMN_SIZE</B> int => column size.
+*  <LI><B>DECIMAL_DIGITS</B> int => the number of fractional digits. Null is returned for data types where
+* DECIMAL_DIGITS is not applicable.
+*  <LI><B>NUM_PREC_RADIX</B> int => Radix (typically either 10 or 2)
+*  <LI><B>COLUMN_USAGE</B> String => The allowed usage for the column.  The
+*  value returned will correspond to the enum name returned by {@link PseudoColumnUsage#name PseudoColumnUsage.name()}
+*  <LI><B>REMARKS</B> String => comment describing column (may be <code>null</code>)
+*  <LI><B>CHAR_OCTET_LENGTH</B> int => for char types the
+*       maximum number of bytes in the column
+*  <LI><B>IS_NULLABLE</B> String  => ISO rules are used to determine the nullability for a column.
+*       <UL>
+*       <LI> YES           --- if the column can include NULLs
+*       <LI> NO            --- if the column cannot include NULLs
+*       <LI> empty string  --- if the nullability for the column is unknown
+*       </UL>
+*  </OL>
+*
+* <p>The COLUMN_SIZE column specifies the column size for the given column.
+* For numeric data, this is the maximum precision.  For character data, this is the length in characters.
+* For datetime datatypes, this is the length in characters of the String representation (assuming the
+* maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes.  For the ROWID datatype,
+* this is the length in bytes. Null is returned for data types where the
+* column size is not applicable.
+*
+* @param catalog a catalog name; must match the catalog name as it
+*        is stored in the database; "" retrieves those without a catalog;
+*        <code>null</code> means that the catalog name should not be used to narrow
+*        the search
+* @param schemaPattern a schema name pattern; must match the schema name
+*        as it is stored in the database; "" retrieves those without a schema;
+*        <code>null</code> means that the schema name should not be used to narrow
+*        the search
+* @param tableNamePattern a table name pattern; must match the
+*        table name as it is stored in the database
+* @param columnNamePattern a column name pattern; must match the column
+*        name as it is stored in the database
+* @return <code>ResultSet</code> - each row is a column description
+* @exception SQLException if a database access error occurs
+* @see PseudoColumnUsage
+* @since 1.7
+*/
+ResultSet getPseudoColumns(String catalog, String schemaPattern,
+String tableNamePattern, String columnNamePattern)
+throws SQLException;
+/**
+* Retrieves whether a generated key will always be returned if the column
+* name(s) or indexe(s) specified for the auto generated key column(s)
+* are valid and the statement succeeds.  The key that is returned may or
+* may not be based on the column(s) for the auto generated key.
+* Consult your JDBC driver documentation for additional details.
+* @return <code>true</code> if so; <code>false</code> otherwise
+* @exception SQLException if a database access error occurs
+* @since 1.7
+*/
+boolean  generatedKeyAlwaysReturned() throws SQLException;
 }

changeset 6540	a4ae668f6125
parent 5506	202f599c92aa
child 6541	a40c440705b3