Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.derby.database
Interface Database  view Database download Database.java


public interface Database

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.

IBM Corp. reserves the right to change, rename, or remove this interface at any time.


Method Summary
 void backup(java.io.File backupDir)
          Backup the database to a backup directory.
 void backup(java.lang.String backupDir)
          Backup the database to a backup directory.
 void backupAndEnableLogArchiveMode(java.io.File backupDir, boolean deleteOnlineArchivedLogFiles)
          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.
 void backupAndEnableLogArchiveMode(java.lang.String backupDir, boolean deleteOnlineArchivedLogFiles)
          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.
 void checkpoint()
          Checkpoints the database, that is, flushes all dirty data to disk.
 void disableLogArchiveMode(boolean deleteOnlineArchivedLogFiles)
          Disables the log archival process, i.e No old log files will be kept around for a roll-forward recovery.
 void dropAllJDBCMetaDataSPSes()
          Delete all stored prepared statements that were created for JDBC MetaData queries.
 void freeze()
          Freeze the database temporarily so a backup can be taken.
 org.apache.derby.catalog.UUID getId()
          Deprecated. No longer supported.
 java.util.Locale getLocale()
          Get the Locale for this database.
 boolean isReadOnly()
          Tells whether the Database is configured as read-only, or the Database was started in read-only mode.
 void unfreeze()
          Unfreeze the database after a backup has been taken.
 

Method Detail

isReadOnly

public boolean isReadOnly()
Tells whether the Database is configured as read-only, or the Database was started in read-only mode.


dropAllJDBCMetaDataSPSes

public void dropAllJDBCMetaDataSPSes()
                              throws java.sql.SQLException
Delete all stored prepared statements that were created for JDBC MetaData queries.


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.


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.


backupAndEnableLogArchiveMode

public void backupAndEnableLogArchiveMode(java.lang.String backupDir,
                                          boolean deleteOnlineArchivedLogFiles)
                                   throws java.sql.SQLException
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.


backupAndEnableLogArchiveMode

public void backupAndEnableLogArchiveMode(java.io.File backupDir,
                                          boolean deleteOnlineArchivedLogFiles)
                                   throws java.sql.SQLException
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.


disableLogArchiveMode

public void disableLogArchiveMode(boolean deleteOnlineArchivedLogFiles)
                           throws java.sql.SQLException
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.


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.


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.


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.


getLocale

public java.util.Locale getLocale()
Get the Locale for this database.


getId

public org.apache.derby.catalog.UUID getId()
Deprecated. No longer supported.

Return the UUID of this database.