Issue Details (XML | Word | Printable)

Key: DERBY-916
Type: Sub-task Sub-task
Status: Closed Closed
Resolution: Fixed
Priority: Major Major
Assignee: Eric Radzinski
Reporter: Eric Radzinski
Votes: 1
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Derby
DERBY-239

documentation to address Derby-239: online backup

Created: 03/Feb/06 09:33 AM   Updated: 20/Mar/07 09:54 PM
Return to search
Component/s: Documentation
Affects Version/s: 10.0.2.0
Fix Version/s: 10.2.1.6

Time Tracking:
Not Specified

File Attachments:
  Size
File Licensed for inclusion in ASF works derby916-1.diff 2006-02-15 08:57 AM Eric Radzinski 26 kB
File Licensed for inclusion in ASF works derby916-2.diff 2006-03-04 05:59 AM Jeff Levitt 27 kB
Zip Archive Licensed for inclusion in ASF works derby916-2html.zip 2006-03-04 05:59 AM Jeff Levitt 17 kB
Zip Archive Licensed for inclusion in ASF works derby916_html_files.zip 2006-02-15 08:57 AM Eric Radzinski 19 kB

Resolution Date: 09/Mar/06 03:27 AM


 All   Comments   Work Log   Change History   Subversion Commits      Sort Order: Ascending order - Click to sort in descending order
Eric Radzinski added a comment - 03/Feb/06 09:38 AM
Can somebody confirm that this is what is required to document Derby-239:

Reference Guide:
Add the following two new stored procedures:
--SYSC_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT and
--SYSC_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT

Also, it doesn't look like there are any changes to the SYSCS_UTIL.SYSCS_BACKUP_DATABASE topic. Is that correct?

Server and Admin Guide:
--Remove references to update operations not being possible during a backup (there are a lot of these)
--Add topic about performing an online backup in which unlogged operations immediately return an error.

Anything else?

Suresh Thalamati added a comment - 04/Feb/06 06:57 AM
Hi Eric,

Thanks for volunteering to document the online backup feature. You are
right, Server Admin Guide and Reference Guide has to be updated with the
above information.

In addition to what you already mentioned, I think following information
also should be added:

Server Guide :

1) in Section : Using the backup procedure to perform an online backup
(SYSCS_UTIL.SYSCS_BACKUP_DATABASE ..topic)


SYSCS_UTIL.SYSCS_BACKUP_DATABASE procedures will throw error, if there are
any unlogged operations already executed in the same transaction as backup
procedure. If there are any unlogged operations in progress in other
transactions in the system when backup starts, this procedures will block
until those transactions are completed before performing the backup.
Derby automatically converts unlogged operations to logged mode if
they are started when the backup is in progress except operations that are used
to maintain application jar files in the database. Procedures to install,
replace, and remove jar files in a database are blocked when the backup
is in progress.

If you don't want backup to block for unlogged operation in other transactions
to complete, use SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT procedure. This
procedure will return error immediately if there are any transactions in
progress with unlogged operations at the start of the backup instead of waiting
for those transactions to complete.


2) Same information as above should be added to Rollforward Recovery Section
   also. (SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE topic).


Info is same as above(1) , except procedure names will be
SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE and
SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT


3) Any mention of update operations not possible should be removed except
when it is mentioned in the context of using
SYSCS_UTIL.SYSCS_FREEZE_DATABASE procedure.


4) In the freeze procedure section following sentence should be changed.

Current sentence:
"For example, because the UNIX tar command uses operating system file-copying
routines, and Derby uses the IBM Application Developer Kit file-copying
routines, the tar command might provide faster backups than the
SYSCS_UTIL.SYSCS_BACKUP_DATABASE procedure.
"

replace it with something like:

"For example, because the UNIX tar command uses operating system file-copying
routines, and SYSCS_UTIL.SYSCS_BACKUP_DATABASE procedure uses java I/O calls
with additional internal synchronization to allow updates during the backup, the tar command might
provide faster backups than the SYSCS_UTIL.SYSCS_BACKUP_DATABASE procedure.
"

Reference Guide:

1) Following two new procedures needs to be added to the Reference Guide:

--SYSC_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT and
--SYSC_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT

2) While scanning throws the docs, I also noticed Following two procedures are
missing in 10.0 and 10.1 docs in the reference manual , I think they need to be added too.

SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE
(IN BACKUPDIR VARCHAR(32672), IN SMALLINT DELETE_ARCHIVED_LOG_FILES)

SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE(IN SMALLINT DELETE_ARCHIVED_LOG_FILES)


Thanks
-suresht

Eric Radzinski added a comment - 15/Feb/06 08:57 AM
This patch addresses the changes to online backups. It adds the following four new topics to the Reference Guide:

SYSCS_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT
SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT
SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE
SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE

And affects five files in the Server and Admin Guide. The HTML files are included for review.

Eric Radzinski added a comment - 25/Feb/06 08:39 AM
Can somebody take a look at the doc patch for this issue?

Suresh Thalamati added a comment - 02/Mar/06 09:39 AM
Thanks very much for documenting online backup. changes looks good except for one minor error in
SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE doc.

rrefdiableprog.html: small correction needed

SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE:

1) procedure description is not clear:

current decription :
The SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE system procedure disables log archive mode for the database.

should be changed to:
"
This system procedure disables the log archive mode and deletes any existing
online archived log files if the input parameter DELETE_ARCHIVED_LOG_FILES is
non-zero.
"

2) DELETE_ARCHIVED_LOG_FILES argument explanation is incorrect:
 
Current description:

If the input parameter value for the DELETE_ARCHIVED_LOG_FILES parameter is a
non-zero value, online archived log files that were created before this backup
will be deleted. The log files are deleted only after a successful backup.


The correct one should be :
"

If the input parameter value for the DELETE_ARCHIVED_LOG_FILES parameter is a
non-zero value then all existing online archived log files are deleted. If the
value is zero then exiting online archived log files files are not deleted.
'

Thanks
-suresh

Jeff Levitt added a comment - 04/Mar/06 05:59 AM
I went ahead and made these final minor changes to the patch because it was so close to commit. The derby916-2.diff is the new patch file, and contains the latest comments from Suresh. The derby916-2html.zip file contains new html ouput files for review. Thanks!

Suresh Thalamati added a comment - 08/Mar/06 09:19 AM
Thanks for making the changes Jeff. It looks good.

+1

-suresht
 

Jeff Levitt added a comment - 09/Mar/06 03:01 AM
Can a committer please commit this? It looks like there are no objections to the latest patch. Thanks Suresh!

Andrew McIntyre added a comment - 09/Mar/06 03:27 AM
Hi Jeff, committed this yesterday, forgot to mark resolved. Committed, revision 384085.