| org.apache.derby.database.Database
| Database | | public interface Database (Code) | | 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.
See Also: org.apache.derby.iapi.db.Factory |
| Method Summary | |
| public void | backup(String backupDir, boolean wait)
Backup the database to a backup directory. | | public void | backupAndEnableLogArchiveMode(String backupDir, boolean deleteOnlineArchivedLogFiles, boolean wait)
Backup the database to a backup directory and enable the log archive
mode that will keep the archived log files required for roll-forward
from this version backup.
Parameters:
backupDir - The directory name where the database backup should go. | | public void | checkpoint()
Checkpoints the database, that is, flushes all dirty data to disk. | | public void | disableLogArchiveMode(boolean deleteOnlineArchivedLogFiles)
Disables the log archival process, i.e No old log files
will be kept around for a roll-forward recovery. | | public void | dropAllJDBCMetaDataSPSes()
Delete all stored prepared statements that were
created for JDBC MetaData queries. | | public void | freeze()
Freeze the database temporarily so a backup can be taken. | | public UUID | getId()
Return the UUID of this database. | | public Locale | getLocale()
Get the Locale for this database. | | public boolean | isReadOnly()
Tells whether the Database is configured as read-only, or the
Database was started in read-only mode. | | public void | unfreeze()
Unfreeze the database after a backup has been taken. |
| backup | | public void backup(String backupDir, boolean wait) throws SQLException(Code) | | Backup the database to a backup directory. See online documentation
for more detail about how to use this feature.
Parameters:
backupDir - the directory name where the database backup shouldgo. This directory will be created if not it does not exist.
Parameters:
wait - if true, waits for all the backup blocking operations in progress to finish.
exception:
SQLException - Thrown on error |
| backupAndEnableLogArchiveMode | | public void backupAndEnableLogArchiveMode(String backupDir, boolean deleteOnlineArchivedLogFiles, boolean wait) throws SQLException(Code) | | Backup the database to a backup directory and enable the log archive
mode that will keep the archived log files required for roll-forward
from this version backup.
Parameters:
backupDir - The directory name where the database backup should go. This directory will be created if it does not exist.
Parameters:
deleteOnlineArchivedLogFiles - If true deletes online archived logfiles that exist before this backup;otherwise they will not be deleted. Deletion will occur only after backup is complete.
Parameters:
wait - if true, waits for all the backup blocking operations in progress to finish.
exception:
SQLException - Thrown on error |
| checkpoint | | public void checkpoint() throws SQLException(Code) | | Checkpoints the database, that is, flushes all dirty data to disk.
Records a checkpoint in the transaction log, if there is a log.
exception:
SQLException - Thrown on error |
| disableLogArchiveMode | | public void disableLogArchiveMode(boolean deleteOnlineArchivedLogFiles) throws SQLException(Code) | | Disables the log archival process, i.e No old log files
will be kept around for a roll-forward recovery. Only restore that can
be performed after disabling log archive mode is version recovery.
Parameters:
deleteOnlineArchivedLogFiles - If true deletes all online archivedlog files that exist before this call immediately; otherwise they will not be deleted.
exception:
SQLException - Thrown on error |
| dropAllJDBCMetaDataSPSes | | public void dropAllJDBCMetaDataSPSes() throws SQLException(Code) | | Delete all stored prepared statements that were
created for JDBC MetaData queries.
exception:
SQLException - thrown on error deletingthe stored prepared statements, most likelya deadlock or timeout. |
| freeze | | public void freeze() throws SQLException(Code) | | Freeze the database temporarily so a backup can be taken.
Please see Cloudscape on line documentation on backup and restore.
exception:
SQLException - Thrown on error |
| getId | | public UUID getId()(Code) | | Return the UUID of this database.
|
| getLocale | | public Locale getLocale()(Code) | | Get the Locale for this database.
|
| isReadOnly | | public boolean isReadOnly()(Code) | | Tells whether the Database is configured as read-only, or the
Database was started in read-only mode.
TRUE means the Database is read-only, FALSE means it isnot read-only. |
| unfreeze | | public void unfreeze() throws SQLException(Code) | | Unfreeze the database after a backup has been taken.
Please see Cloudscape on line documentation on backup and restore.
exception:
SQLException - Thrown on error |
|
|