<div id="docs-body">
 <div class="section">
  <div class="titlepage">
   <div>
    <div>
     <h4 class="title">
      <a name="mysql-cluster-backup-configuration">
      </a>
      25.6.8.3 Configuration for NDB Cluster Backups
     </h4>
    </div>
   </div>
  </div>
  <a class="indexterm" name="idm46045091957632">
  </a>
  <a class="indexterm" name="idm46045091956144">
  </a>
  <a class="indexterm" name="idm46045091954656">
  </a>
  <a class="indexterm" name="idm46045091953168">
  </a>
  <p>
   Five configuration parameters are essential for backup:
  </p>
  <div class="itemizedlist">
   <ul class="itemizedlist" style="list-style-type: disc; ">
    <li class="listitem">
     <p>
      <a class="indexterm" name="idm46045091950448">
      </a>
      <a class="link" href="mysql-cluster-ndbd-definition.html#ndbparam-ndbd-backupdatabuffersize">
       <code class="literal">
        BackupDataBufferSize
       </code>
      </a>
     </p>
     <p>
      The amount of memory used to buffer data before it is
            written to disk.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a class="indexterm" name="idm46045091946816">
      </a>
      <a class="link" href="mysql-cluster-ndbd-definition.html#ndbparam-ndbd-backuplogbuffersize">
       <code class="literal">
        BackupLogBufferSize
       </code>
      </a>
     </p>
     <p>
      The amount of memory used to buffer log records before these
            are written to disk.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a class="indexterm" name="idm46045091943232">
      </a>
      <a class="link" href="mysql-cluster-ndbd-definition.html#ndbparam-ndbd-backupmemory">
       <code class="literal">
        BackupMemory
       </code>
      </a>
     </p>
     <p>
      The total memory allocated in a data node for backups. This
            should be the sum of the memory allocated for the backup
            data buffer and the backup log buffer.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a class="indexterm" name="idm46045091939552">
      </a>
      <a class="link" href="mysql-cluster-ndbd-definition.html#ndbparam-ndbd-backupwritesize">
       <code class="literal">
        BackupWriteSize
       </code>
      </a>
     </p>
     <p>
      The default size of blocks written to disk. This applies for
            both the backup data buffer and the backup log buffer.
     </p>
    </li>
    <li class="listitem">
     <p>
      <a class="indexterm" name="idm46045091935936">
      </a>
      <a class="link" href="mysql-cluster-ndbd-definition.html#ndbparam-ndbd-backupmaxwritesize">
       <code class="literal">
        BackupMaxWriteSize
       </code>
      </a>
     </p>
     <p>
      The maximum size of blocks written to disk. This applies for
            both the backup data buffer and the backup log buffer.
     </p>
    </li>
   </ul>
  </div>
  <p>
   In addition,
   <a class="link" href="mysql-cluster-ndbd-definition.html#ndbparam-ndbd-compressedbackup">
    <code class="literal">
     CompressedBackup
    </code>
   </a>
   causes
   <code class="literal">
    NDB
   </code>
   to use compression when creating and
        writing to backup files.
  </p>
  <p>
   More detailed information about these parameters can be found in
   <a class="link" href="mysql-cluster-ndbd-definition.html#mysql-cluster-backup-parameters" title="Backup parameters">
    Backup
        Parameters
   </a>
   .
  </p>
  <p>
   You can also set a location for the backup files using the
   <a class="link" href="mysql-cluster-ndbd-definition.html#ndbparam-ndbd-backupdatadir">
    <code class="literal">
     BackupDataDir
    </code>
   </a>
   configuration parameter. The default is
   <a class="link" href="mysql-cluster-ndbd-definition.html#ndbparam-ndbd-filesystempath">
    <code class="literal">
     FileSystemPath
    </code>
   </a>
   <code class="filename">
    /BACKUP/BACKUP-
    <em class="replaceable">
     <code>
      backup_id
     </code>
    </em>
   </code>
   .
  </p>
  <p>
   You can enforce encryption of backup files by setting
   <a class="link" href="mysql-cluster-ndbd-definition.html#ndbparam-ndbd-requireencryptedbackup">
    <code class="literal">
     RequireEncryptedBackup
    </code>
   </a>
   to 1; this prevents the creation of backups without specifying
   <code class="literal">
    ENCRYPT
        PASSWORD=
    <em class="replaceable">
     <code>
      password
     </code>
    </em>
   </code>
   as part
        of a
   <code class="literal">
    START BACKUP
   </code>
   command.
  </p>
 </div>
 <br/>
</div>
