Loading TOC...
JavaScript admin.databaseHourlyBackup

MarkLogic 9 Product Documentation
admin:database-hourly-backup

admin:database-hourly-backup(
   $backup-dir as xs:string,
   $backup-period as xs:positiveInteger,
   $start-minute as xs:nonNegativeInteger,
   $max-backups as xs:unsignedLong,
   $backup-security-db as xs:boolean,
   $backup-schemas-db as xs:boolean,
   $backup-triggers-db as xs:boolean,
   [$include-replicas as xs:boolean],
   [$journal-archiving as xs:boolean?],
   [$journal-archive-path as xs:string?],
   [$lag-limit as xs:unsignedLong?]
) as element(db:database-backup)

Summary

This function constructs an hourly scheduled database backup specification.

Parameters
backup-dir The directory to save the backup.
backup-period The number of hours to elapse between each backup.
start-minute The number of minutes after the hour to start the backup. Note that this setting does not add to the backup period value.
max-backups The maximum number of backups to keep. When you reach the specified maximum number of backups, the next backup will delete the oldest backup. Specify 0 to keep an unlimited number of backups.
backup-security-db Whether to backup the security database alongside the current backup.
backup-schemas-db Whether to backup the schemas database alongside the current backup.
backup-triggers-db Whether to backup the triggers database alongside the current backup.
include-replicas If set to false, do not include the replicas in the backup. The default is true, which means to include all replicas in the backup.
journal-archiving Whether or not to enable journal archiving. Defaults to false.
journal-archive-path Path for where archived journals are stored. Defaults to the backup data directory.
lag-limit Maximum difference in seconds that the archived journal can lag behind its forest's active journal. Defaults to 900.

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  return
    admin:database-hourly-backup("/backup-dir", 2,
      30, 10, true(), true(), true())

  (: Returns the hourly database backup specification. For example, if the current
     time is 2:15pm, the backup will run at 4:30pm, 6:30pm, 8:30pm, and so on. :)

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  return
    admin:database-hourly-backup("/backup-dir", 2,
      30, 10, true(), true(), true(),false(),true(),(),500)

  (: Returns the hourly database backup specification. For example, if the current
     time is 2:15pm, the backup will run at 4:30pm, 6:30pm, 8:30pm, and so on. :)

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.