org.apache.derby.iapi.db

Class ConsistencyChecker

java.lang.Object

org.apache.derby.iapi.db.ConsistencyChecker

public class ConsistencyChecker
extends java.lang.Object

The ConsistencyChecker class provides static methods for verifying the consistency of the data stored within a database.

This class can only be used within an SQL-J statement, a Java procedure or a server side Java method.

This class can be accessed using the class alias CONSISTENCYCHECKER in SQL-J statements.

Method Summary

Modifier and Type	Method and Description
static boolean	checkTable(java.lang.String schemaName, java.lang.String tableName) Check the named table, ensuring that all of its indexes are consistent with the base table.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

checkTable

public static boolean checkTable(java.lang.String schemaName,
                                 java.lang.String tableName)
                          throws java.sql.SQLException

Check the named table, ensuring that all of its indexes are consistent with the base table. Use this method only within an SQL-J statement; do not call it directly.

When tables are consistent, the method returns true. Otherwise, the method throws an exception.

To check the consistency of a single table:

VALUES ConsistencyChecker::checkTable(SchemaName, TableName)

For example, to check the consistency of the table APP.Flights:

VALUES ConsistencyChecker::checkTable('APP', 'FLIGHTS')

To check the consistency of all of the tables in the 'APP' schema, stopping at the first failure:

SELECT tablename, ConsistencyChecker::checkTable(
'APP', tablename)
FROM sys.sysschemas s, sys.systables t WHERE s.schemaname = 'APP' AND s.schemaid = t.schemaid

To check the consistency of an entire database, stopping at the first failure:

SELECT schemaname, tablename,
ConsistencyChecker::checkTable(schemaname, tablename)
FROM sys.sysschemas s, sys.systables t
WHERE s.schemaid = t.schemaid

Parameters:

schemaName - The schema name of the table.

tableName - The name of the table

Returns:

true, if the table is consistent, exception thrown if inconsistent

Throws:

java.sql.SQLException - Thrown if some inconsistency is found, or if some unexpected exception is thrown..