Class Hierarchy Previous Next Index
Interface COM.cloudscape.database.Database
- public interface Database
Copyright © 1998-2000, Informix Software, 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.
For examples on how to call these methods see the comments
in the COM.cloudscape.database.Factory class.
Previous releases of this class included methods that threw
COM.cloudscape.database.DatabaseException. This DatabaseException
class has been removed and now methods throw java.sql.SQLException.
Cloudscape reserves the right to change, rename, or
remove this interface at any time.
- See Also:
- Factory
RPD_ALIAS-
RPD_BASE_CONGLOMERATE-
RPD_CONSTRAINT-
RPD_FILE-
RPD_FOREIGN_KEY-
RPD_INDEX-
RPD_STATEMENT-
RPD_TABLE-
RPD_TARGET_DB_PROPERTY-
RPD_TO_ALIAS-
RPD_TO_CONSTRAINT-
RPD_TO_FOREIGN_KEY-
RPD_TO_INDEX-
RPD_TO_MODIFY_COLUMNS-
RPD_TO_STATEMENT-
RPD_TO_TRIGGER-
RPD_TO_VIEW-
RPD_TO_WORK_UNIT-
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.
getId()
- Return the UUID of this database.
getLocale()
- Get the Locale for this database.
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
RPD_TO_ALIAS
public static final int RPD_TO_ALIAS
RPD_TO_WORK_UNIT
public static final int RPD_TO_WORK_UNIT
RPD_TO_INDEX
public static final int RPD_TO_INDEX
RPD_TO_MODIFY_COLUMNS
public static final int RPD_TO_MODIFY_COLUMNS
RPD_TO_CONSTRAINT
public static final int RPD_TO_CONSTRAINT
RPD_TO_FOREIGN_KEY
public static final int RPD_TO_FOREIGN_KEY
RPD_TO_VIEW
public static final int RPD_TO_VIEW
RPD_TO_STATEMENT
public static final int RPD_TO_STATEMENT
RPD_TO_TRIGGER
public static final int RPD_TO_TRIGGER
isReadOnly
public 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 boolean deleteError(UUID errorId) throws java.sql.SQLException
Delete the error with the specified UUID from SYSERRORS.
- Throws:
- java.sql.SQLException - thrown if the deletion fails.
deleteErrors
public int deleteErrors(UUID errorDbId,
java.sql.Timestamp until) throws java.sql.SQLException
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:
- java.sql.SQLException - thrown if the deletion fails.
dropAllJDBCMetaDataSPSes
public void dropAllJDBCMetaDataSPSes() throws java.sql.SQLException
Delete all stored prepared statements that were
created for JDBC MetaData queries.
- Throws:
- java.sql.SQLException - thrown on error deleting
the stored prepared statements, most likely
a deadlock or timeout.
backup
public void backup(java.lang.String backupDir) throws java.sql.SQLException
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:
- java.sql.SQLException - Thrown on error
backup
public void backup(java.io.File backupDir) throws java.sql.SQLException
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:
- java.sql.SQLException - Thrown on error
freeze
public void freeze() throws java.sql.SQLException
Freeze the database temporarily so a backup can be taken.
Please see cloudscape on line documentation on backup and restore.
- Throws:
- java.sql.SQLException - Thrown on error
unfreeze
public void unfreeze() throws java.sql.SQLException
Unfreeze the database after a backup has been taken.
Please see cloudscape on line documentation on backup and restore.
- Throws:
- java.sql.SQLException - Thrown on error
checkpoint
public void checkpoint() throws java.sql.SQLException
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:
- java.sql.SQLException - Thrown on error
getLocale
public java.util.Locale getLocale()
Get the Locale for this database. This method may return null for
target databases that have not been refreshed since they were upgraded
to version 3.5.
getId
public UUID getId()
Return the UUID of this database.
Class Hierarchy Previous Next Index