net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData Maven / Gradle / Ivy
package net.sourceforge.squirrel_sql.fw.sql;
/*
* Copyright (C) 2007 Rob Manning
* [email protected]
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
import java.sql.DatabaseMetaData;
import java.sql.SQLException;
import java.util.List;
import net.sourceforge.squirrel_sql.fw.datasetviewer.DataSetException;
import net.sourceforge.squirrel_sql.fw.datasetviewer.IDataSet;
import net.sourceforge.squirrel_sql.fw.datasetviewer.ResultSetDataSet;
import net.sourceforge.squirrel_sql.fw.sql.dbobj.BestRowIdentifier;
/**
* An interface that describes public API of SQLDatabaseMetaData.
*
* @author manningr
*/
public interface ISQLDatabaseMetaData {
/**
* Return the name of the current user. Cached on first call.
*
* @return the current user name.
*/
String getUserName() throws SQLException;
/**
* Return the database product name for this connection. Cached on first
* call.
*
* @return the database product name for this connection.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
String getDatabaseProductName() throws SQLException;
/**
* Return the database product version for this connection. Cached on first
* call.
*
* @return database product version
*
* @throws SQLException Thrown if an SQL error occurs.
*/
String getDatabaseProductVersion() throws SQLException;
/**
* Return the database major version for this connection. Cached on first
* call.
*
* @return database major version
*
* @throws SQLException Thrown if an SQL error occurs.
*/
int getDatabaseMajorVersion() throws SQLException;
/**
* Return the JDBC driver name for this connection. Cached on first call.
*
* @return the JDBC driver name for this connection.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
String getDriverName() throws SQLException;
/**
* Return the JDBC version of this driver. Cached on first call.
*
* @return the JDBC version of the driver.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
int getJDBCVersion() throws SQLException;
/**
* Return the string used to quote characters in this DBMS. Cached on first
* call.
*
* @return quote string.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
String getIdentifierQuoteString() throws SQLException;
/**
* Returns the "cascade" constraints clause which is supported by some
* databases when performing a delete to removed child records in dependent
* tables which would otherwise be orphaned and make the delete fail.
*
* @return the "cascade" clause.
*
* @throws SQLException
*/
String getCascadeClause() throws SQLException;
/**
* Return a string array containing the names of all the schemas in the
* database. Cached on first call.
*
* @return String[] of the names of the schemas in the database.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
String[] getSchemas() throws SQLException;
/**
* Retrieves whether this database supports schemas at all.
*
* @return true if database supports schemas.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean supportsSchemas() throws SQLException;
/**
* Retrieves whether a schema name can be used in a data manipulation
* statement. Cached on first call.
*
* @return true if a schema name can be used in a data
* manipulation statement.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean supportsSchemasInDataManipulation() throws SQLException;
/**
* Retrieves whether a schema name can be used in a table definition
* statement. Cached on first call.
*
* @return true if a schema name can be used in a table
* definition statement.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean supportsSchemasInTableDefinitions() throws SQLException;
/**
* Retrieves whether this DBMS supports stored procedures. Cached on first
* call.
*
* @return true if DBMS supports stored procedures.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean supportsStoredProcedures() throws SQLException;
/**
* Retrieves whether this DBMS supports save points. Cached on first
* call.
*
* @return true if DBMS supports save points.
*
* @throws SQLException if an SQL error occurs.
*/
boolean supportsSavepoints() throws SQLException;
/**
* Retrieves whether this DBMS supports result sets of the specified type.
* Cached on first call.
*
* @param type the type of the ResultSet. There are constants defined in
* the ResultSet class that define the different types.
*
* @return true if DBMS supports this type of ResultSet.
*
* @throws SQLException if an SQL error occurs.
*/
boolean supportsResultSetType(int type) throws SQLException;
/**
* Return a string array containing the names of all the catalogs in the
* database. Cached on first call.
*
* @return String[] of the names of the catalogs in the database.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
String[] getCatalogs() throws SQLException;
/**
* Retrieves the URL for this DBMS.
*
* @return the URL for this DBMS or null if it cannot be generated
*
* @throws SQLException if a database access error occurs
*/
String getURL() throws SQLException;
/**
* Retrieves the database vendor's preferred term for "catalog".
*
* @return the vendor term for "catalog"
*
* @throws SQLException if a database access error occurs
*/
String getCatalogTerm() throws SQLException;
/**
* Retrieves the database vendor's preferred term for "schema".
*
* @return the vendor term for "schema"
*
* @throws SQLException if a database access error occurs
*/
String getSchemaTerm() throws SQLException;
/**
* Retrieves the database vendor's preferred term for "procedure".
*
* @return the vendor term for "procedure"
*
* @throws SQLException if a database access error occurs
*/
String getProcedureTerm() throws SQLException;
/**
* Retrieves the String that this database uses as the separator between a
* catalog and table name. Cached on first call.
*
* @return The separator character.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
String getCatalogSeparator() throws SQLException;
/**
* Retrieves whether this database supports catalogs at all.
*
* @return true fi database supports catalogs.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean supportsCatalogs() throws SQLException;
/**
* Retrieves whether a catalog name can be used in a table definition
* statement. Cached on first call.
*
* @return true if a catalog name can be used in a table
* definition statement.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean supportsCatalogsInTableDefinitions() throws SQLException;
/**
* Retrieves whether a catalog name can be used in a data manipulation
* statement. Cached on first call.
*
* @return true if a catalog name can be used in a data
* manipulation statement.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean supportsCatalogsInDataManipulation() throws SQLException;
/**
* Retrieves whether a catalog name can be used in a procedure call. Cached
* on first call.
*
* @return true if a catalog name can be used in a procedure
* call.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean supportsCatalogsInProcedureCalls() throws SQLException;
/**
* Return the DatabaseMetaData object for this connection.
*
* @return The DatabaseMetaData object for this connection.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
DatabaseMetaData getJDBCMetaData() throws SQLException;
/**
*
* @return
* @throws SQLException
*/
IDataSet getMetaDataSet() throws SQLException;
/**
*
* @return
* @throws DataSetException
*/
IDataSet getTypesDataSet() throws DataSetException;
/**
* Retrieve information about the data types in the database.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
DataTypeInfo[] getDataTypes() throws SQLException;
/**
* NOTE: This method should only be used by SchemaInfo since this class should not and does not cache.
*
* Retrieve information about the procedures in the system.
*/
IProcedureInfo[] getProcedures(String catalog, String schemaPattern,
String procedureNamePattern, ProgressCallBack progressCallBack)
throws SQLException;
/**
* Return a string array containing the different types of tables in this
* database. E.G. "TABLE", "VIEW", "SYSTEM TABLE". Cached on first
* call.
*
* @return table type names.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
String[] getTableTypes() throws SQLException;
/**
* NOTE: This method should only be used by SchemaInfo since this class sholud not and does not cache.
*
* Retrieve information about the tables in the system.
*/
ITableInfo[] getTables(String catalog, String schemaPattern,
String tableNamePattern, String[] types,
ProgressCallBack progressCallBack) throws SQLException;
/**
* Retrieve information about the UDTs in the system.
*
* @param catalog The name of the catalog to retrieve UDTs
* for. An empty string will return those without a
* catalog. null means that the catalog
* will not be used to narrow the search.
* @param schemaPattern The name of the schema to retrieve UDTs
* for. An empty string will return those without a
* schema. null means that the schema
* will not be used to narrow the search.
* @param typeNamepattern A type name pattern; must match the
* type name as it is stored in the
* database.
* @param types List of user-defined types (JAVA_OBJECT, STRUCT, or
* DISTINCT) to include; null returns all types
*
* @throws SQLException Thrown if an SQL error occurs.
*/
IUDTInfo[] getUDTs(String catalog, String schemaPattern,
String typeNamePattern, int[] types) throws SQLException;
/**
* Retrieve the names of the Numeric Functions that this DBMS supports.
* Cached on first call.
*
* @return String[] of function names.
*/
String[] getNumericFunctions() throws SQLException;
/**
* Retrieve the names of the String Functions that this DBMS supports.
* Cached on first call.
*
* @return String[] of function names.
*/
String[] getStringFunctions() throws SQLException;
/**
* Retrieve the names of the System Functions that this DBMS supports.
* Cached on first call.
*
* @return String[] of function names.
*/
String[] getSystemFunctions() throws SQLException;
/**
* Retrieve the names of the Date/Time Functions that this DBMS supports.
* Cached on first call.
*
* @return String[] of function names.
*/
String[] getTimeDateFunctions() throws SQLException;
/**
* Retrieve the names of the non-standard keywords that this DBMS supports.
* Cached on first call.
*
* @return String[] of keywords.
*/
String[] getSQLKeywords() throws SQLException;
BestRowIdentifier[] getBestRowIdentifier(ITableInfo ti) throws SQLException;
/**
*
* @param ti
* @param columnIndices
* @param computeWidths
* @return
* @throws DataSetException
*/
IDataSet getColumnPrivilegesDataSet(ITableInfo ti, int[] columnIndices,
boolean computeWidths) throws DataSetException;
/**
*
* @param ti
* @return
* @throws DataSetException
*/
IDataSet getExportedKeysDataSet(ITableInfo ti) throws DataSetException;
ForeignKeyInfo[] getImportedKeysInfo(String catalog, String schema,
String tableName) throws SQLException;
ForeignKeyInfo[] getImportedKeysInfo(ITableInfo ti) throws SQLException;
IDataSet getImportedKeysDataSet(ITableInfo ti) throws DataSetException;
ForeignKeyInfo[] getExportedKeysInfo(String catalog, String schema,
String tableName) throws SQLException;
ForeignKeyInfo[] getExportedKeysInfo(ITableInfo ti) throws SQLException;
/**
*
* @param ti
* @param columnIndices
* @param computeWidths
* @return
* @throws DataSetException
*/
ResultSetDataSet getIndexInfo(ITableInfo ti, int[] columnIndices,
boolean computeWidths) throws DataSetException;
/**
* Returns a list of IndexInfos describing indexes for the specified table.
*
* @param ti the table to find all index information for.
* @return a list of IndexInfos
* @throws SQLException
*/
public List getIndexInfo(ITableInfo ti) throws SQLException;
/**
*
* @param ti
* @param columnIndices
* @param computeWidths
* @return
* @throws DataSetException
*/
IDataSet getPrimaryKey(ITableInfo ti, int[] columnIndices,
boolean computeWidths) throws DataSetException;
/**
*
* @param ti
* @return
* @throws SQLException
*/
PrimaryKeyInfo[] getPrimaryKey(ITableInfo ti) throws SQLException;
/**
*
* @param ti
* @return
* @throws SQLException
*/
PrimaryKeyInfo[] getPrimaryKey(String catalog, String schema, String table)
throws SQLException;
/**
*
* @param ti
* @return
* @throws DataSetException
*/
IDataSet getProcedureColumnsDataSet(IProcedureInfo ti)
throws DataSetException;
/**
*
* @param ti
* @param columnIndices
* @param computeWidths
* @return
* @throws DataSetException
*/
IDataSet getTablePrivilegesDataSet(ITableInfo ti, int[] columnIndices,
boolean computeWidths) throws DataSetException;
/**
*
* @param ti
* @return
* @throws DataSetException
*/
IDataSet getVersionColumnsDataSet(ITableInfo ti) throws DataSetException;
/**
*
* @param ti
* @param columnIndices
* @param computeWidths
* @return
* @throws DataSetException
*/
IDataSet getColumns(ITableInfo ti, int[] columnIndices,
boolean computeWidths) throws DataSetException;
/**
*
* @param catalog
* @param schema
* @param table
* @return
* @throws SQLException
*/
TableColumnInfo[] getColumnInfo(String catalog, String schema, String table)
throws SQLException;
/**
*
* @param ti
* @return
* @throws SQLException
*/
TableColumnInfo[] getColumnInfo(ITableInfo ti) throws SQLException;
/**
* Retrieve whether this driver correctly handles Statement.setMaxRows(int).
* Some drivers such as version 5.02 of the Opta2000 driver use setMaxRows
* for UPDATEs, DELETEs etc. instead of just SELECTs. If this method returns
* false then setMaxRows should only be applied to statements
* that are running SELECTs.
*
* @return true if this driver correctly implements setMaxRows().
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean correctlySupportsSetMaxRows() throws SQLException;
/**
* Retrieve whether this driver supports multiple result sets. Cached on
* first call.
*
* @return true if driver supports multiple result sets
* else false.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean supportsMultipleResultSets() throws SQLException;
/**
* Retrieves whether this database treats mixed case unquoted SQL
* identifiers as case insensitive and stores them in upper case.
* Cached on first call.
*
* @return true if driver stores upper case identifiers
* else false.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
boolean storesUpperCaseIdentifiers() throws SQLException;
/**
* Clear cache of commonly accessed metadata properties.
*/
void clearCache();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy