Java Doc for ISQLDatabaseMetaData.java in » Database-Client » squirrel-sql-2.6.5a » net » sourceforge » squirrel_sql » fw » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database Client » squirrel sql 2.6.5a » net.sourceforge.squirrel_sql.fw.sql

Source Cross Reference Class Diagram Java Document (Java Doc)

net.sourceforge.squirrel_sql.fw.sql .ISQLDatabaseMetaData

All known Subclasses:   net.sourceforge.squirrel_sql.fw.sql .MockSQLDatabaseMetaData,  net.sourceforge.squirrel_sql.fw.sql .SQLDatabaseMetaData,
ISQLDatabaseMetaData
public interface ISQLDatabaseMetaData (Code)
An interface that describes public API of SQLDatabaseMetaData.
author:
   manningr

Method Summary
void clearCache()
     Clear cache of commonly accessed metadata properties.
boolean correctlySupportsSetMaxRows()
     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.
BestRowIdentifier[] getBestRowIdentifier(ITableInfo ti)

String getCascadeClause()
     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.
String getCatalogSeparator()
     Retrieves the String that this database uses as the separator between a catalog and table name.
String getCatalogTerm()
     Retrieves the database vendor's preferred term for "catalog".
String[] getCatalogs()
     Return a string array containing the names of all the catalogs in the database.
TableColumnInfo[] getColumnInfo(String catalog, String schema, String table)

TableColumnInfo[] getColumnInfo(ITableInfo ti)

IDataSet getColumnPrivilegesDataSet(ITableInfo ti, int[] columnIndices, boolean computeWidths)

IDataSet getColumns(ITableInfo ti, int[] columnIndices, boolean computeWidths)

DataTypeInfo[] getDataTypes()
     Retrieve information about the data types in the database.
int getDatabaseMajorVersion()
     Return the database major version for this connection.
String getDatabaseProductName()
     Return the database product name for this connection.
String getDatabaseProductVersion()
     Return the database product version for this connection.
String getDriverName()
     Return the JDBC driver name for this connection.
IDataSet getExportedKeysDataSet(ITableInfo ti)

ForeignKeyInfo[] getExportedKeysInfo(String catalog, String schema, String tableName)

ForeignKeyInfo[] getExportedKeysInfo(ITableInfo ti)

String getIdentifierQuoteString()
     Return the string used to quote characters in this DBMS.
IDataSet getImportedKeysDataSet(ITableInfo ti)

ForeignKeyInfo[] getImportedKeysInfo(String catalog, String schema, String tableName)

ForeignKeyInfo[] getImportedKeysInfo(ITableInfo ti)

ResultSetDataSet getIndexInfo(ITableInfo ti, int[] columnIndices, boolean computeWidths)

public List<IndexInfo> getIndexInfo(ITableInfo ti)
     Returns a list of IndexInfos describing indexes for the specified table.
Parameters:
  ti - the table to find all index information for.
DatabaseMetaData getJDBCMetaData()
     Return the DatabaseMetaData object for this connection.
int getJDBCVersion()
     Return the JDBC version of this driver.
IDataSet getMetaDataSet()

String[] getNumericFunctions()
     Retrieve the names of the Numeric Functions that this DBMS supports.
IDataSet getPrimaryKey(ITableInfo ti, int[] columnIndices, boolean computeWidths)

PrimaryKeyInfo[] getPrimaryKey(ITableInfo ti)

PrimaryKeyInfo[] getPrimaryKey(String catalog, String schema, String table)

IDataSet getProcedureColumnsDataSet(IProcedureInfo ti)

String getProcedureTerm()
     Retrieves the database vendor's preferred term for "procedure".
IProcedureInfo[] getProcedures(String catalog, String schemaPattern, String procedureNamePattern, ProgressCallBack progressCallBack)
     NOTE: This method should only be used by SchemaInfo since this class should not and does not cache.
String[] getSQLKeywords()
     Retrieve the names of the non-standard keywords that this DBMS supports.
String getSchemaTerm()
     Retrieves the database vendor's preferred term for "schema".
String[] getSchemas()
     Return a string array containing the names of all the schemas in the database.
String[] getStringFunctions()
     Retrieve the names of the String Functions that this DBMS supports.
String[] getSystemFunctions()
     Retrieve the names of the System Functions that this DBMS supports.
IDataSet getTablePrivilegesDataSet(ITableInfo ti, int[] columnIndices, boolean computeWidths)

String[] getTableTypes()
     Return a string array containing the different types of tables in this database.
ITableInfo[] getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types, ProgressCallBack progressCallBack)
     NOTE: This method should only be used by SchemaInfo since this class sholud not and does not cache.
String[] getTimeDateFunctions()
     Retrieve the names of the Date/Time Functions that this DBMS supports.
IDataSet getTypesDataSet()

IUDTInfo[] getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types)
     Retrieve information about the UDTs in the system.
Parameters:
  catalog - The name of the catalog to retrieve UDTsfor.
String getURL()
     Retrieves the URL for this DBMS.
String getUserName()
     Return the name of the current user.
IDataSet getVersionColumnsDataSet(ITableInfo ti)

boolean storesUpperCaseIdentifiers()
     Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case.
boolean supportsCatalogs()
     Retrieves whether this database supports catalogs at all.
boolean supportsCatalogsInDataManipulation()
     Retrieves whether a catalog name can be used in a data manipulation statement.
boolean supportsCatalogsInProcedureCalls()
     Retrieves whether a catalog name can be used in a procedure call.
boolean supportsCatalogsInTableDefinitions()
     Retrieves whether a catalog name can be used in a table definition statement.
boolean supportsMultipleResultSets()
     Retrieve whether this driver supports multiple result sets.
boolean supportsResultSetType(int type)
     Retrieves whether this DBMS supports result sets of the specified type.
boolean supportsSavepoints()
     Retrieves whether this DBMS supports save points.
boolean supportsSchemas()
     Retrieves whether this database supports schemas at all.
boolean supportsSchemasInDataManipulation()
     Retrieves whether a schema name can be used in a data manipulation statement.
boolean supportsSchemasInTableDefinitions()
     Retrieves whether a schema name can be used in a table definition statement.
boolean supportsStoredProcedures()
     Retrieves whether this DBMS supports stored procedures.

Method Detail
clearCache
void clearCache()(Code)
Clear cache of commonly accessed metadata properties.

correctlySupportsSetMaxRows
boolean correctlySupportsSetMaxRows() throws SQLException(Code)
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. true if this driver correctly implements setMaxRows().
throws:
  SQLException - Thrown if an SQL error occurs.

getBestRowIdentifier
BestRowIdentifier[] getBestRowIdentifier(ITableInfo ti) throws SQLException(Code)

getCascadeClause
String getCascadeClause() throws SQLException(Code)
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. the "cascade" clause.
throws:
  SQLException -

getCatalogSeparator
String getCatalogSeparator() throws SQLException(Code)
Retrieves the String that this database uses as the separator between a catalog and table name. Cached on first call. The separator character.
throws:
  SQLException - Thrown if an SQL error occurs.

getCatalogTerm
String getCatalogTerm() throws SQLException(Code)
Retrieves the database vendor's preferred term for "catalog". the vendor term for "catalog"
throws:
  SQLException - if a database access error occurs

getCatalogs
String[] getCatalogs() throws SQLException(Code)
Return a string array containing the names of all the catalogs in the database. Cached on first call. String[] of the names of the catalogs in the database.
throws:
  SQLException - Thrown if an SQL error occurs.

getColumnInfo
TableColumnInfo[] getColumnInfo(String catalog, String schema, String table) throws SQLException(Code)

Parameters:
  catalog -
Parameters:
  schema -
Parameters:
  table -
throws:
  SQLException -

getColumnInfo
TableColumnInfo[] getColumnInfo(ITableInfo ti) throws SQLException(Code)

Parameters:
  ti -
throws:
  SQLException -

getColumnPrivilegesDataSet
IDataSet getColumnPrivilegesDataSet(ITableInfo ti, int[] columnIndices, boolean computeWidths) throws DataSetException(Code)

Parameters:
  ti -
Parameters:
  columnIndices -
Parameters:
  computeWidths -
throws:
  DataSetException -

getColumns
IDataSet getColumns(ITableInfo ti, int[] columnIndices, boolean computeWidths) throws DataSetException(Code)

Parameters:
  ti -
Parameters:
  columnIndices -
Parameters:
  computeWidths -
throws:
  DataSetException -

getDataTypes
DataTypeInfo[] getDataTypes() throws SQLException(Code)
Retrieve information about the data types in the database.
throws:
  SQLException - Thrown if an SQL error occurs.

getDatabaseMajorVersion
int getDatabaseMajorVersion() throws SQLException(Code)
Return the database major version for this connection. Cached on first call. database major version
throws:
  SQLException - Thrown if an SQL error occurs.

getDatabaseProductName
String getDatabaseProductName() throws SQLException(Code)
Return the database product name for this connection. Cached on first call. the database product name for this connection.
throws:
  SQLException - Thrown if an SQL error occurs.

getDatabaseProductVersion
String getDatabaseProductVersion() throws SQLException(Code)
Return the database product version for this connection. Cached on first call. database product version
throws:
  SQLException - Thrown if an SQL error occurs.

getDriverName
String getDriverName() throws SQLException(Code)
Return the JDBC driver name for this connection. Cached on first call. the JDBC driver name for this connection.
throws:
  SQLException - Thrown if an SQL error occurs.

getExportedKeysDataSet
IDataSet getExportedKeysDataSet(ITableInfo ti) throws DataSetException(Code)

Parameters:
  ti -
throws:
  DataSetException -

getExportedKeysInfo
ForeignKeyInfo[] getExportedKeysInfo(String catalog, String schema, String tableName) throws SQLException(Code)

getExportedKeysInfo
ForeignKeyInfo[] getExportedKeysInfo(ITableInfo ti) throws SQLException(Code)

getIdentifierQuoteString
String getIdentifierQuoteString() throws SQLException(Code)
Return the string used to quote characters in this DBMS. Cached on first call. quote string.
throws:
  SQLException - Thrown if an SQL error occurs.

getImportedKeysDataSet
IDataSet getImportedKeysDataSet(ITableInfo ti) throws DataSetException(Code)

getImportedKeysInfo
ForeignKeyInfo[] getImportedKeysInfo(String catalog, String schema, String tableName) throws SQLException(Code)

getImportedKeysInfo
ForeignKeyInfo[] getImportedKeysInfo(ITableInfo ti) throws SQLException(Code)

getIndexInfo
ResultSetDataSet getIndexInfo(ITableInfo ti, int[] columnIndices, boolean computeWidths) throws DataSetException(Code)

Parameters:
  ti -
Parameters:
  columnIndices -
Parameters:
  computeWidths -
throws:
  DataSetException -

getIndexInfo
public List<IndexInfo> getIndexInfo(ITableInfo ti) throws SQLException(Code)
Returns a list of IndexInfos describing indexes for the specified table.
Parameters:
  ti - the table to find all index information for. a list of IndexInfos
throws:
  SQLException -

getJDBCMetaData
DatabaseMetaData getJDBCMetaData() throws SQLException(Code)
Return the DatabaseMetaData object for this connection. The DatabaseMetaData object for this connection.
throws:
  SQLException - Thrown if an SQL error occurs.

getJDBCVersion
int getJDBCVersion() throws SQLException(Code)
Return the JDBC version of this driver. Cached on first call. the JDBC version of the driver.
throws:
  SQLException - Thrown if an SQL error occurs.

getMetaDataSet
IDataSet getMetaDataSet() throws SQLException(Code)

throws:
  SQLException -

getNumericFunctions
String[] getNumericFunctions() throws SQLException(Code)
Retrieve the names of the Numeric Functions that this DBMS supports. Cached on first call. String[] of function names.

getPrimaryKey
IDataSet getPrimaryKey(ITableInfo ti, int[] columnIndices, boolean computeWidths) throws DataSetException(Code)

Parameters:
  ti -
Parameters:
  columnIndices -
Parameters:
  computeWidths -
throws:
  DataSetException -

getPrimaryKey
PrimaryKeyInfo[] getPrimaryKey(ITableInfo ti) throws SQLException(Code)

Parameters:
  ti -
throws:
  SQLException -

getPrimaryKey
PrimaryKeyInfo[] getPrimaryKey(String catalog, String schema, String table) throws SQLException(Code)

Parameters:
  ti -
throws:
  SQLException -

getProcedureColumnsDataSet
IDataSet getProcedureColumnsDataSet(IProcedureInfo ti) throws DataSetException(Code)

Parameters:
  ti -
throws:
  DataSetException -

getProcedureTerm
String getProcedureTerm() throws SQLException(Code)
Retrieves the database vendor's preferred term for "procedure". the vendor term for "procedure"
throws:
  SQLException - if a database access error occurs

getProcedures
IProcedureInfo[] getProcedures(String catalog, String schemaPattern, String procedureNamePattern, ProgressCallBack progressCallBack) throws SQLException(Code)
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.

getSQLKeywords
String[] getSQLKeywords() throws SQLException(Code)
Retrieve the names of the non-standard keywords that this DBMS supports. Cached on first call. String[] of keywords.

getSchemaTerm
String getSchemaTerm() throws SQLException(Code)
Retrieves the database vendor's preferred term for "schema". the vendor term for "schema"
throws:
  SQLException - if a database access error occurs

getSchemas
String[] getSchemas() throws SQLException(Code)
Return a string array containing the names of all the schemas in the database. Cached on first call. String[] of the names of the schemas in the database.
throws:
  SQLException - Thrown if an SQL error occurs.

getStringFunctions
String[] getStringFunctions() throws SQLException(Code)
Retrieve the names of the String Functions that this DBMS supports. Cached on first call. String[] of function names.

getSystemFunctions
String[] getSystemFunctions() throws SQLException(Code)
Retrieve the names of the System Functions that this DBMS supports. Cached on first call. String[] of function names.

getTablePrivilegesDataSet
IDataSet getTablePrivilegesDataSet(ITableInfo ti, int[] columnIndices, boolean computeWidths) throws DataSetException(Code)

Parameters:
  ti -
Parameters:
  columnIndices -
Parameters:
  computeWidths -
throws:
  DataSetException -

getTableTypes
String[] getTableTypes() throws SQLException(Code)
Return a string array containing the different types of tables in this database. E.G. "TABLE", "VIEW", "SYSTEM TABLE". Cached on first call. table type names.
throws:
  SQLException - Thrown if an SQL error occurs.

getTables
ITableInfo[] getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types, ProgressCallBack progressCallBack) throws SQLException(Code)
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.

getTimeDateFunctions
String[] getTimeDateFunctions() throws SQLException(Code)
Retrieve the names of the Date/Time Functions that this DBMS supports. Cached on first call. String[] of function names.

getTypesDataSet
IDataSet getTypesDataSet() throws DataSetException(Code)

throws:
  DataSetException -

getUDTs
IUDTInfo[] getUDTs(String catalog, String schemaPattern, String typeNamePattern, int[] types) throws SQLException(Code)
Retrieve information about the UDTs in the system.
Parameters:
  catalog - The name of the catalog to retrieve UDTsfor. An empty string will return those without acatalog. null means that the catalogwill not be used to narrow the search.
Parameters:
  schemaPattern - The name of the schema to retrieve UDTsfor. An empty string will return those without aschema. null means that the schemawill not be used to narrow the search.
Parameters:
  typeNamepattern - A type name pattern; must match thetype name as it is stored in thedatabase.
Parameters:
  types - List of user-defined types (JAVA_OBJECT, STRUCT, orDISTINCT) to include; null returns all types
