Class Hierarchy Index
Interface COM.cloudscape.database.Database
- public interface Database
Copyright © 1998-1999, Cloudscape, Inc. All rights reserved.
The Database interface provides control over a database
(that is, the stored data and the files the data are stored in),
operations on the database such as backup and recovery,
and all other things that are associated with the database itself.
Cloudscape reserves the right to change, rename, or
remove this interface at any time.
-
RPD_ALIAS
-
-
RPD_BASE_CONGLOMERATE
-
-
RPD_CONSTRAINT
-
-
RPD_FILE
-
-
RPD_FOREIGN_KEY
-
-
RPD_INDEX
-
-
RPD_STATEMENT
-
-
RPD_TABLE
-
-
RPD_TARGET_DB_PROPERTY
-
-
RPD_TRIGGER
-
-
RPD_UNKNOWN
-
-
RPD_VIEW
-
-
backup(File)
- Backup the database to a backup directory.
-
backup(String)
- Backup the database to a backup directory.
-
checkpoint()
- Checkpoints the database, that is, flushes all dirty data to disk.
-
deleteError(UUID)
- Delete the error with the specified UUID from SYSERRORS.
-
deleteErrors(UUID, Timestamp)
- Delete selected errors from SYSERRORS.
-
dropAllJDBCMetaDataSPSes()
- Delete all stored prepared statements that were
created for JDBC MetaData queries.
-
freeze()
- Freeze the database temporarily so a backup can be taken.
-
isReadOnly()
- Tells whether the Database is configured as read-only, or the
Database was started in read-only mode.
-
unfreeze()
- Unfreeze the database after a backup has been taken.
RPD_UNKNOWN
public static final int RPD_UNKNOWN
RPD_TABLE
public static final int RPD_TABLE
RPD_VIEW
public static final int RPD_VIEW
RPD_BASE_CONGLOMERATE
public static final int RPD_BASE_CONGLOMERATE
RPD_INDEX
public static final int RPD_INDEX
RPD_CONSTRAINT
public static final int RPD_CONSTRAINT
RPD_FOREIGN_KEY
public static final int RPD_FOREIGN_KEY
RPD_ALIAS
public static final int RPD_ALIAS
RPD_STATEMENT
public static final int RPD_STATEMENT
RPD_TARGET_DB_PROPERTY
public static final int RPD_TARGET_DB_PROPERTY
RPD_FILE
public static final int RPD_FILE
RPD_TRIGGER
public static final int RPD_TRIGGER
isReadOnly
public abstract boolean isReadOnly()
- Tells whether the Database is configured as read-only, or the
Database was started in read-only mode.
- Returns:
- TRUE means the Database is read-only, FALSE means it is
not read-only.
deleteError
public abstract boolean deleteError(UUID errorId) throws DatabaseException
- Delete the error with the specified UUID from SYSERRORS.
- Throws: DatabaseException
- thrown if the deletion fails.
deleteErrors
public abstract int deleteErrors(UUID errorDbId,
Timestamp until) throws DatabaseException
- Delete selected errors from SYSERRORS.
- Parameters:
- errorDbId - Delete errors for this database. null means
delete errors for all databases.
- until - Delete errors that occurred until this time. null
means delete errors that occurred any time.
- Throws: DatabaseException
- thrown if the deletion fails.
dropAllJDBCMetaDataSPSes
public abstract void dropAllJDBCMetaDataSPSes() throws DatabaseException
- Delete all stored prepared statements that were
created for JDBC MetaData queries.
- Throws: DatabaseException
- thrown on error deleting
the stored prepared statements, most likely
a deadlock or timeout.
backup
public abstract void backup(String backupDir) throws StandardException
- Backup the database to a backup directory. See on line documentation
for more detail about how to use this feature.
- Parameters:
- backupDir - the directory name where the database backup should
go. This directory will be created if not it does not exist.
- Throws: StandardException
- Thrown on error
backup
public abstract void backup(File backupDir) throws StandardException
- Backup the database to a backup directory. See on line documentation
for more detail about how to use this feature.
- Parameters:
- backupDir - the directory where the database backup should
go. This directory will be created if not it does not exist.
- Throws: StandardException
- Thrown on error
freeze
public abstract void freeze() throws StandardException
- Freeze the database temporarily so a backup can be taken.
Please see cloudscape on line documentation on backup and restore.
- Throws: StandardException
- Thrown on error
unfreeze
public abstract void unfreeze() throws StandardException
- Unfreeze the database after a backup has been taken.
Please see cloudscape on line documentation on backup and restore.
- Throws: StandardException
- Thrown on error
checkpoint
public abstract void checkpoint() throws StandardException
- Checkpoints the database, that is, flushes all dirty data to disk.
Records a checkpoint in the transaction log, if there is a log.
- Returns:
- Nothing
- Throws: StandardException
- Thrown on error
Class Hierarchy Index