org.firebirdsql.management.NBackupManager Maven / Gradle / Ivy
Show all versions of jaybird Show documentation
/*
* Public Firebird Java API.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.firebirdsql.management;
import java.sql.SQLException;
/**
* Implements the incremental backup and restore functionality of NBackup
* via the Firebird Services API.
*
* @author Thomas Steinmaurer
* @author Mark Rotteveel
*/
public interface NBackupManager extends ServiceManager {
/**
* Sets the location of the backup file.
*
* Warning: this method behaves identical to {@link #addBackupFile(String)}.
*
*
* @param backupFile
* the location of the backup file.
*/
void setBackupFile(String backupFile);
/**
* Add additional backup files.
*
* Specifying multiple backup files is only valid for restore, for backup only the first file is used.
*
*
* Use {@link #clearBackupFiles()} to clear earlier backup files.
*
*
* @param backupFile
* the location of the backup file.
*/
void addBackupFile(String backupFile);
/**
* Clear the information about backup files. This method undoes all
* parameters set in the {@link #addBackupFile(String)} method.
*/
void clearBackupFiles();
/**
* Set the path to the database. This method is used both for backup and
* restore operation.
*
* @param path
* path to the database file.
*
* In case of backup, value specifies the path of the existing database on the server that will be
* backed up.
*
*
* In case of restore, value specifies the path of the database where the backup will be restored to.
*
*/
void setDatabase(String path);
/**
* Perform the backup operation.
*
* @throws SQLException
* if a database error occurs during the backup
*/
void backupDatabase() throws SQLException;
/**
* Perform the restore operation.
*
* Set {@link #setPreserveSequence(boolean)} to preserve the original database GUID and replication sequence.
*
*
* @throws SQLException
* if a database error occurs during the restore
*/
void restoreDatabase() throws SQLException;
/**
* Perform the nbackup fixup operation.
*
* A fixup will switch a locked database to 'normal' state without merging the delta, so this is a potentially
* destructive action. The normal use-case of this option is to unlock a copy of a database file where the source
* database file was locked with {@code nbackup -L} or {@code ALTER DATABASE BEGIN BACKUP}.
*
*
* Set {@link #setPreserveSequence(boolean)} to preserve the original database GUID and replication sequence.
*
*
* @throws SQLException
* if a database error occurs during the fixup
* @since 5
*/
void fixupDatabase() throws SQLException;
/**
* Sets the backup level (0 = full, 1..n = incremental)
*
* @param level
* backup level (e.g. 0 = full backup, 1 = level 1 incremental backup based on level 0 backup
*/
void setBackupLevel(int level);
/**
* Sets the backup GUID (Firebird 4 and higher only).
*
* The backup GUID is the GUID of a previous backup of the (source) database. This is used by Firebird to backup
* the pages modified since that backup.
*
*
* This setting is mutually exclusive with {@link #setBackupLevel(int)}, but this is only checked server-side.
*
*
* @param guid
* A GUID string of a previous backup, enclosed in braces.
* @since 4.0.4
*/
void setBackupGuid(String guid);
/**
* Sets the option no database triggers when connecting at backup or in-place restore.
*
* @param noDBTriggers
* {@code true} disable db triggers during backup or in-place restore.
*/
void setNoDBTriggers(boolean noDBTriggers);
/**
* Enables in-place restore.
*
* @param inPlaceRestore
* {@code true} to enable in-place restore
* @since 4.0.4
*/
void setInPlaceRestore(boolean inPlaceRestore);
/**
* Enables preserve sequence (for fixup or restore).
*
* This preserves the existing GUID and replication sequence of the original database (they are reset otherwise).
*
*
* @param preserveSequence
* {@code true} to enable preserve sequence
* @since 5
*/
void setPreserveSequence(boolean preserveSequence);
/**
* Enables clean history on backup.
*
* The backup will fail if {@link #setKeepDays(int)} or {@link #setKeepRows(int)} has not been called.
*
*
* @param cleanHistory
* {@code true} to enable clean history
* @since 4.0.7
*/
void setCleanHistory(boolean cleanHistory);
/**
* Sets the number of days of backup history to keep.
*
* Server-side, this option is mutually exclusive with {@link #setKeepRows(int)}, this is not enforced by the Java
* code.
*
*
* This option only has effect when {@code setCleanHistory(true)} has been called.
*
*
* @param days
* number of days to keep history when cleaning, or {@code -1} to clear current value
* @see #setCleanHistory(boolean)
* @see #setKeepRows(int)
* @since 4.0.7
*/
void setKeepDays(int days);
/**
* Sets the number of rows of backup history to keep (this includes the row created by the backup).
*
* Server-side, this option is mutually exclusive with {@link #setKeepDays(int)}, this is not enforced by the Java
* code.
*
*
* This option only has effect when {@code setCleanHistory(true)} has been called.
*
*
* @param rows
* number of rows to keep history when cleaning, or {@code -1} to clear current value
* @see #setCleanHistory(boolean)
* @see #setKeepDays(int)
* @since 4.0.7
*/
void setKeepRows(int rows);
}