throws:
  SQLException - Thrown if an SQL error occurs.

getURL
String getURL() throws SQLException(Code)
Retrieves the URL for this DBMS. the URL for this DBMS or null if it cannot be generated
throws:
  SQLException - if a database access error occurs

getUserName
String getUserName() throws SQLException(Code)
Return the name of the current user. Cached on first call. the current user name.

getVersionColumnsDataSet
IDataSet getVersionColumnsDataSet(ITableInfo ti) throws DataSetException(Code)

Parameters:
  ti -
throws:
  DataSetException -

storesUpperCaseIdentifiers
boolean storesUpperCaseIdentifiers() throws SQLException(Code)
Retrieves whether this database treats mixed case unquoted SQL identifiers as case insensitive and stores them in upper case. Cached on first call. true if driver stores upper case identifierselse false.
throws:
  SQLException - Thrown if an SQL error occurs.

supportsCatalogs
boolean supportsCatalogs() throws SQLException(Code)
Retrieves whether this database supports catalogs at all. true fi database supports catalogs.
throws:
  SQLException - Thrown if an SQL error occurs.

supportsCatalogsInDataManipulation
boolean supportsCatalogsInDataManipulation() throws SQLException(Code)
Retrieves whether a catalog name can be used in a data manipulation statement. Cached on first call. true if a catalog name can be used in a datamanipulation statement.
throws:
  SQLException - Thrown if an SQL error occurs.

supportsCatalogsInProcedureCalls
boolean supportsCatalogsInProcedureCalls() throws SQLException(Code)
Retrieves whether a catalog name can be used in a procedure call. Cached on first call. true if a catalog name can be used in a procedurecall.
throws:
  SQLException - Thrown if an SQL error occurs.

supportsCatalogsInTableDefinitions
boolean supportsCatalogsInTableDefinitions() throws SQLException(Code)
Retrieves whether a catalog name can be used in a table definition statement. Cached on first call. true if a catalog name can be used in a tabledefinition statement.
throws:
  SQLException - Thrown if an SQL error occurs.

supportsMultipleResultSets
boolean supportsMultipleResultSets() throws SQLException(Code)
Retrieve whether this driver supports multiple result sets. Cached on first call. true if driver supports multiple result setselse false.
throws:
  SQLException - Thrown if an SQL error occurs.

supportsResultSetType
boolean supportsResultSetType(int type) throws SQLException(Code)
Retrieves whether this DBMS supports result sets of the specified type. Cached on first call.
Parameters:
  type - the type of the ResultSet. There are constants defined in the ResultSet class that define the different types. true if DBMS supports this type of ResultSet.
throws:
  SQLException - if an SQL error occurs.

supportsSavepoints
boolean supportsSavepoints() throws SQLException(Code)
Retrieves whether this DBMS supports save points. Cached on first call. true if DBMS supports save points.
throws:
  SQLException - if an SQL error occurs.

supportsSchemas
boolean supportsSchemas() throws SQLException(Code)
Retrieves whether this database supports schemas at all. true if database supports schemas.
throws:
  SQLException - Thrown if an SQL error occurs.

supportsSchemasInDataManipulation
boolean supportsSchemasInDataManipulation() throws SQLException(Code)
Retrieves whether a schema name can be used in a data manipulation statement. Cached on first call. true if a schema name can be used in a datamanipulation statement.
throws:
  SQLException - Thrown if an SQL error occurs.

supportsSchemasInTableDefinitions
boolean supportsSchemasInTableDefinitions() throws SQLException(Code)
Retrieves whether a schema name can be used in a table definition statement. Cached on first call. true if a schema name can be used in a tabledefinition statement.
throws:
  SQLException - Thrown if an SQL error occurs.

supportsStoredProcedures
boolean supportsStoredProcedures() throws SQLException(Code)
Retrieves whether this DBMS supports stored procedures. Cached on first call. true if DBMS supports stored procedures.
throws:
  SQLException - Thrown if an SQL error occurs.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.