< prev index next >

src/java.sql/share/classes/java/sql/DatabaseMetaData.java

Print this page




  51  * <P>
  52  * Some <code>DatabaseMetaData</code> methods return lists of information
  53  * in the form of <code>ResultSet</code> objects.
  54  * Regular <code>ResultSet</code> methods, such as
  55  * <code>getString</code> and <code>getInt</code>, can be used
  56  * to retrieve the data from these <code>ResultSet</code> objects.  If
  57  * a given form of metadata is not available, an empty <code>ResultSet</code>
  58  * will be returned. Additional columns beyond the columns defined to be
  59  * returned by the <code>ResultSet</code> object for a given method
  60  * can be defined by the JDBC driver vendor and must be accessed
  61  * by their <B>column label</B>.
  62  * <P>
  63  * Some <code>DatabaseMetaData</code> methods take arguments that are
  64  * String patterns.  These arguments all have names such as fooPattern.
  65  * Within a pattern String, "%" means match any substring of 0 or more
  66  * characters, and "_" means match any one character. Only metadata
  67  * entries matching the search pattern are returned. If a search pattern
  68  * argument is set to <code>null</code>, that argument's criterion will
  69  * be dropped from the search.
  70  *

  71  */
  72 public interface DatabaseMetaData extends Wrapper {
  73 
  74     //----------------------------------------------------------------------
  75     // First, a variety of minor information about the target database.
  76 
  77     /**
  78      * Retrieves whether the current user can call all the procedures
  79      * returned by the method <code>getProcedures</code>.
  80      *
  81      * @return <code>true</code> if so; <code>false</code> otherwise
  82      * @exception SQLException if a database access error occurs
  83      */
  84     boolean allProceduresAreCallable() throws SQLException;
  85 
  86     /**
  87      * Retrieves whether the current user can use all the tables returned
  88      * by the method <code>getTables</code> in a <code>SELECT</code>
  89      * statement.
  90      *




  51  * <P>
  52  * Some <code>DatabaseMetaData</code> methods return lists of information
  53  * in the form of <code>ResultSet</code> objects.
  54  * Regular <code>ResultSet</code> methods, such as
  55  * <code>getString</code> and <code>getInt</code>, can be used
  56  * to retrieve the data from these <code>ResultSet</code> objects.  If
  57  * a given form of metadata is not available, an empty <code>ResultSet</code>
  58  * will be returned. Additional columns beyond the columns defined to be
  59  * returned by the <code>ResultSet</code> object for a given method
  60  * can be defined by the JDBC driver vendor and must be accessed
  61  * by their <B>column label</B>.
  62  * <P>
  63  * Some <code>DatabaseMetaData</code> methods take arguments that are
  64  * String patterns.  These arguments all have names such as fooPattern.
  65  * Within a pattern String, "%" means match any substring of 0 or more
  66  * characters, and "_" means match any one character. Only metadata
  67  * entries matching the search pattern are returned. If a search pattern
  68  * argument is set to <code>null</code>, that argument's criterion will
  69  * be dropped from the search.
  70  *
  71  * @since 1.1
  72  */
  73 public interface DatabaseMetaData extends Wrapper {
  74 
  75     //----------------------------------------------------------------------
  76     // First, a variety of minor information about the target database.
  77 
  78     /**
  79      * Retrieves whether the current user can call all the procedures
  80      * returned by the method <code>getProcedures</code>.
  81      *
  82      * @return <code>true</code> if so; <code>false</code> otherwise
  83      * @exception SQLException if a database access error occurs
  84      */
  85     boolean allProceduresAreCallable() throws SQLException;
  86 
  87     /**
  88      * Retrieves whether the current user can use all the tables returned
  89      * by the method <code>getTables</code> in a <code>SELECT</code>
  90      * statement.
  91      *


< prev index next >