Package org.firebirdsql.management

Interface NBackupManager

    • Method Detail

      • setBackupFile

        void setBackupFile​(java.lang.String backupFile)
        Sets the location of the backup file.

        Warning: this method behaves identical to addBackupFile(String).

        Parameters:
        backupFile - the location of the backup file.

      • addBackupFile

        void addBackupFile​(java.lang.String backupFile)
        Add additional backup files.

        Specifying multiple backup files is only valid for restore, for backup only the first file is used.

        Use clearBackupFiles() to clear earlier backup files.

        Parameters:
        backupFile - the location of the backup file.

      • clearBackupFiles

        void clearBackupFiles()
        Clear the information about backup files. This method undoes all parameters set in the addBackupFile(String) method.

      • setDatabase

        void setDatabase​(java.lang.String path)
        Set the path to the database. This method is used both for backup and restore operation.
        Specified by:
        setDatabase in interface ServiceManager
        Parameters:
        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.

      • backupDatabase

        void backupDatabase()
             throws java.sql.SQLException
        Perform the backup operation.
        Throws:
        java.sql.SQLException - if a database error occurs during the backup

      • restoreDatabase

        void restoreDatabase()
              throws java.sql.SQLException
        Perform the restore operation.

        Set setPreserveSequence(boolean) to preserve the original database GUID and replication sequence.

        Throws:
        java.sql.SQLException - if a database error occurs during the restore

      • fixupDatabase

        void fixupDatabase()
            throws java.sql.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 nbackup -L or ALTER DATABASE BEGIN BACKUP.

        Set setPreserveSequence(boolean) to preserve the original database GUID and replication sequence.

        Throws:
        java.sql.SQLException - if a database error occurs during the fixup
        Since:
        5

      • setBackupLevel

        void setBackupLevel​(int level)
        Sets the backup level (0 = full, 1..n = incremental)
        Parameters:
        level - backup level (e.g. 0 = full backup, 1 = level 1 incremental backup based on level 0 backup

      • setBackupGuid

        void setBackupGuid​(java.lang.String guid)
        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 setBackupLevel(int), but this is only checked server-side.

        Parameters:
        guid - A GUID string of a previous backup, enclosed in braces.
        Since:
        4.0.4

      • setNoDBTriggers

        void setNoDBTriggers​(boolean noDBTriggers)
        Sets the option no database triggers when connecting at backup or in-place restore.
        Parameters:
        noDBTriggers - true disable db triggers during backup or in-place restore.

      • setInPlaceRestore

        void setInPlaceRestore​(boolean inPlaceRestore)
        Enables in-place restore.
        Parameters:
        inPlaceRestore - true to enable in-place restore
        Since:
        4.0.4

      • setPreserveSequence

        void setPreserveSequence​(boolean preserveSequence)
        Enables preserve sequence (for fixup or restore).

        This preserves the existing GUID and replication sequence of the original database (they are reset otherwise).

        Parameters:
        preserveSequence - true to enable preserve sequence
        Since:
        5

      • setCleanHistory

        void setCleanHistory​(boolean cleanHistory)
        Enables clean history on backup.

        The backup will fail if setKeepDays(int) or setKeepRows(int) has not been called.

        Parameters:
        cleanHistory - true to enable clean history
        Since:
        4.0.7

      • setKeepDays

        void setKeepDays​(int days)
        Sets the number of days of backup history to keep.

        Server-side, this option is mutually exclusive with setKeepRows(int), this is not enforced by the Java code.

        This option only has effect when setCleanHistory(true) has been called.

        Parameters:
        days - number of days to keep history when cleaning, or -1 to clear current value
        Since:
        4.0.7
        See Also:
        setCleanHistory(boolean), setKeepRows(int)

      • setKeepRows

        void setKeepRows​(int rows)
        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 setKeepDays(int), this is not enforced by the Java code.

        This option only has effect when setCleanHistory(true) has been called.

        Parameters:
        rows - number of rows to keep history when cleaning, or -1 to clear current value
        Since:
        4.0.7
        See Also:
        setCleanHistory(boolean), setKeepDays(int)