From 2ba33bef6e16ad6a5add06493081db03ab611403 Mon Sep 17 00:00:00 2001
From: GitHub Action <github-action@users.noreply.github.com>
Date: Wed, 25 Sep 2024 07:25:32 +0000
Subject: [PATCH] Deployed b29efe9e to 8.0 with MkDocs 1.6.1 and mike 2.1.3

---
 8.0/404.html                                  |  10 +-
 8.0/about-xtrabackup.html                     |  10 +-
 8.0/accelerate-backup-process.html            |  10 +-
 8.0/analyze-table-statistics.html             |  10 +-
 8.0/apt-download-deb.html                     | 190 ++++++++++--
 8.0/apt-files.html                            |  10 +-
 8.0/apt-pinning.html                          |  48 ++--
 8.0/apt-repo.html                             | 272 +++++++++++++++---
 8.0/apt-uninstall-xtrabackup.html             |  33 ++-
 8.0/backup-overview.html                      |  10 +-
 8.0/backup-strategy.html                      |  10 +-
 8.0/binaries-overview.html                    |  10 +-
 8.0/binary-tarball-names.html                 |  10 +-
 8.0/binary-tarball.html                       |  10 +-
 8.0/compile-xtrabackup.html                   |  10 +-
 8.0/configure-xtrabackup.html                 |  10 +-
 8.0/copyright-and-licensing-information.html  |  10 +-
 8.0/create-compressed-backup.html             |  10 +-
 8.0/create-full-backup.html                   |  10 +-
 8.0/create-gtid-replica.html                  |  10 +-
 8.0/create-incremental-backup.html            |  10 +-
 8.0/create-individual-partition-backup.html   |  10 +-
 8.0/create-partial-backup.html                |  10 +-
 8.0/dictionary-cache.html                     |  10 +-
 8.0/differences.html                          |  10 +-
 8.0/docker.html                               |  10 +-
 8.0/download-instructions.html                |  10 +-
 8.0/encrypt-backups.html                      |  10 +-
 8.0/encrypted-innodb-tablespace-backups.html  |  10 +-
 8.0/error-message-instant.html                |  10 +-
 8.0/example-full-incr.html                    |  10 +-
 8.0/faq.html                                  |  10 +-
 8.0/flush-tables-with-read-lock.html          |  10 +-
 8.0/glossary.html                             |  10 +-
 8.0/how-xtrabackup-works.html                 |  10 +-
 8.0/index.html                                |  10 +-
 8.0/installation.html                         |  10 +-
 8.0/lock-options.html                         |  10 +-
 8.0/log-enhancements.html                     |  10 +-
 8.0/lru-dump-backup.html                      |  10 +-
 8.0/make-backup-in-replication-env.html       |  10 +-
 8.0/page-tracking.html                        |  10 +-
 8.0/permissions.html                          |  10 +-
 8.0/point-in-time-recovery.html               |  10 +-
 8.0/prepare-compressed-backup.html            |  10 +-
 8.0/prepare-full-backup.html                  |  10 +-
 8.0/prepare-incremental-backup.html           |  10 +-
 8.0/prepare-individual-partitions-backup.html |  10 +-
 8.0/prepare-partial-backup.html               |  10 +-
 8.0/privileges.html                           |  10 +-
 8.0/quickstart-docker.html                    |  10 +-
 8.0/quickstart-exit.html                      |  10 +-
 8.0/quickstart-next-steps.html                |  10 +-
 8.0/quickstart-overview.html                  |  10 +-
 8.0/quickstart-restore-backup.html            |  10 +-
 8.0/redo-log-archiving.html                   |  10 +-
 8.0/release-notes.html                        |  10 +-
 8.0/release-notes/8.0/8.0-3-rc1.html          |  10 +-
 8.0/release-notes/8.0/8.0.10.html             |  10 +-
 8.0/release-notes/8.0/8.0.11.html             |  10 +-
 8.0/release-notes/8.0/8.0.12.html             |  10 +-
 8.0/release-notes/8.0/8.0.13.html             |  10 +-
 8.0/release-notes/8.0/8.0.14.html             |  10 +-
 8.0/release-notes/8.0/8.0.22-15.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.23-16.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.25-17.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.26-18.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.27-19.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.28-20.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.28-21.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.29-22.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.30-23.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.31-24.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.32-25.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.32-26.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.33-27.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.33-28.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.34-29.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.35-30.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.35-31.0.html        |  10 +-
 8.0/release-notes/8.0/8.0.35-31.0.upd.html    |  10 +-
 8.0/release-notes/8.0/8.0.4.html              |  10 +-
 8.0/release-notes/8.0/8.0.5.html              |  10 +-
 8.0/release-notes/8.0/8.0.6.html              |  10 +-
 8.0/release-notes/8.0/8.0.7.html              |  10 +-
 8.0/release-notes/8.0/8.0.8.html              |  10 +-
 8.0/release-notes/8.0/8.0.9.html              |  10 +-
 8.0/restore-a-backup.html                     |  10 +-
 8.0/restore-individual-partitions.html        |  10 +-
 8.0/restore-individual-tables.html            |  10 +-
 8.0/restore-partial-backup.html               |  10 +-
 8.0/search/search_index.json                  |   2 +-
 8.0/server-backup-version-comparison.html     |  10 +-
 8.0/set-up-replication.html                   |  10 +-
 8.0/smart-memory-estimation.html              |  10 +-
 8.0/store-backup-history.html                 |  10 +-
 8.0/supported-versions.html                   |  10 +-
 8.0/take-streaming-backup.html                |  10 +-
 8.0/throttling-backups.html                   |  10 +-
 8.0/toolkit-version-check.html                |  10 +-
 8.0/topic-index.html                          |  10 +-
 8.0/trademark-policy.html                     |  10 +-
 8.0/update-curl-utility.html                  |  10 +-
 8.0/verify-backup.html                        |  10 +-
 8.0/work-with-apparmor.html                   |  10 +-
 8.0/work-with-selinux.html                    |  10 +-
 8.0/working-with-binary-logs.html             |  10 +-
 8.0/xbcloud-azure.html                        |  10 +-
 8.0/xbcloud-binary-fifo-datasink.html         |  10 +-
 8.0/xbcloud-binary-overview.html              |  10 +-
 8.0/xbcloud-exbackoff.html                    |  10 +-
 8.0/xbcloud-gcs.html                          |  10 +-
 8.0/xbcloud-iam-profile.html                  |  10 +-
 8.0/xbcloud-minio.html                        |  10 +-
 8.0/xbcloud-options.html                      |  10 +-
 8.0/xbcloud-s3.html                           |  10 +-
 8.0/xbcloud-swift.html                        |  10 +-
 8.0/xbcrypt-binary-overview.html              |  10 +-
 8.0/xbcrypt-options.html                      |  10 +-
 8.0/xbstream-binary-overview.html             |  10 +-
 8.0/xbstream-options.html                     |  10 +-
 8.0/xtrabackup-binary-overview.html           |  10 +-
 8.0/xtrabackup-exit-codes.html                |  10 +-
 8.0/xtrabackup-files.html                     |  10 +-
 8.0/xtrabackup-implementation-details.html    |  10 +-
 8.0/xtrabackup-option-reference.html          |  10 +-
 8.0/xtrabackup-version-numbers.html           |  10 +-
 8.0/yum-download-rpm.html                     | 164 +++++++++--
 8.0/yum-files.html                            |  10 +-
 8.0/yum-repo.html                             | 214 ++++++++++++--
 8.0/yum-uninstall-xtrabackup.html             |  37 ++-
 131 files changed, 1434 insertions(+), 756 deletions(-)

diff --git a/8.0/404.html b/8.0/404.html
index dab076c6..c9b2b599 100644
--- a/8.0/404.html
+++ b/8.0/404.html
@@ -3021,7 +3021,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3063,7 +3063,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3084,7 +3084,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3190,7 +3190,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3232,7 +3232,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/about-xtrabackup.html b/8.0/about-xtrabackup.html
index 9572da59..9127e7fa 100644
--- a/8.0/about-xtrabackup.html
+++ b/8.0/about-xtrabackup.html
@@ -3122,7 +3122,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3164,7 +3164,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3185,7 +3185,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3291,7 +3291,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3333,7 +3333,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/accelerate-backup-process.html b/8.0/accelerate-backup-process.html
index 0a3e4b6f..44fd9870 100644
--- a/8.0/accelerate-backup-process.html
+++ b/8.0/accelerate-backup-process.html
@@ -3098,7 +3098,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3140,7 +3140,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3161,7 +3161,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3267,7 +3267,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3309,7 +3309,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/analyze-table-statistics.html b/8.0/analyze-table-statistics.html
index 6f33f1d4..7e6338aa 100644
--- a/8.0/analyze-table-statistics.html
+++ b/8.0/analyze-table-statistics.html
@@ -3107,7 +3107,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3149,7 +3149,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3170,7 +3170,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3276,7 +3276,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3318,7 +3318,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/apt-download-deb.html b/8.0/apt-download-deb.html
index 9bece1bd..7b0981bd 100644
--- a/8.0/apt-download-deb.html
+++ b/8.0/apt-download-deb.html
@@ -8,7 +8,7 @@
       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
       
-        <meta name="description" content="Download DEB packages of the desired series for your architecture from Percona Product Downloads.">
+        <meta name="description" content="This guide walks you through installing Percona XtraBackup 8.0 using DEB packages on Ubuntu-based systems.">
       
       
         <meta name="author" content="Percona LLC">
@@ -28,7 +28,7 @@
     
     
       
-        <title>Downloaded DEB packages - Percona XtraBackup</title>
+        <title>Download DEB packages - Percona XtraBackup</title>
       
     
     
@@ -91,7 +91,7 @@
                  
                  
                  <meta property="og:type" content="website" />
-                 <meta property="og:title" content="Percona XtraBackup - Downloaded DEB packages" />
+                 <meta property="og:title" content="Percona XtraBackup - Download DEB packages" />
                  <meta property="og:image" content="https://docs.percona.com/percona-xtrabackup/8.0/_static/percona-mysql-logo.png">
                  <meta property="og:url" content="https://docs.percona.com/percona-xtrabackup/">
 
@@ -114,7 +114,7 @@
     <div data-md-component="skip">
       
         
-        <a href="#install-percona-xtrabackup-80-using-downloaded-deb-packages" class="md-skip">
+        <a href="#install-with-deb-packages" class="md-skip">
           Skip to content
         </a>
       
@@ -189,7 +189,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
             
-              Downloaded DEB packages
+              Download DEB packages
             
           </span>
         </div>
@@ -3029,7 +3029,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3080,7 +3080,7 @@
           
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3091,7 +3091,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3114,6 +3114,42 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#common-dependencies-for-percona-xtrabackup" class="md-nav__link">
+    <span class="md-ellipsis">
+      Common dependencies for Percona XtraBackup
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#identify-and-add-missing-dependencies" class="md-nav__link">
+    <span class="md-ellipsis">
+      Identify and add missing dependencies
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#verify-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Verify the installation
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#troubleshoot-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Troubleshoot the installation
+    </span>
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#get-expert-help" class="md-nav__link">
     <span class="md-ellipsis">
@@ -3143,7 +3179,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3249,7 +3285,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3291,7 +3327,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
@@ -4620,6 +4656,42 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#common-dependencies-for-percona-xtrabackup" class="md-nav__link">
+    <span class="md-ellipsis">
+      Common dependencies for Percona XtraBackup
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#identify-and-add-missing-dependencies" class="md-nav__link">
+    <span class="md-ellipsis">
+      Identify and add missing dependencies
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#verify-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Verify the installation
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#troubleshoot-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Troubleshoot the installation
+    </span>
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#get-expert-help" class="md-nav__link">
     <span class="md-ellipsis">
@@ -4666,18 +4738,96 @@
   
 
 
-<h1 id="install-percona-xtrabackup-80-using-downloaded-deb-packages">Install Percona XtraBackup 8.0 using downloaded DEB packages<a class="headerlink" href="#install-percona-xtrabackup-80-using-downloaded-deb-packages" title="Permanent link">&para;</a></h1>
-<p>Download <code>DEB</code> packages of the desired series for your architecture from <a href="https://www.percona.com/downloads">Percona Product Downloads</a>. </p>
-<p>The following example downloads <em>Percona XtraBackup</em> 8.0.26-18 release package for Ubuntu 20.04:</p>
+<h1 id="install-with-deb-packages">Install with DEB packages<a class="headerlink" href="#install-with-deb-packages" title="Permanent link">&para;</a></h1>
+<p class="power-number">This guide walks you through installing Percona XtraBackup 8.0 using DEB packages on Ubuntu-based systems.</p>
+<ol>
+<li>
+<p>Download the DEB package</p>
+<p>On the <a href="https://www.percona.com/downloads">Percona Software Downloads</a> website, find the Percona XtraBackup 8.0 package for your system. </p>
+<p>For example, for Ubuntu 20.04, this command downloads the appropriate package:</p>
 <div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>wget<span class="w"> </span>https://downloads.percona.com/downloads/Percona-XtraBackup-LATEST/Percona-XtraBackup-8.0.26-18/binary/debian/focal/x86_64/percona-xtrabackup-80_8.0.26-18-1.focal_amd64.deb
 </code></pre></div>
-<p>Install Percona XtraBackup by using <code>dpkg</code>. Run this command as root or use the sudo command:</p>
+</li>
+<li>
+<p>Install the package</p>
+<p>Use the dpkg command to install the downloaded package. You need root privileges for this:</p>
 <div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>dpkg<span class="w"> </span>-i<span class="w"> </span>percona-xtrabackup-80_8.0.26-18-1.focal_amd64.deb
 </code></pre></div>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>When installing packages manually like this, resolve all the dependencies and install missing packages yourself.</p>
-</div>
+</li>
+</ol>
+<h2 id="common-dependencies-for-percona-xtrabackup">Common dependencies for Percona XtraBackup<a class="headerlink" href="#common-dependencies-for-percona-xtrabackup" title="Permanent link">&para;</a></h2>
+<table>
+<thead>
+<tr>
+<th>Library Name</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>libmysqlclient</td>
+<td>A client library for MySQL, providing essential functions for connecting to and communicating with MySQL databases.</td>
+</tr>
+<tr>
+<td>libssl</td>
+<td>A cryptographic library used for implementing SSL/TLS encryption, necessary for secure data transmission.</td>
+</tr>
+<tr>
+<td>libcurl</td>
+<td>A library that enables data transfer via various protocols such as HTTP, FTP, and others, commonly used for handling web requests.</td>
+</tr>
+<tr>
+<td>libev</td>
+<td>A high-performance event-loop library, often used in network applications for handling asynchronous events efficiently.</td>
+</tr>
+<tr>
+<td>libgcrypt</td>
+<td>A general-purpose cryptographic library that provides encryption, decryption, and cryptographic hashing algorithms.</td>
+</tr>
+<tr>
+<td>zlib</td>
+<td>A compression library used for data compression and decompression, supporting the popular DEFLATE compression algorithm.</td>
+</tr>
+</tbody>
+</table>
+<h2 id="identify-and-add-missing-dependencies">Identify and add missing dependencies<a class="headerlink" href="#identify-and-add-missing-dependencies" title="Permanent link">&para;</a></h2>
+<p>If there are missing dependencies, dpkg shows error messages. Install any missing packages with the following command:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-f
+</code></pre></div>
+<p>Retry the Percona XtraBackup installation.</p>
+<h2 id="verify-the-installation">Verify the installation<a class="headerlink" href="#verify-the-installation" title="Permanent link">&para;</a></h2>
+<p>The following command returns the version information.</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>xtrabackup<span class="w"> </span>--version
+</code></pre></div>
+<h2 id="troubleshoot-the-installation">Troubleshoot the installation<a class="headerlink" href="#troubleshoot-the-installation" title="Permanent link">&para;</a></h2>
+<table>
+<thead>
+<tr>
+<th>Issue</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Permission denied</td>
+<td>Ensure you&rsquo;re using sudo or have root access for installation commands.</td>
+</tr>
+<tr>
+<td>Repository issues</td>
+<td>If packages are not found, check your yum repository configuration.</td>
+</tr>
+<tr>
+<td>Incompatible OS version</td>
+<td>Double-check your OS version matches the package requirements.</td>
+</tr>
+<tr>
+<td>Conflicts with existing packages</td>
+<td>Consider removing conflicting packages or use a separate environment.</td>
+</tr>
+</tbody>
+</table>
+<p>If you encounter persistent issues, consult the Percona XtraBackup documentation or reach out to their support forums for assistance.</p>
+<p>Remember, when installing packages manually, you&rsquo;re responsible for managing dependencies and potential conflicts. Always back up your data before making significant system changes.</p>
 <div data-banner="data-banner">
 <p><svg style="display:block;margin:-1em 0 0.75em" width="78" height="69" viewBox="0 0 78 69" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M56.7281 30.7666C62.6528 26.8938 64.5914 18.9942 61.0059 12.7854C59.2094 9.67113 56.3053 7.44082 52.8311 6.50951C49.6122 5.64535 46.2502 5.99872 43.2912 7.49366L39.251 0.5L30.8648 15.0245L11.4811 48.5937H67.021L56.7281 30.7666ZM51.881 10.0674C54.4064 10.7401 56.5079 12.3616 57.8168 14.6194C60.3895 19.0701 59.053 24.7153 54.8808 27.5665L45.1362 10.6905C47.2355 9.68104 49.6034 9.46087 51.881 10.0674ZM39.251 7.87125L60.6339 44.907H48.1228L32.9927 18.7102L39.2499 7.87235L39.251 7.87125ZM17.8682 44.907L30.8637 22.4035L43.8592 44.907H17.8682Z" fill="url(#paint0_linear_2899_1968)"/><path style="fill:var(--md-typeset-color)" d="M4.981 64.943H3.157V68.207H.756V57.323H5.217C7.822 57.323 9.397 58.861 9.397 61.086V61.116C9.397 63.635 7.433 64.94 4.984 64.94L4.981 64.943V64.943ZM6.961 61.134C6.961 60.061 6.213 59.485 5.011 59.485H3.154V62.812H5.056C6.258 62.812 6.958 62.096 6.958 61.163V61.134H6.961ZM10.738 68.208V57.323H18.973V59.455H13.124V61.664H18.27V63.796H13.124V66.082H19.051V68.214H10.738V68.208 68.208ZM27.557 68.208 25.218 64.726H23.332V68.208H20.931V57.323H25.921C28.496 57.323 30.039 58.677 30.039 60.915V60.945C30.039 62.702 29.088 63.807 27.7 64.32L30.367 68.207H27.556L27.557 68.208ZM27.605 61.041C27.605 60.016 26.887 59.485 25.719 59.485H23.333V62.61H25.767C26.936 62.61 27.605 61.987 27.605 61.071V61.042 61.041ZM36.922 68.499C33.668 68.499 31.249 65.994 31.249 62.825V62.795C31.249 59.659 33.619 57.091 37.019 57.091 39.105 57.091 40.356 57.783 41.383 58.792L39.834 60.571C38.98 59.798 38.113 59.327 37.004 59.327 35.141 59.327 33.795 60.871 33.795 62.762V62.793C33.795 64.684 35.107 66.257 37.004 66.257 38.268 66.257 39.043 65.753 39.913 64.964L41.462 66.524C40.322 67.738 39.059 68.493 36.925 68.493L36.922 68.499ZM47.885 68.499C44.47 68.499 42.021 65.962 42.021 62.825V62.795C42.021 59.659 44.503 57.091 47.915 57.091 51.327 57.091 53.779 59.628 53.779 62.765V62.795C53.779 65.931 51.297 68.499 47.885 68.499ZM51.237 62.795C51.237 60.904 49.846 59.331 47.885 59.331 45.925 59.331 44.567 60.874 44.567 62.766V62.796C44.567 64.688 45.959 66.261 47.919 66.261 49.879 66.261 51.237 64.717 51.237 62.826V62.795 62.795ZM67.001 68.217 72.374 57.091 77.746 68.218H75.052L72.374 62.681 69.705 68.218H67.001V68.217ZM66.007 57.327V68.5L57.813 61.884V68.199H55.264V57.091L63.458 63.681V57.327H66.007Z"/><defs><linearGradient id="paint0_linear_2899_1968" x1="18.1513" y1="44.7152" x2="61.4356" y2="20.9786" gradientUnits="userSpaceOnUse"><stop stop-color="#FC3519"/><stop offset="1" stop-color="#F0D136"/></linearGradient></defs></svg></p>
 <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href="#get-expert-help" title="Permanent link">&para;</a></h2>
@@ -4693,7 +4843,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
   <small>
     
       Last update:
-      2023-06-12
+      2024-09-13
     
   </small>
 </div>
diff --git a/8.0/apt-files.html b/8.0/apt-files.html
index 37c6d948..450ab9e3 100644
--- a/8.0/apt-files.html
+++ b/8.0/apt-files.html
@@ -3029,7 +3029,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3122,7 +3122,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3143,7 +3143,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3249,7 +3249,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3291,7 +3291,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/apt-pinning.html b/8.0/apt-pinning.html
index 5317fd8a..490ebff9 100644
--- a/8.0/apt-pinning.html
+++ b/8.0/apt-pinning.html
@@ -8,7 +8,7 @@
       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
       
-        <meta name="description" content="In some cases you might need to pin the selected packages to avoid the upgrades from the distribution repositories.">
+        <meta name="description" content="You may need to keep a specific package at a certain version and prevent it from being automatically updated by your package manager. This action is called “pinning” a package.">
       
       
         <meta name="author" content="Percona LLC">
@@ -28,7 +28,7 @@
     
     
       
-        <title>Apt pinning - Percona XtraBackup</title>
+        <title>Pin packages - Percona XtraBackup</title>
       
     
     
@@ -91,7 +91,7 @@
                  
                  
                  <meta property="og:type" content="website" />
-                 <meta property="og:title" content="Percona XtraBackup - Apt pinning" />
+                 <meta property="og:title" content="Percona XtraBackup - Pin packages" />
                  <meta property="og:image" content="https://docs.percona.com/percona-xtrabackup/8.0/_static/percona-mysql-logo.png">
                  <meta property="og:url" content="https://docs.percona.com/percona-xtrabackup/">
 
@@ -114,7 +114,7 @@
     <div data-md-component="skip">
       
         
-        <a href="#apt-pinning-the-percona-xtrabackup-80-packages" class="md-skip">
+        <a href="#pin-packages-in-debian-based-systems" class="md-skip">
           Skip to content
         </a>
       
@@ -189,7 +189,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
             
-              Apt pinning
+              Pin packages
             
           </span>
         </div>
@@ -3029,7 +3029,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3071,7 +3071,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3101,7 +3101,7 @@
           
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3112,7 +3112,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3249,7 +3249,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3291,7 +3291,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
@@ -4666,14 +4666,28 @@
   
 
 
-<h1 id="apt-pinning-the-percona-xtrabackup-80-packages">Apt pinning the Percona XtraBackup 8.0 packages<a class="headerlink" href="#apt-pinning-the-percona-xtrabackup-80-packages" title="Permanent link">&para;</a></h1>
-<p>In some cases you might need to <code>pin</code> the selected packages to avoid the upgrades from the distribution repositories. </p>
-<p>The pinning takes place in the <code>preference</code> file. To pin a package, set the <code>Pin-Priority</code> to higher numbers.</p>
-<p>Make a new file <code>/etc/apt/preferences.d/00percona.pref</code>. For example, add the following to the preference file:</p>
-<div class="highlight"><pre><span></span><code>Package:
+<h1 id="pin-packages-in-debian-based-systems">Pin packages in Debian-based systems<a class="headerlink" href="#pin-packages-in-debian-based-systems" title="Permanent link">&para;</a></h1>
+<p class="power-number">You may need to keep a specific package at a certain version and prevent it from being automatically updated by your package manager. This action is called &ldquo;pinning&rdquo; a package.</p>
+<ol>
+<li>
+<p>Create a preference file, <code>00percona.pref</code>, in the <code>/etc/apt/preferences.d/</code> directory.</p>
+</li>
+<li>
+<p>Set the Pinning priority</p>
+<p>To pin a package, set the <code>Pin-Priority</code> to a higher number than the default priority of the packages. This setting makes the packages higher priority over the other sources.</p>
+<p>For example, add the following lines to the preference file:</p>
+<div class="highlight"><pre><span></span><code>Package: &lt;package_name&gt;
 Pin: release o=Percona Development Team
 Pin-Priority: 1001
 </code></pre></div>
+<p>Replace the <code>&lt;package_name&gt;</code> with the package&rsquo;s name. </p>
+</li>
+<li>
+<p>Save the <code>00percona.pref</code> file.</p>
+</li>
+</ol>
+<p>You can pin multiple packages by adding separate entries to the file.</p>
+<p>Remove the entry from the file if you no longer want to pin the package.</p>
 <p>For more information about the pinning, check the official <a href="http://wiki.debian.org/AptPreferences">debian wiki</a>.</p>
 <div data-banner="data-banner">
 <p><svg style="display:block;margin:-1em 0 0.75em" width="78" height="69" viewBox="0 0 78 69" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M56.7281 30.7666C62.6528 26.8938 64.5914 18.9942 61.0059 12.7854C59.2094 9.67113 56.3053 7.44082 52.8311 6.50951C49.6122 5.64535 46.2502 5.99872 43.2912 7.49366L39.251 0.5L30.8648 15.0245L11.4811 48.5937H67.021L56.7281 30.7666ZM51.881 10.0674C54.4064 10.7401 56.5079 12.3616 57.8168 14.6194C60.3895 19.0701 59.053 24.7153 54.8808 27.5665L45.1362 10.6905C47.2355 9.68104 49.6034 9.46087 51.881 10.0674ZM39.251 7.87125L60.6339 44.907H48.1228L32.9927 18.7102L39.2499 7.87235L39.251 7.87125ZM17.8682 44.907L30.8637 22.4035L43.8592 44.907H17.8682Z" fill="url(#paint0_linear_2899_1968)"/><path style="fill:var(--md-typeset-color)" d="M4.981 64.943H3.157V68.207H.756V57.323H5.217C7.822 57.323 9.397 58.861 9.397 61.086V61.116C9.397 63.635 7.433 64.94 4.984 64.94L4.981 64.943V64.943ZM6.961 61.134C6.961 60.061 6.213 59.485 5.011 59.485H3.154V62.812H5.056C6.258 62.812 6.958 62.096 6.958 61.163V61.134H6.961ZM10.738 68.208V57.323H18.973V59.455H13.124V61.664H18.27V63.796H13.124V66.082H19.051V68.214H10.738V68.208 68.208ZM27.557 68.208 25.218 64.726H23.332V68.208H20.931V57.323H25.921C28.496 57.323 30.039 58.677 30.039 60.915V60.945C30.039 62.702 29.088 63.807 27.7 64.32L30.367 68.207H27.556L27.557 68.208ZM27.605 61.041C27.605 60.016 26.887 59.485 25.719 59.485H23.333V62.61H25.767C26.936 62.61 27.605 61.987 27.605 61.071V61.042 61.041ZM36.922 68.499C33.668 68.499 31.249 65.994 31.249 62.825V62.795C31.249 59.659 33.619 57.091 37.019 57.091 39.105 57.091 40.356 57.783 41.383 58.792L39.834 60.571C38.98 59.798 38.113 59.327 37.004 59.327 35.141 59.327 33.795 60.871 33.795 62.762V62.793C33.795 64.684 35.107 66.257 37.004 66.257 38.268 66.257 39.043 65.753 39.913 64.964L41.462 66.524C40.322 67.738 39.059 68.493 36.925 68.493L36.922 68.499ZM47.885 68.499C44.47 68.499 42.021 65.962 42.021 62.825V62.795C42.021 59.659 44.503 57.091 47.915 57.091 51.327 57.091 53.779 59.628 53.779 62.765V62.795C53.779 65.931 51.297 68.499 47.885 68.499ZM51.237 62.795C51.237 60.904 49.846 59.331 47.885 59.331 45.925 59.331 44.567 60.874 44.567 62.766V62.796C44.567 64.688 45.959 66.261 47.919 66.261 49.879 66.261 51.237 64.717 51.237 62.826V62.795 62.795ZM67.001 68.217 72.374 57.091 77.746 68.218H75.052L72.374 62.681 69.705 68.218H67.001V68.217ZM66.007 57.327V68.5L57.813 61.884V68.199H55.264V57.091L63.458 63.681V57.327H66.007Z"/><defs><linearGradient id="paint0_linear_2899_1968" x1="18.1513" y1="44.7152" x2="61.4356" y2="20.9786" gradientUnits="userSpaceOnUse"><stop stop-color="#FC3519"/><stop offset="1" stop-color="#F0D136"/></linearGradient></defs></svg></p>
@@ -4690,7 +4704,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
   <small>
     
       Last update:
-      2023-06-12
+      2024-09-13
     
   </small>
 </div>
diff --git a/8.0/apt-repo.html b/8.0/apt-repo.html
index 764f3664..5d612813 100644
--- a/8.0/apt-repo.html
+++ b/8.0/apt-repo.html
@@ -29,7 +29,7 @@
     
     
       
-        <title>Use APT repositories - Percona XtraBackup</title>
+        <title>Percona release and APT - Percona XtraBackup</title>
       
     
     
@@ -92,7 +92,7 @@
                  
                  
                  <meta property="og:type" content="website" />
-                 <meta property="og:title" content="Percona XtraBackup - Use APT repositories" />
+                 <meta property="og:title" content="Percona XtraBackup - Percona release and APT" />
                  <meta property="og:image" content="https://docs.percona.com/percona-xtrabackup/8.0/_static/percona-mysql-logo.png">
                  <meta property="og:url" content="https://docs.percona.com/percona-xtrabackup/">
 
@@ -115,7 +115,7 @@
     <div data-md-component="skip">
       
         
-        <a href="#use-an-apt-repository-to-install-percona-xtrabackup-80" class="md-skip">
+        <a href="#install-percona-xtrabackup-on-debian-based-systems" class="md-skip">
           Skip to content
         </a>
       
@@ -190,7 +190,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
             
-              Use APT repositories
+              Percona release and APT
             
           </span>
         </div>
@@ -3039,7 +3039,7 @@
           
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3050,7 +3050,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3074,9 +3074,36 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#install-percona-xtrabackup-through-percona-release" class="md-nav__link">
+  <a href="#version-changes" class="md-nav__link">
     <span class="md-ellipsis">
-      Install Percona XtraBackup through percona-release
+      Version changes
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#prerequisites" class="md-nav__link">
+    <span class="md-ellipsis">
+      Prerequisites
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#installation-steps" class="md-nav__link">
+    <span class="md-ellipsis">
+      Installation steps
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#troubleshooting" class="md-nav__link">
+    <span class="md-ellipsis">
+      Troubleshooting
     </span>
   </a>
   
@@ -3132,7 +3159,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3153,7 +3180,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3259,7 +3286,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3301,7 +3328,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
@@ -4631,9 +4658,36 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#install-percona-xtrabackup-through-percona-release" class="md-nav__link">
+  <a href="#version-changes" class="md-nav__link">
+    <span class="md-ellipsis">
+      Version changes
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#prerequisites" class="md-nav__link">
+    <span class="md-ellipsis">
+      Prerequisites
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#installation-steps" class="md-nav__link">
     <span class="md-ellipsis">
-      Install Percona XtraBackup through percona-release
+      Installation steps
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#troubleshooting" class="md-nav__link">
+    <span class="md-ellipsis">
+      Troubleshooting
     </span>
   </a>
   
@@ -4685,46 +4739,189 @@
   
 
 
-<h1 id="use-an-apt-repository-to-install-percona-xtrabackup-80">Use an APT repository to install Percona XtraBackup 8.0<a class="headerlink" href="#use-an-apt-repository-to-install-percona-xtrabackup-80" title="Permanent link">&para;</a></h1>
+<h1 id="install-percona-xtrabackup-on-debian-based-systems">Install Percona XtraBackup on Debian-based systems<a class="headerlink" href="#install-percona-xtrabackup-on-debian-based-systems" title="Permanent link">&para;</a></h1>
 <p>Ready-to-use packages are available from the Percona XtraBackup software
 repositories and the <a href="https://www.percona.com/downloads">download page</a>.</p>
 <p>Specific information on the supported platforms, products, and versions is
 described in <a href="https://www.percona.com/services/policies/percona-software-platform-lifecycle#mysql">Percona Release Lifecycle Overview</a>.</p>
-<div class="admonition important">
-<p class="admonition-title">Important</p>
 <p>To prevent intermittent backup failures, <a href="update-curl-utility.html">update the curl utility in Debian 10</a>.</p>
-</div>
-<h2 id="install-percona-xtrabackup-through-percona-release">Install Percona XtraBackup through percona-release<a class="headerlink" href="#install-percona-xtrabackup-through-percona-release" title="Permanent link">&para;</a></h2>
-<p>Percona XtraBackup, like many other Percona products, is installed with the <em>percona-release</em> package configuration tool.</p>
+<p>This guide walks you through the process of installing Percona XtraBackup 8.0 on Debian-based systems using the Percona-release tool.</p>
+<h2 id="version-changes">Version changes<a class="headerlink" href="#version-changes" title="Permanent link">&para;</a></h2>
+<p>Starting with <a href="release-notes/8.0/8.0.35-31.0.html">Percona XtraBackup 8.0.35-31</a>, the APT builds for the following platforms include ARM packages with the <code>arm64.deb</code> extension:</p>
+<ul>
+<li>
+<p>Debian 12</p>
+</li>
+<li>
+<p>Debian 11</p>
+</li>
+<li>
+<p>Ubuntu 24.04</p>
+</li>
+<li>
+<p>Ubuntu 22.04</p>
+</li>
+<li>
+<p>Ubuntu 20.04</p>
+</li>
+</ul>
+<p>This extension means Percona XtraBackup is now available for users on ARM-based systems.</p>
+<p>We recommend downloading Percona XtraBackup for the same platform as your MySQL-compatible server. For instance, if your server runs on an ARM64 platform, you should download and use the Percona XtraBackup with the <code>arm64.deb</code> extension for that operating system.</p>
+<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h2>
+<ul>
+<li>
+<p>Sudo or root access</p>
+</li>
+<li>
+<p>Internet connection</p>
+</li>
+</ul>
+<h2 id="installation-steps">Installation steps<a class="headerlink" href="#installation-steps" title="Permanent link">&para;</a></h2>
+<p class="power-number">The following procedure installs Percona XtraBackup 8.0.</p>
 <ol>
 <li>
-<p>Download a <code>DEB</code> package for <em>percona-release</em> the repository packages from Percona web:</p>
-<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>wget<span class="w"> </span>https://repo.percona.com/apt/percona-release_latest.<span class="k">$(</span>lsb_release<span class="w"> </span>-sc<span class="k">)</span>_all.deb
+<p>Update the system package list</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>update
 </code></pre></div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>Get:1 http://ports.ubuntu.com/ubuntu-ports jammy InRelease [270 kB]
+Get:2 http://ports.ubuntu.com/ubuntu-ports jammy-updates InRelease [128 kB]
+Get:3 http://ports.ubuntu.com/ubuntu-ports jammy-backports InRelease [127 kB]
+Get:4 http://ports.ubuntu.com/ubuntu-ports jammy-security InRelease [129 kB]
+Get:5 http://ports.ubuntu.com/ubuntu-ports jammy/restricted arm64 Packages [24.2 kB]
+Get:6 http://ports.ubuntu.com/ubuntu-ports jammy/multiverse arm64 Packages [224 kB]
+Get:7 http://ports.ubuntu.com/ubuntu-ports jammy/universe arm64 Packages [17.2 MB]
+Get:8 http://ports.ubuntu.com/ubuntu-ports jammy/main arm64 Packages [1758 kB]
+Get:9 http://ports.ubuntu.com/ubuntu-ports jammy-updates/restricted arm64 Packages [2400 kB]
+Get:10 http://ports.ubuntu.com/ubuntu-ports jammy-updates/multiverse arm64 Packages [29.5 kB]
+Get:11 http://ports.ubuntu.com/ubuntu-ports jammy-updates/universe arm64 Packages [1379 kB]
+Get:12 http://ports.ubuntu.com/ubuntu-ports jammy-updates/main arm64 Packages [2217 kB]
+Get:13 http://ports.ubuntu.com/ubuntu-ports jammy-backports/universe arm64 Packages [31.8 kB]
+Get:14 http://ports.ubuntu.com/ubuntu-ports jammy-backports/main arm64 Packages [81.0 kB]
+Get:15 http://ports.ubuntu.com/ubuntu-ports jammy-security/main arm64 Packages [1949 kB]
+Get:16 http://ports.ubuntu.com/ubuntu-ports jammy-security/restricted arm64 Packages [2330 kB]
+Get:17 http://ports.ubuntu.com/ubuntu-ports jammy-security/multiverse arm64 Packages [24.1 kB]
+Get:18 http://ports.ubuntu.com/ubuntu-ports jammy-security/universe arm64 Packages [1096 kB]
+Fetched 31.4 MB in 7s (4264 kB/s)
+Reading package lists... Done
+Building dependency tree... Done
+Reading state information... Done
+9 packages can be upgraded. Run &#39;apt list --upgradable&#39; to see them.
+</code></pre></div>
+</details>
 </li>
 <li>
-<p>Install the downloaded package with <strong>dpkg</strong>. To do that, run the following commands as root or with <strong>sudo</strong>: <code>dpkg -i percona-release_latest.$(lsb_release -sc)_all.deb</code></p>
-<p>Once you install this package the Percona repositories should be added. You
-can check the repository setup in the <code>/etc/apt/sources.list.d/percona-release.list</code> file.</p>
+<p>Install the curl download utility if it&rsquo;s not installed:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>curl
+</code></pre></div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>Reading package lists... Done
+Building dependency tree... Done
+Reading state information... Done
+The following additional packages will be installed:
+  ca-certificates libbrotli1 libcurl4 libldap-2.5-0 libldap-common libnghttp2-14 libpsl5 librtmp1
+Suggested packages:
+...
+Updating certificates in /etc/ssl/certs...
+0 added, 0 removed; done.######################################################################...]
+Running hooks in /etc/ca-certificates/update.d...
+done.
+</code></pre></div>
+</details>
+</li>
+<li>
+<p>Download the percona-release the repository package:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>curl<span class="w"> </span>-O<span class="w"> </span>https://repo.percona.com/apt/percona-release_latest.generic_all.deb
+</code></pre></div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                Dload  Upload   Total   Spent    Left Speed
+100 16510  100 16510    0     0  31433      0 --:--:-- --:--:-- --:--:-- 31447
+</code></pre></div>
+</details>
 </li>
 <li>
-<p>Enable the repository: <code>percona-release enable-only tools release</code></p>
-<p>If <em>Percona XtraBackup</em> is intended to be used in combination with
-the upstream MySQL Server, you only need to enable the <code>tools</code>
-repository: <code>percona-release enable-only tools</code>.</p>
+<p>Install the downloaded package and its dependencies using apt:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>gnupg2<span class="w"> </span>lsb-release<span class="w"> </span>./percona-release_latest.generic_all.deb
+</code></pre></div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>Reading package lists... Done
+Building dependency tree... Done
+Reading state information... Done
+Note, selecting &#39;percona-release&#39; instead of &#39;./percona-release_latest.generic_all.deb&#39;
+The following additional packages will be installed:
+</code></pre></div>
+</details>
 </li>
 <li>
 <p>Refresh the local cache to update the package information:</p>
 <div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>update
 </code></pre></div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>Hit:1 http://repo.percona.com/pmm2-client/apt jammy InRelease
+Hit:2 http://ports.ubuntu.com/ubuntu-ports jammy InRelease
+Hit:3 http://repo.percona.com/prel/apt jammy InRelease
+...
+</code></pre></div>
+</details>
 </li>
 <li>
-<p>Install the <code>percona-xtrabackup-80</code> package:</p>
+<p>Enable the repository:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>percona-release<span class="w"> </span>setup<span class="w"> </span>pxb-80
+</code></pre></div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>* Disabling all Percona Repositories
+* Enabling the Percona XtraBackup 8.0 repository
+Hit:1 http://repo.percona.com/prel/apt jammy InRelease
+Get:2 http://repo.percona.com/pxb-80/apt jammy InRelease [18.7 kB]
+Hit:3 http://ports.ubuntu.com/ubuntu-ports jammy InRelease
+Get:4 http://ports.ubuntu.com/ubuntu-ports jammy-updates InRelease [128 kB]
+Hit:5 http://repo.percona.com/telemetry/apt jammy InRelease
+Get:6 http://repo.percona.com/pxb-80/apt jammy/main Sources [3393 B]
+Get:7 http://ports.ubuntu.com/ubuntu-ports jammy-backports InRelease [127 kB]
+Get:8 http://ports.ubuntu.com/ubuntu-ports jammy-security InRelease [129 kB]
+Fetched 406 kB in 1s (274 kB/s)
+Reading package lists... Done
+</code></pre></div>
+</details>
+</li>
+<li>
+<p>Install the package:</p>
 <div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>percona-xtrabackup-80
 </code></pre></div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>Reading package lists... Done
+Building dependency tree... Done
+Reading state information... Done
+The following additional packages will be installed:
+  libaio1 libcurl4-openssl-dev libdbd-mysql-perl libdbi-perl libev4 libgdbm-compat4 libgdbm6
+  libmysqlclient21 libperl5.34 libpopt0 mysql-common netbase perl perl-modules-5.34 rsync zstd
+...
+Setting up libdbd-mysql-perl:amd64 (4.050-5ubuntu0.22.04.1) ...##########################.........]
+Setting up percona-xtrabackup-80 (8.0.35-31-1.jammy) ...####################################......]
+Processing triggers for libc-bin (2.35-0ubuntu3.8) ...########################################....]
+</code></pre></div>
+</details>
 </li>
 <li>
-<p>To decompress backups made using <code>LZ4</code> or <code>ZSTD</code> compression algorithm, install the corresponding package:</p>
+<p>Verify the installation:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>xtrabackup<span class="w"> </span>--version
+</code></pre></div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>xtrabackup version 8.0.35-31 based on MySQL server 8.0.35 Linux (x86_64) (revision id: 55ec21d7)
+</code></pre></div>
+</details>
+</li>
+<li>
+<p>Install optional compression packages if you plan to use LZ4 or ZSTD compression:</p>
 <div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Install the <code>lz4</code> package</label><label for="__tabbed_1_2">Install the <code>zstd</code> package</label></div>
 <div class="tabbed-content">
 <div class="tabbed-block">
@@ -4739,12 +4936,15 @@ <h2 id="install-percona-xtrabackup-through-percona-release">Install Percona Xtra
 </div>
 </li>
 </ol>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
+<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">&para;</a></h2>
+<p>If you encounter any errors during the installation process, check your system&rsquo;s error logs:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>tail<span class="w"> </span>-n<span class="w"> </span><span class="m">50</span><span class="w"> </span>/var/log/syslog
+</code></pre></div>
+<p>Ensure your system meets the minimum requirements for Percona XtraBackup. </p>
+<p>If you encounter permission errors, ensure you&rsquo;re running the commands with <code>sudo</code> or have root access.</p>
 <p>For AppArmor profile information, see <a href="work-with-apparmor.html">Working with AppArmor</a>.</p>
-</div>
 <div class="admonition admonition">
-<p class="admonition-title">See also</p>
+<p class="admonition-title">Additional resources</p>
 <p>To install Percona XtraBackup using downloaded deb packages, see <a href="apt-download-deb.html">Install Percona XtraBackup 8.0</a>.</p>
 <p>To uninstall Percona XtraBackup, see <a href="apt-uninstall-xtrabackup.html">Uninstall Percona XtraBackup 8.0</a></p>
 </div>
@@ -4763,7 +4963,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
   <small>
     
       Last update:
-      2023-06-30
+      2024-09-13
     
   </small>
 </div>
diff --git a/8.0/apt-uninstall-xtrabackup.html b/8.0/apt-uninstall-xtrabackup.html
index 127daacc..c9649cb7 100644
--- a/8.0/apt-uninstall-xtrabackup.html
+++ b/8.0/apt-uninstall-xtrabackup.html
@@ -8,7 +8,7 @@
       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
       
-        <meta name="description" content="To completely uninstall Percona XtraBackup, remove all the installed packages:">
+        <meta name="description" content="Remember to back up any important data before uninstalling software.">
       
       
         <meta name="author" content="Percona LLC">
@@ -114,7 +114,7 @@
     <div data-md-component="skip">
       
         
-        <a href="#uninstall-percona-xtrabackup-80-on-debian-and-ubuntu" class="md-skip">
+        <a href="#uninstall-percona-xtrabackup-80-on-debian-based-systems" class="md-skip">
           Skip to content
         </a>
       
@@ -3029,7 +3029,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3071,7 +3071,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3092,7 +3092,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3249,7 +3249,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3291,7 +3291,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
@@ -4666,10 +4666,25 @@
   
 
 
-<h1 id="uninstall-percona-xtrabackup-80-on-debian-and-ubuntu">Uninstall Percona XtraBackup 8.0 on Debian and Ubuntu<a class="headerlink" href="#uninstall-percona-xtrabackup-80-on-debian-and-ubuntu" title="Permanent link">&para;</a></h1>
+<h1 id="uninstall-percona-xtrabackup-80-on-debian-based-systems">Uninstall Percona XtraBackup 8.0 on Debian-based systems<a class="headerlink" href="#uninstall-percona-xtrabackup-80-on-debian-based-systems" title="Permanent link">&para;</a></h1>
+<p>Remember to back up any important data before uninstalling software.</p>
 <p>To completely uninstall Percona XtraBackup, remove all the installed packages:</p>
 <div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>remove<span class="w"> </span>percona-xtrabackup-80
 </code></pre></div>
+<p>Run the following command to remove all configuration files along with the packages:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>purge<span class="w"> </span>percona-xtrabackup-80
+</code></pre></div>
+<p>Remove any unused dependencies:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>autoremove
+</code></pre></div>
+<p>To verify the removal, check the version:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>xtrabackup<span class="w"> </span>--version
+</code></pre></div>
+<p>This should return a <code>command not found</code>.</p>
+<p>You must remove any remaining directories manually:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>rm<span class="w"> </span>-rf<span class="w"> </span>/var/lib/xtrabackup
+</code></pre></div>
+<p>You can also remove any added Percona repositories from your system manager&rsquo;s configuration.</p>
 <div data-banner="data-banner">
 <p><svg style="display:block;margin:-1em 0 0.75em" width="78" height="69" viewBox="0 0 78 69" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M56.7281 30.7666C62.6528 26.8938 64.5914 18.9942 61.0059 12.7854C59.2094 9.67113 56.3053 7.44082 52.8311 6.50951C49.6122 5.64535 46.2502 5.99872 43.2912 7.49366L39.251 0.5L30.8648 15.0245L11.4811 48.5937H67.021L56.7281 30.7666ZM51.881 10.0674C54.4064 10.7401 56.5079 12.3616 57.8168 14.6194C60.3895 19.0701 59.053 24.7153 54.8808 27.5665L45.1362 10.6905C47.2355 9.68104 49.6034 9.46087 51.881 10.0674ZM39.251 7.87125L60.6339 44.907H48.1228L32.9927 18.7102L39.2499 7.87235L39.251 7.87125ZM17.8682 44.907L30.8637 22.4035L43.8592 44.907H17.8682Z" fill="url(#paint0_linear_2899_1968)"/><path style="fill:var(--md-typeset-color)" d="M4.981 64.943H3.157V68.207H.756V57.323H5.217C7.822 57.323 9.397 58.861 9.397 61.086V61.116C9.397 63.635 7.433 64.94 4.984 64.94L4.981 64.943V64.943ZM6.961 61.134C6.961 60.061 6.213 59.485 5.011 59.485H3.154V62.812H5.056C6.258 62.812 6.958 62.096 6.958 61.163V61.134H6.961ZM10.738 68.208V57.323H18.973V59.455H13.124V61.664H18.27V63.796H13.124V66.082H19.051V68.214H10.738V68.208 68.208ZM27.557 68.208 25.218 64.726H23.332V68.208H20.931V57.323H25.921C28.496 57.323 30.039 58.677 30.039 60.915V60.945C30.039 62.702 29.088 63.807 27.7 64.32L30.367 68.207H27.556L27.557 68.208ZM27.605 61.041C27.605 60.016 26.887 59.485 25.719 59.485H23.333V62.61H25.767C26.936 62.61 27.605 61.987 27.605 61.071V61.042 61.041ZM36.922 68.499C33.668 68.499 31.249 65.994 31.249 62.825V62.795C31.249 59.659 33.619 57.091 37.019 57.091 39.105 57.091 40.356 57.783 41.383 58.792L39.834 60.571C38.98 59.798 38.113 59.327 37.004 59.327 35.141 59.327 33.795 60.871 33.795 62.762V62.793C33.795 64.684 35.107 66.257 37.004 66.257 38.268 66.257 39.043 65.753 39.913 64.964L41.462 66.524C40.322 67.738 39.059 68.493 36.925 68.493L36.922 68.499ZM47.885 68.499C44.47 68.499 42.021 65.962 42.021 62.825V62.795C42.021 59.659 44.503 57.091 47.915 57.091 51.327 57.091 53.779 59.628 53.779 62.765V62.795C53.779 65.931 51.297 68.499 47.885 68.499ZM51.237 62.795C51.237 60.904 49.846 59.331 47.885 59.331 45.925 59.331 44.567 60.874 44.567 62.766V62.796C44.567 64.688 45.959 66.261 47.919 66.261 49.879 66.261 51.237 64.717 51.237 62.826V62.795 62.795ZM67.001 68.217 72.374 57.091 77.746 68.218H75.052L72.374 62.681 69.705 68.218H67.001V68.217ZM66.007 57.327V68.5L57.813 61.884V68.199H55.264V57.091L63.458 63.681V57.327H66.007Z"/><defs><linearGradient id="paint0_linear_2899_1968" x1="18.1513" y1="44.7152" x2="61.4356" y2="20.9786" gradientUnits="userSpaceOnUse"><stop stop-color="#FC3519"/><stop offset="1" stop-color="#F0D136"/></linearGradient></defs></svg></p>
 <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href="#get-expert-help" title="Permanent link">&para;</a></h2>
@@ -4685,7 +4700,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
   <small>
     
       Last update:
-      2023-06-12
+      2024-09-13
     
   </small>
 </div>
diff --git a/8.0/backup-overview.html b/8.0/backup-overview.html
index fb61a88c..1ff1bae8 100644
--- a/8.0/backup-overview.html
+++ b/8.0/backup-overview.html
@@ -3021,7 +3021,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3063,7 +3063,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3084,7 +3084,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3190,7 +3190,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3232,7 +3232,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/backup-strategy.html b/8.0/backup-strategy.html
index ac4813b2..8deaa090 100644
--- a/8.0/backup-strategy.html
+++ b/8.0/backup-strategy.html
@@ -3147,7 +3147,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3189,7 +3189,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3210,7 +3210,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3316,7 +3316,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3358,7 +3358,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/binaries-overview.html b/8.0/binaries-overview.html
index ac5c8669..c1c5683d 100644
--- a/8.0/binaries-overview.html
+++ b/8.0/binaries-overview.html
@@ -3078,7 +3078,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3120,7 +3120,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3141,7 +3141,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3247,7 +3247,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3289,7 +3289,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/binary-tarball-names.html b/8.0/binary-tarball-names.html
index 8961ec8c..65e5c1db 100644
--- a/8.0/binary-tarball-names.html
+++ b/8.0/binary-tarball-names.html
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3196,7 +3196,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3238,7 +3238,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/binary-tarball.html b/8.0/binary-tarball.html
index b998ee86..4e92373c 100644
--- a/8.0/binary-tarball.html
+++ b/8.0/binary-tarball.html
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3196,7 +3196,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3238,7 +3238,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/compile-xtrabackup.html b/8.0/compile-xtrabackup.html
index 141399bc..0983509c 100644
--- a/8.0/compile-xtrabackup.html
+++ b/8.0/compile-xtrabackup.html
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3196,7 +3196,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3238,7 +3238,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/configure-xtrabackup.html b/8.0/configure-xtrabackup.html
index 35efa9aa..45696767 100644
--- a/8.0/configure-xtrabackup.html
+++ b/8.0/configure-xtrabackup.html
@@ -3091,7 +3091,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3133,7 +3133,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3154,7 +3154,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3260,7 +3260,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3302,7 +3302,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/copyright-and-licensing-information.html b/8.0/copyright-and-licensing-information.html
index 47112a6b..a693e687 100644
--- a/8.0/copyright-and-licensing-information.html
+++ b/8.0/copyright-and-licensing-information.html
@@ -3023,7 +3023,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3065,7 +3065,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3086,7 +3086,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3192,7 +3192,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3234,7 +3234,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/create-compressed-backup.html b/8.0/create-compressed-backup.html
index b03d85e3..6997f85b 100644
--- a/8.0/create-compressed-backup.html
+++ b/8.0/create-compressed-backup.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/create-full-backup.html b/8.0/create-full-backup.html
index aef62de5..7247fc36 100644
--- a/8.0/create-full-backup.html
+++ b/8.0/create-full-backup.html
@@ -3033,7 +3033,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3075,7 +3075,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3096,7 +3096,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3202,7 +3202,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3244,7 +3244,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/create-gtid-replica.html b/8.0/create-gtid-replica.html
index 3f783eb0..df65ee42 100644
--- a/8.0/create-gtid-replica.html
+++ b/8.0/create-gtid-replica.html
@@ -3032,7 +3032,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3074,7 +3074,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3095,7 +3095,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3201,7 +3201,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3243,7 +3243,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/create-incremental-backup.html b/8.0/create-incremental-backup.html
index 269de527..a408a14b 100644
--- a/8.0/create-incremental-backup.html
+++ b/8.0/create-incremental-backup.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/create-individual-partition-backup.html b/8.0/create-individual-partition-backup.html
index 13dec9f5..4c15517b 100644
--- a/8.0/create-individual-partition-backup.html
+++ b/8.0/create-individual-partition-backup.html
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3196,7 +3196,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3238,7 +3238,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/create-partial-backup.html b/8.0/create-partial-backup.html
index 6c37e7d4..4d7f35d2 100644
--- a/8.0/create-partial-backup.html
+++ b/8.0/create-partial-backup.html
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3196,7 +3196,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3238,7 +3238,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/dictionary-cache.html b/8.0/dictionary-cache.html
index a0cd00bb..4b06a553 100644
--- a/8.0/dictionary-cache.html
+++ b/8.0/dictionary-cache.html
@@ -3098,7 +3098,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3140,7 +3140,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3161,7 +3161,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3267,7 +3267,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3309,7 +3309,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/differences.html b/8.0/differences.html
index 3829dec1..9d1b4504 100644
--- a/8.0/differences.html
+++ b/8.0/differences.html
@@ -3078,7 +3078,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3120,7 +3120,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3141,7 +3141,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3247,7 +3247,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3289,7 +3289,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/docker.html b/8.0/docker.html
index d9ba7e9d..60071f0c 100644
--- a/8.0/docker.html
+++ b/8.0/docker.html
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3196,7 +3196,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3238,7 +3238,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/download-instructions.html b/8.0/download-instructions.html
index 8f47378d..ce028c2a 100644
--- a/8.0/download-instructions.html
+++ b/8.0/download-instructions.html
@@ -3107,7 +3107,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3149,7 +3149,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3170,7 +3170,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3276,7 +3276,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3318,7 +3318,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/encrypt-backups.html b/8.0/encrypt-backups.html
index db0c472c..360e0e5b 100644
--- a/8.0/encrypt-backups.html
+++ b/8.0/encrypt-backups.html
@@ -3150,7 +3150,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3192,7 +3192,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3213,7 +3213,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3319,7 +3319,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3361,7 +3361,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/encrypted-innodb-tablespace-backups.html b/8.0/encrypted-innodb-tablespace-backups.html
index 3db9f28a..45434dbe 100644
--- a/8.0/encrypted-innodb-tablespace-backups.html
+++ b/8.0/encrypted-innodb-tablespace-backups.html
@@ -3263,7 +3263,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3305,7 +3305,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3326,7 +3326,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3432,7 +3432,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3474,7 +3474,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/error-message-instant.html b/8.0/error-message-instant.html
index 1add5aa1..863b3c1d 100644
--- a/8.0/error-message-instant.html
+++ b/8.0/error-message-instant.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/example-full-incr.html b/8.0/example-full-incr.html
index 64c1beaa..639bb21e 100644
--- a/8.0/example-full-incr.html
+++ b/8.0/example-full-incr.html
@@ -3123,7 +3123,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3165,7 +3165,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3186,7 +3186,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3292,7 +3292,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3334,7 +3334,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/faq.html b/8.0/faq.html
index dd47c801..0236675a 100644
--- a/8.0/faq.html
+++ b/8.0/faq.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/flush-tables-with-read-lock.html b/8.0/flush-tables-with-read-lock.html
index da1a766a..f15db162 100644
--- a/8.0/flush-tables-with-read-lock.html
+++ b/8.0/flush-tables-with-read-lock.html
@@ -3120,7 +3120,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3162,7 +3162,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3183,7 +3183,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3289,7 +3289,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3331,7 +3331,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/glossary.html b/8.0/glossary.html
index 773ead4f..52010a90 100644
--- a/8.0/glossary.html
+++ b/8.0/glossary.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/how-xtrabackup-works.html b/8.0/how-xtrabackup-works.html
index da6bdb19..60514e08 100644
--- a/8.0/how-xtrabackup-works.html
+++ b/8.0/how-xtrabackup-works.html
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3132,7 +3132,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3153,7 +3153,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3259,7 +3259,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3301,7 +3301,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/index.html b/8.0/index.html
index f56e2b69..8f25ea37 100644
--- a/8.0/index.html
+++ b/8.0/index.html
@@ -3147,7 +3147,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3189,7 +3189,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3210,7 +3210,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3316,7 +3316,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3358,7 +3358,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/installation.html b/8.0/installation.html
index a0bfea95..006e2e93 100644
--- a/8.0/installation.html
+++ b/8.0/installation.html
@@ -3087,7 +3087,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3129,7 +3129,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3150,7 +3150,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3256,7 +3256,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3298,7 +3298,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/lock-options.html b/8.0/lock-options.html
index 2ab27604..be6dcbfd 100644
--- a/8.0/lock-options.html
+++ b/8.0/lock-options.html
@@ -3098,7 +3098,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3140,7 +3140,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3161,7 +3161,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3267,7 +3267,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3309,7 +3309,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/log-enhancements.html b/8.0/log-enhancements.html
index 0a721d75..adae2369 100644
--- a/8.0/log-enhancements.html
+++ b/8.0/log-enhancements.html
@@ -3089,7 +3089,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3131,7 +3131,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3152,7 +3152,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3258,7 +3258,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3300,7 +3300,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/lru-dump-backup.html b/8.0/lru-dump-backup.html
index 1efb4153..e8bb11eb 100644
--- a/8.0/lru-dump-backup.html
+++ b/8.0/lru-dump-backup.html
@@ -3083,7 +3083,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3125,7 +3125,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3146,7 +3146,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3252,7 +3252,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3294,7 +3294,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/make-backup-in-replication-env.html b/8.0/make-backup-in-replication-env.html
index 7fcafe1a..31366844 100644
--- a/8.0/make-backup-in-replication-env.html
+++ b/8.0/make-backup-in-replication-env.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/page-tracking.html b/8.0/page-tracking.html
index 315e5ca3..761a2ff0 100644
--- a/8.0/page-tracking.html
+++ b/8.0/page-tracking.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/permissions.html b/8.0/permissions.html
index 90a336d8..e1c2ef6f 100644
--- a/8.0/permissions.html
+++ b/8.0/permissions.html
@@ -3082,7 +3082,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3124,7 +3124,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3145,7 +3145,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3251,7 +3251,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3293,7 +3293,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/point-in-time-recovery.html b/8.0/point-in-time-recovery.html
index 0e49bffa..eb9a41e5 100644
--- a/8.0/point-in-time-recovery.html
+++ b/8.0/point-in-time-recovery.html
@@ -3081,7 +3081,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3123,7 +3123,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3144,7 +3144,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3250,7 +3250,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3292,7 +3292,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/prepare-compressed-backup.html b/8.0/prepare-compressed-backup.html
index 733dbad7..d064f53d 100644
--- a/8.0/prepare-compressed-backup.html
+++ b/8.0/prepare-compressed-backup.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/prepare-full-backup.html b/8.0/prepare-full-backup.html
index cd9b9c7d..faf9c54a 100644
--- a/8.0/prepare-full-backup.html
+++ b/8.0/prepare-full-backup.html
@@ -3026,7 +3026,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3068,7 +3068,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3089,7 +3089,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3195,7 +3195,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3237,7 +3237,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/prepare-incremental-backup.html b/8.0/prepare-incremental-backup.html
index a9b44744..497d5010 100644
--- a/8.0/prepare-incremental-backup.html
+++ b/8.0/prepare-incremental-backup.html
@@ -3038,7 +3038,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3080,7 +3080,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3101,7 +3101,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3207,7 +3207,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3249,7 +3249,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/prepare-individual-partitions-backup.html b/8.0/prepare-individual-partitions-backup.html
index 264ff7a1..d42030f9 100644
--- a/8.0/prepare-individual-partitions-backup.html
+++ b/8.0/prepare-individual-partitions-backup.html
@@ -3026,7 +3026,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3068,7 +3068,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3089,7 +3089,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3195,7 +3195,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3237,7 +3237,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/prepare-partial-backup.html b/8.0/prepare-partial-backup.html
index 961871c5..ca4bcbdc 100644
--- a/8.0/prepare-partial-backup.html
+++ b/8.0/prepare-partial-backup.html
@@ -3026,7 +3026,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3068,7 +3068,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3089,7 +3089,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3195,7 +3195,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3237,7 +3237,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/privileges.html b/8.0/privileges.html
index 8807d708..fadcbb0d 100644
--- a/8.0/privileges.html
+++ b/8.0/privileges.html
@@ -3132,7 +3132,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3174,7 +3174,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3195,7 +3195,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3301,7 +3301,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3343,7 +3343,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/quickstart-docker.html b/8.0/quickstart-docker.html
index de332a59..4210297f 100644
--- a/8.0/quickstart-docker.html
+++ b/8.0/quickstart-docker.html
@@ -3120,7 +3120,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3162,7 +3162,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3183,7 +3183,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3289,7 +3289,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3331,7 +3331,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/quickstart-exit.html b/8.0/quickstart-exit.html
index 4d02791d..d6a37a29 100644
--- a/8.0/quickstart-exit.html
+++ b/8.0/quickstart-exit.html
@@ -3087,7 +3087,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3129,7 +3129,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3150,7 +3150,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3256,7 +3256,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3298,7 +3298,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/quickstart-next-steps.html b/8.0/quickstart-next-steps.html
index 41d7bfe6..4c642f43 100644
--- a/8.0/quickstart-next-steps.html
+++ b/8.0/quickstart-next-steps.html
@@ -3129,7 +3129,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3171,7 +3171,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3192,7 +3192,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3298,7 +3298,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3340,7 +3340,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/quickstart-overview.html b/8.0/quickstart-overview.html
index ff439877..952478e1 100644
--- a/8.0/quickstart-overview.html
+++ b/8.0/quickstart-overview.html
@@ -3165,7 +3165,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3207,7 +3207,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3228,7 +3228,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3334,7 +3334,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3376,7 +3376,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/quickstart-restore-backup.html b/8.0/quickstart-restore-backup.html
index bc525a3b..ae7ba3a5 100644
--- a/8.0/quickstart-restore-backup.html
+++ b/8.0/quickstart-restore-backup.html
@@ -3096,7 +3096,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3138,7 +3138,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3159,7 +3159,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3265,7 +3265,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3307,7 +3307,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/redo-log-archiving.html b/8.0/redo-log-archiving.html
index c268bef8..ca08e438 100644
--- a/8.0/redo-log-archiving.html
+++ b/8.0/redo-log-archiving.html
@@ -3105,7 +3105,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3147,7 +3147,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3168,7 +3168,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3274,7 +3274,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3316,7 +3316,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes.html b/8.0/release-notes.html
index 3f675a48..3cf9ea45 100644
--- a/8.0/release-notes.html
+++ b/8.0/release-notes.html
@@ -3078,7 +3078,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3120,7 +3120,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3141,7 +3141,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3247,7 +3247,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3289,7 +3289,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0-3-rc1.html b/8.0/release-notes/8.0/8.0-3-rc1.html
index 9c49aa7c..c0e8ff38 100644
--- a/8.0/release-notes/8.0/8.0-3-rc1.html
+++ b/8.0/release-notes/8.0/8.0-3-rc1.html
@@ -3109,7 +3109,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3151,7 +3151,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3172,7 +3172,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3278,7 +3278,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3320,7 +3320,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.10.html b/8.0/release-notes/8.0/8.0.10.html
index 87cac8d6..0b44f774 100644
--- a/8.0/release-notes/8.0/8.0.10.html
+++ b/8.0/release-notes/8.0/8.0.10.html
@@ -3089,7 +3089,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3131,7 +3131,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3152,7 +3152,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3258,7 +3258,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3300,7 +3300,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.11.html b/8.0/release-notes/8.0/8.0.11.html
index d06cd1be..ecf207e5 100644
--- a/8.0/release-notes/8.0/8.0.11.html
+++ b/8.0/release-notes/8.0/8.0.11.html
@@ -3080,7 +3080,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3122,7 +3122,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3143,7 +3143,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3249,7 +3249,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3291,7 +3291,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.12.html b/8.0/release-notes/8.0/8.0.12.html
index f1c88c1c..e16a85de 100644
--- a/8.0/release-notes/8.0/8.0.12.html
+++ b/8.0/release-notes/8.0/8.0.12.html
@@ -3089,7 +3089,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3131,7 +3131,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3152,7 +3152,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3258,7 +3258,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3300,7 +3300,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.13.html b/8.0/release-notes/8.0/8.0.13.html
index e99a0946..7cae43cc 100644
--- a/8.0/release-notes/8.0/8.0.13.html
+++ b/8.0/release-notes/8.0/8.0.13.html
@@ -3089,7 +3089,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3131,7 +3131,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3152,7 +3152,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3258,7 +3258,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3300,7 +3300,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.14.html b/8.0/release-notes/8.0/8.0.14.html
index 02e27c84..6fec281a 100644
--- a/8.0/release-notes/8.0/8.0.14.html
+++ b/8.0/release-notes/8.0/8.0.14.html
@@ -3098,7 +3098,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3140,7 +3140,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3161,7 +3161,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3267,7 +3267,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3309,7 +3309,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.22-15.0.html b/8.0/release-notes/8.0/8.0.22-15.0.html
index 68284fbf..b76853c1 100644
--- a/8.0/release-notes/8.0/8.0.22-15.0.html
+++ b/8.0/release-notes/8.0/8.0.22-15.0.html
@@ -3107,7 +3107,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3149,7 +3149,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3170,7 +3170,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3276,7 +3276,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3318,7 +3318,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.23-16.0.html b/8.0/release-notes/8.0/8.0.23-16.0.html
index 535d64bc..fb34064c 100644
--- a/8.0/release-notes/8.0/8.0.23-16.0.html
+++ b/8.0/release-notes/8.0/8.0.23-16.0.html
@@ -3098,7 +3098,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3140,7 +3140,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3161,7 +3161,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3267,7 +3267,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3309,7 +3309,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.25-17.0.html b/8.0/release-notes/8.0/8.0.25-17.0.html
index 9f85d68b..4e724d91 100644
--- a/8.0/release-notes/8.0/8.0.25-17.0.html
+++ b/8.0/release-notes/8.0/8.0.25-17.0.html
@@ -3089,7 +3089,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3131,7 +3131,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3152,7 +3152,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3258,7 +3258,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3300,7 +3300,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.26-18.0.html b/8.0/release-notes/8.0/8.0.26-18.0.html
index df20be0a..4a42b331 100644
--- a/8.0/release-notes/8.0/8.0.26-18.0.html
+++ b/8.0/release-notes/8.0/8.0.26-18.0.html
@@ -3098,7 +3098,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3140,7 +3140,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3161,7 +3161,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3267,7 +3267,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3309,7 +3309,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.27-19.0.html b/8.0/release-notes/8.0/8.0.27-19.0.html
index 161f0daa..87ac860a 100644
--- a/8.0/release-notes/8.0/8.0.27-19.0.html
+++ b/8.0/release-notes/8.0/8.0.27-19.0.html
@@ -3116,7 +3116,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3158,7 +3158,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3179,7 +3179,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3285,7 +3285,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3327,7 +3327,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.28-20.0.html b/8.0/release-notes/8.0/8.0.28-20.0.html
index de720482..d246a1f3 100644
--- a/8.0/release-notes/8.0/8.0.28-20.0.html
+++ b/8.0/release-notes/8.0/8.0.28-20.0.html
@@ -3116,7 +3116,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3158,7 +3158,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3179,7 +3179,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3285,7 +3285,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3327,7 +3327,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.28-21.0.html b/8.0/release-notes/8.0/8.0.28-21.0.html
index d8cba508..52779b73 100644
--- a/8.0/release-notes/8.0/8.0.28-21.0.html
+++ b/8.0/release-notes/8.0/8.0.28-21.0.html
@@ -3116,7 +3116,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3158,7 +3158,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3179,7 +3179,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3285,7 +3285,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3327,7 +3327,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.29-22.0.html b/8.0/release-notes/8.0/8.0.29-22.0.html
index cc4828a8..bf0388c1 100644
--- a/8.0/release-notes/8.0/8.0.29-22.0.html
+++ b/8.0/release-notes/8.0/8.0.29-22.0.html
@@ -3098,7 +3098,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3140,7 +3140,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3161,7 +3161,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3267,7 +3267,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3309,7 +3309,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.30-23.0.html b/8.0/release-notes/8.0/8.0.30-23.0.html
index b83bae40..a701df41 100644
--- a/8.0/release-notes/8.0/8.0.30-23.0.html
+++ b/8.0/release-notes/8.0/8.0.30-23.0.html
@@ -3134,7 +3134,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3176,7 +3176,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3197,7 +3197,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3303,7 +3303,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3345,7 +3345,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.31-24.0.html b/8.0/release-notes/8.0/8.0.31-24.0.html
index 8eb8eff0..d8843f22 100644
--- a/8.0/release-notes/8.0/8.0.31-24.0.html
+++ b/8.0/release-notes/8.0/8.0.31-24.0.html
@@ -3123,7 +3123,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3165,7 +3165,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3186,7 +3186,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3292,7 +3292,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3334,7 +3334,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.32-25.0.html b/8.0/release-notes/8.0/8.0.32-25.0.html
index c5c51c82..be578777 100644
--- a/8.0/release-notes/8.0/8.0.32-25.0.html
+++ b/8.0/release-notes/8.0/8.0.32-25.0.html
@@ -3096,7 +3096,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3138,7 +3138,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3159,7 +3159,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3265,7 +3265,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3307,7 +3307,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.32-26.0.html b/8.0/release-notes/8.0/8.0.32-26.0.html
index 47b6d512..ec81e8e0 100644
--- a/8.0/release-notes/8.0/8.0.32-26.0.html
+++ b/8.0/release-notes/8.0/8.0.32-26.0.html
@@ -3114,7 +3114,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3156,7 +3156,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3177,7 +3177,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3283,7 +3283,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3325,7 +3325,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.33-27.0.html b/8.0/release-notes/8.0/8.0.33-27.0.html
index ab7f5c40..7bfc34b6 100644
--- a/8.0/release-notes/8.0/8.0.33-27.0.html
+++ b/8.0/release-notes/8.0/8.0.33-27.0.html
@@ -3105,7 +3105,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3147,7 +3147,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3168,7 +3168,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3274,7 +3274,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3316,7 +3316,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.33-28.0.html b/8.0/release-notes/8.0/8.0.33-28.0.html
index 382e6716..0dad077e 100644
--- a/8.0/release-notes/8.0/8.0.33-28.0.html
+++ b/8.0/release-notes/8.0/8.0.33-28.0.html
@@ -3132,7 +3132,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3174,7 +3174,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3195,7 +3195,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3301,7 +3301,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3343,7 +3343,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.34-29.0.html b/8.0/release-notes/8.0/8.0.34-29.0.html
index 605843d9..0552f2b8 100644
--- a/8.0/release-notes/8.0/8.0.34-29.0.html
+++ b/8.0/release-notes/8.0/8.0.34-29.0.html
@@ -3138,7 +3138,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3180,7 +3180,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3201,7 +3201,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3307,7 +3307,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3349,7 +3349,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.35-30.0.html b/8.0/release-notes/8.0/8.0.35-30.0.html
index 8f1ac1c4..c45d4c84 100644
--- a/8.0/release-notes/8.0/8.0.35-30.0.html
+++ b/8.0/release-notes/8.0/8.0.35-30.0.html
@@ -3114,7 +3114,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3156,7 +3156,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3177,7 +3177,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3283,7 +3283,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3325,7 +3325,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.35-31.0.html b/8.0/release-notes/8.0/8.0.35-31.0.html
index b30cb023..4e28143b 100644
--- a/8.0/release-notes/8.0/8.0.35-31.0.html
+++ b/8.0/release-notes/8.0/8.0.35-31.0.html
@@ -3114,7 +3114,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3156,7 +3156,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3177,7 +3177,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3283,7 +3283,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3325,7 +3325,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.35-31.0.upd.html b/8.0/release-notes/8.0/8.0.35-31.0.upd.html
index 0d80c174..2cef0346 100644
--- a/8.0/release-notes/8.0/8.0.35-31.0.upd.html
+++ b/8.0/release-notes/8.0/8.0.35-31.0.upd.html
@@ -3087,7 +3087,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3129,7 +3129,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3150,7 +3150,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3256,7 +3256,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3298,7 +3298,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.4.html b/8.0/release-notes/8.0/8.0.4.html
index 5563d153..ec57c879 100644
--- a/8.0/release-notes/8.0/8.0.4.html
+++ b/8.0/release-notes/8.0/8.0.4.html
@@ -3109,7 +3109,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3151,7 +3151,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3172,7 +3172,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3278,7 +3278,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3320,7 +3320,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.5.html b/8.0/release-notes/8.0/8.0.5.html
index 835decf5..ba3a5d43 100644
--- a/8.0/release-notes/8.0/8.0.5.html
+++ b/8.0/release-notes/8.0/8.0.5.html
@@ -3109,7 +3109,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3151,7 +3151,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3172,7 +3172,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3278,7 +3278,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3320,7 +3320,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.6.html b/8.0/release-notes/8.0/8.0.6.html
index aa593959..fcf76d10 100644
--- a/8.0/release-notes/8.0/8.0.6.html
+++ b/8.0/release-notes/8.0/8.0.6.html
@@ -3100,7 +3100,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3142,7 +3142,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3163,7 +3163,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3269,7 +3269,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3311,7 +3311,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.7.html b/8.0/release-notes/8.0/8.0.7.html
index 81db94e5..4a90e809 100644
--- a/8.0/release-notes/8.0/8.0.7.html
+++ b/8.0/release-notes/8.0/8.0.7.html
@@ -3100,7 +3100,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3142,7 +3142,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3163,7 +3163,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3269,7 +3269,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3311,7 +3311,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.8.html b/8.0/release-notes/8.0/8.0.8.html
index a1e89386..4b1444e4 100644
--- a/8.0/release-notes/8.0/8.0.8.html
+++ b/8.0/release-notes/8.0/8.0.8.html
@@ -3100,7 +3100,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3142,7 +3142,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3163,7 +3163,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3269,7 +3269,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3311,7 +3311,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/release-notes/8.0/8.0.9.html b/8.0/release-notes/8.0/8.0.9.html
index ebd50129..8ddb5668 100644
--- a/8.0/release-notes/8.0/8.0.9.html
+++ b/8.0/release-notes/8.0/8.0.9.html
@@ -3091,7 +3091,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3133,7 +3133,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3154,7 +3154,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3260,7 +3260,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3302,7 +3302,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/restore-a-backup.html b/8.0/restore-a-backup.html
index 4f0106ac..2494a137 100644
--- a/8.0/restore-a-backup.html
+++ b/8.0/restore-a-backup.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/restore-individual-partitions.html b/8.0/restore-individual-partitions.html
index 4acdd729..cf1cbdac 100644
--- a/8.0/restore-individual-partitions.html
+++ b/8.0/restore-individual-partitions.html
@@ -3026,7 +3026,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3068,7 +3068,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3089,7 +3089,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3195,7 +3195,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3237,7 +3237,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/restore-individual-tables.html b/8.0/restore-individual-tables.html
index c7913247..7f302fae 100644
--- a/8.0/restore-individual-tables.html
+++ b/8.0/restore-individual-tables.html
@@ -3098,7 +3098,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3140,7 +3140,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3161,7 +3161,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3267,7 +3267,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3309,7 +3309,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/restore-partial-backup.html b/8.0/restore-partial-backup.html
index 06a2732d..9cb871ae 100644
--- a/8.0/restore-partial-backup.html
+++ b/8.0/restore-partial-backup.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/search/search_index.json b/8.0/search/search_index.json
index ba1e607b..49139bf7 100644
--- a/8.0/search/search_index.json
+++ b/8.0/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-,:!=\\[\\]()\"`/]+|\\.(?!\\d)|&[lg]t;|(?!\\b)(?=[A-Z][a-z])","pipeline":["stopWordFilter"]},"docs":[{"location":"index.html","title":"Percona XtraBackup - Documentation","text":"<p>This documentation is for the latest release: Percona XtraBackup 8.0.35-31 Update release notes.</p> <p>Percona XtraBackup is an open source hot backup utility for MySQL-based servers, that keeps your database fully available during planned maintenance windows.</p> <p>Whether it is a 24x7 highly loaded server or a low-transaction-volume Percona XtraBackup is designed to make backups seamless without disrupting the performance of the server in a production environment. Percona XtraBackup (PXB) is a 100% open source backup solution with commercial support available for organizations who want to benefit from comprehensive, responsive, and cost-flexible database support for MySQL.</p>"},{"location":"index.html#supported-versions","title":"Supported versions","text":"<p>Percona XtraBackup 8.0.35-31 can take backups of MySQL-compatible databases in older server versions, if specific conditions are met, and the following later versions:</p> <ul> <li> <p>Percona Server for MySQL 8.0.34, and MySQL 8.0.34</p> </li> <li> <p>Percona Server for MySQL 8.0.35, and MySQL 8.0.35</p> </li> <li> <p>Percona Server for MySQL 8.0.36, and MySQL 8.0.36</p> </li> <li> <p>Percona Server for MySQL 8.0.37, and MySQL 8.0.37</p> </li> </ul> <p>For more information, see Percona XtraBackup Version Compatibility and Server Version Checks.</p> <p>Taking your backup with Percona XtraBackup is easy. Follow our documentation guides, and you\u2019ll be set up in quickly.</p>"},{"location":"index.html#quickstart-guide","title":"Quickstart guide","text":"<p>Get started quickly with our Quickstart guide.</p> <p>Quickstart guide </p>"},{"location":"index.html#installation-guides","title":"Installation guides","text":"<p>Find the best installation solution with our step-by-step installation instructions.</p> <p>Installation instructions </p>"},{"location":"index.html#binaries","title":"Binaries","text":"<p>Learn about the Percona XtraBackup binaries: xtrabackup, xbcloud, xbcrypt, and xbstream.</p> <p>Binaries </p>"},{"location":"index.html#backup-management","title":"Backup management","text":"<p>Learn about the different types of backups and how to take them.</p> <p>Backup management </p>"},{"location":"index.html#supported-storage-engines","title":"Supported storage engines","text":"<p>Percona XtraBackup can back up data from InnoDB, XtraDB, MyISAM, and MyRocks tables on MySQL 8.0 servers as well as Percona Server for MySQL with XtraDB, Percona Server for MySQL 8.0, and Percona XtraDB Cluster 8.0.</p> <p>Version updates</p> <p>Version 8.0.6 and later supports the MyRocks storage engine.  An incremental backup on the MyRocks storage engine does not  determine if an earlier full or incremental backup  contains the same files. Percona XtraBackup copies all  MyRocks files each time it takes a backup. Percona XtraBackup does not support the TokuDB storage engine. Find more information in Percona TokuBackup. </p>"},{"location":"index.html#limitations","title":"Limitations","text":"<p>Percona XtraBackup 8.0 does not support making backups of databases created in versions prior to 8.0 of MySQL, Percona Server for MySQL or Percona XtraDB Cluster. As the changes that MySQL 8.0 introduced in data dictionaries, redo log and undo log are incompatible with previous versions, it is currently impossible for Percona XtraBackup 8.0 to also support versions prior to 8.0.</p> <p>Due to changes in MySQL 8.0.20 released by Oracle at the end of April 2020, Percona XtraBackup 8.0, up to version 8.0.11, is not compatible with MySQL version 8.0.20 or higher, or Percona products that are based on it: Percona Server for MySQL and Percona XtraDB Cluster.</p> <p>For more information, see Percona XtraBackup 8.x and MySQL 8.0.20</p> <p>Learn more about other Percona products</p> <p>Percona Distribution for MySQL 8.0 </p> <p></p>"},{"location":"index.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"404.html","title":"404 - Not Found","text":"<p>We can\u2019t find the page you are looking for. Try using the Search or return to the homepage.</p> <p></p>"},{"location":"404.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"about-xtrabackup.html","title":"About Percona XtraBackup","text":"<p>Percona XtraBackup is the world\u2019s only open source, free MySQL hot backup software that performs non-blocking backups for InnoDB and XtraDB databases. </p> <p>With Percona XtraBackup, you can achieve the following benefits:</p> <ul> <li> <p>Backups that complete quickly and reliably</p> </li> <li> <p>Uninterrupted transaction processing during backups</p> </li> <li> <p>Savings on disk space and network bandwidth</p> </li> <li> <p>Automatic backup verification</p> </li> <li> <p>Higher uptime due to faster restore time</p> </li> </ul> <p>Percona XtraBackup makes MySQL hot backups for all versions of Percona Server for MySQL, and MySQL. It performs streaming, compressed, and incremental MySQL backups.</p> <p>Check the latest list of all Supported versions.</p> <p>Important</p> <p>Percona XtraBackup 2.4 supports MySQL and Percona Server for MySQL  5.6 and 5.7 databases. Due to changes in the MySQL redo log and data  dictionary formats, the Percona XtraBackup 8.0.x versions are only  compatible with MySQL 8.0.x, Percona Server for MySQL 8.0.x, and  compatible versions.</p> <p>Percona\u2019s enterprise-grade commercial MySQL Support contracts include support for Percona XtraBackup. We recommend support for critical production deployments. Percona XtraDB Backup supports encryption.</p>"},{"location":"about-xtrabackup.html#supported-storage-engines","title":"Supported storage engines","text":"<p>Percona XtraBackup can back up data from InnoDB, XtraDB, MyISAM, and MyRocks tables on MySQL 8.0 servers as well as Percona Server for MySQL with XtraDB, Percona Server for MySQL 8.0, and Percona XtraDB Cluster 8.0.</p> <p>Version updates</p> <p>Version 8.0.6 and later supports the MyRocks storage engine.  An incremental backup on the MyRocks storage engine does not  determine if an earlier full or incremental backup  contains the same files. Percona XtraBackup copies all  MyRocks files each time it takes a backup. Percona  XtraBackup does not support the TokuDB storage engine.</p> <p>See also</p> <p>Percona TokuBackup</p>"},{"location":"about-xtrabackup.html#limitations","title":"Limitations","text":"<p>Percona XtraBackup 8.0 does not support making backups of databases created in versions prior to 8.0 of MySQL, Percona Server for MySQL or Percona XtraDB Cluster. As the changes that MySQL 8.0 introduced in data dictionaries, redo log and undo log are incompatible with previous versions, it is currently impossible for Percona XtraBackup 8.0 to also support versions prior to 8.0.</p> <p>Due to changes in MySQL 8.0.20 released by Oracle at the end of April 2020, Percona XtraBackup 8.0, up to version 8.0.11, is not compatible with MySQL version 8.0.20 or higher, or Percona products that are based on it: Percona Server for MySQL and Percona XtraDB Cluster.</p> <p>For more information, see Percona XtraBackup 8.x and MySQL 8.0.20</p>"},{"location":"about-xtrabackup.html#what-are-the-features-of-percona-xtrabackup","title":"What are the features of Percona XtraBackup?","text":"<p>Here is a short list of the Percona XtraBackup features. See the documentation for more.</p> <ul> <li> <p>Create hot InnoDB backups without pausing your database</p> </li> <li> <p>Make incremental backups of MySQL</p> </li> <li> <p>Stream compressed MySQL backups to another server</p> </li> <li> <p>Move tables between MySQL servers on-line</p> </li> <li> <p>Create new MySQL replication replicas easily</p> </li> <li> <p>Backup MySQL without adding load to the server</p> </li> <li> <p>Percona XtraBackup performs throttling based on the number of IO operations per second</p> </li> <li> <p>Percona XtraBackup can export individual tables even from a full backup, regardless of the InnoDB version</p> </li> <li> <p>Backup locks is a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> available in Percona Server. Percona XtraBackup uses them automatically to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p> </li> </ul> <p>See also</p> <p>How Percona XtraBackup works</p>"},{"location":"about-xtrabackup.html#additional-information","title":"Additional information","text":"<p>The InnoDB tables are locked while copying non-InnoDB data.</p> <p></p>"},{"location":"about-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"accelerate-backup-process.html","title":"Accelerate the backup process","text":""},{"location":"accelerate-backup-process.html#copy-with-the-parallel-and-compress-threads-options","title":"Copy with the <code>--parallel</code> and <code>--compress-threads</code> options","text":"<p>When making a local or streaming backup with xbstream option, multiple files can be copied at the same time when using the <code>--parallel</code> option. This option specifies the number of threads created by xtrabackup to copy data files.</p> <p>To take advantage of this option either the multiple tablespaces option must be enabled (innodb_file_per_table) or the shared tablespace must be stored in multiple ibdata files with the innodb_data_file_path option. Having multiple files for the database (or splitting one into many) doesn\u2019t have a measurable impact on performance.</p> <p>As this feature is implemented at the file level, concurrent file transfer can sometimes increase I/O throughput when doing a backup on highly fragmented data files, due to the overlap of a greater number of random read requests. You should consider tuning the filesystem also to obtain the maximum performance (e.g. checking fragmentation).</p> <p>If the data is stored on a single file, this option will have no effect.</p> <p>To use this feature, simply add the option to a local backup, for example:</p> <pre><code>$ xtrabackup --backup --parallel=4 --target-dir=/path/to/backup\n</code></pre> <p>By using the xbstream in streaming backups, you can additionally speed up the compression process with the <code>--compress-threads</code> option. This option specifies the number of threads created by xtrabackup for for parallel data compression. The default value for this option is 1.</p> <p>To use this feature, simply add the option to a local backup, for example:</p> <pre><code>$ xtrabackup --backup --stream=xbstream --compress --compress-threads=4 --target-dir=./ &gt; backup.xbstream\n</code></pre> <p>Before applying logs, compressed files will need to be uncompressed.</p>"},{"location":"accelerate-backup-process.html#the-rsync-option","title":"The <code>--rsync</code> option","text":"<p>In order to speed up the backup process and to minimize the time <code>FLUSH TABLES WITH READ LOCK</code> is blocking the writes, the option <code>--rsync</code> should be used. When this option is specified, xtrabackup uses <code>rsync</code> to copy all non-InnoDB files instead of spawning a separate <code>cp</code> for each file, which can be much faster for servers with a large number of databases or tables. xtrabackup will call the <code>rsync</code> twice, once before the <code>FLUSH TABLES WITH READ LOCK</code> and once during to minimize the time the read lock is being held. During the second <code>rsync</code> call, it will only synchronize the changes to non-transactional data (if any) since the first call performed before the <code>FLUSH TABLES WITH READ LOCK</code>. Note that Percona XtraBackup will use Backup locks where available as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code>. This feature is available in Percona Server for MySQL 5.6+. Percona XtraBackup uses this automatically to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p> <p>Note</p> <p>This option cannot be used together with the <code>--stream</code> option.</p> <p></p>"},{"location":"accelerate-backup-process.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"analyze-table-statistics.html","title":"Analyze table statistics","text":"<p>Note</p> <p>As of Percona XtraBackup 8.0.30 the \u2013stats option is deprecated and may be removed in future releases.  We no longer support using the \u2013stats option in Percona XtraBackup 8.0.29 and older versions.</p> <p>The xtrabackup binary can analyze InnoDB data files in read-only mode to give statistics about them. To do this, you should use the \u2013stats option. You can combine this with the \u2013tables option to limit the files to examine. It also uses the \u2013use-memory option.</p> <p>You can perform the analysis on a running server, with some chance of errors due to the data being changed during analysis. Or, you can analyze a backup copy of the database. Either way, to use the statistics feature, you need a clean copy of the database including correctly sized log files, so you need to execute with <code>--prepare</code> twice to use this functionality on a backup.</p> <p>The result of running on a backup might look like the following:</p> Expected output <pre><code>&lt;INDEX STATISTICS&gt;\n  table: test/table1, index: PRIMARY, space id: 12, root page 3\n  estimated statistics in dictionary:\n    key vals: 25265338, leaf pages 497839, size pages 498304\n  real statistics:\n     level 2 pages: pages=1, data=5395 bytes, data/pages=32%\n     level 1 pages: pages=415, data=6471907 bytes, data/pages=95%\n        leaf pages: recs=25958413, pages=497839, data=7492026403 bytes, data/pages=91%\n</code></pre> <p>This can be interpreted as follows:</p> <ul> <li> <p>The first line simply shows the table and index name and its internal identifiers. If you see an index named <code>GEN_CLUST_INDEX</code>, that is the table\u2019s clustered index, automatically created because you did not explicitly create a <code>PRIMARY KEY</code>.</p> </li> <li> <p>The estimated statistics in dictionary information is similar to the data that\u2019s gathered through <code>ANALYZE TABLE</code> inside of InnoDB to be stored as estimated cardinality statistics and passed to the query optimizer.</p> </li> <li> <p>The real statistics information is the result of scanning the data pages and computing exact information about the index.</p> </li> <li> <p><code>The level &lt;X&gt; pages</code>: output means that the line shows information about pages at that level in the index tree. The larger <code>&lt;X&gt;</code> is, the farther it is from the leaf pages, which are level 0. The first line is the root page.</p> </li> <li> <p>The <code>leaf pages</code> output shows the leaf pages, of course. This is where the table\u2019s data is stored.</p> </li> <li> <p>The <code>external pages</code>: output (not shown) shows large external pages that hold values too long to fit in the row itself, such as long <code>BLOB</code> and <code>TEXT</code> values.</p> </li> <li> <p>The <code>recs</code> is the real number of records (rows) in leaf pages.</p> </li> <li> <p>The <code>pages</code> is the page count.</p> </li> <li> <p>The <code>data</code> is the total size of the data in the pages, in bytes.</p> </li> <li> <p>The <code>data/pages</code> is calculated as (<code>data</code> / (<code>pages</code> * <code>PAGE_SIZE</code>)) * 100%. It will never reach 100% because of space reserved for page headers and footers.</p> </li> </ul> <p>A more detailed example is posted as a MySQL Performance Blog post.</p>"},{"location":"analyze-table-statistics.html#script-to-format-output","title":"Script to format output","text":"<p>The following script can be used to summarize and tabulate the output of the statistics information:</p> Expected output <pre><code>tabulate-xtrabackup-stats.pl\n\n#!/usr/bin/env perl\nuse strict;\nuse warnings FATAL =&gt; 'all';\nmy $script_version = \"0.1\";\n\nmy $PG_SIZE = 16_384; # InnoDB defaults to 16k pages, change if needed.\nmy ($cur_idx, $cur_tbl);\nmy (%idx_stats, %tbl_stats);\nmy ($max_tbl_len, $max_idx_len) = (0, 0);\nwhile ( my $line = &lt;&gt; ) {\n   if ( my ($t, $i) = $line =~ m/table: (.*), index: (.*), space id:/ ) {\n      $t =~ s!/!.!;\n      $cur_tbl = $t;\n      $cur_idx = $i;\n      if ( length($i) &gt; $max_idx_len ) {\n         $max_idx_len = length($i);\n      }\n      if ( length($t) &gt; $max_tbl_len ) {\n         $max_tbl_len = length($t);\n      }\n   }\n   elsif ( my ($kv, $lp, $sp) = $line =~ m/key vals: (\\d+), \\D*(\\d+), \\D*(\\d+)/ ) {\n      @{$idx_stats{$cur_tbl}-&gt;{$cur_idx}}{qw(est_kv est_lp est_sp)} = ($kv, $lp, $sp);\n      $tbl_stats{$cur_tbl}-&gt;{est_kv} += $kv;\n      $tbl_stats{$cur_tbl}-&gt;{est_lp} += $lp;\n      $tbl_stats{$cur_tbl}-&gt;{est_sp} += $sp;\n   }\n    elsif ( my ($l, $pages, $bytes) = $line =~ m/(?:level (\\d+)|leaf) pages:.*pages=(\\d+), data=(\\d+) bytes/ ) {\n      $l ||= 0;\n      $idx_stats{$cur_tbl}-&gt;{$cur_idx}-&gt;{real_pages} += $pages;\n      $idx_stats{$cur_tbl}-&gt;{$cur_idx}-&gt;{real_bytes} += $bytes;\n      $tbl_stats{$cur_tbl}-&gt;{real_pages} += $pages;\n      $tbl_stats{$cur_tbl}-&gt;{real_bytes} += $bytes;\n   }\n}\n\nmy $hdr_fmt = \"%${max_tbl_len}s %${max_idx_len}s %9s %10s %10s\\n\";\nmy @headers = qw(TABLE INDEX TOT_PAGES FREE_PAGES PCT_FULL);\nprintf $hdr_fmt, @headers;\n\nmy $row_fmt = \"%${max_tbl_len}s %${max_idx_len}s %9d %10d %9.1f%%\\n\";\nforeach my $t ( sort keys %tbl_stats ) {\n  my $tbl = $tbl_stats{$t};\n  printf $row_fmt, $t, \"\", $tbl-&gt;{est_sp}, $tbl-&gt;{est_sp} - $tbl-&gt;{real_pages},\n      $tbl-&gt;{real_bytes} / ($tbl-&gt;{real_pages} * $PG_SIZE) * 100;\n   foreach my $i ( sort keys %{$idx_stats{$t}} ) {\n      my $idx = $idx_stats{$t}-&gt;{$i};\n      printf $row_fmt, $t, $i, $idx-&gt;{est_sp}, $idx-&gt;{est_sp} - $idx-&gt;{real_pages},\n         $idx-&gt;{real_bytes} / ($idx-&gt;{real_pages} * $PG_SIZE) * 100;\n   }\n}\n</code></pre>"},{"location":"analyze-table-statistics.html#sample-script-output","title":"Sample script output","text":"<p>The output of the above Perl script, when run against the sample shown in the previously mentioned blog post, will appear as follows:</p> Expected output <pre><code>      TABLE           INDEX TOT_PAGES FREE_PAGES   PCT_FULL\nart.link_out104                    832383      38561      86.8%\nart.link_out104         PRIMARY    498304         49      91.9%\nart.link_out104       domain_id     49600       6230      76.9%\nart.link_out104     domain_id_2     26495       3339      89.1%\nart.link_out104 from_message_id     28160        142      96.3%\nart.link_out104    from_site_id     38848       4874      79.4%\nart.link_out104   revert_domain    153984      19276      71.4%\nart.link_out104    site_message     36992       4651      83.4%\n</code></pre> <p>The columns are the table and index, followed by the total number of pages in that index, the number of pages not actually occupied by data, and the number of bytes of real data as a percentage of the total size of the pages of real data. The first line in the above output, in which the <code>INDEX</code> column is empty, is a summary of the entire table.</p> <p></p>"},{"location":"analyze-table-statistics.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-download-deb.html","title":"Install Percona XtraBackup 8.0 using downloaded DEB packages","text":"<p>Download <code>DEB</code> packages of the desired series for your architecture from Percona Product Downloads. </p> <p>The following example downloads Percona XtraBackup 8.0.26-18 release package for Ubuntu 20.04:</p> <pre><code>$ wget https://downloads.percona.com/downloads/Percona-XtraBackup-LATEST/Percona-XtraBackup-8.0.26-18/binary/debian/focal/x86_64/percona-xtrabackup-80_8.0.26-18-1.focal_amd64.deb\n</code></pre> <p>Install Percona XtraBackup by using <code>dpkg</code>. Run this command as root or use the sudo command:</p> <pre><code>$ sudo dpkg -i percona-xtrabackup-80_8.0.26-18-1.focal_amd64.deb\n</code></pre> <p>Warning</p> <p>When installing packages manually like this, resolve all the dependencies and install missing packages yourself.</p> <p></p>"},{"location":"apt-download-deb.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-files.html","title":"Files in the DEB package built for Percona XtraBackup 8.0","text":"<p>The following tables show what data each <code>DEB</code> package contains.</p> Package Contains percona-xtrabackup-80 The latest Percona XtraBackup GA binaries and associated files percona-xtrabackup-dbg-80 The debug symbols for binaries in <code>percona-xtrabackup-80</code> percona-xtrabackup-test-80 The test suite for Percona XtraBackup percona-xtrabackup The older version of the Percona XtraBackup <p></p>"},{"location":"apt-files.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-pinning.html","title":"Apt pinning the Percona XtraBackup 8.0 packages","text":"<p>In some cases you might need to <code>pin</code> the selected packages to avoid the upgrades from the distribution repositories. </p> <p>The pinning takes place in the <code>preference</code> file. To pin a package, set the <code>Pin-Priority</code> to higher numbers.</p> <p>Make a new file <code>/etc/apt/preferences.d/00percona.pref</code>. For example, add the following to the preference file:</p> <pre><code>Package:\nPin: release o=Percona Development Team\nPin-Priority: 1001\n</code></pre> <p>For more information about the pinning, check the official debian wiki.</p> <p></p>"},{"location":"apt-pinning.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-repo.html","title":"Use an APT repository to install Percona XtraBackup 8.0","text":"<p>Ready-to-use packages are available from the Percona XtraBackup software repositories and the download page.</p> <p>Specific information on the supported platforms, products, and versions is described in Percona Release Lifecycle Overview.</p> <p>Important</p> <p>To prevent intermittent backup failures, update the curl utility in Debian 10.</p>"},{"location":"apt-repo.html#install-percona-xtrabackup-through-percona-release","title":"Install Percona XtraBackup through percona-release","text":"<p>Percona XtraBackup, like many other Percona products, is installed with the percona-release package configuration tool.</p> <ol> <li> <p>Download a <code>DEB</code> package for percona-release the repository packages from Percona web:</p> <pre><code>$ wget https://repo.percona.com/apt/percona-release_latest.$(lsb_release -sc)_all.deb\n</code></pre> </li> <li> <p>Install the downloaded package with dpkg. To do that, run the following commands as root or with sudo: <code>dpkg -i percona-release_latest.$(lsb_release -sc)_all.deb</code></p> <p>Once you install this package the Percona repositories should be added. You can check the repository setup in the <code>/etc/apt/sources.list.d/percona-release.list</code> file.</p> </li> <li> <p>Enable the repository: <code>percona-release enable-only tools release</code></p> <p>If Percona XtraBackup is intended to be used in combination with the upstream MySQL Server, you only need to enable the <code>tools</code> repository: <code>percona-release enable-only tools</code>.</p> </li> <li> <p>Refresh the local cache to update the package information:</p> <pre><code>$ sudo apt update\n</code></pre> </li> <li> <p>Install the <code>percona-xtrabackup-80</code> package:</p> <pre><code>$ sudo apt install percona-xtrabackup-80\n</code></pre> </li> <li> <p>To decompress backups made using <code>LZ4</code> or <code>ZSTD</code> compression algorithm, install the corresponding package:</p> Install the <code>lz4</code> packageInstall the <code>zstd</code> package <pre><code>$ sudo apt install lz4\n</code></pre> <pre><code>$ sudo apt install zstd\n</code></pre> </li> </ol> <p>Note</p> <p>For AppArmor profile information, see Working with AppArmor.</p> <p>See also</p> <p>To install Percona XtraBackup using downloaded deb packages, see Install Percona XtraBackup 8.0.</p> <p>To uninstall Percona XtraBackup, see Uninstall Percona XtraBackup 8.0</p> <p></p>"},{"location":"apt-repo.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-uninstall-xtrabackup.html","title":"Uninstall Percona XtraBackup 8.0 on Debian and Ubuntu","text":"<p>To completely uninstall Percona XtraBackup, remove all the installed packages:</p> <pre><code>$ sudo apt remove percona-xtrabackup-80\n</code></pre> <p></p>"},{"location":"apt-uninstall-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"backup-overview.html","title":"Backup process overview","text":"<p>Percona Xtrabackup is a tool that allows you to create backups of MySQL or MariaDB databases. It works by copying the data files and the binary log files of the server, while ensuring that the data is consistent and not corrupted by ongoing transactions. Percona Xtrabackup can also prepare the backup files for restoration, apply incremental backups, and stream the backup files to another server or storage device.</p>"},{"location":"backup-overview.html#backup-types","title":"Backup types","text":"<p>You can take and prepare the following types of backups:</p> <ul> <li> <p>Full backup - a backup of all the contents of the database</p> </li> <li> <p>Incremental backup - a backup of only the files that have changed since the last full backup</p> </li> <li> <p>Compressed backup - a backup of all the contents of the database with applying a compression algorithm that reduces the size of the data to be stored</p> </li> <li> <p>Partial backup - a backup of only the files that have changed in a specific folder or a set of folders, rather than the entire database</p> </li> <li> <p>Individual partitions backup - a backup of an individual partition</p> </li> </ul>"},{"location":"backup-overview.html#backup-restoration","title":"Backup restoration","text":"<ul> <li> <p>Restore full, incremental, compressed backups</p> </li> <li> <p>Restore a partial backup</p> </li> <li> <p>Restore an individual partitions backup</p> </li> <li> <p>Restore individual tables</p> </li> </ul> <p></p>"},{"location":"backup-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"backup-strategy.html","title":"Backup strategy and backup policy","text":"<p>In conversation, \u2018backup strategy,\u2019 \u2018backup policy,\u2019 and \u2018backup plan\u2019 are used interchangeably, but the terms have distinct meanings.</p> <p>A backup strategy is an overall approach or methodology for backing up the data in a database system. The strategy includes the decisions and considerations for what data to back up, how frequently backups should be taken, what backup methods and technologies to use, where to store the backup files, and what steps should be taken to ensure data integrity and the ability to recover.</p> <p>A backup strategy typically involves business requirements, the Recovery Point Objective (RPO), the maximum acceptable data loss in case of system failure or disaster, and the Recovery Time Objective (RTO), the acceptable downtime for restoring the system after a failure, and compliance regulations.</p> <p>A backup policy defines the guidelines, rules, or standards for specific procedures and practices for implementing the backup strategy.</p> <p>The policy outlines the following:</p> <ul> <li> <p>Detailed steps and parameters for performing backups</p> </li> <li> <p>Retention periods</p> </li> <li> <p>Backup types</p> </li> <li> <p>Backup verification methods</p> </li> <li> <p>Error handling procedures</p> </li> <li> <p>Security measures</p> </li> </ul> <p>A backup plan, based on the backup strategy and the backup policy, is a detailed operation document that specifies how to execute the backup strategy in actionable steps and defines the timelines for backup activities. </p> <p>A backup plan can include the following details:</p> <ul> <li> <p>Who performs the backup</p> </li> <li> <p>When backups are scheduled</p> </li> <li> <p>How backups are monitored and audited</p> </li> <li> <p>What actions to take in case of backup failures or emergencies</p> </li> </ul>"},{"location":"backup-strategy.html#types-of-backup","title":"Types of backup","text":"<p>A full backup copies all data to a storage location. This type of backup creates a complete copy of the data set. The benefit of a full backup is a quick recovery since the data is stored in one place. However, this type of backup is also the most time-consuming and storage-intensive; it duplicates all data regardless of whether it has changed since the last backup.</p> <p>An incremental backup only copies data that has changed since the last backup, whether that was a full or another incremental backup. This method is faster and more storage-efficient than a full backup. However, the recovery can be slower because you must restore each set of changes in sequence.</p> <p>For more information, see the example of using a full backup with incremental backups.</p>"},{"location":"backup-strategy.html#backup-policy-defined","title":"Backup policy defined","text":"<p>The backup policy sets the guidelines and objectives for data protection, while the backup strategy provides the roadmap for achieving those objectives.</p> <p>A backup policy may state that all customer data must be backed up daily, with a full backup at the start of each week and incremental backups taken each business day. These definitions are based on the following: It also defines how long backups should be retained based on legal or regulatory requirements.</p> <p>The difference between a backup policy and a backup strategy lies in their scope and detail. A backup policy is more about the following:</p> <ul> <li> <p>\u2018what\u2019 \u2014 What should be backed up and may include information on compliance and governance</p> </li> <li> <p>\u2018when\u2019 - When should you do backups</p> </li> </ul> <p>The backup strategy contains the \u2018how\u2019 \u2014 how the backups are scheduled and includes information on the backup technologies and the restoration process.  </p> <p>The backup strategy details the use of specific backup software, the configuration of backup schedules, the process for monitoring backup success, and the necessary steps for restoring data.</p>"},{"location":"backup-strategy.html#backup-policy-best-practices","title":"Backup policy best practices","text":"<p>An effective backup policy is crucial for safeguarding an organization\u2019s data integrity and availability. Here are some best practices to consider:</p> <p>Backup Policy Best Practices | Markdown Table</p> Best Practice Description Regularly Update and Review Ensure the backup policy is a living document, updated to reflect changes in technology, business processes, and regulations. Clearly Define Roles and Responsibilities Assign specific individuals or teams for executing backups, monitoring success, and managing restoration. Adopt the 3-2-1 Backup Rule Have 3 data copies, store them on 2 different media types, and keep 1 copy offsite. Ensure Comprehensive Coverage The policy should cover all critical data, applications, and systems to avoid data loss gaps. Encrypt Backup Data Protect backups with encryption, especially for offsite or cloud storage. Test Backups Regularly Regularly test backup processes to ensure data can be effectively restored. Implement a Disaster Recovery Plan Integrate the backup policy with a broader disaster recovery plan for data loss scenarios. Use Reliable Backup Software and Hardware Invest in proven technologies with robust backup and restoration capabilities. Monitor Backup Procedures Continuously monitor procedures to ensure they function as intended and identify issues promptly. Train Staff Educate relevant staff on the importance of backups and their role in the process. Document the Backup Process Maintain thorough documentation of the backup process, including schedules, technologies, and restoration procedures. Define Service Level Agreements (SLAs) Establish clear SLAs for backup and recovery times to set expectations and ensure accountability. Comply with Legal and Regulatory Requirements Ensure the policy complies with relevant laws and regulations regarding data retention and protection. Plan for Scalability Design the policy to accommodate future data volume growth and infrastructure changes. Conduct Periodic Risk Assessments Regularly assess data risks and adjust the backup policy to mitigate those risks. <p>By adhering to these best practices, organizations can create a robust backup policy that protects their data and supports their business continuity and disaster recovery strategies. It\u2019s important to remember that the effectiveness of a backup policy is not just in its creation but in its implementation and ongoing management. Regular reviews, updates, and staff training ensure the backup policy remains relevant and effective in evolving data landscapes and threats. The goal is to have a backup policy that is not only comprehensive and compliant but also practical and responsive to the organization\u2019s needs.</p>"},{"location":"backup-strategy.html#backup-policy-example","title":"Backup policy example","text":"<p>An example of a backup policy might include the following components: </p> Aspect Details Purpose To define the procedures and responsibilities for backing up organizational data to ensure its availability in case of data loss. Scope This policy applies to all data, hardware, and software in the organization\u2019s information systems. Policy Statement The organization shall maintain a regular backup schedule for all critical data. Full backups are to be performed weekly, with incremental backups occurring daily. All backups must be encrypted and stored in a secure, off-site location. Roles and Responsibilities The IT department is responsible for executing backups as scheduled.  The department head will ensure that backup procedures are followed and reviewed regularly. Backup Procedures The IT department must use software and hardware. Data to be backed up includes, but is not limited to, customer information, financial records, and operational data. Data Retention Retain the backup data for five years or as required by law or industry regulations. Disaster Recovery In the event of data loss, the IT department shall follow the disaster recovery plan to restore data from the most recent backup. Review and Testing Review the backup policy and procedures annually.  Test the backup and restoration procedures quarterly to ensure they are effective."},{"location":"backup-strategy.html#test-the-backups","title":"Test the backups","text":"<p>You must test the effectiveness of your backups and demonstrate that you can recover your data in the event of loss or corruption. </p> <p>Here are several methods to assess the reliability of your backup system:</p> Aspect Details Perform Regular Test Restores The most reliable way to test backups is to periodically restore the data to a separate system. This restoration verifies the backup\u2019s integrity and the restoration process\u2019s functionality. Monitor Backup Reports Regularly review backup reports and logs for any errors or failures during the backup process. This can help identify issues early before they become critical problems. Check for Data Consistency Compare the original data with the backed-up data to ensure consistency. This can be done by checking file sizes, using checksums, or employing other data validation techniques. One tool would be to use [<code>pt-table-checksum</code>]. Simulate Disaster Scenarios Conducting a simulated disaster recovery exercise can help determine how well your backup system will perform under stress and identify any gaps in your recovery plan. Audit Backup Procedures Regular audits of the backup procedures can ensure that the backups are being performed in accordance with the established policies and that the backup system is functioning as expected. Validate Backup Configuration Ensure that the backup configuration is correct and that all necessary data is being backed up. This includes checking backup schedules, retention policies, and the scope of the data backed up. Verify Security Measures Confirm that the backup data is secure and that encryption and other security measures are functioning correctly to protect against unauthorized access. Evaluate Recovery Time Objectives Measure how long it takes to restore data from backups and compare this with your recovery time objectives to ensure they align with your business requirements. Assess Backup Media Reliability Regularly check the physical and logical condition of the backup media, whether it\u2019s tape, disk, or cloud storage, to ensure it\u2019s in good working order. Conduct Incremental Backup Tests Test the restoration of incremental backups to ensure that they work in conjunction with full backups and that the data can be restored to a specific point in time. Review Backup Software Updates Keep the backup software updated and test after updates to ensure new versions or patches do not introduce issues with the backup or restoration processes. Check for Compatibility Issues Ensure that the backup system is compatible with all the software and data formats used in your organization to avoid restoration issues. Document Test Results Keep detailed records of all backup tests, including the scope, date, issues encountered, and resolutions. This documentation can be invaluable for troubleshooting and improving the backup process. <p>By implementing these methods, you are confident that your backup system protects your data and can recover your data when necessary. Regular testing and monitoring are key to maintaining an effective backup strategy and ensuring business continuity. Remember, the goal of testing is not just to prove that backups can be restored, but to identify and resolve any issues before an actual disaster occurs. This proactive approach can save valuable time and resources, and ultimately, safeguard your organization\u2019s data integrity.</p>"},{"location":"backup-strategy.html#common-challenges","title":"Common challenges","text":"<p>Common backup challenges often include issues such as damaged backups, missing or failed backups, maintaining legacy systems, adhering to strict privacy and security regulations, and managing the costs associated with data backup. To overcome these challenges, organizations can adopt several strategies. Implementing a modern, reliable backup solution that includes automated data consistency checking can help protect against damaged backups. Regular recovery tests can ensure that data is recoverable and not corrupt.</p> <p>For missing or failed backups, it\u2019s essential to have a robust monitoring system that alerts IT staff to any issues with the backup process. This allows for immediate action to rectify any problems before they escalate. Maintaining legacy systems can be addressed by gradually phasing out older technology and replacing it with more current, supported solutions. This can help avoid the pitfalls of outdated systems that may not be compatible with newer technologies or that may no longer be supported by the vendor.</p> <p>Adhering to privacy and security regulations requires a thorough understanding of the laws and standards that apply to an organization\u2019s industry and geography. Implementing encryption and access controls can help ensure that backups are secure and compliant with regulations. Finally, managing the costs of data backup involves careful planning and budgeting. Organizations should consider the total cost of ownership of their backup solutions, including initial investment, ongoing maintenance, and potential costs associated with data recovery.</p> <p>In addition to these strategies, it\u2019s essential to follow best practices such as the 3-2-1 backup rule, which suggests having three copies of data on two different media, with one copy stored offsite. Regular testing and validation of backups, clear documentation of backup procedures, and continuous training for staff involved in the backup process are also crucial for overcoming common backup challenges. By staying vigilant and proactive, organizations can ensure that their data remains secure and recoverable, even in these challenges.</p>"},{"location":"backup-strategy.html#disaster-recovery-plan","title":"Disaster recovery plan","text":"<p>A disaster recovery plan (DRP) is a structured approach with detailed instructions for responding to unplanned incidents such as natural disasters, power outages, cyber-attacks, and other disruptive events.</p> <p>This table organizes the different sections of the disaster recovery plan, along with brief descriptions of each section.</p> Section Description Introduction This section outlines the purpose of the plan, its scope, and the types of disasters it covers. It also includes the plan\u2019s objectives, such as minimizing downtime and data loss. Roles and Responsibilities This part defines the disaster recovery team\u2019s specific roles. It lists the contact information for each team member and outlines the chain of command. Incident Response This section provides the steps to detect, report, and assess damage caused by a disaster. It includes procedures for immediate response to limit the impact on operations. Plan Activation Here, the criteria for launching the disaster recovery plan are detailed. It specifies who has the authority to activate the plan and under what circumstances. Communication Plan This part details how communication should be handled during a disaster, including internal communication with employees and external communication with customers, suppliers, and the media. Recovery Strategies This section outlines the strategies for restoring hardware, software, and data that are critical to resuming business operations. It includes prioritized actions for recovery and the resources required. Data Backup Procedures Detailed instructions for restoring data from backups are provided here. It includes the locations of backups, the types of backups (full, incremental), and the backup schedule. Site Relocation If the primary business location is compromised, this part of the plan details the process for moving operations to an alternate site. Plan Testing and Maintenance This section describes the schedule for regular testing of the DRP to ensure its effectiveness. It also outlines the process for updating the plan as the business and technology environment changes. Appendices The appendices may include site maps, network diagrams, floor plans, and any other documentation that supports disaster recovery efforts. <p>It\u2019s important to note that a DRP should be tailored to the specific needs of the organization and should be reviewed and tested regularly to ensure it remains effective and up-to-date. The example provided here is a high-level overview and would need to be expanded with detailed, actionable steps specific to the organization\u2019s operational requirements. For more detailed templates and guidance on creating a disaster recovery plan, there are resources available online that can provide a starting point for developing a comprehensive plan.</p> <p></p>"},{"location":"backup-strategy.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"binaries-overview.html","title":"Percona XtraBackup binaries overview","text":"<p>Percona XtraBackup is a set of the following binaries:</p> <ul> <li> <p>xtrabackup - a compiled C binary that provides functionality to backup a whole MySQL database instance with MyISAM, InnoDB, and XtraDB tables.</p> </li> <li> <p>xbcrypt - a utility used for encrypting and decrypting backup files.</p> </li> <li> <p>xbstream - a utility that allows streaming and extracting files to / from the xbstream format.</p> </li> <li> <p>xbcloud - a utility used for downloading and uploading full or part of xbstream archive from / to cloud.</p> </li> </ul> <p>The recommended way to take the backup is by using the xtrabackup script. For more information on script options, see xtrabackup.</p> <p></p>"},{"location":"binaries-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"binary-tarball-names.html","title":"Binary tarball file names available","text":"<p>Download the binary tarballs from Percona Product Downloads. For more information, see the [download instructions]. To install Percona XtraBackup, see install with binary tarball.</p> <p>The following table lists the tarball types available in <code>Linux - Generic</code>. Select the Percona XtraBackup 8.0 version, the software or the operating system, and the tarball type for your installation. Binary tarballs support all AMD64 distributions.</p> <p>After you have downloaded the binary tarballs, extract the tarball in the file location of your choice.</p> Type Name Operating systems Description Full percona-xtrabackup--Linux.x86_64.glibc2.12.tar.gz Built for CentOS 6 Contains binary files, libraries, test files, and debug symbols Minimal percona-xtrabackup--Linux.x86_64.glibc2.12-minimal.tar.gz Built for CentOS 6 Contains binary files, and libraries but does not include test files, or debug symbols Full percona-xtrabackup--Linux.x86_64.glibc2.17.tar.gz Compatible with any operating system except for CentOS 6 Contains binary files, libraries, test files, and debug symbols Minimal percona-xtrabackup--Linux.x86_64.glibc2.17-minimal.tar.gz Compatible with any operating system except for CentOS 6 Contains binary files, and libraries but does not include test files, or debug symbols <p>Select a different software, such as Ubuntu 20.04 (Focal Fossa), for a  tarball for that operating system. You can download the packages together or separately.</p> <p></p>"},{"location":"binary-tarball-names.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"binary-tarball.html","title":"Install Percona XtraBackup 8.0 from a binary tarball","text":"<p>Binary tarballs provide a ready-to-use application since they contain precompiled executables, libraries, and dependencies. Installing from a tarball is straightforward \u2014 extract the files to your desired location. Compiling or building from source is unnecessary, which saves time and effort. You avoid the compilation process, which can be time-consuming and error-prone.</p> <p>Binary tarballs provide only the necessary files, reducing disk space usage. A binary tarball installation allows customization since you can choose installation paths, configure options, and tailor the application to your requirements. Binary tarballs often come with version numbers, letting you track and update the installed version as needed.</p> <p>Be aware of the following when installing from a binary tarball:</p> <ul> <li> <p>Binary tarballs bundle dependencies within themselves. If your system already has specific libraries or versions installed, you may have conflicts.</p> </li> <li> <p>Binary tarball installation bypasses the package manager. Package managers handle updates, dependencies, and conflict resolution. Manual management of updates becomes necessary.</p> </li> <li> <p>Binary tarballs may not receive security patches automatically. You must actively monitor and apply updates.</p> </li> <li> <p>Binary tarball custom installation can scatter files. It may not adhere to standard paths, which makes maintenance challenging.</p> </li> </ul>"},{"location":"binary-tarball.html#download-the-tarball","title":"Download the tarball","text":"<p>You can download the binary tarballs from the <code>Linux - Generic</code> section on the Percona Product Downloads. For more information, see the download instructions. For information on the available binary tarball names, see binary tarball names.</p> <p>The following command is an example of downloading a tarball for Linux/Generic:</p> <pre><code>$ wget https://downloads.percona.com/downloads/Percona-XtraBackup-8.0/Percona-XtraBackup-8.0.35-30/binary/tarball/percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17.tar.gz\n</code></pre> Expected result <pre><code>--2024-03-18 11:34:50--  https://downloads.percona.com/downloads/Percona-XtraBackup-8.0/Percona-XtraBackup-8.0.35-30/binary/tarball/percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17.tar.gz\nResolving downloads.percona.com (downloads.percona.com)... 147.135.54.159, 2604:2dc0:200:69f::2\nConnecting to downloads.percona.com (downloads.percona.com)|147.135.54.159|:443... connected.\n...\npercona-xtrabackup-8.0 100%[==========================&gt;] 448.02M  2.56MB/s    in 5m 5s\n2024-03-18 11:39:56 (1.47 MB/s) - 'percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17.tar.gz' saved [469780148/469780148]\n</code></pre>"},{"location":"binary-tarball.html#extract-the-tarball","title":"Extract the tarball","text":"<p>After downloading the tarball to the selected location, use the following command to extract the tarball:</p> <pre><code>$ tar -xvf percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17.tar.gz\n</code></pre> Expected result <pre><code>percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xbcloud_osenv\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xtrabackup\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xbcrypt\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xbstream\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xbcloud\n...\n</code></pre> <p>After the extraction, navigate to the <code>bin</code> directory to find the binary files. </p> <pre><code>$ cd percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin\n</code></pre> <p>In the bin directory, run one of the binary files.</p> <pre><code>$ ./xtrabackup --version\n</code></pre> Expected result <pre><code>./xtrabackup version 8.0.35-30 based on MySQL server 8.0.35 Linux (x86_64) (revision id: 6beb4b49)\n</code></pre> <p></p>"},{"location":"binary-tarball.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"compile-xtrabackup.html","title":"Compile and install Percona XtraBackup 8.0 from source","text":"<p>The following instructions install Percona XtraBackup 8.0.</p>"},{"location":"compile-xtrabackup.html#1-install-percona-xtrabackup-from-the-git-source-tree","title":"1. Install Percona XtraBackup from the Git Source Tree","text":"<p>Percona uses the Github revision control system for development. To build the latest Percona Server for MySQL from the source tree, you will need <code>git</code> installed on your system.</p> <p>You can now fetch the latest Percona XtraBackup 8.0 sources:</p> <pre><code>$ git clone https://github.com/percona/percona-xtrabackup.git\n$ cd percona-xtrabackup\n$ git checkout 8.0\n$ git submodule update --init --recursive\n</code></pre>"},{"location":"compile-xtrabackup.html#2-installation-prerequisites","title":"2. Installation prerequisites","text":"<p>The following packages and tools must be installed to compile Percona XtraBackup from source. These might vary from system to system.</p> <p>Important</p> <p>To build **Percona XtraBackup 8.0 from source, you must use <code>cmake</code>  version 3. To check which version is  currently installed, run <code>cmake --version</code> at a command prompt. If the  version is not <code>3</code>, install <code>cmake3</code>.</p> <p>This <code>cmake</code> version may be available  in your distribution as a separate package <code>cmake3</code>. For more information, see cmake.org</p> Debian or Ubuntu using <code>apt</code>CentOS or Red Hat using <code>yum</code> <pre><code>sudo apt install bison pkg-config cmake devscripts debconf \\\ndebhelper automake bison ca-certificates libprocps-dev \\\nlibcurl4-openssl-dev cmake debhelper libaio-dev \\\nlibncurses-dev libssl-dev libtool libz-dev libgcrypt-dev libev-dev libprocps-dev \\\nlsb-release build-essential rsync libdbd-mysql-perl \\\nlibnuma1 socat librtmp-dev libtinfo5 vim-common \\\nlibudev-dev \\\nliblz4-tool liblz4-1 liblz4-dev zstd python-docutils qpress\n</code></pre> <p>To install the man pages, install the python3-sphinx package first:</p> <pre><code>$ sudo apt install python3-sphinx\n</code></pre> <p>Percona Xtrabackup requires GCC version 5.3 or higher. If the version of GCC installed on your system is lower then you may need to install and enable the Developer Toolset on <code>RPM</code>-based distributions to make sure that you use the latest GCC compiler and development tools.  Then, install <code>cmake</code> and other dependencies:</p> <pre><code>$ sudo yum install cmake openssl-devel libaio libaio-devel automake autoconf \\\nbison libtool ncurses-devel libgcrypt-devel libev-devel libcurl-devel zlib-devel \\\nbibudev-dev \\\nzstd vim-common procps-ng-devel\n</code></pre> <p>To install the man pages, install the python3-sphinx package first:</p> <pre><code>$ sudo yum install python3-sphinx\n</code></pre>"},{"location":"compile-xtrabackup.html#3-generate-the-build-pipeline","title":"3. Generate the build pipeline","text":"<p>At this step, you have <code>cmake</code> run the commands in the <code>CMakeList.txt</code> file to generate the build pipeline, i.e., a native build environment that will be used to compile the source code).</p> <ol> <li> <p>Change to the directory where you cloned the Percona XtraBackup repository</p> <pre><code>$ cd percona-xtrabackup\n</code></pre> </li> <li> <p>Create a directory to store the compiled files and then change to that directory:</p> <pre><code>$ mkdir build\n$ cd build\n</code></pre> </li> <li> <p>Run cmake or cmake3. In either case, the options you need to use are the same.</p> </li> </ol> <p>Note</p> <p>You can build Percona XtraBackup with man pages but this requires <code>python-sphinx</code> package which isn\u2019t available from that main repositories for every distribution. If you installed the <code>python-sphinx</code> package you need to remove the <code>-DWITH_MAN_PAGES=OFF</code> from previous command.</p> <pre><code>$ cmake -DWITH_BOOST=PATH-TO-BOOST-LIBRARY -DDOWNLOAD_BOOST=ON \\\n-DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF -B ..\n</code></pre>"},{"location":"compile-xtrabackup.html#parameter-information","title":"Parameter Information","text":"Parameter Description <code>-DWITH_BOOST</code> For the <code>-DWITH_BOOST</code> parameter, specify the name of a directory to download the boost library to. This directory is created automatically in your current directory. <code>-DWITH_MAN_PAGES</code> To build Percona XtraBackup man pages, use <code>ON</code> or remove this parameter from the command line (it is <code>ON</code> by default). To install the man pages, install the python3-sphinx package first. <code>-B</code> (\u2013build) Percona XtraBackup is configured to forbid generating the build    pipeline for make in the same directory where you store your sources. The <code>-B</code> parameter refers to the directory that contains the source code. In this example, we use the relative path to the parent directory (..). <p>Important</p> <p>CMake Error at CMakeLists.txt:367 (MESSAGE): Please do not build in-source. Out-of source builds are highly recommended: you can have multiple builds for the same source, and there is an easy way to do cleanup, simply remove the build directory (note that \u2018make clean\u2019 or \u2018make distclean\u2019 does <code>not</code> work)</p> <p>You <code>can</code> force in-source build by invoking cmake with <code>-DFORCE_INSOURCE_BUILD=1</code>.</p>"},{"location":"compile-xtrabackup.html#4-compile-the-source-code","title":"4. Compile the source code","text":"<p>To compile the source code in your <code>build</code> directory, use the <code>make</code> command.</p> <ol> <li> <p>Change to the <code>build</code> directory (created at Step 2: Generating the build pipeline).</p> </li> <li> <p>Run the <code>make</code> command. This command may take a long time to complete.</p> <pre><code>$ make\n</code></pre> <p>To use all CPU threads and make compilation faster please use:</p> <pre><code>$ make -j$(nproc --all)\n</code></pre> </li> </ol>"},{"location":"compile-xtrabackup.html#5-install-on-the-target-system","title":"5. Install on the target system","text":"<p>The following command installs all Percona XtraBackup binaries xtrabackup and tests to default location on the target system: <code>/usr/local/xtrabackup</code>.</p> <p>Run <code>make install</code> to install Percona XtraBackup to the default location.</p> <pre><code>$ sudo make install\n</code></pre>"},{"location":"compile-xtrabackup.html#install-to-a-non-default-location","title":"Install to a non-default location","text":"<p>You may use the <code>DESTDIR</code> parameter with <code>make install</code> to install Percona XtraBackup to another location. Make sure that the effective user is able to write to the destination you choose.</p> <pre><code>$ sudo make DESTDIR=&lt;DIR_NAME&gt; install\n</code></pre> <p>In fact, the destination directory is determined by the installation layout (<code>-DINSTALL_LAYOUT</code>) that <code>cmake</code> applies (see Step 2: Generating the build pipeline). In addition to the installation directory, this parameter controls a number of other destinations that you can adjust for your system.</p> <p>By default, this parameter is set to <code>STANDALONE</code>, which implies the installation directory to be <code>/usr/local/xtrabackup</code>.</p> <p>See also</p> <p>MySQL Documentation: -DINSTALL_LAYOUT</p>"},{"location":"compile-xtrabackup.html#6-run-percona-xtrabackup","title":"6. Run Percona XtraBackup","text":"<p>After Percona XtraBackup is installed on your system, you may run it by using the full path to the <code>xtrabackup</code> command:</p> <pre><code>$ /usr/local/xtrabackup/bin/xtrabackup\n</code></pre> <p>Update your PATH environment variable if you would like to use the command on the command line directly.</p> <pre><code>$# Setting $PATH on the command line\n$ PATH=$PATH:/usr/local/xtrabackup/bin/xtrabackup\n\n$# Run xtrabackup directly\n$ xtrabackup\n</code></pre> <p>Alternatively, you may consider placing a soft link (using <code>ln -s</code>) to one of the locations listed in your <code>PATH</code> environment variable.</p> <p>To view the documentation with <code>man</code>, update the <code>MANPATH</code> variable.</p> <p></p>"},{"location":"compile-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"configure-xtrabackup.html","title":"Configure xtrabackup","text":"<p>All the xtrabackup configuration is done through options, which behave exactly like standard MySQL program options: they can be specified either at the command-line, or through a file such as <code>/etc/my.cnf</code>.</p> <p>The xtrabackup binary reads the <code>mysqld</code> and <code>xtrabackup</code> sections from any configuration files, in that order. That is so that it can read its options from your existing MySQL installation, such as the datadir or some InnoDB options. If you want to override these options specify them in the <code>xtrabackup</code> section. These options are read at a later time and take precedence.</p> <p>You don\u2019t need to put any configuration in your <code>my.cnf</code> if you don\u2019t want to. You can simply specify the options on the command-line. Normally, the only thing you might find convenient to place in the <code>xtrabackup</code> section of your <code>my.cnf</code> file is the <code>target_dir</code> option to default the directory in which the backups will be placed, for example:</p> <pre><code>[xtrabackup]\ntarget_dir = /data/backups/mysql/\n</code></pre> <p>This manual will assume that you do not have any file-based configuration for xtrabackup, so it will always show command-line options being used explicitly. Please see the option and variable reference for details on all the configuration options.</p> <p>The xtrabackup binary does not accept exactly the same syntax in the <code>my.cnf</code> file as the mysqld server binary does. For historical reasons, the mysqld server binary accepts parameters with a <code>--set-variable=&lt;variable&gt;=&lt;value&gt;</code> syntax, which xtrabackup does not understand. If your <code>my.cnf</code> file has such configuration directives, you should rewrite them in the <code>--variable=value</code> syntax.</p>"},{"location":"configure-xtrabackup.html#system-configuration-and-nfs-volumes","title":"System configuration and NFS volumes","text":"<p>The xtrabackup tool requires no special configuration on most systems. However, the storage where the <code>--target-dir</code> is located must behave properly when <code>fsync()</code> is called. In particular, we have noticed that if you mount the NFS volume without the <code>sync</code> option the NFS volume does not sync the data. As a result, if you back up to an NFS volume mounted with the async option, and then try to prepare the backup from a different server that also mounts that volume, the data might appear to be corrupt. You can use the <code>sync</code> mount option to avoid this problem.</p> <p></p>"},{"location":"configure-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"copyright-and-licensing-information.html","title":"Copyright and licensing information","text":""},{"location":"copyright-and-licensing-information.html#documentation-licensing","title":"Documentation licensing","text":"<p>Percona XtraBackup documentation is (C)2009-2023 Percona LLC and/or its affiliates and is distributed under the Creative Commons Attribution 4.0 International License.</p> <p></p>"},{"location":"copyright-and-licensing-information.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-compressed-backup.html","title":"Create a compressed backup","text":"<p>Percona XtraBackup supports compressed backups. A local or streaming backup can be compressed or decompressed with xbstream.</p> <p>To make a compressed backup, use the <code>--compress</code> option along with the <code>--backup</code> and <code>--target-dir</code> options. </p>"},{"location":"create-compressed-backup.html#version-updates","title":"Version updates","text":"Percona XtraBackup 8.0.34-29 and later <p>Percona XtraBackup removes <code>qpress/QuickLZ</code> and moves the <code>ZSTD</code> compression method to General Availability. With this version <code>ZSTD</code> becomes the default compression method for the <code>--compress</code> option.</p> <p>The following compression algorithms are supported:</p> <p><code>Zstandard (ZSTD)</code></p> <p><code>ZSTD</code> is a fast lossless compression algorithm that targets real-time compression scenarios and better compression ratios. <code>ZSTD</code> is the default compression method for the <code>--compress</code> option.</p> <p>To compress files using the <code>ZSTD</code> compression algorithm, run the following command:</p> <pre><code>$ xtrabackup --backup --compress --target-dir=/data/backup\n</code></pre> <p>You can specify <code>ZSTD</code> compression level with the <code>--compress-zstd-level(=#)</code> option. The default value is <code>1</code>.</p> <pre><code>$ xtrabackup --backup --compress --compress-zstd-level=1 --target-dir=/data/backup\n</code></pre> <p>If you want to speed up the compression you can use the parallel compression, which can be enabled with <code>--compress-threads</code> option. Following example will use four threads for compression:</p> <pre><code>$ xtrabackup --backup --compress --compress-threads=4 \\\n--target-dir=/data/compressed/\n</code></pre> <p>The expected output:</p> <pre><code>...\n170223 13:00:38 [01] Compressing ./test/sbtest1.frm to /tmp/compressed/test/sbtest1.frm.qp\n170223 13:00:38 [01]        ...done\n170223 13:00:38 [01] Compressing ./test/sbtest2.frm to /tmp/compressed/test/sbtest2.frm.qp\n170223 13:00:38 [01]        ...done\n...\n170223 13:00:39 [00] Compressing xtrabackup_info\n170223 13:00:39 [00]        ...done\nxtrabackup: Transaction log of lsn (9291934) to (9291934) was copied.\n170223 13:00:39 completed OK!\n</code></pre> <p><code>lz4</code></p> <p>To compress files using the <code>lz4</code> compression algorithm, set <code>--compress</code> option to <code>lz4</code>:</p> <pre><code>$ xtrabackup --backup --compress=lz4 --target-dir=/data/backup\n</code></pre> <p>To decompress files, use the <code>--decompress</code> option. </p> Percona XtraBackup 8.0.31-24 to 8.0.34-29  <p>Using qpress/QuickLZ to compress backups is deprecated and may be removed in future versions. We recommend using either <code>LZ4</code> or Zstandard (<code>ZSTD</code>) compression algorithms. <code>ZSTD</code> compression algorithm is in tech preview. </p> Before Percona XtraBackup 8.0.31-24 <p>By default, the <code>--compress</code> option uses the <code>qpress</code> tool that you can install with the <code>percona-release</code> package configuration tool as follows:</p> <pre><code>$ sudo percona-release enable tools\n$ sudo apt update\n$ sudo apt install qpress\n</code></pre> <p>Note</p> <p>Enable the repository: <code>percona-release enable-only tools release</code>.</p> <p>If Percona XtraBackup is intended to be used in combination with the upstream MySQL Server, you only need to enable the <code>tools</code> repository: <code>percona-release enable-only tools</code>.</p> <p>The following compression algorithms are supported:</p> <p><code>quicklz</code></p> <p>To compress files using the <code>quicklz</code> compression algorithm, use <code>--compress</code> option:</p> <pre><code>$ xtrabackup --backup --compress --target-dir=/data/backup\n</code></pre> <p><code>lz4</code></p> <p>To compress files using the <code>lz4</code> compression algorithm, set <code>--compress</code> option to <code>lz4</code>:</p> <pre><code>$ xtrabackup --backup --compress=lz4 --target-dir=/data/backup\n</code></pre> <p><code>Zstandard (ZSTD)</code></p> <p>The Zstandard (ZSTD) compression algorithm is a tech preview feature. Before using ZSTD in production, we recommend that you test restoring production from physical backups in your environment, and also use the alternative backup method for redundancy.</p> <p>Percona XtraBackup 8.0.30-23 adds support for the <code>Zstandard (ZSTD)</code> compression algorithm. <code>ZSTD</code> is a fast lossless compression algorithm that targets real-time compression scenarios and better compression ratios. </p> <p>To compress files using the <code>ZSTD</code> compression algorithm, set <code>--compress</code> option to <code>zstd</code>:</p> <pre><code>$ xtrabackup --backup --compress=zstd --target-dir=/data/backup\n</code></pre> <p>You can specify <code>ZSTD</code> compression level with the <code>--compress-zstd-level(=#)</code> option. The default value is <code>1</code>.</p> <pre><code>$ xtrabackup --backup --compress --compress-zstd-level=1 --target-dir=/data/backup\n</code></pre> <p>If you want to speed up the compression you can use the parallel compression, which can be enabled with <code>--compress-threads</code> option. Following example will use four threads for compression:</p> <pre><code>$ xtrabackup --backup --compress --compress-threads=4 \\\n--target-dir=/data/compressed/\n</code></pre> <p>The expected output:</p> <pre><code>...\n170223 13:00:38 [01] Compressing ./test/sbtest1.frm to /tmp/compressed/test/sbtest1.frm.qp\n170223 13:00:38 [01]        ...done\n170223 13:00:38 [01] Compressing ./test/sbtest2.frm to /tmp/compressed/test/sbtest2.frm.qp\n170223 13:00:38 [01]        ...done\n...\n170223 13:00:39 [00] Compressing xtrabackup_info\n170223 13:00:39 [00]        ...done\nxtrabackup: Transaction log of lsn (9291934) to (9291934) was copied.\n170223 13:00:39 completed OK!\n</code></pre> <p>Using <code>--encrypt</code> might create larger backups than expected when used with InnoDB Page Compression.</p> <p>To avoid this issue with compressed backups, use the <code>--compress</code> option with the <code>--xbstream</code> option in Percona XtraBackup 8.0.31-24 and later.</p> <p>The next step is to prepare the backup in order to restore it. </p> <p></p>"},{"location":"create-compressed-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-full-backup.html","title":"Create a full backup","text":"<p>To create a backup, run xtrabackup with the <code>--backup</code> option. You also need to specify the <code>--target-dir</code> option, which is where the backup will be stored, if the InnoDB data or log files are not stored in the same directory, you might need to specify the location of those, too. If the target directory does not exist, xtrabackup creates it. If the directory does exist and is empty, xtrabackup will succeed.</p> <p>xtrabackup will not overwrite existing files, it will fail with operating system error 17, <code>file exists</code>.</p> <p>To start the backup process run:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/\n</code></pre> <p>This will store the backup at <code>/data/backups/</code>. If you specify a relative path, the target directory will be relative to the current directory.</p> <p>During the backup process, you should see a lot of output showing the data files being copied, as well as the log file thread repeatedly scanning the log files and copying from it. Here is an example that shows the log thread scanning the log in the background, and a file copying thread working on the <code>ibdata1</code> file:</p> Expected output <pre><code>160906 10:19:17 Finished backing up non-InnoDB tables and files\n160906 10:19:17 Executing FLUSH NO_WRITE_TO_BINLOG ENGINE LOGS...\nxtrabackup: The latest check point (for incremental): '62988944'\nxtrabackup: Stopping log copying thread.\n.160906 10:19:18 &gt;&gt; log scanned up to (137343534)\n160906 10:19:18 Executing UNLOCK TABLES\n160906 10:19:18 All tables unlocked\n160906 10:19:18 Backup created in directory '/data/backups/'\n160906 10:19:18 [00] Writing backup-my.cnf\n160906 10:19:18 [00]        ...done\n160906 10:19:18 [00] Writing xtrabackup_info\n160906 10:19:18 [00]        ...done\nxtrabackup: Transaction log of lsn (26970807) to (137343534) was copied.\n160906 10:19:18 completed OK!\n</code></pre> <p>The last thing you should see is something like the following, where the value of the <code>&lt;LSN&gt;</code> will be a number that depends on your system:</p> <pre><code>$ xtrabackup: Transaction log of lsn (&lt;LSN&gt;) to (&lt;LSN&gt;) was copied.\n</code></pre> <p>Note</p> <p>Log copying thread checks the transactional log every second to see if there were any new log records written that need to be copied, but there is a chance that the log copying thread might not be able to keep up with the amount of writes that go to the transactional logs, and will hit an error when the log records are overwritten before they could be read.</p> <p>After the backup is finished, the target directory will contain files such as the following, assuming you have a single InnoDB table <code>test.tbl1</code> and you are using MySQL\u2019s innodb_file_per_table option:</p> <pre><code>$ ls -lh /data/backups/\n</code></pre> <p>The result should look like this:</p> Expected output <pre><code>total 182M\ndrwx------  7 root root 4.0K Sep  6 10:19 .\ndrwxrwxrwt 11 root root 4.0K Sep  6 11:05 ..\n-rw-r-----  1 root root  387 Sep  6 10:19 backup-my.cnf\n-rw-r-----  1 root root  76M Sep  6 10:19 ibdata1\ndrwx------  2 root root 4.0K Sep  6 10:19 mysql\ndrwx------  2 root root 4.0K Sep  6 10:19 performance_schema\ndrwx------  2 root root 4.0K Sep  6 10:19 sbtest\ndrwx------  2 root root 4.0K Sep  6 10:19 test\ndrwx------  2 root root 4.0K Sep  6 10:19 world2\n-rw-r-----  1 root root  116 Sep  6 10:19 xtrabackup_checkpoints\n-rw-r-----  1 root root  433 Sep  6 10:19 xtrabackup_info\n-rw-r-----  1 root root 106M Sep  6 10:19 xtrabackup_logfile\n</code></pre> <p>The backup can take a long time, depending on how large the database is. It is safe to cancel at any time, because xtrabackup does not modify the database.</p> <p>The next step is to prepare the backup in order to restore it. </p> <p></p>"},{"location":"create-full-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-gtid-replica.html","title":"How to create a new (or repair a broken) GTID-based replica","text":"<p>MySQL 5.6 introduced the Global Transaction ID (GTID) support in replication. Percona XtraBackup automatically stores the <code>GTID</code> value in the <code>xtrabackup_binlog_info</code> when doing the backup of MySQL and Percona Server for MySQL 5.7 with the <code>GTID</code> mode enabled. This information can be used to create a new (or repair a broken) <code>GTID</code>-based replica.</p>"},{"location":"create-gtid-replica.html#1-take-a-backup-from-any-server-on-the-replication-environment-source-or-replica","title":"1. Take a backup from any server on the replication environment, source or replica","text":"<p>The following command takes a backup and saves it in the <code>/data/backups/$TIMESTAMP</code> folder:</p> <pre><code>$ xtrabackup --backup --target-dirs=/data/backups/\n</code></pre> <p>In the destination folder, there will be a file with the name <code>xtrabackup_binlog_info</code>. This file contains both binary log coordinates and the <code>GTID</code> information.</p> <p><pre><code>$ cat xtrabackup_binlog_info\n</code></pre> The result could look like this:</p> Expected output <pre><code>mysql-bin.000002    1232        c777888a-b6df-11e2-a604-080027635ef5:1-4\n</code></pre> <p>That information is also printed by xtrabackup after taking the backup:</p> Expected output <pre><code>xtrabackup: MySQL binlog position: filename 'mysql-bin.000002', position 1232, GTID of the last change 'c777888a-b6df-11e2-a604-080027635ef5:1-4'\n</code></pre>"},{"location":"create-gtid-replica.html#2-prepare-the-backup","title":"2. Prepare the backup","text":"<p>The backup will be prepared with the following command on the Source:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup\n</code></pre> <p>You need to select the path where your snapshot has been taken, for example <code>/data/backups/2013-05-07_08-33-33</code>. If everything is ok you should get the same OK message. Now, the transaction logs are applied to the data files, and new ones are created: your data files are ready to be used by the MySQL server.</p>"},{"location":"create-gtid-replica.html#3-move-the-backup-to-the-destination-server","title":"3. Move the backup to the destination server","text":"<p>Use rsync or scp to copy the data to the destination server. If you are synchronizing the data directly to the already running replica\u2019s data directory it is advised to stop the MySQL server there.</p> <pre><code>$ rsync -avprP -e ssh /path/to/backupdir/$TIMESTAMP NewSlave:/path/to/mysql/\n</code></pre> <p>After you copy the data over, make sure MySQL has proper permissions to access them.</p> <pre><code>$ chown mysql:mysql /path/to/mysql/datadir\n</code></pre>"},{"location":"create-gtid-replica.html#4-configure-and-start-replication","title":"4. Configure and start replication","text":"<p>Set the <code>gtid_purged</code> variable to the <code>GTID</code> from <code>xtrabackup_binlog_info</code>. Then, update the information about the source node and, finally, start the replica. Run the following commands on the replica if you are using a version before 8.0.22:</p> <pre><code># Using the mysql shell\n &gt; SET SESSION wsrep_on = 0;\n &gt; RESET MASTER;\n &gt; SET SESSION wsrep_on = 1;\n &gt; SET GLOBAL gtid_purged='&lt;gtid_string_found_in_xtrabackup_binlog_info&gt;';\n &gt; CHANGE MASTER TO\n             MASTER_HOST=\"$masterip\",\n             MASTER_USER=\"repl\",\n             MASTER_PASSWORD=\"$slavepass\",\n             MASTER_AUTO_POSITION = 1;\n &gt; START SLAVE;\n</code></pre> <p>If you are using version 8.0.22 or later, use <code>START REPLICA</code> instead of <code>START SLAVE</code>. <code>START SLAVE</code> is deprecated as of that release. If you are using version 8.0.21 or earlier, use <code>START SLAVE</code>.</p> <p>If you are using a version 8.0.23 or later, run the following commands:</p> <pre><code># Using the mysql shell\n &gt; SET SESSION wsrep_on = 0;\n &gt; RESET MASTER;\n &gt; SET SESSION wsrep_on = 1;\n &gt; SET GLOBAL gtid_purged='&lt;gtid_string_found_in_xtrabackup_binlog_info&gt;';\n &gt; CHANGE REPLICATION SOURCE TO\n             SOURCE_HOST=\"$masterip\",\n             SOURCE_USER=\"repl\",\n             SOURCE_PASSWORD=\"$slavepass\",\n             SOURCE_AUTO_POSITION = 1;\n &gt; START REPLICA;\n</code></pre> <p>If you are using version 8.0.23 or later, use CHANGE_REPLICATION_SOURCE_TO and the appropriate options. <code>CHANGE_MASTER_TO</code> is deprecated as of that release.</p> <p>Note</p> <p>The example above is applicable to Percona XtraDB Cluster. The <code>wsrep_on</code> variable is set to 0 before resetting the source (<code>RESET MASTER</code>). The reason is that Percona XtraDB Cluster will not allow resetting the source if <code>wsrep_on=1</code>.</p>"},{"location":"create-gtid-replica.html#5-check-the-replication-status","title":"5. Check the replication status","text":"<p>The following command returns the replica status:</p> <p><pre><code>mysql&gt; SHOW REPLICA STATUS\\G\n</code></pre> The results should be similar to the following:</p> Expected output <pre><code>[..]\nSlave_IO_Running: Yes\nSlave_SQL_Running: Yes\n[...]\nRetrieved_Gtid_Set: c777888a-b6df-11e2-a604-080027635ef5:5\nExecuted_Gtid_Set: c777888a-b6df-11e2-a604-080027635ef5:1-5\n</code></pre> <p>Note</p> <p>The command SHOW SLAVE STATUS is deprecated. Use SHOW REPLICA STATUS.</p> <p>We can see that the replica has retrieved a new transaction with number 5, so transactions from 1 to 5 are already on this slave.</p> <p>We have created a new replica in our <code>GTID</code> based replication environment.</p> <p></p>"},{"location":"create-gtid-replica.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-incremental-backup.html","title":"Create an incremental backup","text":"<p>xtrabackup supports incremental backups, which means that they can copy only all the data that has changed since the last backup.</p> <p>Note</p> <p>Incremental backups on the MyRocks storage engine do not determine if an earlier full backup or incremental backup contains the same files. Percona XtraBackup copies all the MyRocks files each time it takes a backup.</p> <p>You can perform many incremental backups between each full backup, so you can set up a backup process such as a full backup once a week and an incremental backup every day, or full backups every day and incremental backups every hour.</p> <p>Incremental backups work because each InnoDB page contains a log sequence number, or LSN. The LSN is the system version number for the entire database. Each page\u2019s LSN shows how recently it was changed.</p> <p>An incremental backup copies each page which LSN is newer than the previous incremental or full backup\u2019s LSN. An algorithm finds the pages that match the criteria. The algorithm reads the data pages and checks the page LSN.</p>"},{"location":"create-incremental-backup.html#use-the-changed-page-tracking-algorithm","title":"Use the changed page tracking algorithm","text":"<p>Percona XtraBackup 8.0.30 removes the algorithm that used the changed page tracking feature in Percona Server for MySQL. Percona Server for MySQL 8.0.27 deprecated the changed page tracking feature.</p> <p>With PXB 8.0.27 or earlier, another algorithm enabled the Percona Server for MySQL changed page tracking feature. The algorithm generates a bitmap file. The xtrabackup binary uses that bitmap file to read only those pages needed for the incremental backup. This method potentially saves resources. The backup enables the algorithm by default if the xtrabackup binary discovers the bitmap file. You can override the algorithm with <code>--incremental-force-scan</code> which forces a read of all pages even if the bitmap file is available.</p>"},{"location":"create-incremental-backup.html#create-an-incremental-backup_1","title":"Create an incremental backup","text":"<p>To make an incremental backup, begin with a full backup as usual. The xtrabackup binary writes a file called <code>xtrabackup_checkpoints</code> into the backup\u2019s target directory. This file contains a line showing the <code>to_lsn</code>, which is the database\u2019s LSN at the end of the backup. Create the full backup with a following command:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/base\n</code></pre> <p>If you look at the <code>xtrabackup_checkpoints</code> file, you should see similar content depending on your LSN nuber:</p> Expected output <pre><code>backup_type = full-backuped\nfrom_lsn = 0\nto_lsn = 1626007\nlast_lsn = 1626007\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p>Now that you have a full backup, you can make an incremental backup based on it. Use the following command:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/inc1 \\\n--incremental-basedir=/data/backups/base\n</code></pre> <p>The <code>/data/backups/inc1/</code> directory should now contain delta files, such as <code>ibdata1.delta</code> and <code>test/table1.ibd.delta</code>. These represent the changes since the <code>LSN 1626007</code>. If you examine the <code>xtrabackup_checkpoints</code> file in this directory, you should see similar content to the following:</p> Expected output <pre><code>backup_type = incremental\nfrom_lsn = 1626007\nto_lsn = 4124244\nlast_lsn = 4124244\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p><code>from_lsn</code> is the starting LSN of the backup and for incremental it has to be the same as <code>to_lsn</code> (if it is the last checkpoint) of the previous/base backup.</p> <p>It\u2019s now possible to use this directory as the base for yet another incremental backup:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/inc2 \\\n--incremental-basedir=/data/backups/inc1\n</code></pre> <p>This folder also contains the <code>xtrabackup_checkpoints</code>:</p> Expected output <pre><code>backup_type = incremental\nfrom_lsn = 4124244\nto_lsn = 6938371\nlast_lsn = 7110572\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p>Note</p> <p>In this case you can see that there is a difference between the <code>to_lsn</code> (last checkpoint LSN) and <code>last_lsn</code> (last copied LSN), this means that there was some traffic on the server during the backup process.</p> <p>The next step is to prepare the backup in order to restore it. </p> <p></p>"},{"location":"create-incremental-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-individual-partition-backup.html","title":"Create an individual partitions backup","text":"<p>Percona XtraBackup lets you back up individual partitions because partitions are regular tables with specially formatted names. The only requirement for this feature is to enable the <code>innodb_file_per_table</code> option on the server.</p> <p>There is one caveat about using this kind of backup: you can not copy back the prepared backup. Restoring partial backups should be done by importing the tables.</p> <p>There are three ways of specifying which part of the whole data will be backed up: regular expressions (<code>--tables</code>), enumerating the tables in a file (<code>--tables-file</code>) or providing a list of databases (<code>--databases</code>).</p> <p>The regular expression provided to this option will be matched against the fully qualified database name and table name, in the form of <code>database-name.table-name</code>.</p> <p>If the partition 0 is not backed up, Percona XtraBackup cannot generate a .cfg file. MySQL 8.0 stores the table metadata in partition 0.</p> <p>For example, this operation takes a back-up of the partition <code>p4</code> from  the table <code>name</code> located in the database <code>imdb</code>:</p> <pre><code>$ xtrabackup --tables=^imdb[.]name#p#p4 --backup\n</code></pre> <p>If partition 0 is not backed up, the following errors may occur:</p> The error message <pre><code>xtrabackup: export option not specified\nxtrabackup: error: cannot find dictionary record of table imdb/name#p#p4\n</code></pre> <p>Note that this option is passed to <code>xtrabackup --tables</code> and is matched against each table of each database, the directories of each database will be created even if they are empty.</p> <p></p>"},{"location":"create-individual-partition-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-partial-backup.html","title":"Create a partial backup","text":"<p>xtrabackup supports taking partial backups when the <code>innodb_file_per_table</code> option is enabled. There are three ways to create partial backups:</p> <ol> <li> <p>matching the tables names with a regular expression</p> </li> <li> <p>providing a list of table names in a file</p> </li> <li> <p>providing a list of databases</p> </li> </ol> <p>Warning</p> <p>Do not copy back the prepared backup.</p> <p>Restoring partial backups should be done by importing the tables, not by using the \u2013copy-back option. It is not recommended to run incremental backups after running a partial backup.</p> <p>Although there are some scenarios where restoring can be done by copying back the files, this may lead to database inconsistencies in many cases and it is not a recommended way to do it.</p> <p>For the purposes of this manual page, we will assume that there is a database named <code>test</code> which contains tables named <code>t1</code> and <code>t2</code>.</p> <p>Warning</p> <p>If any of the matched or listed tables is deleted during the backup, xtrabackup will fail.</p> <p>There are multiple ways of specifying which part of the whole data is backed up:</p> <ul> <li> <p>Use the <code>--tables</code> option to list the table names</p> </li> <li> <p>Use the <code>--tables-file</code> option to list the tables in a file</p> </li> <li> <p>Use the <code>--databases</code> option to list the databases</p> </li> <li> <p>Use the <code>--databases-file</code> option to list the databases</p> </li> </ul>"},{"location":"create-partial-backup.html#the-tables-option","title":"The <code>\u2013-tables</code> option","text":"<p>The first method involves the xtrabackup \u2013tables option. The option\u2019s value is a regular expression that is matched against the fully-qualified database name and table name using the <code>databasename.tablename</code> format.</p> <p>To back up only tables in the <code>test</code> database, use the following command:</p> <pre><code>$ xtrabackup --backup --datadir=/var/lib/mysql --target-dir=/data/backups/ \\\n--tables=\"^test[.].*\"\n</code></pre> <p>To back up only the <code>test.t1</code> table, use the following command:</p> <pre><code>$ xtrabackup --backup --datadir=/var/lib/mysql --target-dir=/data/backups/ \\\n--tables=\"^test[.]t1\"\n</code></pre>"},{"location":"create-partial-backup.html#the-tables-file-option","title":"The <code>-\u2013tables-file</code> option","text":"<p>The <code>--tables-file</code> option specifies a file that can contain multiple table names, one table name per line in the file. Only the tables named in the file will be backed up. Names are matched exactly, case-sensitive, with no pattern or regular expression matching. The table names must be fully-qualified in <code>databasename.tablename</code> format.</p> <pre><code>$ echo \"mydatabase.mytable\" &gt; /tmp/tables.txt\n$ xtrabackup --backup --tables-file=/tmp/tables.txt\n</code></pre>"},{"location":"create-partial-backup.html#the-databases-and-databases-file-options","title":"The <code>--databases</code> and <code>-\u2013databases-file</code> options","text":"<p>The ` \u2013databases` option accepts a space-separated list of the databases and tables to backup in the <code>databasename[.tablename]</code> format. In addition to this list, make sure to specify the <code>mysql</code>, <code>sys</code>, and</p> <p><code>performance_schema</code> databases. These databases are required when restoring the databases using xtrabackup \u2013copy-back.</p> <p>Note</p> <p>Tables processed during the \u2013prepare step may also be added to the backup even if they are not explicitly listed by the parameter if they were created after the backup started.</p> <pre><code>$ xtrabackup --databases='mysql sys performance_schema test ...'\n</code></pre>"},{"location":"create-partial-backup.html#the-databases-file-option","title":"The <code>--databases-file</code> option","text":"<p>The \u2013databases-file option specifies a file that can contain multiple databases and tables in the <code>databasename[.tablename]</code> format, one element name per line in the file. Names are matched exactly, case-sensitive, with no pattern or regular expression matching.</p> <p>Note</p> <p>Tables processed during the \u2013prepare step may also be added to the backup even if they are not explicitly listed by the parameter if they were created after the backup started.</p> <p>The next step is to prepare the backup in order to restore it. </p> <p></p>"},{"location":"create-partial-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"dictionary-cache.html","title":"Dictionary cache","text":"<p>Percona XtraBackup is based on how <code>crash recovery</code> works. Percona XtraBackup copies the InnoDB data files, which results in data that is internally inconsistent; then the <code>prepare</code> phase performs crash recovery on the files to make a consistent, usable database again.</p> <p>The \u2013prepare phase has the following operations:</p> <ul> <li>Applies the redo log</li> <li>Applies the undo log</li> </ul> <p>As a physical operation, the changes from the redo log modifications are applied to a page. In the redo log operation, there is no concept of row or transaction. The redo apply operation does not make the database consistent with a transaction. An uncommitted transaction can be flushed or written to the redo log by the server. Percona XtraBackup applies changes recorded in the redo log.</p> <p>Percona XtraBackup physically modifies a specific offset of a page within a tablespace (IBD file) when applying a redo log. </p> <p>As a logical operation, Percona XtraBackup applies the undo log on a specific row. When the redo log completes, XtraBackup uses the undo log to roll back changes from uncommitted transactions during the backup.</p>"},{"location":"dictionary-cache.html#undo-log","title":"Undo log","text":"<p>There are two types of undo log records:</p> <ul> <li>INSERT</li> <li>UPDATE</li> </ul> <p>An undo log record contains a <code>table_id</code>. Percona XtraBackup uses this <code>table_id</code> to find the table definition, and then uses that information to parse the records on an index page. The transaction rollback reads the undo log records and applies the changes. </p> <p>After initializing the data dictionary engine and the data dictionary cache, the storage engine can request the <code>table_id</code> and uses this ID to fetch the table schema. An index search tuple (key) is created from the table schema and key fields from the undo log record. The server finds the record using the search tuple (key) and performs the undo operation.</p> <p>For example, InnoDB uses the <code>table_id</code> (also known as the <code>se_private_id</code>) for a table definition. Percona XtraBackup does not behave like a server and does not have access to the data dictionary. XtraBackup initializes the InnoDB engine and uses the <code>InnoDB table object</code> (<code>dict_table_t</code>) when needed. XtraBackup relies on Serialized Dictionary Information (SDI) that is stored in the tablespace. SDI is a JSON representation of a table.</p>"},{"location":"dictionary-cache.html#version-changes","title":"Version changes","text":"<p>Prior to Percona XtraBackup 8.0.33-28, XtraBackup loads the SDI from every <code>.IBD</code> file and all tables into cache as non-evictable. Making the tables non-evictable essentially disables the LRU cache. Every table remains in memory until the operation ends.</p> <p>This method has the following issues:</p> <ul> <li>Unnecessary IO operations from reading SDI pages to load the tables that are not required for rollback</li> <li>All tables loaded into the cache increases the time required in the \u2013prepare phase</li> <li>Unnecessary tables can lead to out-of-memory errors</li> <li>Huge number of tables and IBD files may cause an exit in the \u2013prepare phase</li> </ul> <p>Percona XtraBackup 8.0.33-28 implements a new design and tables are loaded as <code>evictable</code>. XtraBackup scans the B-tree index of the data dictionary tables <code>mysql.indexes</code> and <code>mysql.index_partitions</code> to establish a relationship between the <code>table_id</code> and the tablespace(space_id). XtraBackup uses this relationship during transaction rollback. XtraBackup does not load user tables unless there is a transaction rollback on them.</p> <p>A background thread or a Percona XtraBackup main thread handles the cache eviction when the cache size limit is reached.</p> <p>This new design provides the following benefits during the \u2013prepare phase:</p> <ul> <li>Uses less memory</li> <li>Uses less IO</li> <li>Improves the time taken in the \u2013prepare phase</li> <li>Completes successfully, even if the \u2013prepare phase has a huge number of tables</li> <li>Completes the Percona XtraDB Cluster SST process faster</li> </ul> <p></p>"},{"location":"dictionary-cache.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"differences.html","title":"Differences between a logical backup and Percona XtraBackup","text":"<p>You\u2019ll notice several key differences when transitioning from a logical database to Percona XtraBackup.</p> Type Logical backup Physical backup Definition Contains logical data (tables, schemas, procedures). Copies entire database directories and files. Method Exported as binary files using EXPORT/IMPORT tools. Copies raw data files directly from the database. Data contents Includes data structure (schema, tables, procedures). Contains complete data (structure, tables, transactions) Instance Independence Can be restored on any other machine or environment. Tied to the specific database instance and environment. OS-level restoration Not suitable for OS-level restoration Suitable for full disaster recovery scenarios. Granularity Granular recovery of specific components. Restores the entire database. Performance Slower due to SQL parsing and execution Faster due to direct file copying Use cases Data migration platform-independent copies Full database restoration, disaster recovery Security Less secure More secure <p>XtraBackup is designed to perform hot backups of MySQL, MariaDB, and Percona Server databases without interrupting database services. XtraBackup performs physical backups by copying the data files, ensuring minimal impact on server performance. XtraBackup includes advanced features such as backup compression and encryption, providing efficient and secure data protection. The tool also offers a streaming backup option, which is useful for backing up large databases or transferring backups to another server. XtraBackup integrates with Percona\u2019s additional tools like Percona Toolkit and Percona Monitoring and Management (PMM), offering a comprehensive database performance monitoring, management, and optimization solution. These features are not typically found in logical database backup solutions.</p> <p>Another difference is the support for incremental backups with XtraBackup. You can back up only the data that has changed since the last full backup, significantly reducing the time and storage requirements compared to a full logical backup.</p> <p>A logical backup contains copies of information about a database, such as tables, schemas, and procedures. Commonly, these backups are exported as binary files using EXPORT/IMPORT tools. Logical backups focus on the data structure and SQL statements, and you can back up a selected set of data or exclude specific data during the export, saving time and storage. They contain only structural information about the database, not instance-specific details. Logical backups are slower than physical backups because of the SQL parsing and execution. A logical backup does not preserve the file system-level security settings, user accounts, privileges, or authentication settings. During restoration, you must manually reconfigure these settings.</p> <p>You can restore a logical backup on any other machine and in different environments. Logical backups provide granular recovery capabilities to restore specific components, such as individual tables or schemas. The recovery process can be more difficult because it involves recreating the entire data structure. Use logical backups when restoring or moving a database copy to another environment. They are an option for platform-independent data migration.</p> <p>Unlike physical backups, logical backups are less secure because the data is unencrypted. Anyone with access to the backup could read sensitive information. </p> <p></p>"},{"location":"differences.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"docker.html","title":"Run Percona XtraBackup 8.0 in a Docker container","text":"<p>Docker containers are built from Docker images, which are snapshots of the configuration needed to run an applications, such as the code, and libraries. With Docker, you can build, deploy, run, update, and manage containers, which isolate applications from the host system. A Docker container lets you work with Percona XtraBackup without installing the product on a local drive. You may run Percona Server for MySQL in one container and Percona XtraBackup in another.</p> <p>For this document, container refers to the Docker container and instance refers to the database server in the container.</p> <p>Percona XtraBackup has an official Docker image hosted on Docker Hub. If you want the latest version, use the <code>latest</code> tag. You can reference a specific version using the Docker tag filter for the 8.0 versions.</p> <p>Make sure that you are using the latest version of Docker. The <code>APT</code> and <code>YUM</code> versions may be outdated and cause errors. Use the installation instructions to install Docker on your system.</p>"},{"location":"docker.html#1-run-percona-server-for-mysql-container","title":"1. Run Percona Server for MySQL container","text":"<p>Percona XtraBackup works in combination with a MySQL-compatible database, Percona Server for MySQL, in our example. To take a backup of Percona Server for MySQL, run Percona Server for MySQL in a Docker container and create a database with data. Read the instructions on how to Run Percona Server for MySQL in a Docker Container.</p> <p>As soon as Percona Server for MySQL runs and the database contains data, you are ready to connect the Percona XtraBackup container to the Percona Server for MySQL container and take a backup.</p>"},{"location":"docker.html#2-create-percona-xtrabackup-docker-container-and-connect-to-percona-server-for-mysql-container","title":"2. Create Percona XtraBackup Docker container and connect to Percona Server for MySQL container","text":"<p>You can create a Docker container based on Percona XtraBackup image with either <code>docker create</code> or the <code>docker run</code> command. <code>docker create</code> creates a Docker container and makes it available for starting later.</p> <p>Docker downloads the Percona XtraBackup 8.0 image from the Docker Hub. If it is not the first time you use the selected image, Docker uses the image available locally.</p> <p>Important</p> <p>When running Percona XtraBackup from a container and connecting to a  MySQLserver container, we recommend using the \u2013user=root option in the  Docker command.</p> <pre><code>$ sudo docker create --name percona-xtrabackup --volumes-from percona-server-mysql:8.0 \\\npercona/percona-xtrabackup:8.0  \\\nxtrabackup --backup --datadir=/var/lib/mysql/ --target-dir=/backup \\\n--user=root --password=root\n</code></pre> <p>With parameter name you give a meaningful name to your new Docker container so that you could easily locate it among your other containers.</p> <p>The <code>volumes-from</code> flag refers to Percona Server for MySQL and indicates that you intend to use the same data as the Percona Server for MySQL container.</p>"},{"location":"docker.html#percona-xtrabackup-arm64","title":"Percona XtraBackup ARM64","text":"<p>Starting with Percona XtraBackup 8.0.35-31, you can run the Docker ARM64 version of Percona XtraBackup. You can find the version and architecture on Docker Hub Percona/Percona-Server Tags. The Docker images for ARM64 version contain <code>aarch64</code> in the tag name, for example, <code>8.0.35-aarch64</code>.</p> <p>We recommend that the architectures match. If the server is ARM64, you should also use Percona XtraBackup in ARM64.</p>"},{"location":"docker.html#start-the-percona-xtrabackup-container","title":"Start the Percona XtraBackup container","text":"<p>Start the Percona XtraBackup container with exactly the same parameters that were used when the container was created:</p> <pre><code>$ sudo docker start -ai percona-xtrabackup\n</code></pre> <p>This command starts the <code>percona-xtrabackup</code> container, attaches to its input/output streams, and opens an interactive shell.</p>"},{"location":"docker.html#docker-run-command","title":"Docker run command","text":"<p>The <code>docker run</code> command is a shortcut command that creates a Docker container and then immediately runs it.</p> <pre><code>$ sudo docker run --name percona-xtrabackup --volumes-from percona-server-mysql:8.0 \\\npercona/percona-xtrabackup:8.0\nxtrabackup --backup --datadir=/var/lib/mysql --target-dir=/backup --user=root --password=root\n</code></pre>"},{"location":"docker.html#for-more-information","title":"For more information","text":"<p>Review the Docker Docs</p> <p></p>"},{"location":"docker.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"download-instructions.html","title":"Percona Product Download Instructions","text":""},{"location":"download-instructions.html#select-the-software","title":"Select the software","text":"<p>Do the following steps to select the software:</p> <ol> <li>Open Percona Product Downloads</li> <li>Locate the Percona Software, for example, Percona Server for MySQL</li> <li>In <code>Select Product</code>, select which product, for example, Percona Server 8.0</li> <li>In <code>Select Product Version</code>, select the version, for example, PERCONA-SERVER-8.0.36-28</li> <li>In <code>Select Software</code>, select the operating system, for example, RED HAT ENTERPRISE LINUX / CENTOS/ ORACLE LINUX 9</li> </ol> <p>The easiest method is to download all packages.</p>"},{"location":"download-instructions.html#download-to-a-local-computer","title":"Download to a local computer","text":"<p>In <code>Package Download Options</code>, select a specific package or choose the <code>DOWNLOAD ALL PACKAGES</code> button. This action downloads the selected packages to the local computer.</p>"},{"location":"download-instructions.html#download-to-another-computer","title":"Download to another computer","text":"<p>In <code>Package Download Options</code>, you can do either of the following:</p> <ul> <li> <p>Select a specific package and right-click on the arrow next to <code>DOWNLOAD</code>, and in the drop-down menu, choose <code>Copy Link Address</code></p> </li> <li> <p>Select <code>DOWNLOAD ALL PACKAGES</code> and right-click on the arrow, and in the drop-down menu, choose <code>Copy Link Address</code></p> </li> </ul> <p>Paste the link in your terminal prompt to download the selected package.</p> <p></p>"},{"location":"download-instructions.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"encrypt-backups.html","title":"Encrypt backups","text":"<p>Percona XtraBackup supports encrypting and decrypting local and streaming backups with the upstream option, adding another protection layer. The encryption is implemented using the <code>libgcrypt</code> library from GnuPG.</p>"},{"location":"encrypt-backups.html#create-encrypted-backups","title":"Create encrypted backups","text":"<p>The following options create encrypted backups. The <code>--encrypt-key</code> and <code>--encrypt-key-file</code> options specify the encryption key and are mutually exclusive. You should select one or the other.</p> <ul> <li> <p><code>--encrypt</code></p> </li> <li> <p><code>--encrypt-key</code></p> </li> <li> <p><code>--encrypt-key-file</code></p> </li> </ul> <p>For an encryption key, use a command, such as <code>openssl rand -base64 24</code>, to generate a random alphanumeric string.</p>"},{"location":"encrypt-backups.html#the-encrypt-key-option","title":"The <code>--encrypt-key</code> option","text":"<p>An example of the xtrabackup command using the <code>--encrypt-key</code>:</p> <pre><code>$  xtrabackup --backup --encrypt=AES256 --encrypt-key=\"{randomly-generated-alphanumeric-string}\" --target-dir=/data/backup\n</code></pre>"},{"location":"encrypt-backups.html#the-encrypt-key-file-option","title":"The <code>--encrypt-key-file</code> option","text":"<p>The recommended method uses the command line: <code>echo -n \u201c{randomly-generated-alphanumeric-string}\u201d &gt; /data/backups/keyfile</code> to create the file.</p> <p>Remember that your text editor can automatically insert a CRLF (end of line) character in the <code>KEYFILE</code> when using the\u2013 <code>encrypt-key-file</code> option. This inserted character invalidates the key because the size is wrong. </p> <p>An example of using the <code>--encrypt-key-file</code> option:</p> <pre><code>$ xtrabackup --backup --encrypt=AES256 --encrypt-key-file=/data/backups/keyfile --target-dir=/data/backup\n</code></pre>"},{"location":"encrypt-backups.html#optimize-the-encryption-process","title":"Optimize the encryption process","text":"<p>Additional encrypted backup options, <code>--encrypt-threads</code> and <code>--encrypt-chunk-size</code>, can speed up the encryption process. </p> <p>Use the <code>--encrypt-threads</code> option to enable parallel encryption with multiple threads. </p> <p>The <code>--encrypt-chunk-size</code> option specifies the size, in bytes, of the working encryption buffer for each encryption thread. The default size is 64K.</p>"},{"location":"encrypt-backups.html#decrypt-encrypted-backups","title":"Decrypt encrypted backups","text":"<p>You can decrypt backups with the <code>xbcrypt</code> binary. The following example encrypts a backup.</p> <p>You can use the <code>--parallel</code> option and the <code>--decrypt</code> option to decrypt multiple files simultaneously.</p> <pre><code>$ for i in `find . -iname \"*\\.xbcrypt\"`; do xbcrypt -d --encrypt-key-file=/root/secret_key --encrypt-algo=AES256 &lt; $i &gt; $(dirname $i)/$(basename $i .xbcrypt) &amp;&amp; rm $i; done\n</code></pre> <p>The following example shows a decryption process.</p> <pre><code>$ xtrabackup --decrypt=AES256 --encrypt-key=\"{randomly-generated-alphanumeric-string}\" --target-dir=/data/backup/\n</code></pre> <p>Percona XtraBackup doesn\u2019t automatically remove the encrypted files. You must remove the <code>\\*.xbcrypt</code> files manually.</p>"},{"location":"encrypt-backups.html#prepare-encrypted-backups","title":"Prepare encrypted backups","text":"<p>After decrypting the backups, prepare the backups with the <code>--prepare</code> option:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup/\n</code></pre>"},{"location":"encrypt-backups.html#restore-encrypted-backups","title":"Restore encrypted backups","text":"<p>xtrabackup offers the <code>--copy-back</code> option to restore a backup to the server\u2019s datadir:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup/\n</code></pre> <p>The option copies all the data-related files to the server\u2019s datadir. The server\u2019s <code>my.cnf</code> configuration file determines the location. </p> <p>You should check the last line of the output for a success message:</p> Expected output <pre><code>150318 11:08:13  xtrabackup: completed OK!\n</code></pre> <p></p>"},{"location":"encrypt-backups.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"encrypted-innodb-tablespace-backups.html","title":"Encrypted InnoDB tablespace backups","text":"<p>InnoDB supports data encryption for InnoDB tables stored in file-per-table tablespaces. This feature provides an at-rest encryption for physical tablespace data files.</p> <p>For an authenticated user or application to access an  encrypted  tablespace, InnoDB uses the master encryption key to decrypt  the tablespace key. The master encryption key is stored in a keyring.  xtrabackup supports two keyring plugins: <code>keyring_file</code>, and  <code>keyring_vault</code>. These plugins are installed into the <code>plugin</code> directory.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#version-updates","title":"Version updates","text":"<p>Percona XtraBackup 8.0.25-17 adds support for the <code>keyring_file</code> component, which is part of the component-based infrastructure MySQL which extends the server capabilities. The component is stored in the <code>plugin</code> directory.</p> <p>See a comparison of keyring components and keyring plugins for more information.</p> <p>Percona XtraBackup 8.0.27-19 adds support for the Key Management Interoperability Protocol (KMIP) which enables the communication between the key management system and encrypted database server. </p> <p>Percona XtraBackup 8.0.28-21 adds support for the Amazon Key Management Service (AWS KMS). AWS KMS is cloud-based encryption and key management service. The keys and functionality can be used for other AWS services or your applications that use AWS. No configuration is required to back up a server with AWS KMS-enabled encryption. </p>"},{"location":"encrypted-innodb-tablespace-backups.html#use-keyring_file-plugin","title":"Use <code>keyring_file</code> plugin","text":"<p>In order to back up and prepare a database containing encrypted InnoDB tablespaces, specify the path to a keyring file as the value of the <code>--keyring-file-data</code> option.</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backup/ --user=root \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>After xtrabackup takes the backup, the following message confirms the action:</p> Confirmation message <pre><code>xtrabackup: Transaction log of lsn (5696709) to (5696718) was copied.\n160401 10:25:51 completed OK!\n</code></pre> <p>Warning</p> <p>xtrabackup does not copy the keyring file into the backup directory. To prepare the backup, you must copy the keyring file manually.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-the-backup-with-the-keyring_file-plugin","title":"Prepare the backup with the <code>keyring_file</code> plugin","text":"<p>To prepare the backup specify the keyring-file-data.</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>After xtrabackup takes the backup, the following message confirms the action:</p> Confirmation message <pre><code>InnoDB: Shutdown completed; log sequence number 5697064\n160401 10:34:28 completed OK!\n</code></pre> <p>The backup is now prepared and can be restored with the <code>--copy-back</code> option. In case the keyring has been rotated, you must restore the keyring used when the backup was taken and prepared.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#use-keyring_vault-plugin","title":"Use <code>keyring_vault</code> plugin","text":"<p>Keyring vault plugin settings are described here.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#create-a-backup-with-the-keyring_vault-plugin","title":"Create a backup with the <code>keyring_vault</code> plugin","text":"<p>The following command creates a backup in the <code>/data/backup</code> directory:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backup --user=root\n</code></pre> <p>After xtrabackup completes the action, the following message confirms the action:</p> Confirmation message <pre><code>xtrabackup: Transaction log of lsn (5696709) to (5696718) was copied.\n160401 10:25:51 completed OK!\n</code></pre>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-the-backup-with-the-keyring_vault-plugin","title":"Prepare the backup with the <code>keyring_vault</code> plugin","text":"<p>To prepare the backup, xtrabackup must access the keyring. xtrabackup does not communicate with the MySQL server or read the default <code>my.cnf</code> configuration file. Specify the keyring settings in the command line:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--keyring-vault-config=/etc/vault.cnf\n</code></pre> <p>Review using the keyring vault plugin for a description of keyring vault plugin settings.</p> <p>After xtrabackup completes the action, the following message confirms the action:</p> Confirmation message <pre><code>InnoDB: Shutdown completed; log sequence number 5697064\n160401 10:34:28 completed OK!\n</code></pre> <p>The backup is now prepared and can be restored with the <code>--copy-back</code> option:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql\n</code></pre>"},{"location":"encrypted-innodb-tablespace-backups.html#use-the-keyring_file-component","title":"Use the <code>keyring_file</code> component","text":"<p>A component is not loaded with the <code>--early_plugin_load</code> option. The  server uses a manifest to load the component and the component has its  own configuration file. See the MySQL documentation on the component  installation for more  information.</p> <p>An example of a manifest and a configuration file follows:</p> <p>An example of <code>./bin/mysqld.my</code>:</p> <pre><code>{\n   \"components\": \"file://component_keyring_file\"\n}\n</code></pre> <p>An example of <code>/lib/plugin/component_keyring_file.cnf</code>:</p> <pre><code>{\n   \"path\": \"/var/lib/mysql-keyring/keyring_file\", \"read_only\": false\n}\n</code></pre> <p>For more information, see Keyring Component Installation and Using the keyring_file File-Based Keyring Plugin.</p> <p>With the appropriate privilege, you can <code>SELECT</code> on the performance_schema.keyring_component_status table to view the attributes and status of the installed keyring component  when in use.</p> <p>The component has no special requirements for backing up a database that contains encrypted InnoDB tablespaces.</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backup --user=root\n</code></pre> <p>After xtrabackup completes the action, the following message confirms the action:</p> Confirmation message <pre><code>xtrabackup: Transaction log of lsn (5696709) to (5696718) was copied.\n160401 10:25:51 completed OK!\n</code></pre>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-the-backup-with-component-keyring-config","title":"Prepare the backup with <code>component-keyring-config</code>","text":"<p>You can copy the <code>component_keyring_file.cnf</code> file to the backup directory before starting the <code>prepare</code> step or add the <code>component_keyring_config</code> option. You must specify the path if the <code>component-keyring-config</code> is not in the default location.</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--component-keyring-config=/usr/lib64/mysql/plugin/component_keyring_file.cnf\n</code></pre> <p>After xtrabackup completes preparing the backup, the following message confirms the action:</p> Confirmation message <pre><code>InnoDB: Shutdown completed; log sequence number 5697064\n160401 10:34:28 completed OK!\n</code></pre> <p>The backup is prepared. To restore the backup use the <code>--copy-back</code> option. If the keyring has been rotated, you must restore the specific keyring used to take and prepare the backup.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#incremental-encrypted-innodb-tablespace-backups-with-keyring_file","title":"Incremental encrypted InnoDB tablespace backups with <code>keyring_file</code>","text":"<p>The process of taking incremental backups with InnoDB tablespace encryption is similar to taking the Incremental Backups with unencrypted tablespace. The <code>keyring-file</code> component should not used in production or for regulatory compliance.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#create-an-incremental-backup","title":"Create an incremental backup","text":"<p>To make an incremental backup, begin with a full backup. The xtrabackup binary writes a file called <code>xtrabackup_checkpoints</code> into the backup\u2019s target directory. This file contains a line showing the <code>to_lsn</code>, which is the database\u2019s LSN at the end of the backup. First you need to create a full backup with the following command:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/base \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>In order to prepare the backup, you must make a copy of the keyring file yourself. xtrabackup does not copy the keyring file into the backup directory.  Restoring the backup after the keyring has been changed causes errors like <code>ERROR 3185 (HY000): Can't find master key from keyring, please check keyring plugin is loaded.</code> when the restore process tries accessing an encrypted table.</p> <p>If you look at the <code>xtrabackup_checkpoints</code> file, you should see the output similar to the following:</p> Expected output <pre><code>backup_type = full-backuped\nfrom_lsn = 0\nto_lsn = 7666625\nlast_lsn = 7666634\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p>Now that you have a full backup, you can make an incremental backup based on it. Use a command such as the following:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/inc1 \\\n--incremental-basedir=/data/backups/base \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>To prepare the backup, you must copy the keyring file manually. xtrabackup does not copy the keyring file into the backup directory. </p> <p>If the keyring has not been rotated you can use the same as the one you\u2019ve backed-up with the base backup. If the keyring has been rotated, or you have  upgraded the plugin to a component, you must back up the keyring file.  Otherwise, you cannot prepare the backup.</p> <p>The <code>/data/backups/inc1/</code> directory should now contain delta files, such as <code>ibdata1.delta</code> and <code>test/table1.ibd.delta</code>. These represent the changes since the <code>LSN 7666625</code>. If you examine the <code>xtrabackup_checkpoints</code> file in this directory, you should see  the output similar to the following:</p> Expected output <pre><code>backup_type = incremental\nfrom_lsn = 7666625\nto_lsn = 8873920\nlast_lsn = 8873929\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p>Use this directory as the base for yet another incremental backup:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/inc2 \\\n--incremental-basedir=/data/backups/inc1 \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-incremental-backups","title":"Prepare incremental backups","text":"<p>The <code>--prepare</code> step for incremental backups is not the same as for normal backups. In normal backups, two types of operations are performed to make the database consistent: committed transactions are replayed from the log file against the data files, and uncommitted transactions are rolled back. You must skip the rollback of uncommitted transactions when preparing a backup, because transactions that were uncommitted at the time of your backup may be in progress, and it\u2019s likely that they will be committed in the next incremental backup. You should use the <code>--apply-log-only</code> option to prevent the rollback phase.</p> <p>If you do not use the <code>--apply-log-only</code> option to prevent the rollback phase, then your incremental backups are useless. After transactions have been rolled back, further incremental backups cannot be applied.</p> <p>Beginning with the full backup you created, you can prepare it and then apply the incremental differences to it. Recall that you have the following backups:</p> <pre><code>/data/backups/base\n/data/backups/inc1\n/data/backups/inc2\n</code></pre> <p>To prepare the base backup, you need to run <code>--prepare</code> as usual, but prevent the rollback phase:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/data/backups/base \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> Expected output <pre><code>InnoDB: Shutdown completed; log sequence number 7666643\nInnoDB: Number of pools: 1\n160401 12:31:11 completed OK!\n</code></pre> <p>To apply the first incremental backup to the full backup, you should use the following command:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/data/backups/base \\\n--incremental-dir=/data/backups/inc1 \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>The backup should be prepared with the keyring file and type that was used when backup was being taken. This means that if the keyring has been rotated, or you have upgraded from a plugin to a component between the base and incremental backup that you must use the keyring that was in use when the first incremental backup has been taken.</p> <p>Preparing the second incremental backup is a similar process: apply the deltas to the (modified) base backup, and you will roll its data forward in  time to the point of the second incremental backup:</p> <p><pre><code>$ xtrabackup --prepare --target-dir=/data/backups/base \\\n--incremental-dir=/data/backups/inc2 \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> Use <code>--apply-log-only</code> when merging all incremental backups except the last one. That\u2019s why the previous line does not contain the <code>--apply-log-only</code> option. Even if the <code>--apply-log-only</code> was used on the last step, backup would still be consistent but in that case  server would perform the rollback phase.</p> <p>The backup is now prepared and can be restored with <code>--copy-back</code> option. In case the keyring has been rotated you\u2019ll need to restore the keyring which was used to take and prepare the backup.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#use-the-key-management-interoperability-protocol-kmip","title":"Use the Key Management Interoperability Protocol (KMIP)","text":"<p>Percona XtraBackup 8.0.27-19 adds support for the Key Management Interoperability Protocol (KMIP) which enables the communication between the key management system and encrypted database server.</p> <p>Percona XtraBackup has no special requirements for backing up a database that contains encrypted InnoDB tablespaces.</p> <p>Percona XtraBackup performs the following actions:</p> <ol> <li> <p>Connects to the MySQL server</p> </li> <li> <p>Pulls the configuration</p> </li> <li> <p>Connects to the KMIP server</p> </li> <li> <p>Fetches the necessary keys from the KMIP server</p> </li> <li> <p>Stores the KMIP server configuration settings in  the <code>xtrabackup_component_keyring_kmip.cnf</code> file in the backup directory</p> </li> </ol> <p>When preparing the backup, Percona XtraBackup connects to the KMIP server with the settings from the <code>xtrabackup_component_keyring_kmip.cnf</code> file.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#restore-a-backup-when-the-keyring-is-not-available","title":"Restore a backup when the keyring is not available","text":"<p>While the described restore method works, this method requires access to the same keyring that the server is using. It may not be possible if the backup is prepared on a different server or at a much later time, when keys in the keyring are purged, or, in the case of a malfunction, when the keyring vault server is not available at all.</p> <p>The <code>--transition-key=&lt;passphrase&gt;</code> option should be used to make it possible for xtrabackup to process the backup without access to the keyring vault server. In this case, xtrabackup derives the AES encryption key from the specified passphrase and will use it to encrypt tablespace keys of tablespaces that are being backed up.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#create-a-backup-with-a-passphrase","title":"Create a backup with a passphrase","text":"<p>The following example illustrates how the backup can be created in this case:</p> <pre><code>$ xtrabackup --backup --user=root -p --target-dir=/data/backup \\\n--transition-key=MySecretKey\n</code></pre> <p>If <code>--transition-key</code> is specified without a value, xtrabackup will ask for it.</p> <p>xtrabackup scrapes <code>--transition-key</code> so that its value is not visible in the <code>ps</code> command output.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-a-backup-with-a-passphrase","title":"Prepare a backup with a passphrase","text":"<p>The same passphrase should be specified for the prepare command:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--transition-key=MySecretKey\n</code></pre> <p>There are no <code>--keyring-vault...</code>,``\u2013keyring-file\u2026``, or <code>--component-keyring-file-config</code> options here, because xtrabackup does not talk to the keyring in this case.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#restore-a-backup-with-a-generated-key","title":"Restore a backup with a generated key","text":"<p>When restoring a backup you will need to generate a new master key. Here is the example for <code>keyring_file</code> plugin or component:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql \\\n--transition-key=MySecretKey --generate-new-master-key \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>In case of <code>keyring_vault</code>, it will look like this:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql \\\n--transition-key=MySecretKey --generate-new-master-key \\\n--keyring-vault-config=/etc/vault.cnf\n</code></pre> <p>xtrabackup will generate a new master key, store it in the target keyring vault server and re-encrypt the tablespace keys using this key.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#make-a-backup-with-a-stored-transition-key","title":"Make a backup with a stored transition key","text":"<p>Finally, there is an option to store a transition key in the keyring. In this case, xtrabackup will need to access the same keyring file or vault server during prepare and copy-back but does not depend on whether the server keys have been purged.</p> <p>In this scenario, the three stages of the backup process look as follows.</p> <ul> <li>Backup</li> </ul> <pre><code>$ xtrabackup --backup --user=root -p --target-dir=/data/backup \\\n--generate-transition-key\n</code></pre> <ul> <li> <p>Prepare</p> <ul> <li><code>keyring_file</code> variant:</li> </ul> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <ul> <li><code>keyring_vault</code> variant:</li> </ul> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--keyring-vault-config=/etc/vault.cnf\n</code></pre> </li> <li> <p>Copy-back</p> </li> <li> <p><code>keyring_file</code> variant:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql \\\n--generate-new-master-key --keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> </li> <li> <p><code>keyring_vault</code> variant:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql \\\n--generate-new-master-key --keyring-vault-config=/etc/vault.cnf\n</code></pre> </li> </ul> <p></p>"},{"location":"encrypted-innodb-tablespace-backups.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"error-message-instant.html","title":"Error Message: Found tables with row versions due to INSTANT ADD/DROP columns","text":"<p>MySQL 8.0.29 extended the support for <code>ALTER TABLE \u2026 ALGORITHM=INSTANT</code> to allow users to add a column in any table position or drop any column. As part of this update, the redo log format has changed for all server DML operations. This updated redo log format has a design flaw that can cause data corruption for tables with INSTANT ADD/DROP COLUMNS.</p> <p>The corruption happens when the crash recovery occurs. InnoDB applies redo logs at startup. Xtrabackup copies the redo log during the backup and applies the log as part of the <code>--prepare</code> step to bring the backup to a consistent state.</p> <p>Percona fixed the corruption issue and several other issues with the INSTANT ADD/DROP column feature in the upcoming Percona Server for MySQL 8.0.29.</p> <p>For more details, see the following:</p> <ul> <li> <p>PS-8291,</p> </li> <li> <p>PS-8292</p> </li> <li> <p>PS-8303</p> </li> </ul> <p>Percona XtraBackup 8.0.32-25 allows instant columns in the backup for MySQL 8.0.32. This limitation remains for backing up MySQL 8.0.31 and lower versions. This limitation does not exist for backing up Percona Server for any version.</p> <p>Percona XtraBackup 8.0.29 is able to take backups of Percona Server for MySQL 8.0.29 with tables that have INSTANT ADD/DROP COLUMNS. However, the issues in MySQL 8.0.29 make this version unsafe to take backups.</p> <p>It is impossible for XtraBackup to deal with the corrupted redo log generated by MySQL 8.0.29 and, for this reason, XtraBackup 8.0.29 version will not take backups if it detects tables with <code>INSTANT ADD/DROP COLUMNS</code> and generates an error listing the affected tables and providing instructions to convert them to regular tables.</p> <p>Please avoid ALTER ADD/DROP COLUMN without an explicit ALGORITHM=INPLACE. The default ALGORITHM is INSTANT, so ALTER TABLE without the ALGORITHM keyword uses the newly introduced INSTANT algorithm.</p> <p>If you already have such tables (information below on how to find such tables), users are advised to do <code>OPTIMIZE TABLE</code> against these tables before taking backups.</p> <p>To find tables with <code>INSTANT ADD/DROP COLUMNS</code> run the following command:</p> <pre><code>mysql&gt; SELECT NAME FROM INFORMATION_SCHEMA.INNODB_TABLES WHERE TOTAL_ROW_VERSIONS &gt; 0;\n+---------+\n| NAME    |\n+---------+\n| test/t1 |\n| test/t2 |\n| test/t3 |\n+---------+\n3 rows in set (0.02 sec)\n</code></pre> <p>If this query shows an empty result set, you have no issues. Percona Xtrabackup takes the backup of your MySQL 8.0.29 server. If the results are a list of tables, please run OPTIMIZE TABLE on the list before taking the backup.</p>"},{"location":"error-message-instant.html#percona-xtrabackup-error-message","title":"Percona XtraBackup Error Message","text":"<p>If Percona XtraBackup detects that MySQL 8.0.29 server has tables with instant add/drop columns, it aborts with the following error message</p> <pre><code>2022-07-01T15:18:35.127689+05:30 0 [ERROR] [MY-011825] [Xtrabackup] Found tables with row versions due to INSTANT ADD/DROP columns\n2022-07-01T15:18:35.127714+05:30 0 [ERROR] [MY-011825] [Xtrabackup] This feature is not stable and will cause backup corruption.\n2022-07-01T15:18:35.127723+05:30 0 [ERROR] [MY-011825] [Xtrabackup] Tables found:\n2022-07-01T15:18:35.127730+05:30 0 [ERROR] [MY-011825] [Xtrabackup] test/t1\n2022-07-01T15:18:35.127737+05:30 0 [ERROR] [MY-011825] [Xtrabackup] test/t2\n2022-07-01T15:18:35.127744+05:30 0 [ERROR] [MY-011825] [Xtrabackup] test/t3\n2022-07-01T15:18:35.127752+05:30 0 [ERROR] [MY-011825] [Xtrabackup] Please run OPTIMIZE TABLE or ALTER TABLE ALGORITHM=COPY on all listed tables to fix this issue.\n</code></pre>"},{"location":"error-message-instant.html#summary","title":"Summary","text":"<p>The option, <code>ALGORITHM=INSTANT</code> is the default value in MySQL 8.0.29. If you do not specify an algorithm, all <code>ALTER TABLE ADD/DROP COLUMN</code> statements use this algorithm.</p> <p>The <code>INSTANT</code> algorithm is unstable at this point.</p> <p>Percona XtraBackup refuses to take backups from MySQL 8.0.29 tables that have used this algorithm. Percona Server users do not suffer the same limitations as the corruption issues are fixed in the upcoming release of Percona Server for MySQL 8.0.29</p> <p></p>"},{"location":"error-message-instant.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"example-full-incr.html","title":"Backup example","text":"<p>This example demonstrates how a beginner DBA can set up daily full backups and hourly incremental backups for a large organization using Percona XtraBackup 8.0 with a Percona Server for MySQL 8.0 database server.</p>"},{"location":"example-full-incr.html#assumptions","title":"Assumptions","text":"<ul> <li>You have Percona XtraBackup 8.0 installed on your system.</li> <li>You have a Percona Server for MySQL 8.0 database server running.</li> <li>You have created dedicated directories for storing backups:<ul> <li><code>/backups/mysql/full</code> - for daily full backups</li> <li><code>/backups/mysql/incr</code> - for hourly incremental backups</li> </ul> </li> </ul>"},{"location":"example-full-incr.html#daily-full-backup-script","title":"Daily Full Backup Script","text":"<p>This following script defines the server details like hostname, username, password, data directory, and backup directory. Replace these with your actual values.</p> <ul> <li> <p>Defines the server credentials</p> </li> <li> <p>Generates a timestamp with the <code>date</code> command for the full backup filename</p> </li> <li> <p>Uses <code>xtrabackup</code> with the <code>--backup</code> flag for a full backup</p> </li> <li> <p>Specifies the directory to store the backup with <code>--target-dir</code></p> </li> <li> <p><code>--datadir</code> points to the location of your MySQL data files.</p> </li> <li> <p>Provides the credentials with <code>--user</code> and <code>--password</code> to access the database server.</p> </li> <li> <p>Echoes a message confirming the successful backup completion.</p> </li> </ul> <pre><code>#!/bin/bash\n\n# Set server details (replace with your actual values)\nSERVER_HOST=\"your_server_hostname\"\nSERVER_USER=\"your_db_username\"\nSERVER_PASSWORD=\"your_db_password\"\nDATA_DIR=\"/var/lib/mysql\"  # Replace with your data directory path\nBACKUP_DIR=\"/backups/mysql/full\"\n\n# Get current date for filename\nTODAY=$(date +%Y-%m-%d)\nFULL_BACKUP_FILENAME=\"${BACKUP_DIR}/${TODAY}\"\n\n# Run xtrabackup with full backup command\nxtrabackup --backup \\\n  --target-dir=\"${FULL_BACKUP_FILENAME}\" \\\n  --datadir=\"${DATA_DIR}\" \\\n  --user=\"${SERVER_USER}\" \\\n  --password=\"${SERVER_PASSWORD}\"\n\necho \"Daily full backup completed at $(date)\"\n</code></pre>"},{"location":"example-full-incr.html#running-the-daily-script","title":"Running the Daily Script","text":"<p>You can schedule this script to run automatically using cron. For example, to run it every day at midnight (00:00), add this line to your crontab:</p> <pre><code>$ 0 0 * * * /path/to/daily_full_backup.sh\n</code></pre>"},{"location":"example-full-incr.html#hourly-incremental-backup-script","title":"Hourly Incremental Backup Script","text":"<p>This script uses the same server details as the daily script. It retrieves the current date and hour for the incremental backup filename. The core command uses <code>xtrabackup</code> with the <code>--backup</code> and <code>--incremental</code> flags for an incremental backup. <code>--target-dir</code> specifies the directory to store the incremental backup. <code>--base-dir</code> points to the latest full backup directory obtained using <code>ls</code> and <code>tail</code> commands. This ensures the incremental backup references the most recent full backup. Similar to the daily script, it echoes a confirmation message.</p> <pre><code>#!/bin/bash\n\n# Set server details (same as daily script)\nSERVER_HOST=\"your_server_hostname\"\nSERVER_USER=\"your_db_username\"\nSERVER_PASSWORD=\"your_db_password\"\nDATA_DIR=\"/var/lib/mysql\"  # Replace with your data directory path\nBACKUP_DIR=\"/backups/mysql/incr\"\n\n# Get current date and hour for filename\nTODAY=$(date +%Y-%m-%d)\nHOUR=$(date +%H)  # Get current hour (00-23)\nINCR_BACKUP_FILENAME=\"${BACKUP_DIR}/${TODAY}_${HOUR}\"\n\n# Set the base directory for incremental backups (point to the latest full backup)\nBASE_DIR=\"/backups/mysql/full/$(ls -tr /backups/mysql/full | tail -n 1)\"\n\n# Run xtrabackup with incremental backup command\nxtrabackup --backup \\\n  --incremental \\\n  --target-dir=\"${INCR_BACKUP_FILENAME}\" \\\n  --base-dir=\"${BASE_DIR}\" \\\n  --user=\"${SERVER_USER}\" \\\n  --password=\"${SERVER_PASSWORD}\"\n\necho \"Hourly incremental backup completed at $(date)\"\n</code></pre>"},{"location":"example-full-incr.html#run-the-hourly-script","title":"Run the Hourly Script","text":"<p>Schedule this script to run every hour using cron.</p> <pre><code>$ 0 * * * * /path/to/your/script.sh\n</code></pre> <p></p>"},{"location":"example-full-incr.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"faq.html","title":"Frequently asked questions","text":""},{"location":"faq.html#does-percona-xtrabackup-80-support-taking-backups-of-databases-in-versions-prior-to-80","title":"Does Percona XtraBackup 8.0 support taking backups of databases in versions prior to 8.0?","text":"<p>Percona XtraBackup 8.0 does not support making backups of databases created in versions prior to 8.0 of MySQL, Percona Server for MySQL or Percona XtraDB Cluster. As the changes that MySQL 8.0 introduced in data dictionaries, redo log and undo log are incompatible with previous versions, it is currently impossible for Percona XtraBackup 8.0 to also support versions prior to 8.0.</p> <p>Due to changes in MySQL 8.0.20 released by Oracle at the end of April 2020, Percona XtraBackup 8.0, up to version 8.0.11, is not compatible with MySQL version 8.0.20 or higher, or Percona products that are based on it: Percona Server for MySQL and Percona XtraDB Cluster.</p> <p>For more information, see Percona XtraBackup 8.x and MySQL 8.0.20</p>"},{"location":"faq.html#does-percona-xtrabackup-80-support-taking-backups-of-databases-in-higher-versions-within-the-80-series","title":"Does Percona XtraBackup 8.0 support taking backups of databases in higher versions within the 8.0 series?","text":"<p>Yes, starting with Percona XtraBackup 8.0.34, you can back up MySQL-compatible databases of higher versions within the 8.0 series.</p> <p>Check the latest list of all Supported versions.</p>"},{"location":"faq.html#does-percona-xtrabackup-80-support-taking-backups-of-databases-in-lower-versions-within-the-80-series","title":"Does Percona XtraBackup 8.0 support taking backups of databases in lower versions within the 8.0 series?","text":"<p>Yes, if you use Percona XtraBackup 8.0.35 or higher, you can back up MySQL-compatible databases starting from version 8.0.34 or higher.</p> <p>Check the latest list of all Supported versions.</p>"},{"location":"faq.html#why-will-innobackupex-not-run-in-percona-xtrabackup-80","title":"Why will <code>innobackupex</code> not run in Percona XtraBackup 8.0?","text":"<p>innobackupex has been removed from Percona XtraBackup 8.0 in favor of xtrabackup.</p>"},{"location":"faq.html#are-you-aware-of-any-web-based-backup-management-tools-commercial-or-not-built-around-percona-xtrabackup","title":"Are you aware of any web-based backup management tools (commercial or not) built around Percona XtraBackup?","text":"<p>Zmanda Recovery Manager is a commercial tool that uses Percona XtraBackup for Non-Blocking Backups:</p> <p>\u201cZRM provides support for non-blocking backups of MySQL using Percona XtraBackup. ZRM with *Percona XtraBackup provides resource utilization management by providing throttling based on the number of IO operations per second. Percona XtraBackup based backups also allow for table level recovery even though the backup was done at the database level (needs the recovery database server to be Percona Server for MySQL with XtraDB).\u201d*</p>"},{"location":"faq.html#xtrabackup-binary-fails-with-a-floating-point-exception","title":"xtrabackup binary fails with a floating point exception","text":"<p>In most of the cases this is due to not having installed the required libraries (and version) by xtrabackup. Installing the GCC suite with the supporting libraries and recompiling xtrabackup solves the issue. See Compiling and Installing from Source Code for instructions on the procedure.</p>"},{"location":"faq.html#how-xtrabackup-handles-the-ibdataib_log-files-on-restore-if-they-arent-in-mysql-datadir","title":"How xtrabackup handles the ibdata/ib_log files on restore if they aren\u2019t in mysql datadir?","text":"<p>In case the <code>ibdata</code> and <code>ib_log</code> files are located in different directories outside the datadir, you will have to put them in their proper place after the logs have been applied.</p>"},{"location":"faq.html#backup-fails-with-error-24-too-many-open-files","title":"Backup fails with Error 24: \u2018Too many open files\u2019","text":"<p>This usually happens when database being backed up contains large amount of files and Percona XtraBackup can\u2019t open all of them to create a successful backup. In order to avoid this error the operating system should be configured appropriately so that Percona XtraBackup can open all its files. On Linux, this can be done with the <code>ulimit</code> command for specific backup session or by editing the <code>/etc/security/limits.conf</code> to change it globally (NOTE: the maximum possible value that can be set up is <code>1048576</code> which is a hard-coded constant in the Linux kernel).</p>"},{"location":"faq.html#how-to-deal-with-skipping-of-redo-logs-for-ddl-operations","title":"How to deal with skipping of redo logs for DDL operations?","text":"<p>To prevent creating corrupted backups when running DDL operations, Percona XtraBackup aborts if it detects that redo logging is disabled. In this case, the following error is printed:</p> <pre><code>[FATAL] InnoDB: An optimized (without redo logging) DDL operation has been performed. All modified pages may not have been flushed to the disk yet.\nPercona XtraBackup will not be able to take a consistent backup. Retry the backup operation.\n</code></pre> <p>Note</p> <p>Redo logging is disabled during a sorted index build. To avoid this error, Percona XtraBackup can use metadata locks on tables while they are copied:</p> <ul> <li> <p>To block all DDL operations, use the <code>--lock-ddl</code> option   that issues <code>LOCK TABLES FOR BACKUP</code>.</p> </li> <li> <p>If <code>LOCK TABLES FOR BACKUP</code> is not supported,   you can block DDL for each table   before XtraBackup starts to copy it   and until the backup is completed   using the <code>--lock-ddl-per-table</code> option.</p> </li> </ul> <p>Note</p> <p>As of Percona XtraBackup 8.0.15, the \u2013lock-ddl-per-table option is deprecated. Use the <code>--lock-ddl</code> option.</p> <p></p>"},{"location":"faq.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"flush-tables-with-read-lock.html","title":"FLUSH TABLES WITH READ LOCK option","text":"<p>The <code>FLUSH TABLES WITH READ LOCK</code> option does the following with a global read lock:</p> <ul> <li> <p>Closes all open tables</p> </li> <li> <p>Locks all tables for all databases</p> </li> </ul> <p>Release the lock with <code>UNLOCK TABLES</code>.</p> <p>Note</p> <p><code>FLUSH TABLES WITH READ LOCK</code> does not prevent inserting rows into the log tables.</p> <p>To ensure consistent backups, use the <code>FLUSH TABLES WITH READ LOCK</code> option before taking a non-InnoDB file backup. The option does not affect long-running queries.</p> <p>Long-running queries with <code>FLUSH TABLES WITH READ LOCK</code> enabled can leave the server in a read-only mode until the queries finish. Killing the <code>FLUSH TABLES WITH READ LOCK</code> does not help if the database is in either the <code>Waiting for table flush</code> or <code>Waiting for master to send event</code> state. To return to normal operation, you must kill any long-running queries.</p> <p>Note</p> <p>All described in this section has no effect when backup locks are used. Percona XtraBackup will use Backup locks where available as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code>. This feature is available in Percona Server for MySQL 5.6+. Percona XtraBackup uses this automatically to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p> <p>In order to prevent this from happening two things have been implemented:</p> <ul> <li> <p>xtrabackup waits for a good moment to issue the global lock</p> </li> <li> <p>xtrabackup kills all queries or only the SELECT queries which prevent the global lock from being acquired</p> </li> </ul>"},{"location":"flush-tables-with-read-lock.html#wait-for-queries-to-finish","title":"Wait for queries to finish","text":"<p>You should issue a global lock when no long queries are running. Waiting to issue the global lock for extended period of time is not a good method. The wait can extend the time needed for backup to take place. The [\u2013ftwrl-wait-timeout] option can limit the waiting time. If it cannot issue the lock during this time, xtrabackup stops the option, exits with an error message, and backup is not be taken.</p> <p>The default value for this option is zero (0) value which turns off the option.</p> <p>Another possibility is to specify the type of query to wait on. In this case \u2013ftwrl-wait-query-type. Possible values are <code>all</code> and <code>update</code>. When <code>all</code> is used xtrabackup will wait for all long running queries (execution time longer than allowed by \u2013ftwrl-wait-threshold) to finish before running the <code>FLUSH TABLES WITH READ LOCK</code>. When <code>update</code> is used xtrabackup will wait on <code>UPDATE/ALTER/REPLACE/INSERT</code> queries to finish.</p> <p>The time needed for a specific query to complete is hard to predict. We assume that the long-running queries will not finish in a timely manner. Other queries which run for a short time finish quickly. xtrabackup uses the value of the [\u2013ftwrl-wait-threshold] option to specify the long-running queries and will block a global lock. In order to use this option xtrabackup user should have <code>PROCESS</code> and <code>SUPER</code> privileges.</p>"},{"location":"flush-tables-with-read-lock.html#kill-the-blocking-queries","title":"Kill the blocking queries","text":"<p>The second option is to kill all the queries which prevent from acquiring the global lock. In this case, all queries which run longer than <code>FLUSH TABLES WITH READ LOCK</code> are potential blockers. Although all queries can be killed, additional time can be specified for the short running queries to finish using the \u2013kill-long-queries-timeout option. This option specifies the time for queries to complete, after the value is reached, all the running queries will be killed. The default value is zero, which turns this feature off.</p> <p>The \u2013kill-long-query-type option can be used to specify all or only <code>SELECT</code> queries that are preventing global lock from being acquired. In order to use this option xtrabackup user should have <code>PROCESS</code> and <code>SUPER</code> privileges.</p>"},{"location":"flush-tables-with-read-lock.html#options-summary","title":"Options summary","text":"<ul> <li> <p>\u2013ftwrl-wait-timeout (seconds) - how long to wait for a good moment. Default is 0, not to wait.</p> </li> <li> <p>\u2013ftwrl-wait-query-type - which long queries should be finished before <code>FLUSH TABLES WITH READ LOCK</code> is run. Default is all.</p> </li> <li> <p>\u2013ftwrl-wait-threshold (seconds) - how long query should be running before we consider it long running and potential blocker of global lock.</p> </li> <li> <p>\u2013kill-long-queries-timeout (seconds) - how many time we give for queries to complete after <code>FLUSH TABLES WITH READ LOCK</code> is issued before start to kill. Default if <code>0</code>, not to kill.</p> </li> <li> <p>\u2013kill-long-query-type - which queries should be killed once \u2013kill-long-queries-timeout has expired.</p> </li> </ul>"},{"location":"flush-tables-with-read-lock.html#example","title":"Example","text":"<p>Running the xtrabackup with the following options will cause xtrabackup to spend no longer than 3 minutes waiting for all queries older than 40 seconds to complete.</p> <pre><code>$  xtrabackup --backup --ftwrl-wait-threshold=40 \\\n--ftwrl-wait-query-type=all --ftwrl-wait-timeout=180 \\\n--kill-long-queries-timeout=20 --kill-long-query-type=all \\\n--target-dir=/data/backups/\n</code></pre> <p>After <code>FLUSH TABLES WITH READ LOCK</code> is issued, xtrabackup will wait for 20 seconds for lock to be acquired. If lock is still not acquired after 20 seconds, it will kill all queries which are running longer that the <code>FLUSH TABLES WITH READ LOCK</code>.</p> <p></p>"},{"location":"flush-tables-with-read-lock.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"glossary.html","title":"Glossary","text":""},{"location":"glossary.html#csm","title":".CSM","text":"<p>Each table with the CSV Storage Engine has <code>.CSM</code> file which contains the metadata of it.</p>"},{"location":"glossary.html#csv","title":".CSV","text":"<p>Each table with the CSV Storage engine has <code>.CSV</code> file which contains the data of it (which is a standard Comma Separated Value file).</p>"},{"location":"glossary.html#exp","title":".exp","text":"<p>Files with the <code>.exp</code> extension are created by Percona XtraBackup per each InnoDB tablespace when the <code>--export</code> option is used on prepare. See restore individual tables.</p>"},{"location":"glossary.html#frm","title":".frm","text":"<p>For each table, the server will create a file with the <code>.frm</code> extension containing the table definition (for all storage engines).</p>"},{"location":"glossary.html#general-availability-ga","title":"General availability (GA)","text":"<p>A finalized version of the product which is made available to the general public. It is the final stage in the software release cycle.</p>"},{"location":"glossary.html#ibd","title":".ibd","text":"<p>On a multiple tablespace setup ([innodb_file_per_table] enabled), MySQL will store each newly created table on a file with a <code>.ibd</code> extension.</p>"},{"location":"glossary.html#mrg","title":".MRG","text":"<p>Each table using the MERGE storage engine, besides of a <code>.frm</code> file,  will have <code>.MRG</code> file containing the names of the MyISAM tables  associated with it.</p>"},{"location":"glossary.html#myd","title":".MYD","text":"<p>Each MyISAM table has <code>.MYD</code> (MYData) file which contains the data on it.</p>"},{"location":"glossary.html#myi","title":".MYI","text":"<p>Each MyISAM table has <code>.MYI</code> (MYIndex) file which contains the table\u2019s indexes.</p>"},{"location":"glossary.html#opt","title":".opt","text":"<p>MySQL stores options of a database (like charset) in a file with a <code>.opt</code> extension in the database directory.</p>"},{"location":"glossary.html#par","title":".par","text":"<p>Each partitioned table has <code>.par</code> file which contains metadata about the partitions.</p>"},{"location":"glossary.html#trg","title":".TRG","text":"<p>The file contains the triggers associated with a table, for example, <code>\\mytable.TRG</code>. With the <code>.TRN</code> file, they represent all the trigger definitions.</p>"},{"location":"glossary.html#trn","title":".TRN","text":"<p>The file contains the names of triggers that are associated with a table, for example, <code>\\mytable.TRN</code>. With the <code>.TRG</code> file, they represent all the trigger definitions.</p>"},{"location":"glossary.html#backup","title":"backup","text":"<p>The process of copying data or tables to be stored in a different location.</p>"},{"location":"glossary.html#compression","title":"compression","text":"<p>The method that produces backups in a reduced size.</p>"},{"location":"glossary.html#configuration-file","title":"configuration file","text":"<p>The file that contains the server startup options.</p>"},{"location":"glossary.html#crash","title":"crash","text":"<p>An unexpected shutdown which does not allow the normal server shutdown cleanup activities.</p>"},{"location":"glossary.html#crash-recovery","title":"crash recovery","text":"<p>The actions that occur when MySQL is restarted after a crash.</p>"},{"location":"glossary.html#data-dictionary","title":"data dictionary","text":"<p>The metadata for the tables, indexes, and table columns stored in the InnoDB system tablespace.</p>"},{"location":"glossary.html#datadir","title":"datadir","text":"<p>The directory in which the database server stores its data files. Most Linux distribution use <code>/var/lib/mysql</code> by default.</p>"},{"location":"glossary.html#full-backup","title":"full backup","text":"<p>A backup that contains the complete source data from an instance.</p>"},{"location":"glossary.html#ibdata","title":"ibdata","text":"<p>The default prefix for tablespace files. For example, <code>ibdata1</code> is a 10MB auto-extensible file that MySQL creates for a shared tablespace by default.</p>"},{"location":"glossary.html#incremental-backup","title":"incremental backup","text":"<p>A backup stores data from a specific point in time.</p>"},{"location":"glossary.html#innodb","title":"InnoDB","text":"<p>Storage engine which provides ACID-compliant transactions and foreign  key support, among others improvements over MyISAM. It is the default  engine for MySQL as of the 8.0 series.</p>"},{"location":"glossary.html#innodb_buffer_pool_size","title":"innodb_buffer_pool_size","text":"<p>The size in bytes of the memory buffer to cache data and indexes of InnoDB\u2019s tables. This aims to reduce disk access to provide better performance. </p> <p>[mysqld] innodb_buffer_pool_size=8MB</p>"},{"location":"glossary.html#innodb_data_home_dir","title":"innodb_data_home_dir","text":"<p>The directory (relative to <code>datadir</code>) where the database server stores  the files in a shared tablespace setup. This option does not affect the location of <code>innodb\\_file\\_per\\_table</code>. For example:</p> <p>[mysqld] innodb_data_home_dir = ./</p>"},{"location":"glossary.html#innodb_data_file_path","title":"innodb_data_file_path","text":"<p>Specifies the names, sizes and location of shared tablespace files:</p> <p>[mysqld] innodb_data_file_path=ibdata1:50M;ibdata2:50M:autoextend</p>"},{"location":"glossary.html#innodb_file_per_table","title":"innodb_file_per_table","text":"<p>By default, InnoDB creates tables and indexes in a file-per-tablespace. If the <code>innodb_file_per_table</code> variable is disabled, you can enable the variable in your configuration file:</p> <p>[mysqld] innodb_file_per_table  or  start the server with <code>--innodb_file_per_table</code>.</p>"},{"location":"glossary.html#innodb_log_group_home_dir","title":"innodb_log_group_home_dir","text":"<p>Specifies the location of the InnoDB log files:</p> <p>[mysqld] innodb_log_group_home=/var/lib/mysql</p>"},{"location":"glossary.html#logical-backup","title":"logical backup","text":"<p>A backup which contains a set of SQL statements. The statements can be used to recreate the databases.</p>"},{"location":"glossary.html#lsn","title":"LSN","text":"<p>Each InnoDB page contains a log sequence number(LSN). The LSN is the system version number for the database. Each page\u2019s LSN shows how recently it was changed.</p>"},{"location":"glossary.html#mycnf","title":"my.cnf","text":"<p>The database server\u2019s main configuration file. Most Linux distributions place it as <code>/etc/mysql/my.cnf</code> or <code>/etc/my.cnf</code>, but the location and name depends on the particular installation. Note that this method is not the only way of configuring the server, some systems rely on the command options.</p>"},{"location":"glossary.html#myisam","title":"MyISAM","text":"<p>The MySQL default storage engine until version 5.5. It doesn\u2019t fully  support transactions but in some scenarios may be faster than InnoDB.  Each table is stored on disk in 3 files: <code>.frm</code>, <code>.MYD</code>, <code>.MYI</code>.</p>"},{"location":"glossary.html#physical-backup","title":"physical backup","text":"<p>A backup that copies the data files.</p>"},{"location":"glossary.html#point-in-time-recovery","title":"point in time recovery","text":"<p>This method restores the data into the state it was at any selected point of time.</p>"},{"location":"glossary.html#prepared-backup","title":"prepared backup","text":"<p>A consistent set of backup data that is ready to be restored.</p>"},{"location":"glossary.html#restore","title":"restore","text":"<p>Copies the database backups taken using the backup command to the original location or a different location. A restore returns data that has been either lost, corrupted, or stolen to the original condition at a specific point in time.</p>"},{"location":"glossary.html#tech-preview","title":"Tech preview","text":"<p>A tech preview item can be a feature, a variable, or a value within a variable. Before using this feature in production, we recommend that you test restoring production from physical backups in your environment and also use an alternative backup method for redundancy. A tech preview item is included in a release for users to provide feedback. The item is either updated and released as general availability(GA) or removed if not useful. The functionality can change from tech preview to GA.</p>"},{"location":"glossary.html#xbcrypt","title":"xbcrypt","text":"<p>To support the encryption and the decryption of the backups, a new tool xbcrypt was introduced to Percona XtraBackup. This utility has been modeled after the xbstream binary to perform encryption and decryption outside Percona XtraBackup.</p>"},{"location":"glossary.html#xbstream","title":"xbstream","text":"<p>To support simultaneous compression and streaming, Percona XtraBackup uses the xbstream format. For more information see xbstream</p>"},{"location":"glossary.html#xtradb","title":"XtraDB","text":"<p>Percona XtraDB is an enhanced version of the InnoDB storage engine, designed to better scale on modern hardware. Percona XtraDB includes features which are useful in a high performance environment. It is fully backward-compatible, and is a drop-in replacement for the standard InnoDB storage engine. For more information, see The Percona XtraDB Storage Engine.</p>"},{"location":"glossary.html#zstandard-zstd","title":"Zstandard (ZSTD)","text":"<p><code>ZSTD</code> is a fast lossless compression algorithm that targets real-time compression scenarios and better compression ratios.</p> <p><code>ZSTD</code> compression algorithm was implemented in Percona XtraBackup 8.0.30-23.</p> <p></p>"},{"location":"glossary.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"how-xtrabackup-works.html","title":"How Percona XtraBackup works","text":"<p>Percona XtraBackup is based on InnoDB\u2019s crash-recovery functionality. It copies your InnoDB data files, which results in data that is internally inconsistent; but then it performs crash recovery on the files to make them a consistent, usable database again.</p> <p>This works because InnoDB maintains a redo log, also called the transaction log. This contains a record of every change to InnoDB data. When InnoDB starts, it inspects the data files and the transaction log, and performs two steps. It applies committed transaction log entries to the data files, and it performs an undo operation on any transactions that modified data but did not commit.</p> <p>Percona XtraBackup 8.0.30-23 adds the \u2013register-redo-log-consumer parameter. This parameter is disabled by default. When enabled, the parameter lets Percona XtraBackup register as a redo log consumer at the start of the backup. The server does not remove a redo log that Percona XtraBackup (the consumer) has not yet copied. The consumer reads the redo log and manually advances the log sequence number (LSN). The server blocks the writes during the process. Based on the redo log consumption, the server determines when it can purge the log.</p> <p>Percona XtraBackup works by remembering the LSN when it starts, and then copying away the data files. It takes some time to do this, so if the files are changing, then they reflect the state of the database at different points in time. At the same time, Percona XtraBackup runs a background process that watches the transaction log files, and copies changes from it. Percona XtraBackup needs to do this continually because the transaction logs are written in a round-robin fashion, and can be reused after a while. Percona XtraBackup needs the transaction log records for every change to the data files since it began execution.</p> <p>Percona XtraBackup uses Backup locks</p> <p>where available as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code>. This feature is available in Percona Server for MySQL 5.6+. MySQL 8.0 allows acquiring an instance level backup lock via the <code>LOCK INSTANCE FOR BACKUP</code> statement.</p> <p>Locking is only done for MyISAM and other non-InnoDB tables after Percona XtraBackup finishes backing up all InnoDB/XtraDB data and logs. Percona XtraBackup uses this automatically to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p> <p>Important</p> <p>The <code>BACKUP_ADMIN</code> privilege is required to query the  <code>performance_schema_log_status</code> for either <code>LOCK  INSTANCE FOR BACKUP</code> or <code>LOCK TABLES FOR BACKUP</code>.</p> <p>xtrabackup tries to avoid backup locks and <code>FLUSH TABLES WITH READ LOCK</code> when the instance contains only InnoDB tables. In this case, xtrabackup obtains binary log coordinates from <code>performance_schema.log_status</code>. <code>FLUSH TABLES WITH READ LOCK</code> is still required in MySQL 8.0 when xtrabackup is started with the <code>--slave-info</code>. The <code>log_status</code> table in Percona Server for MySQL 8.0 is extended to include the relay log coordinates, so no locks are needed even with the <code>--slave-info</code> option.</p> <p>See also</p> <p>MySQL Documentation: LOCK INSTANCE FOR BACKUP</p> <p>When backup locks are supported by the server, xtrabackup first copies InnoDB data, runs the <code>LOCK TABLES FOR BACKUP</code> and then copies the MyISAM tables. Once this is done, the backup of the files will begin. It will backup .frm, .MRG, .MYD, .MYI, .CSM, .CSV, <code>.sdi</code> and <code>.par</code> files.</p> <p>After that xtrabackup will use <code>LOCK BINLOG FOR BACKUP</code> to block all operations that might change either binary log position or <code>Exec_Master_Log_Pos</code> or <code>Exec_Gtid_Set</code> (i.e. source binary log coordinates corresponding to the current SQL thread state on a replication replica) as reported by <code>SHOW MASTER/SLAVE STATUS</code>. xtrabackup will then finish copying the REDO log files and fetch the binary log coordinates. After this is completed xtrabackup will unlock the binary log and tables.</p> <p>Finally, the binary log position will be printed to <code>STDERR</code> and xtrabackup will exit returning 0 if all went OK.</p> <p>Note that the <code>STDERR</code> of xtrabackup is not written in any file. You will have to redirect it to a file, e.g., <code>xtrabackup OPTIONS 2&gt; backupout.log</code>.</p> <p>It will also create the following files in the directory of the backup.</p> <p>During the <code>prepare</code> phase, Percona XtraBackup performs crash recovery against the copied data files, using the copied transaction log file. After this is done, the database is ready to restore and use.</p> <p>The backed-up MyISAM and InnoDB tables will be eventually consistent with each other, because after the prepare (recovery) process, InnoDB\u2019s data is rolled forward to the point at which the backup completed, not rolled back to the point at which it started. This point in time matches where the <code>FLUSH TABLES WITH READ LOCK</code> was taken, so the MyISAM data and the prepared InnoDB data are in sync.</p> <p>The xtrabackup offers many features not mentioned in the preceding explanation. The functionality of each tool is explained in more detail further in this manual. In brief, though, the tools enable you to do operations such as streaming and incremental backups with various combinations of copying the data files, copying the log files, and applying the logs to the data.</p>"},{"location":"how-xtrabackup-works.html#restoring-a-backup","title":"Restoring a backup","text":"<p>To restore a backup with xtrabackup you can use the \u2013copy-back or \u2013move-back options.</p> <p>xtrabackup will read from the <code>my.cnf</code> the variables datadir, innodb_data_home_dir, innodb_data_file_path, innodb_log_group_home_dir and check that the directories exist.</p> <p>It will copy the MyISAM tables, indexes, etc. (.MRG, .MYD, .MYI, .CSM, .CSV, <code>.sdi</code>, and <code>par</code> files) first, InnoDB tables and indexes next and the log files at last. It will preserve file\u2019s attributes when copying them, you may have to change the files\u2019 ownership to <code>mysql</code> before starting the database server, as they will be owned by the user who created the backup.</p> <p>Alternatively, the \u2013move-back option may be used to restore a backup. This option is similar to \u2013copy-back with the only difference that instead of copying files it moves them to their target locations. As this option removes backup files, it must be used with caution. It is useful in cases when there is not enough free disk space to hold both data files and their backup copies.</p> <p></p>"},{"location":"how-xtrabackup-works.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"installation.html","title":"Install Percona XtraBackup 8.0 overview","text":"<p>We recommend that you install Percona XtraBackup 8.0 from the official Percona software repositories using the appropriate package manager for your system:</p> <ul> <li> <p>Use an APT repo to install Percona XtraBackup</p> </li> <li> <p>Use a YUM repo to install Percona XtraBackup</p> </li> </ul>"},{"location":"installation.html#installation-alternatives","title":"Installation alternatives","text":"<p>Percona also provides the following methods:</p> <ul> <li> <p>Use DEB downloaded packages to install Percona XtraBackup</p> </li> <li> <p>Use RPM downloaded packages to install Percona XtraBackup </p> </li> <li> <p>Install Percona XtraBackup from a Binary Tarball with all the required files and binaries for a manual installation</p> </li> <li> <p>Compile and install Percona XtraBackup from source code</p> </li> <li> <p>Run Percona XtraBackup in a Docker container</p> </li> </ul> <p>Before installing Percona XtraBackup with any of these methods, we recommend that you review the release notes and Server version and backup version comparisonand, if you are using Percona XtraBackup 8.0.34 or later, the latest list of Supported versions.</p> <p></p>"},{"location":"installation.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"lock-options.html","title":"lock-ddl-per-table option improvements","text":"<p>Important</p> <p>The lock-ddl-per-table option is deprecated in Percona Server for MySQL 8.0. Use \u2013lock-ddl instead of this variable.</p> <p>To block DDL statements on an instance, Percona Server implemented LOCK TABLES FOR BACKUP. Percona XtraBackup uses this lock for the duration of the backup. This lock does not affect DML statements.</p> <p>Percona XtraBackup has also implemented \u2013lock-ddl-per-table, which blocks DDL statements by using metadata locks (MDL).</p> <p>The following procedures describe a simplified backup operation when using \u2013lock-ddl-per-table:</p> <ol> <li> <p>Parse and copy all redo logs after the checkpoint mark</p> </li> <li> <p>Fork a dedicated thread to continue following new redo log entries</p> </li> <li> <p>List the tablespaces required to copy</p> </li> <li> <p>Iterate through the list. The following steps occur with each listed tablespace:</p> </li> <li> <p>Query INFORMATION_SCHEMA.INNODB_TABLES to find which tables belong    to the tablespace ID and take an MDL on the underlying table or tables in    case there is a shared tablespace.</p> </li> <li> <p>Copy the tablespace <code>.ibd</code> files.</p> </li> </ol> <p>The backup process may encounter a redo log event, generated by the bulk load operations, which notifies backup tools that data file changes have been omitted from the redo log. This event is an <code>MLOG_INDEX_LOAD</code>. If this event is found by the redo follow thread, the backup continues and assumes the backup is safe because the MDL protects tablespaces already copied and the MLOG_INDEX_LOAD event is for a tablespace that is not copied.</p> <p>These assumptions may not be correct and may lead to inconsistent backups.</p>"},{"location":"lock-options.html#lock-ddl-per-table-redesign","title":"\u2013lock-ddl-per-table redesign","text":"<p>Implemented in Percona XtraBackup version 8.0.22-15.0, the \u2013lock-ddl-per-table has been redesigned to minimize inconsistent backups.</p> <p>The following procedure reorders the steps:</p> <ul> <li> <p>The MDL lock acquired at the beginning of the backup</p> </li> <li> <p>Scan the redo logs. An <code>MLOG_INDEX_LOAD</code> event may be recorded if a <code>CREATE INDEX</code> statement has occurred before the backup starts. At this time, the backup process is safe and can parse and accept the event.</p> </li> <li> <p>After the first scan has completed, the follow redo log thread is initiated. This thread stops the backup process if an <code>MLOG_INDEX_LOAD</code> event is found.</p> </li> <li> <p>Gather the tablespace list to copy</p> </li> <li> <p>Copy the <code>.ibd</code> files.</p> </li> </ul>"},{"location":"lock-options.html#other-improvements","title":"Other improvements","text":"<p>The following improvements have been added:</p> <ul> <li> <p>If the <code>.ibd</code> file belongs to a temporary table, the <code>SELECT</code> query is skipped.</p> </li> <li> <p>For a FullText Index, an MDL is acquired on the base table.</p> </li> <li> <p>A <code>SELECT</code> query that acquires an MDL does not retrieve any data.</p> </li> </ul> <p></p>"},{"location":"lock-options.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"log-enhancements.html","title":"Improved log statements","text":"<p>Percona XtraBackup is an open-source command-line utility. Command-line tools have limited interaction with the background operations and the logs provide the progress of an operation or more information about errors.</p> <p>In earlier versions, the error logs did not have a standard structure. Notice in the following examples the variance in the log statements:</p> <ul> <li>The backup log statement header has the name of the module, <code>xtrabackup</code>, which generated the statement but no timestamp:</li> </ul> <p><pre><code> $ xtrabackup: recognized client arguments: --parallel=4 --target-dir=/data/backups/ --backup=1\n</code></pre> The output should be similar to the following:</p> Expected output <pre><code>./bin/xtrabackup version 8.0.27-19 based on MySQL server 8.0.27 Linux (x86_64) (revision id: b0f75188ca3)\n</code></pre> <ul> <li>The copy-back log statement has a timestamp but no module name. The   timestamp is a mix of UTC and the local timezone.</li> </ul> <pre><code>220322 19:05:13 [01] Copying undo_001 to /data/backups/undo_001\n</code></pre> <ul> <li>The following prepare log statements do not have header information,   which makes diagnosing an issue more difficult.</li> </ul> <pre><code>Completed space ID check of 1008 files.\nInitializing buffer pool, total size = 128.000000M, instances = 1, chunk size =128.000000M\nCompleted initialization of buffer pool\nIf the mysqld execution user is authorized, page cleaner thread priority can be changed. See the man page of setpriority().\n</code></pre>"},{"location":"log-enhancements.html#log-statement-structure","title":"Log statement structure","text":"<p>Starting in Percona XtraBackup 8.0.28-20, changes have been made to improve the log statements. The improved log structure is displayed in the backup, prepare, move-back/copy-back error logs.</p> <p>Each log statement has the following attributes:</p> <ul> <li> <p>Timestamp - a timestamp for when the event occurred in a UTC format.</p> </li> <li> <p>Severity - the severity level of a statement indicates the importance of an event.</p> </li> <li> <p>ID - this identifier is currently not used but may be used in future versions.</p> </li> <li> <p>Context - the name of the module that issued the log statement, such as XtraBackup, InnoDB, or Server.</p> </li> <li> <p>Message - a description of the event generated by the module.</p> </li> </ul> <p>An example of a <code>prepare</code> log that is generated with the improved structure. The uniformity of the headers makes it easier to follow an operation\u2019s progress or review the log to diagnose issues.</p> Expected output <pre><code>2022-03-22T19:15:36.142247+05:30 0 [Note] [MY-011825] [Xtrabackup] This target seems to be not prepared yet.\n2022-03-22T19:15:36.142792+05:30 0 [Note] [MY-013251] [InnoDB] Number of pools: 1\n2022-03-22T19:15:36.149212+05:30 0 [Note] [MY-011825] [Xtrabackup] xtrabackup_logfile detected: size=8388608, start_lsn=(33311656)\n2022-03-22T19:15:36.149998+05:30 0 [Note] [MY-011825] [Xtrabackup] using the following InnoDB configuration for recovery:\n2022-03-22T19:15:36.150023+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_data_home_dir = .\n2022-03-22T19:15:36.150036+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_data_file_path = ibdata1:12M:autoextend\n2022-03-22T19:15:36.150078+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_group_home_dir = .\n2022-03-22T19:15:36.150095+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_files_in_group = 1\n2022-03-22T19:15:36.150111+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_file_size = 8388608\n2022-03-22T19:15:36.151667+05:30 0 [Note] [MY-011825] [Xtrabackup] inititialize_service_handles suceeded\n2022-03-22T19:15:36.151903+05:30 0 [Note] [MY-011825] [Xtrabackup] using the following InnoDB configuration for recovery:\n2022-03-22T19:15:36.151926+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_data_home_dir = .\n2022-03-22T19:15:36.151954+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_data_file_path = ibdata1:12M:autoextend\n2022-03-22T19:15:36.151976+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_group_home_dir = .\n2022-03-22T19:15:36.151991+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_files_in_group = 1\n2022-03-22T19:15:36.152004+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_file_size = 8388608\n2022-03-22T19:15:36.152021+05:30 0 [Note] [MY-011825] [Xtrabackup] Starting InnoDB instance for recovery.\n2022-03-22T19:15:36.152035+05:30 0 [Note] [MY-011825] [Xtrabackup] Using 104857600 bytes for buffer pool (set by --use-memory parameter)\n</code></pre> <p></p>"},{"location":"log-enhancements.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"lru-dump-backup.html","title":"LRU dump backup","text":"<p>Percona XtraBackup includes a saved buffer pool dump into a backup to enable reducing the warm up time. It restores the buffer pool state from <code>ib_buffer_pool</code> file after restart. Percona XtraBackup discovers <code>ib_buffer_pool</code> and backs it up automatically.</p> <p></p> <p>If the buffer restore option is enabled in <code>my.cnf</code> buffer pool will be in the warm state after backup is restored.</p> <p></p>"},{"location":"lru-dump-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"make-backup-in-replication-env.html","title":"Make backups in replication environments","text":"<p>There are options specific to back up from a replication replica.</p>"},{"location":"make-backup-in-replication-env.html#the-slave-info-option","title":"The <code>--slave-info</code> option","text":"<p>This option is useful when backing up a replication replica server. It prints the binary log position and name of the source server. It also writes this information to the <code>xtrabackup_slave_info</code> file as a <code>CHANGE MASTER</code> statement.</p> <p>This option is useful for setting up a new replica for this source. You can start a replica server with this backup and issue the statement saved in the <code>xtrabackup_slave_info</code> file. More details of this procedure can be found in How to setup a replica for replication in 6 simple steps with Percona XtraBackup.</p>"},{"location":"make-backup-in-replication-env.html#the-safe-slave-backup-option","title":"The <code>--safe-slave-backup</code> option","text":"<p>In order to assure a consistent replication state, this option stops the replication SQL thread and waits to start backing up until <code>Slave_open_temp_tables</code> in <code>SHOW STATUS</code> is zero. If there are no open temporary tables, the backup will take place, otherwise the SQL thread will be started and stopped until there are no open temporary tables. The backup will fail if <code>Slave_open_temp_tables</code> does not become zero after <code>--safe-slave-backup-timeout</code> seconds (defaults to 300 seconds). The replication SQL thread will be restarted when the backup finishes.</p> <p>Note</p> <p>Prior to Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup stops the SQL replica thread after the InnoDB tables and before the non-InnoDB tables are backed up.</p> <p>As of Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup option stops the SQL replica thread before copying the InnoDB files.</p> <p>Using this option is always recommended when taking backups from a replica server.</p> <p>Warning</p> <p>Make sure your replica is a true replica of the source before using it as a source for backup. A good tool to validate a replica is pt-table-checksum.</p> <p></p>"},{"location":"make-backup-in-replication-env.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"page-tracking.html","title":"Take an incremental backup using page tracking","text":"<p>Percona XtraBackup 8.0.27 adds support for page tracking functionality for an incremental backup.</p> <p>To create an incremental backup with page tracking, Percona XtraBackup uses the MySQL <code>mysqlbackup</code> component. This component provides a list of pages modified since the last backup, and Percona XtraBackup copies only those pages. This operation removes the need to scan the pages in the database. If the majority of pages have not been modified, the page tracking feature can improve the speed of incremental backups.</p>"},{"location":"page-tracking.html#install-the-component","title":"Install the component","text":"<p>To start using the page tracking functionality, do the following:</p> <ol> <li> <p>Install the <code>mysqlbackup</code> component and enable it on the server:</p> <pre><code>$ INSTALL COMPONENT \"file://component_mysqlbackup\";\n</code></pre> </li> <li> <p>Check whether the <code>mysqlbackup</code> component is installed successfully:</p> <pre><code>$ SELECT COUNT(1) FROM mysql.component WHERE component_urn='file://component_mysqlbackup';\n</code></pre> </li> </ol>"},{"location":"page-tracking.html#use-page-tracking","title":"Use page tracking","text":"<p>You can enable the page tracking functionality for the full and incremental backups with the <code>--page-tracking</code> option.</p> <p>The option has the following benefits:</p> <ul> <li> <p>Resets page tracking to the start of the backup. This reset allows the next incremental backup to use page tracking.</p> </li> <li> <p>Allows the use of page tracking for an incremental backup if the page tracking data is available from the backup\u2019s start checkpoint LSN.</p> </li> </ul> <p>Percona XtraBackup processes a list of all the tracked pages in memory. If Percona XtraBackup does not have enough available memory to process this list, the process throws an error and exits. For example, if an incremental backup uses 200GB, Percona XtraBackup can use an additional 100MB of memory to process and store the page tracking data. </p> <p>The examples of creating full and incremental backups using the <code>--page-tracking</code> option:</p> Full backupIncremental backup <pre><code>$ xtrabackup --backup --target-dir=$FULL_BACK --page-tracking\n</code></pre> <pre><code>$ xtrabackup --backup --target-dir=$INC_BACKUP  \n--incremental-basedir=$FULL_BACKUP --page-tracking\n</code></pre> <p>After enabling the functionality, the next incremental backup finds changed pages using page tracking.</p>"},{"location":"page-tracking.html#limitations","title":"Limitations","text":"<ul> <li> <p>When creating the first full backup using page tracking, Percona XtraBackup may have a delay. The following is an example of the message:</p> <pre><code>xtrabackup: pagetracking: Sleeping for 1 second, waiting for checkpoint lsn 17852922 /\nto reach to page tracking start lsn 21353759\n</code></pre> <p>Enable page tracking before creating the first backup to avoid this delay. This method ensures that the page tracking log sequence number (LSN) is higher than the checkpoint LSN of the server.</p> </li> <li> <p>If an Oracle MySQL Server uses page tracking and runs <code>LOCK=EXCLUSIVE</code> and <code>ALGORITHM=INPLACE</code> DDL operations, Percona XtraBackup may take an inconsistent backup. Oracle MySQL Server does not write these DDL operations (Oracle MySQL bug 106163) to the redo log, and Percona XtraBackup only detects the inconsistency during the <code>--prepare</code> phase.</p> <p>This bug does not influence Percona XtraBackup taking backup of Percona Server for MySQL because the bug is fixed in Percona Server for MySQL 8.0.27.</p> </li> <li> <p>The xtrabackup page tracking requires the system tablespace to be a single file (ibdata1 only). The page tracking feature does not work if the system tablespace is a multi-file tablespace.</p> </li> </ul>"},{"location":"page-tracking.html#start-page-tracking-manually","title":"Start page tracking manually","text":"<p>After the mysqlbackup component is loaded and active on the server, you can start page tracking manually with the following option:</p> <pre><code>$ SELECT mysqlbackup_page_track_set(true);\n</code></pre>"},{"location":"page-tracking.html#check-the-lsn-value","title":"Check the LSN value","text":"<p>Check the LSN value starting from which changed pages are tracked with the following option:</p> <pre><code>$ SELECT mysqlbackup_page_track_get_start_lsn();\n</code></pre>"},{"location":"page-tracking.html#stop-page-tracking","title":"Stop page tracking","text":"<p>To stop page tracking, use the following command:</p> <pre><code>$ SELECT mysqlbackup_page_track_set(false);\n</code></pre>"},{"location":"page-tracking.html#purge-page-tracking-data","title":"Purge page tracking data","text":"<p>When you start page tracking, it creates a file under the server\u2019s datadir to collect data about changed pages. This file grows until you stop the page tracking. If you stop the server and then restart it, page tracking creates a new file but also keeps the old one. The old file continues to grow until you stop the page tracking explicitly.</p> <p>If you purge the page tracking data, you should create a full backup afterward. To purge the page tracking data, do the following steps:</p> <pre><code>$ SELECT mysqlbackup_page_track_set(false);\n$ SELECT mysqlbackup_page_track_purge_up_to(9223372036854775807);\n/* Specify the LSN up to which you want to purge page tracking data. /\n9223372036854775807 is the highest possible LSN which purges all page tracking files.*/\n$ SELECT mysqlbackup_page_track_set(true);\n</code></pre>"},{"location":"page-tracking.html#known-issue","title":"Known issue","text":"<p>If the index is built in place using an exclusive algorithm and then is added to a table after the last LSN checkpoint, you may generate a bad incremental backup using page tracking. For more details see PS-8032.</p>"},{"location":"page-tracking.html#uninstall-the-mysqlbackup-component","title":"Uninstall the mysqlbackup component","text":"<p>To uninstall the mysqlbackup component, use the following statement:</p> <pre><code>$ UNINSTALL COMPONENT \"file://component_mysqlbackup\"\n</code></pre> <p></p>"},{"location":"page-tracking.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"permissions.html","title":"Permissions needed","text":"<p>We will be referring to permissions to the ability of a user to access and perform changes on the relevant parts of the host\u2019s filesystem, starting/stopping services and installing software.</p> <p>By privileges, we refer to the abilities of a database user to perform different kinds of actions on the database server.</p> <p>There are many ways for checking the permission on a file or directory. For example, <code>ls -ls /path/to/file</code> or <code>stat /path/to/file | grep Access</code> will do the job:</p> <p><pre><code>$ stat /etc/mysql | grep Access\n</code></pre> The result could look like this:</p> Expected output <pre><code>Access: (0755/drwxr-xr-x)  Uid: (    0/    root)   Gid: (    0/    root)\nAccess: 2011-05-12 21:19:07.129850437 -0300\n$ ls -ld /etc/mysql/my.cnf\n-rw-r--r-- 1 root root 4703 Apr  5 06:26 /etc/mysql/my.cnf\n</code></pre> <p>As in this example, <code>my.cnf</code> is owned by <code>root</code> and not writable for anyone else. Assuming that you do not have <code>root</code>\u2018s password, you can check what permissions you have on these types of files with <code>sudo -l</code>:</p> <p><pre><code>$ sudo -l\n</code></pre> The results could look like this:</p> Expected output <pre><code>Password:\nYou may run the following commands on this host:\n(root) /usr/bin/\n(root) NOPASSWD: /etc/init.d/mysqld\n(root) NOPASSWD: /bin/vi /etc/mysql/my.cnf\n(root) NOPASSWD: /usr/local/bin/top\n(root) NOPASSWD: /usr/bin/ls\n(root) /bin/tail\n</code></pre> <p>Being able to execute with <code>sudo</code> scripts in <code>/etc/init.d/</code>, <code>/etc/rc.d/</code> or <code>/sbin/service</code> is the ability to start and stop services.</p> <p>Also, If you can execute the package manager of your distribution, you can install or remove software with it. If not, having <code>rwx</code> permission over a directory will let you do a local installation of software by compiling it there. This is a typical situation in many hosting companies\u2019 services.</p> <p>There are other ways for managing permissions, such as using PolicyKit, * Extended ACLs or SELinux*, which may be preventing or allowing your access. You should check them in that case.</p> <p>See also</p> <p>Connection and privileges needed</p> <p></p>"},{"location":"permissions.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"point-in-time-recovery.html","title":"Point-in-time recovery","text":"<p>Recovering up to particular moment in database\u2019s history can be done with xtrabackup and the binary logs of the server.</p> <p>Note that the binary log contains the operations that modified the database from a point in the past. You must have full data directory as a base. Apply a series of operations from the binary log to make the data match the point in time data.</p> <pre><code>$ xtrabackup --backup --target-dir=/path/to/backup\n$ xtrabackup --prepare --target-dir=/path/to/backup\n</code></pre> <p>For more details on these procedures, see Create a full backup and Prepare a full backup.</p> <p>Now, suppose that some time has passed, and you want to restore the database to a certain point in the past, having in mind that there is the constraint of the point where the snapshot was taken.</p> <p>To find out what is the situation of binary logging in the server, execute the following queries:</p> <pre><code>mysql&gt; SHOW BINARY LOGS;\n</code></pre> Expected output <pre><code>+------------------+-----------+\n| Log_name         | File_size |\n+------------------+-----------+\n| mysql-bin.000001 |       126 |\n| mysql-bin.000002 |      1306 |\n| mysql-bin.000003 |       126 |\n| mysql-bin.000004 |       497 |\n+------------------+-----------+\n</code></pre> <p>This query returns the binary log names and file size.</p> <pre><code>mysql&gt; SHOW MASTER STATUS;\n</code></pre> Expected output <pre><code>+------------------+----------+--------------+------------------+\n| File             | Position | Binlog_Do_DB | Binlog_Ignore_DB |\n+------------------+----------+--------------+------------------+\n| mysql-bin.000004 |      497 |              |                  |\n+------------------+----------+--------------+------------------+\n</code></pre> <p>The query returns which file is currently being used to record changes, and the current position within it. Typically,the files are stored in the datadir, unless, when starting the server, another location is specified with the <code>--log-bin=</code> option).</p> <p>To find out the position of the snapshot taken, see the <code>xtrabackup_binlog_info</code> at the backup\u2019s directory:</p> <pre><code>$ cat /path/to/backup/xtrabackup_binlog_info\n</code></pre> Expected output <pre><code>mysql-bin.000003      57\n</code></pre> <p>This result tells you which file was used at the moment of the backup for the binary log and its position. That position will be the effective one when you restore the backup:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/path/to/backup\n</code></pre> <p>As the restoration will not affect the binary log files (you may need to adjust file permissions, see Restore a backup), the next step is extracting the queries from the binary log with mysqlbinlog starting from the position of the snapshot and redirecting the results to a file.</p> <p>If you have multiple files for the binary log, as in the example, you must extract the queries with one process.</p> <pre><code>$ mysqlbinlog /path/to/datadir/mysql-bin.000003 /path/to/datadir/mysql-bin.000004 \\\n    --start-position=57 &gt; mybinlog.sql\n</code></pre> <p>Inspect the file with the queries to determine which position or date corresponds to the wanted point-in-time. Once determined, pipe it to the server. For example, if the point is <code>11-12-25 01:00:00</code>, the command moves the the database forward to that point-in-time.</p> <pre><code>$ mysqlbinlog /path/to/datadir/mysql-bin.000003 /path/to/datadir/mysql-bin.000004 \\\n    --start-position=57 --stop-datetime=\"11-12-25 01:00:00\" | mysql -u root -p\n</code></pre> <p></p>"},{"location":"point-in-time-recovery.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-compressed-backup.html","title":"Decompress and prepare a backup","text":"<p>Before you can prepare the backup you need to decompress all the files.</p>"},{"location":"prepare-compressed-backup.html#decompress-a-backup","title":"Decompress a backup","text":"<ul> <li> <p>To decompress backups made using <code>LZ4</code> or <code>ZSTD</code> compression algorithm, install the corresponding package for your package management system.</p> <p><code>Install on APT systems</code></p> Install the <code>lz4</code> packageInstall the <code>zstd</code> package <pre><code>$ sudo apt install lz4\n</code></pre> <pre><code>$ sudo apt install zstd\n</code></pre> <p><code>Install on YUM systems</code></p> Install the <code>lz4</code> packageInstall the <code>zstd</code> package <pre><code>$ sudo yum install lz4\n</code></pre> <pre><code>$ sudo yum install zstd\n</code></pre> </li> <li> <p>Use the <code>--decompress</code> option to decompress the backup.</p> <pre><code>$ xtrabackup --decompress --target-dir=/data/compressed/\n</code></pre> <p>Note</p> <p><code>--parallel</code> can be used with <code>--decompress</code> option to decompress multiple files simultaneously. </p> <p>Percona XtraBackup does not automatically delete compressed files. To clean up the backup directory, use the <code>--remove-original</code> option. If you do not remove the compressed files, these files will not be copied or moved to the datadir when using the <code>--copy-back</code> or <code>--move-back</code> options.</p> </li> </ul>"},{"location":"prepare-compressed-backup.html#prepare-the-backup","title":"Prepare the backup","text":"<p>When the files are decompressed you can prepare the backup with the <code>--prepare</code> option.</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/compressed/\n</code></pre> Confirmation message <pre><code>InnoDB: Starting shutdown...\nInnoDB: Shutdown completed; log sequence number 9293846\n170223 13:39:31 completed OK!\n</code></pre> <p>Now the files in <code>/data/compressed/</code> are ready to be used by the server.</p> <p>The next step is to Restore a backup. </p> <p></p>"},{"location":"prepare-compressed-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-full-backup.html","title":"Prepare a full backup","text":"<p>After making a backup with the <code>--backup</code> option, you need to prepare it in order to restore it. Data files are not point-in-time consistent until they are prepared, because they were copied at different times as the program ran, and they might have been changed while this was happening.</p> <p>If you try to start InnoDB with these data files, it will detect corruption and stop working to avoid running on damaged data. The <code>--prepare</code> step makes the files perfectly consistent at a single instant in time, so you can run InnoDB on them.</p> <p>You can run the prepare operation on any machine; it does not need to be on the originating server or the server to which you intend to restore. You can copy the backup to a utility server and prepare it there.</p> <p>Note that Percona XtraBackup 8.0 can only prepare backups of MySQL 8.0, Percona Server for MySQL 8.0, and Percona XtraDB Cluster 8.0 databases. Releases prior to 8.0 are not supported.</p> <p>During the prepare operation, xtrabackup boots up a kind of modified embedded InnoDB (the libraries xtrabackup was linked against). The modifications are necessary to disable InnoDB standard safety checks, such as complaining about the log file not being the right size. This warning is not appropriate for working with backups. These modifications are only for the xtrabackup binary; you do not need a modified InnoDB to use xtrabackup for your backups.</p> <p>The prepare step uses this \u201cembedded InnoDB\u201d to perform crash recovery on the copied data files, using the copied log file. The <code>prepare</code> step is very simple to use: you simply run xtrabackup with the <code>--prepare</code> option and tell it which directory to prepare, for example, to prepare the previously taken backup run:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backups/\n</code></pre> <p>When this finishes, you should see an <code>InnoDB shutdown</code> with a message such as the following, where again the value of LSN will depend on your system:</p> Expected output <pre><code>InnoDB: Shutdown completed; log sequence number 137345046\n160906 11:21:01 completed OK!\n</code></pre> <p>All following prepares will not change the already prepared data files, you\u2019ll see that output says:</p> Expected output <pre><code>xtrabackup: This target seems to be already prepared.\nxtrabackup: notice: xtrabackup_logfile was already used to '--prepare'.\n</code></pre> <p>It is not recommended to interrupt xtrabackup process while preparing backup because it may cause data files corruption and backup will become unusable. Backup validity is not guaranteed if prepare process was interrupted.</p> <p>Note</p> <p>If you intend the backup to be the basis for further incremental backups, you should use the <code>--apply-log-only</code> option when preparing the backup, or you will not be able to apply incremental backups to it. See the documentation on preparing incremental backups for more details.</p> <p>After preparing the backup, you can restore the backup.</p> <p></p>"},{"location":"prepare-full-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-incremental-backup.html","title":"Prepare an incremental backup","text":"<p>The <code>--prepare</code> step for incremental backups is not the same as for full backups. In full backups, two types of operations are performed to make the database consistent: committed transactions are replayed from the log file against the data files, and uncommitted transactions are rolled back. You must skip the rollback of uncommitted transactions when preparing an incremental backup, because transactions that were uncommitted at the time of your backup may be in progress, and it\u2019s likely that they will be committed in the next incremental backup. You should use the <code>--apply-log-only</code> option to prevent the rollback phase.</p> <p>Warning</p> <p>If you do not use the <code>--apply-log-only</code> option to prevent the rollback phase, then your incremental backups will be useless. After transactions have been rolled back, further incremental backups cannot be applied.</p> <p>Beginning with the full backup you created, you can prepare it, and then apply the incremental differences to it. Recall that you have the following backups:</p> <pre><code>/data/backups/base\n/data/backups/inc1\n/data/backups/inc2\n</code></pre> <p>To prepare the base backup, you need to run <code>--prepare</code> as usual, but prevent the rollback phase:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/data/backups/base\n</code></pre> <p>The output should end with text similar to the following:</p> Expected output <pre><code>InnoDB: Shutdown completed; log sequence number 1626007\n161011 12:41:04 completed OK!\n</code></pre> <p>The log sequence number should match the <code>to_lsn</code> of the base backup, which you saw previously.</p> <p>Warning</p> <p>This backup is actually safe to restore as-is now, even though the rollback phase has been skipped. If you restore it and start MySQL, InnoDB will detect that the rollback phase was not performed, and it will do that in the background, as it usually does for a crash recovery upon start. It will notify you that the database was not shut down normally.</p> <p>To apply the first incremental backup to the full backup, run the following command:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/data/backups/base \\\n--incremental-dir=/data/backups/inc1\n</code></pre> <p>This applies the delta files to the files in <code>/data/backups/base</code>, which rolls them forward in time to the time of the incremental backup. It then applies the redo log as usual to the result. The final data is in <code>/data/backups/base</code>, not in the incremental directory. You should see an output similar to:</p> Expected output <pre><code>incremental backup from 1626007 is enabled.\nxtrabackup: cd to /data/backups/base\nxtrabackup: This target seems to be already prepared with --apply-log-only.\nxtrabackup: xtrabackup_logfile detected: size=2097152, start_lsn=(4124244)\n...\nxtrabackup: page size for /tmp/backups/inc1/ibdata1.delta is 16384 bytes\nApplying /tmp/backups/inc1/ibdata1.delta to ./ibdata1...\n...\n161011 12:45:56 completed OK!\n</code></pre> <p>Again, the LSN should match what you saw from your earlier inspection of the first incremental backup. If you restore the files from <code>/data/backups/base</code>, you should see the state of the database as of the first incremental backup.</p> <p>Warning</p> <p>Percona XtraBackup does not support using the same incremental backup directory to prepare two copies of backup. Do not run <code>--prepare</code> with the same incremental backup directory (the value of \u2013incremental-dir) more than once.</p> <p>Preparing the second incremental backup is a similar process: apply the deltas to the (modified) base backup, and you will roll its data forward in time to the point of the second incremental backup:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backups/base \\\n--incremental-dir=/data/backups/inc2\n</code></pre> <p>Note</p> <p><code>--apply-log-only</code> should be used when merging the incremental backups except the last one. That\u2019s why the previous line does not contain the <code>--apply-log-only</code> option. Even if the <code>--apply-log-only</code> was used on the last step, backup would still be consistent but in that case server would perform the rollback phase.</p> <p>Once prepared incremental backups are the same as the full backups, and they can be restored in the same way.</p> <p></p>"},{"location":"prepare-incremental-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-individual-partitions-backup.html","title":"Prepare an individual partitions backup","text":"<p>For preparing partial backups, the procedure is analogous to restoring individual tables. Apply the logs and use xtrabackup <code>--export</code>:</p> <pre><code>$ xtrabackup --apply-log --export /mnt/backup/2012-08-28_10-29-09\n</code></pre> <p>You may see warnings in the output about tables that do not exist. This happens because InnoDB-based engines stores its data dictionary inside the tablespace files. xtrabackup removes the missing tables (those that haven\u2019t been selected in the partial backup) from the data dictionary in order to avoid future warnings or errors.</p> <p>The next step is  to restore the backup. </p> <p></p>"},{"location":"prepare-individual-partitions-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-partial-backup.html","title":"Prepare a partial backup","text":"<p>The procedure is analogous to restoring individual tables: apply the logs and use the <code>--export</code> option:</p> <pre><code>$ xtrabackup --prepare --export --target-dir=/path/to/partial/backup\n</code></pre> <p>When you use the <code>--prepare</code> option on a partial backup, you will see warnings about tables that don\u2019t exist. This is because these tables exist in the data dictionary inside InnoDB, but the corresponding .ibd files don\u2019t exist. They were not copied into the backup directory. These tables will be removed from the data dictionary, and when you restore the backup and start InnoDB, they will no longer exist and will not cause any errors or warnings to be printed to the log file.</p> <p>Could not find any file associated with the tablespace ID: 5</p> <p>Use <code>--innodb-directories</code> to find the tablespace files. If that fails then use <code>-\u2013innodb-force-recovery=1</code> to ignore this and to permanently lose all changes to the missing tablespace(s).</p> <p>The next step is to restore restore the partition from the backup. </p> <p></p>"},{"location":"prepare-partial-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"privileges.html","title":"Connection and privileges needed","text":"<p>Percona XtraBackup needs to be able to connect to the database server and perform operations on the server and the datadir when creating a backup, when preparing in some scenarios and when restoring it. In order to do so, there are privileges and permission requirements on its execution that must be fulfilled.</p> <p>Privilege refers to the operations that a system user is permitted to do in the database server. They are set at the database server and only apply to users in the database server.</p> <p>Permissions are those which permits a user to perform operations on the system, like reading, writing or executing on a certain directory or start/stop a system service. They are set at a system level and only apply to system users.</p> <p>When xtrabackup is used, there are two actors involved: the user invoking the program - a system user - and the user performing action in the database server - a database user. Note that these are different users in different places, even though they may have the same username.</p> <p>All the invocations of xtrabackup in this documentation assume that the system user has the appropriate permissions, and you are providing the relevant options for connecting the database server - besides the options for the action to be performed - and the database user has adequate privileges.</p>"},{"location":"privileges.html#connect-to-the-server","title":"Connect to the server","text":"<p>The database user used to connect to the server and its password are specified by the <code>--user</code> and <code>--password</code> option:</p> <pre><code>$ xtrabackup --user=DVADER --password=14MY0URF4TH3R --backup \\\n--target-dir=/data/bkps/\n</code></pre> <p>If you don\u2019t use the <code>--user</code> option, Percona XtraBackup will assume the database user whose name is the system user executing it.</p>"},{"location":"privileges.html#other-connection-options","title":"Other connection options","text":"<p>According to your system, you may need to specify one or more of the following options to connect to the server:</p> Option Description -port Use this port when connecting to the database with TCP/IP -socket Use this socket when connecting to the local database. -host Use this host when connecting to the database server with TCP/IP <p>These options are passed to the mysql child process without alteration, see <code>mysql --help</code> for details.</p> <p>Note</p> <p>In case of multiple server instances, the correct connection parameters (port, socket, host) must be specified in order for xtrabackup to talk to the correct server.</p>"},{"location":"privileges.html#privileges-needed","title":"Privileges needed","text":"<p>Once connected to the server, in order to perform a backup you need <code>READ</code> and <code>EXECUTE</code> permissions at a filesystem level in the server\u2019s datadir.</p> <p>The database user needs the following privileges to back up tables or databases:</p> <ul> <li> <p><code>RELOAD</code> and <code>LOCK TABLES</code> (unless the <code>--no-lock</code> option is specified) in order to run <code>FLUSH TABLES WITH READ LOCK</code> and <code>FLUSH ENGINE LOGS</code> prior to start copying the files, and requires this privilege when Backup Locks are used</p> </li> <li> <p><code>BACKUP_ADMIN</code> privilege is needed to query the performance_schema.log_status table, and run <code>LOCK INSTANCE FOR BACKUP</code>, <code>LOCK BINLOG FOR BACKUP</code>, or <code>LOCK TABLES FOR BACKUP</code>.</p> </li> <li> <p><code>REPLICATION CLIENT</code> in order to obtain the binary log position,</p> </li> <li> <p><code>CREATE TABLESPACE</code> in order to import tables (see Restoring Individual Tables),</p> </li> <li> <p><code>PROCESS</code> in order to run <code>SHOW ENGINE INNODB STATUS</code> (which is mandatory), and optionally to see all threads which are running on the server (see FLUSH TABLES WITH READ LOCK option),</p> </li> <li> <p><code>SUPER</code> in order to start/stop the replication threads in a replication environment, use XtraDB Changed Page Tracking for Incremental Backups and for handling FLUSH TABLES WITH READ LOCK,</p> </li> <li> <p><code>CREATE</code> privilege in order to create the PERCONA_SCHEMA.xtrabackup_history database and table,</p> </li> <li> <p><code>ALTER</code> privilege in order to upgrade the PERCONA_SCHEMA.xtrabackup_history database and table,</p> </li> <li> <p><code>INSERT</code> privilege in order to add history records to the PERCONA_SCHEMA.xtrabackup_history table,</p> </li> <li> <p><code>SELECT</code> privilege in order to use <code>--incremental-history-name</code> or <code>--incremental-history-uuid</code> in order for the feature to look up the <code>innodb_to_lsn</code> values in the PERCONA_SCHEMA.xtrabackup_history table.</p> </li> <li> <p><code>SELECT</code> privilege on the keyring_component_status table to view the attributes and status of the installed keyring component when in use.</p> </li> <li> <p><code>SELECT</code> privilege on the replication_group_members table to validate if the instance is part of group replication cluster.</p> </li> </ul> <p>A SQL example of creating a database user with the minimum privileges required to take full backups would be:</p> <pre><code>mysql&gt; CREATE USER 'bkpuser'@'localhost' IDENTIFIED BY 's3cr%T';\nmysql&gt; GRANT BACKUP_ADMIN, PROCESS, RELOAD, LOCK TABLES, REPLICATION CLIENT ON *.* TO 'bkpuser'@'localhost';\nmysql&gt; GRANT SELECT ON performance_schema.log_status TO 'bkpuser'@'localhost';\nmysql&gt; GRANT SELECT ON performance_schema.keyring_component_status TO bkpuser@'localhost';\nmysql&gt; GRANT SELECT ON performance_schema.replication_group_members TO bkpuser@'localhost';\nmysql&gt; FLUSH PRIVILEGES;\n</code></pre>"},{"location":"privileges.html#query-the-privileges","title":"Query the privileges","text":"<p>To query the privileges that your database user has been granted at the console of the server execute:</p> <pre><code>mysql&gt; SHOW GRANTS;\n</code></pre> <p>or for a particular user with:</p> <pre><code>mysql&gt; SHOW GRANTS FOR 'db-user'@'host';\n</code></pre> <p>It will display the privileges using the same format as for the GRANT statement.</p> <p>Note that privileges may vary across versions of the server. To list the exact list of privileges that your server support (and a brief description of them) execute:</p> <pre><code>mysql&gt; SHOW PRIVILEGES;\n</code></pre> <p>See also</p> <p>Permissions needed</p> <p></p>"},{"location":"privileges.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-docker.html","title":"Start a Docker container and take a backup","text":"<p>Percona XtraBackup works in combination with a MySQL-compatible database, Percona Server for MySQL, in our scenario. To use Percona XtraBackup, run it in a separate Docker container and then connect the Percona XtraBackup container to the Percona Server for MySQL container. As soon as you start Percona Server for MySQL in a Docker container and create a database and table in Percona Server for MySQL, you are ready to backup your databes with Percona XtraBackup.</p> <p>The following steps create a Docker volume, start Percona XtraBackup in a Docker continer, take and prepare a backup of Percona Server for MySQL database.</p>"},{"location":"quickstart-docker.html#create-a-docker-volume","title":"Create a Docker volume","text":"<p>The benefits of using a Docker volume are the following:</p> <ul> <li> <p>You can keep your data safe and accessible across different containers. For example, if you want to upgrade your database image to a newer version, you can stop the old container and start a new one with the same volume attached without losing any data. </p> </li> <li> <p>You can quickly backup and restore your data using the <code>docker cp</code> command or mount the volume to another container.</p> </li> </ul> <pre><code>$ docker volume create backupvol\n</code></pre> Expected output <pre><code> backupvol\n</code></pre>"},{"location":"quickstart-docker.html#start-percona-xtrabackup-8034-in-a-container-take-and-prepare-a-backup","title":"Start Percona XtraBackup 8.0.34 in a container, take and prepare a backup","text":"<p>The <code>docker run</code> command creates and runs a new container from an image. The command modifies the container\u2019s behavior with options.</p> <p>In our example, the command has the following options:</p> Option Description <code>--name</code> Provides a name to the container. If you do not use this option, Docker adds a random name. <code>--volumes-from</code> Refers to Percona Server for MySQL and indicates that you intend to use the same data as the <code>psmysql</code> container. <code>it</code> Interacts with the container and be a pseudo-terminal. <code>--user root</code> Sets the user to root inside the Percona XtraBackup container. This option is required to access the MySQL data directory and run the xtrabackup command. <code>backup_8034</code> Indicates the directory inside the container where the backup files are stored. <code>-v</code> Mounts a volume from the host machine to volumes in another container that is being run. In our example, the <code>-v</code> option mounts a volume from the <code>psmysql</code> container to the <code>backupvol</code> volume on the host machine. <code>backupvol</code> Indicates the persistent storage for the database. <code>psmysql</code> Indicates the Percona Server for MySQL container. <code>--password</code> Prompts the user to enter the password for the root user. For convenience you can add the password for the root user to this option, for example, <code>--password=secret</code>. Then the password will be passed automaticaly when running the command. Note that if you specify the password with <code>--password=secret</code>, the password is visible in <code>docker ps</code>, <code>docker ps -a</code> (docker history) and regular ps command. <code>8.0.34</code> Use this tag to specify a specific version. Avoid using the <code>latest</code> tag.  In our example, we use the <code>8.0.34</code> tag. In Docker, a tag is a label assigned to an image and is used to maintain different versions of an image. <p>If you do not add a tag, Docker uses <code>latest</code> as the default tag and downloads the newest image from percona/percona-xtrabackup on the Docker Hub. This image can be in a different series or version from what you expect since the latest image changes over time. If you are using Percona XtraBackup version prior to 8.0.34, use tags to ensure that you use compatible versions of Percona Server for MySQL and Percona XtraBackup. </p> <p>Starting with Percona XtraBackup 8.0.35-31, you can run the Docker ARM64 version of Percona XtraBackup. Use the <code>8.0.35-31-aarch64</code> tag instead of <code>8.0.35-31</code>.</p>"},{"location":"quickstart-docker.html#connect-the-percona-xtrabackup-container-to-the-percona-server-container","title":"Connect the Percona XtraBackup container to the Percona Server container","text":"<p>We recommend using the <code>\u2013-user root</code> option in the Docker command.</p> <p>Run a Docker container example</p> <pre><code>$ docker run --name pxb --volumes-from psmysql -v backupvol:/backup_8034 -it --user root percona/percona-xtrabackup:8.0.34 /bin/bash -c \"xtrabackup --backup --datadir=/var/lib/mysql/ --target-dir=/backup_8034 --user=root --password; xtrabackup --prepare --target-dir=/backup_8034\"\n</code></pre> <p>You are prompted to enter the password. In our example, the password is <code>secret</code>.</p> <pre><code>2023-12-21T16:16:10.796716-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized server arguments: --datadir=/var/lib/mysql/2023-12-21T16:16:10.799979-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized client arguments: --backup=1 --target-dir=/backup_8034 --user=root --password\n\nEnter password:\n</code></pre> <p>In this example of expected output, we provide the first and last section of the backup log and use ellipses instead of the entire backup log.</p> Expected output <pre><code>2023-12-14T15:45:16.277503-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized server arguments: --datadir=/var/lib/mysql/ \n\n2023-12-14T15:45:16.280208-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized client arguments: --backup=1 --target-dir=/backup_80 --user=root --password=* \n\nxtrabackup version 8.0.34-29 based on MySQL server 8.0.34 Linux (x86_64) (revision id: 5ba706ee) \n\n2023-12-14T15:45:16.306670-00:00 0 [Note] [MY-011825] [Xtrabackup] perl binary not found. Skipping the version check \n\n2023-12-14T15:45:16.307026-00:00 0 [Note] [MY-011825] [Xtrabackup] Connecting to MySQL server host: localhost, user: root, password: set, port: not set, socket: not set \n\n2023-12-14T15:45:16.320214-00:00 0 [Note] [MY-011825] [Xtrabackup] Using server version 8.0.34-26 \n\n...\n\n2023-12-14T15:45:20.619892-00:00 0 [Note] [MY-011825] [Xtrabackup] completed OK! \n</code></pre> <p>The command runs a Docker container <code>pxb</code> from the <code>percona/percona-xtrabackup:8.0.34</code> image and mounts two volumes: one from another container named <code>psmysql</code>, which contains Percona Server data directory, and another named <code>backupvol</code>, which is where the backup files are stored. The command also sets the user to root and prompts the user to enter the password. </p> <p>The command then executes two steps: </p> <ul> <li> <p>Runs <code>xtrabackup</code> with the <code>--backup</code> option to copy the data files from <code>/var/lib/mysql/</code> to <code>/backup_8034</code></p> </li> <li> <p>Runs <code>xtrabackup</code> with the <code>--prepare</code> option to apply the log files and make the backup consistent and ready for restore</p> </li> </ul> <p>You can check the Xtrabackup logs with the <code>docker container logs &lt;container-name&gt;</code> command.</p> <p>For example:</p> <pre><code>$ docker container logs pxb\n</code></pre>"},{"location":"quickstart-docker.html#next-steps","title":"Next steps","text":"<p>Restore the backup </p> <p></p>"},{"location":"quickstart-docker.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-exit.html","title":"Clean up","text":"<p>In this document you\u2019ll learn how to:</p> <ul> <li> <p>Exit the MySQL command client shell and the Docker container</p> </li> <li> <p>Remove the Docker container and the Docker image</p> </li> <li> <p>Remove the Docker volume.</p> </li> </ul> <p>The steps are as follows:</p> <ol> <li> <p>To exit the MySQL command client shell in <code>psmysql2</code> container, we use <code>exit</code>. You can also use the <code>\\q</code> or <code>quit</code> commands. The execution of the statement also closes the connection.</p> <pre><code>mysql&gt; exit\n</code></pre> Expected output <pre><code>Bye\n</code></pre> </li> <li> <p>Remove docker containers and images, if you no longer need docker containers / images or want to free up disk space. To remove a docker container, use the command <code>docker rm</code> followed by the container name or the container ID. To remove a docker image, use the command <code>docker rmi</code> followed by the image ID or name and the tag. The example uses the <code>-f</code> option to force the removal.</p> <ul> <li> <p>Remove <code>psmysql2</code>, <code>psmysql</code> and <code>pxb</code> Docker containers:</p> <pre><code>$ docker container rm psmysql2 -f\n</code></pre> Expected output <pre><code>psmysql2\n</code></pre> <pre><code>$ docker container rm psmysql -f\n</code></pre> Expected output <pre><code>psmysql\n</code></pre> <pre><code>$ docker container rm pxb -f\n</code></pre> Expected output <pre><code>pxb\n</code></pre> </li> <li> <p>Remove <code>percona/percona-server:8.0.34</code> and <code>percona/percona-xtrabackup:8.0.34</code> Docker images</p> <pre><code>$ docker image rmi percona/percona-server:8.0.34\n</code></pre> Expected output <pre><code>Untagged: percona/percona-server:8.0.34\n</code></pre> <pre><code>$ docker image rmi percona/percona-xtrabackup:8.0.34\n</code></pre> Expected output <pre><code>Untagged: percona/percona-server:8.0.34\nUntagged: percona/percona-server@sha256:4944f9b365e0dc88f41b3b704ff2a02d1459fd07763d7d1a444b263db8498e1f\nDeleted: sha256:b2588da614b1f382468fc9f44600863e324067a9cae57c204a30a2105d61d9d9\nDeleted: sha256:1ceaa6dc89e328281b426854a3b00509b5df13826a9618a09e819a830b752ebd\nDeleted: sha256:77471692427a227eb16d06907357956c3bb43f0fdc3ecf6f8937e1acecae24fe\nDeleted: sha256:8db06cc7b0430437edc7f118b139d2195cb65e2e8025f9a4517d16778f615384\nDeleted: sha256:e5a57a2fafec4ab9482240f28927651d56545c19626e344aceb8be3704c3c397\nDeleted: sha256:f86198f39b893674d44d424c958f23183bf919d2ced20e1f519714d0972d75ed\nDeleted: sha256:db9672f7e12e374d5e9016b758a29d5444e8b0fd1246a6f1fc5c2b3c847dddcf\n</code></pre> </li> </ul> </li> <li> <p>Remove docker volume if a container does not use the volume, and you no longer need it</p> <p>Remove <code>backupvol</code> and <code>myvol2</code> Docker volumes:</p> <pre><code>$ docker volume rm backupvol\n</code></pre> Expected output <pre><code>backupvol\n</code></pre> <pre><code>$ docker volume rm myvol2\n</code></pre> Expected output <pre><code>myvol2\n</code></pre> </li> </ol>"},{"location":"quickstart-exit.html#next-step","title":"Next step","text":"<p>Next steps </p> <p></p>"},{"location":"quickstart-exit.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-next-steps.html","title":"Next steps","text":"<p>After taking your first backup with Percona Xtrabackup, it\u2019s high time to expand your knowledge and skills in using Percona Xtrabackup.</p> <p>Review the Percona Xtrabackup documentation for more information.</p>"},{"location":"quickstart-next-steps.html#learn-more-about-other-percona-products","title":"Learn more about other Percona products","text":""},{"location":"quickstart-next-steps.html#for-superior-and-optimized-performance","title":"For superior and optimized performance","text":"<p>Percona Server for MySQL (PS) is a freely available, fully compatible, enhanced, and open source drop-in replacement for any MySQL database. It provides superior and optimized performance, greater scalability and availability, enhanced backups, increased visibility, and instrumentation. Percona Server for MySQL is trusted by thousands of enterprises to provide better performance and concurrency for their most demanding workloads.</p> <p>Install Percona Server for MySQL.</p>"},{"location":"quickstart-next-steps.html#for-high-availability","title":"For high availability","text":"<p>Percona XtraDB Cluster (PXC) is a 100% open source, enterprise-grade, highly available clustering solution for MySQL multi-master setups based on Galera. PXC helps enterprises minimize unexpected downtime and data loss, reduce costs, and improve performance and scalability of your database environments supporting your critical business applications in the most demanding public, private, and hybrid cloud environments. </p> <p>Install Percona XtraDB Cluster.</p>"},{"location":"quickstart-next-steps.html#for-monitoring-and-management","title":"For Monitoring and Management","text":"<p>Percona Monitoring and Management (PMM) monitors and provides actionable performance data for MySQL variants, including Percona Server for MySQL, Percona XtraDB Cluster, Oracle MySQL Community Edition, Oracle MySQL Enterprise Edition, and MariaDB. PMM captures metrics and data for the InnoDB, XtraDB, and MyRocks storage engines, and has specialized dashboards for specific engine details.</p> <p>Install PMM and connect your MySQL instances to it.</p>"},{"location":"quickstart-next-steps.html#advanced-command-line-tools","title":"Advanced command-line tools","text":"<p>Percona Toolkit is a collection of advanced command-line tools used by the Percona support staff to perform a variety of MySQL, MongoDB, and system tasks that are complex or difficult to perform manually. These tools are ideal alternatives to \u201cone-off\u201d scripts because they are professionally developed, formally tested, and documented. Each tool is self-contained, so installation is quick and easy and does not install libraries.</p> <p>Percona Toolkit documentation</p> <p>Install PMM and connect your MySQL instances to it.</p> <p></p>"},{"location":"quickstart-next-steps.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-overview.html","title":"Overview","text":"<p>Percona XtraBackup is a 100% open source backup solution for all versions of Percona Server for MySQL and MySQL\u00ae that performs online non-blocking, tightly compressed, highly secure full backups on transactional systems.</p> <p>To start with Percona XtraBackup quickly, we recommend using Docker and this Quickstart guide focuses on this installation method. You can explore alternative installation options in the Install section.</p>"},{"location":"quickstart-overview.html#why-to-start-percona-xtrabackup-in-a-docker-container","title":"Why to start Percona XtraBackup in a Docker container","text":"<p>Docker containers are built from Docker images, which are snapshots of the configuration needed to run an applications, such as the code, and libraries. With Docker, you can build, deploy, run, update, and manage containers, which isolate applications from the host system. A Docker container lets you work with Percona XtraBackup without installing the product on a local drive.</p>"},{"location":"quickstart-overview.html#purpose-of-the-quickstart","title":"Purpose of the Quickstart","text":"<p>This section provides you with the basic steps to quiclky start Percona XtraBackup in a Docker continer, take a backup, prepare a backup and restore a backup of Percona Server for MySQL database.</p> <p>You are welcome to change the names of any items in commands. If you do, the results may vary from those we provide in this Quickstart guide.</p> <p>In this section, container refers to the Docker container and instance refers to the database server in the container.</p>"},{"location":"quickstart-overview.html#prerequisites","title":"Prerequisites","text":"<ul> <li>Install Docker on your system.</li> </ul> <p>To take a backup of Percona Server for MySQL, run Percona Server for MySQL in a Docker container and create a database, and a table.</p> <ul> <li>Start Percona Server in a Docker container</li> <li>Create a database and table in Percona Server</li> </ul>"},{"location":"quickstart-overview.html#limitations","title":"Limitations","text":"<p>Percona XtraBackup 8.0 does not support making backups of databases created in versions before the 8.0 series of MySQL, Percona Server for MySQL, or Percona XtraDB Cluster or versions greater than 8.0, such as the 8.1 Innovation release.</p>"},{"location":"quickstart-overview.html#supported-versions","title":"Supported versions","text":"<p>Check the latest list of all Supported versions.</p>"},{"location":"quickstart-overview.html#supported-servers","title":"Supported servers","text":"<p>Percona XtraBackup 8.0 can back up data stored on MySQL servers, Percona Server for MySQL, and Percona XtraDB Cluster.</p>"},{"location":"quickstart-overview.html#supported-storage-engines","title":"Supported storage engines","text":"<p>Percona XtraBackup 8.0 can back up data from InnoDB, XtraDB, MyISAM, and MyRocks tables.</p>"},{"location":"quickstart-overview.html#steps-to-perform","title":"Steps to perform","text":"<p>In this Quickstart, you will learn how to:</p> <ol> <li>Start a Docker container and take a backup</li> <li>Restore a backup</li> <li>Clean up</li> <li>Choose your next steps</li> </ol>"},{"location":"quickstart-overview.html#next-steps","title":"Next steps","text":"<p>Start a Docker container and take a backup </p> <p></p>"},{"location":"quickstart-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-restore-backup.html","title":"Restore the backup","text":"<p>The following steps describe how to restore your backup to another Percona Server container and check whether the data is available.</p> <ol> <li> <p>Create another Docker volume</p> <pre><code>$ docker volume create myvol2\n</code></pre> Expected output <pre><code>myvol2\n</code></pre> </li> <li> <p>Run another Percona Server container to restore the backup to</p> Option Description <code>--name</code> Provides a name to the container. If you do not use this option, Docker adds a random name. <code>-d</code> Detaches the container. The container runs in the background. <code>-e</code> Adds an environmental variable. This example adds the  <code>MYSQL_ROOT_PASSWORD</code>  environment variable. The instance refuses to initialize if no environmental variable is added. Choose a more secure password, if needed. <code>myvol2</code> Indicates the persistent storage for the database. <code>8.0.34</code> Use this tag to specify a specific version. <p>You must provide at least one environment variable to access the database, such as <code>MYSQL_ROOT_PASSWORD</code>, <code>MYSQL_DATABASE</code>, <code>MYSQL_USER</code>, and <code>MYSQL_PASSWORD</code> or the instance refuses to initialize.</p> <p>For this document, we are using the <code>8.0.34</code> tag. In Docker, a tag is a label assigned to an image. Tags are used to maintain different versions of an image. If we did not add a tag, Docker uses <code>latest</code> as the default tag and downloads the latest image from [percona/percona-server on the Docker Hub].</p> <p>To use a Docker volume for persistent storage with a database, specify the path where the database stores its data inside the container, usually <code>/var/lib/mysql</code>.</p> <ul> <li> <p>Run a Docker container example</p> <pre><code>$ docker run -d -p 3307:3306 --name psmysql2 -e MYSQL_ROOT_PASSWORD=secret -v myvol2:/var/lib/mysql percona/percona-server:8.0.34\n</code></pre> </li> </ul> Expected output <pre><code>684464ce43d8880500f81abccb1e7440146a43f7d79c983a2a2a622b9a0d2080\n</code></pre> </li> <li> <p>Stop <code>psmysql2</code> container</p> <pre><code>$ docker stop psmysql2\n</code></pre> Expected output <pre><code>psmysql2\n</code></pre> </li> <li> <p>Remove all created files in <code>myvol2</code> to allow xtrabackup restore data to <code>myvol2</code></p> <p>The <code>--rm</code> option automatically removes the temporary container created from percona/percona-xtrabackup:8.0.34 image after the container exits. </p> <pre><code>$ docker run --volumes-from psmysql2 -v backupvol:/backup_8034 -it --rm --user root percona/percona-xtrabackup:8.0.34 /bin/bash -c \"rm -rf /var/lib/mysql/*\"\n</code></pre> <p>If the command executes successfully, the expected output is empty.</p> </li> <li> <p>Restore backup of <code>psmysql</code> from <code>backupvol</code> to a new <code>psmysql2</code> instance.</p> <pre><code>$ docker run --volumes-from psmysql2 -v backupvol:/backup_8034 -it --rm --user root percona/percona-xtrabackup:8.0.34 /bin/bash -c \"xtrabackup --copy-back --datadir=/var/lib/mysql/ --target-dir=/backup_8034\" \n</code></pre> Expected output <pre><code>2023-12-14T16:06:39.845762-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized server arguments: --datadir=/var/lib/mysql/ \n\n2023-12-14T16:06:39.848408-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized client arguments: --copy-back=1 --target-dir=/backup_8034 \n\nxtrabackup version 8.0.34-29 based on MySQL server 8.0.34 Linux (x86_64) (revision id: 5ba706ee) \n\n2023-12-14T16:06:39.849053-00:00 0 [Note] [MY-011825] [Xtrabackup] cd to /backup_8034/ \n\n...\n\n2023-12-14T16:06:40.111577-00:00 1 [Note] [MY-011825] [Xtrabackup] Creating directory ./#innodb_redo \n\n2023-12-14T16:06:40.111603-00:00 1 [Note] [MY-011825] [Xtrabackup] Done: creating directory ./#innodb_redo \n\n2023-12-14T16:06:40.111634-00:00 1 [Note] [MY-011825] [Xtrabackup] Copying ./ibtmp1 to /var/lib/mysql/ibtmp1 \n\n2023-12-14T16:06:40.125971-00:00 1 [Note] [MY-011825] [Xtrabackup] Done: Copying ./ibtmp1 to /var/lib/mysql/ibtmp1 \n\n2023-12-14T16:06:40.144298-00:00 0 [Note] [MY-011825] [Xtrabackup] completed OK! \n</code></pre> <p>This command restores the backup files from the <code>backup_8034</code> volume to the <code>psmysql2</code> container. It uses the <code>percona/percona-xtrabackup:8.0.34</code> image to run a temporary container with root privileges. It executes the xtrabackup tool with the <code>--copy-back</code> option, which copies the files from the <code>backup_8034</code> volume to the /<code>var/lib/mysql/</code> directory in the <code>psmysql2</code> container. The command uses \u2013rm option to delete the temporary container after it exits.</p> </li> </ol>"},{"location":"quickstart-restore-backup.html#validate-the-backup","title":"Validate the backup","text":"<p>This section describes the backup validation steps assuming that you backed up <code>mydb</code> database with the <code>employees</code> table as we have in our example. The validation steps may vary depending on your data set.</p> <ol> <li> <p>Change the owner of the files in <code>myvol2</code> from <code>root</code> to <code>mysql</code></p> <p>To avoid permission issues when running <code>psmysql2</code> container, you need to change the owner because the files were restored by <code>root</code> user and <code>psmysql2</code> will use <code>mysql</code> user.</p> <pre><code>$ docker run --volumes-from psmysql2 -v backupvol:/backup_8034 -it --rm --user root percona/percona-xtrabackup:8.0.34 /bin/bash -c \"chown -R mysql:mysql /var/lib/mysql/\" \n</code></pre> <p>If the command executes successfully, the expected output is empty.</p> </li> <li> <p>Start the <code>psmysql2</code> container</p> <pre><code>$ docker start psmysql2\n</code></pre> Expected output <pre><code>psmysql2\n</code></pre> </li> <li> <p>Connect to the database instance.</p> <p>For this example, we have the following options:</p> Option Description <code>it</code> Interact with the container and be a pseudo-terminal <code>psmysql2</code> Running container name <code>mysql</code> Connects to a database instance <code>-u</code> Specifies the user account used to connect <code>-p</code> Use this password when connecting <ul> <li> <p>Connect to the database instance example</p> <pre><code>$ docker exec -it psmysql2 mysql -uroot -p\n</code></pre> <p>You are prompted to enter the password, which is <code>secret</code>.</p> <pre><code>Enter password:\n</code></pre> <p>You should see the following result.</p> Expected output <pre><code>Welcome to the MySQL monitor.  Commands end with ; or \\g. \n\nYour MySQL connection id is 31 \n\nServer version: 8.0.34-26 Percona Server (GPL), Release 26, Revision 0fe62c85 \n\nCopyright (c) 2009-2023 Percona LLC and/or its affiliates \n\nCopyright (c) 2000, 2023, Oracle and/or its affiliates. \n\nOracle is a registered trademark of Oracle Corporation and/or its \n\naffiliates. Other names may be trademarks of their respective owners. \n\nType 'help;' or '\\h' for help. Type '\\c' to clear the current input statement. \n</code></pre> </li> </ul> </li> <li> <p>Check the list of databases to make sure, the backed up, <code>mydb</code> database is in the list.</p> <pre><code>mysql&gt; show databases; \n</code></pre> Expected output <pre><code>+--------------------+ \n\n| Database           | \n\n+--------------------+ \n\n| information_schema | \n\n| mydb               | \n\n| mysql              | \n\n| performance_schema | \n\n| sys                | \n\n+--------------------+ \n\n5 rows in set (0.03 sec) \n</code></pre> </li> <li> <p>Use the <code>mydb</code> database.</p> <pre><code>mysql&gt; use mydb; \n</code></pre> Expected output <pre><code>Database changed\n</code></pre> </li> <li> <p>Check that your table contains data</p> <pre><code>mysql&gt; SELECT * FROM employees; \n</code></pre> Expected output <pre><code>+----+--------------------+-----------------------------------+-------------+ \n\n| id | name               | email                             | country     | \n\n+----+--------------------+-----------------------------------+-------------+ \n\n|  1 | Erasmus Richardson | posuere.cubilia.curae@outlook.net | England     | \n\n|  2 | Jenna French       | rhoncus.donec@hotmail.couk        | Canada      | \n\n|  3 | Alfred Dejesus     | interdum@aol.org                  | Austria     | \n\n|  4 | Hamilton Puckett   | dapibus.quam@outlook.com          | Canada      | \n\n|  5 | Michal Brzezinski  | magna@icloud.pl                   | Poland      | \n\n|  6 | Zofia Lis          | zofial00@hotmail.pl               | Poland      | \n\n|  7 | Aisha Yakubu       | ayakubu80@outlook.com             | Nigeria     | \n\n|  8 | Miguel Cardenas    | euismod@yahoo.com                 | Peru        | \n\n|  9 | Luke Jansen        | nibh@hotmail.edu                  | Netherlands | \n\n| 10 | Roger Pettersen    | nunc@protonmail.no                | Norway      | \n\n+----+--------------------+-----------------------------------+-------------+ \n\n10 rows in set (0.00 sec)\n</code></pre> </li> </ol>"},{"location":"quickstart-restore-backup.html#next-steps","title":"Next steps","text":"<p>Clean up </p> <p></p>"},{"location":"quickstart-restore-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"redo-log-archiving.html","title":"InnoDB redo log archiving","text":"<p>A physical backup contains raw copies of the database contents and any related files, such as configuration files or logs. During crash recovery, InnoDB corrects the data from incomplete transactions using the redo log. A redo log contains the entries necessary to bring the database back to a consistent state. An LSN value represents the data in the redo log.</p> <p>Data in the redo log is always appended, and the movement of the checkpoint truncates old data. When a file is full, a new file is created and the movement of the checkpoint truncates the old files. If the MySQL server has significant activity during a backup operation and the redo log file storage media operates faster than the backup storage media, the backup operation may fail to keep pace with the redo log generation and cause data loss.</p> <p>Before the redo log archiving feature, the solutions were:</p> <ul> <li> <p>Increasing the redo log size</p> </li> <li> <p>Checking for I/O congestion if the read speed is slow</p> </li> <li> <p>Checking for I/O or network congestion if the write speed is slow</p> </li> <li> <p>Taking the backup at an off-peak time</p> </li> </ul>"},{"location":"redo-log-archiving.html#redo-log-archiving","title":"redo log archiving","text":"<p>MySQL 8.0.17 added redo log archiving. To enable this feature, the following actions are required:</p> <ul> <li> <p>Create a directory for the archiving logs</p> </li> <li> <p>Call the function to start the archiving process</p> </li> </ul> <p>It would help if you created a directory for the redo log archives. The system user running <code>mysqld</code> must have access to this directory.</p> <p>You can verify if MySQL has configured the archive directory with the following command. The result provides the path or returns NULL, meaning you have not set the archiving directory.</p> <pre><code>$ mkdir -p /var/lib/mysql-redo-archive/backup1\n$ chown mysql. -R /var/lib/mysql-redo-archive\n$ chmod _R 700 /var/lib/mysql-redo-archive/\n</code></pre> <p>The <code>innodb_redo_log_archive_dirs</code> global variable contains labeled directories. The format is <code>label:directory-path</code>. Multiple objects can be listed with a semi-colon between each set.</p> <pre><code>mysql&gt; SET PERSIST innodb_redo_log_archive_dirs='backup1:/var/lib/mysql-redo-archive/';\n</code></pre> <p>Verify that the archive was created with the following command:</p> <pre><code>mysql&gt; SHOW GLOBAL VARIABLES LIKE 'innodb_redo_log_ar%';\n</code></pre> Expected output <pre><code>+------------------------------+--------------------------------------+\n| Variable_name                | Value                                |\n+------------------------------+--------------------------------------+\n| innodb_redo_log_archive_dirs | backup1:/var/lib/mysql-redo-archive/ |\n+------------------------------+--------------------------------------+\n1 row in set (0.0025 sec)\n</code></pre> <p>Users with the INNODB_REDO_LOG_ARCHIVE privilege can call the <code>innodb_redo_log_archive_start()</code> or <code>innodb_redo_log_archive_stop()</code> functions. to either start or stop archiving. </p> <pre><code>mysql&gt; SELECT innodb_redo_log_archive_start('backup1','backup1');\n</code></pre> Expected output <pre><code>+-----------------------------------------------------+\n| innodb_redo_log_archive_start('backup1','backup1')  |\n+------------------------------+----------------------+\n|                                                   0 |\n+------------------- ---------------------------------+\n1 row in set (0.00225 sec)\n</code></pre>"},{"location":"redo-log-archiving.html#percona-xtrabackup-and-redo-log-archiving","title":"Percona XtraBackup and redo log archiving","text":"<p>Percona XtraBackup 8.0.34-29 added the redo-log-arch-dir option. If the archiving directory is not configured in MySQL, Percona XtraBackup creates a temporary directory for the archive file. To use this option, you must run Percona XtraBackup as the same owner as <code>mysqld</code>. If Percona XtraBackup does not have the appropriate permissions, the action generates a \u201cPermission denied\u201d error, and archiving is not used.</p>"},{"location":"redo-log-archiving.html#example-of-reading-a-log","title":"Example of reading a log","text":"<pre><code>$ sudo -H -u mysql bash\n$ xtrabackup --no-lock=1 --compress --parallel=4 --host=localhost --user=root --password='password_string' --backup=1 --target-dir=/Backup/13oct 2&gt; /tmp/b0-with-redo-archiving-as-mysql-os-user.log\n</code></pre> <p>Verify that the archiving is used:</p> <pre><code>$ cat /tmp/b0-with-redo-archiving-as-mysql-os-user.log\n</code></pre> Expected output <pre><code>[Note] [MY-011825] [Xtrabackup] recognized server arguments: --datadir=/var/lib/mysql\u00a0 \n[Note] [MY-011825] [Xtrabackup] recognized client arguments: --no-lock=1 --compress --parallel=4 --host=localhost --user=root --password=* --backup=1 --target-dir=/Backup/22Aug\u00a0 xtrabackup version 8.0.34-29 based on MySQL server 8.0.34 Linux (x86_64) (revision id: 5ba706ee) 230822 13:36:02\u00a0 version_check Connecting to MySQL server with DSN 'dbi:mysql:;mysql_read_default_group=xtrabackup;host=localhost' as 'root'\u00a0 (using password: YES). 230822 13:36:02\u00a0 version_check Connected to MySQL server 230822 13:36:02\u00a0 version_check Executing a version check against the server... 230822 13:36:02\u00a0 version_check Done. \n[Note] [MY-011825] [Xtrabackup] Connecting to MySQL server host: localhost, user: root, password: set, port: not set, socket: not set \n[Note] [MY-011825] [Xtrabackup] Using server version 8.0.34 \n.... \n.... \n[Note] [MY-011825] [Xtrabackup] Connecting to MySQL server host: localhost, user: root, password: set, port: not set, socket: not set \n[Note] [MY-011825] [Xtrabackup] xtrabackup redo_log_arch_dir is set to backup1:/var/lib/mysql-redo-archive/ \n[Note] [MY-011825] [Xtrabackup] Waiting for archive file '/var/lib/mysql-redo-archive//1692711362986/archive.94f4ab58-3d1c-11ee-9e4f-0af1fd7c44c9.000001.log' \n[Note] [MY-011825] [Xtrabackup] &gt;&gt; log scanned up to (19630018) \n.... \n.... \n[Note] [MY-011825] [Xtrabackup] Done: Compressing file /Backup/22Aug/xtrabackup_info.zst \n[Note] [MY-011825] [Xtrabackup] Transaction log of lsn (19630018) to (19630028) was copied. \n[Note] [MY-011825] [Xtrabackup] completed OK!\n</code></pre> <p></p>"},{"location":"redo-log-archiving.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes.html","title":"Percona XtraBackup 8.0 release notes index","text":"<ul> <li> <p>Percona XtraBackup 8.0.35-31 Update (2024-09-20)</p> </li> <li> <p>Percona XtraBackup 8.0.35-31 (2024-06-20)</p> </li> <li> <p>Percona XtraBackup 8.0.35-30 (2023-12-04)</p> </li> <li> <p>Percona XtraBackup 8.0.34-29 (2023-08-21)</p> </li> <li> <p>Percona XtraBackup 8.0.33-28 (2023-07-19)</p> </li> <li> <p>Percona XtraBackup 8.0.33-27 (2023-05-25)</p> </li> <li> <p>Percona XtraBackup 8.0.32-26 (2023-04-04)</p> </li> <li> <p>Percona XtraBackup 8.0.32-25 (2023-02-27)</p> </li> <li> <p>Percona XtraBackup 8.0.31-24 (2023-02-07)</p> </li> <li> <p>Percona XtraBackup 8.0.30-23 (2022-11-14)</p> </li> <li> <p>Percona XtraBackup 8.0.29-22 (2022-07-19)</p> </li> <li> <p>Percona XtraBackup 8.0.28-21 (2022-05-25)</p> </li> <li> <p>Percona XtraBackup 8.0.28-20.0 (2022-04-26)</p> </li> <li> <p>Percona Xtrabackup 8.0.27-19.0 (2022-02-02)</p> </li> <li> <p>Percona XtraBackup 8.0.26-18.0 (2021-09-02)</p> </li> <li> <p>Percona Xtrabackup 8.0.25-17.0 (2021-06-03)</p> </li> <li> <p>Percona XtraBackup 8.0.23-16.0 (2021-03-22)</p> </li> <li> <p>Percona Xtrabackup 8.0.22-15.0 (2020-12-14)</p> </li> <li> <p>Percona XtraBackup 8.0.14 (2020-08-31)</p> </li> <li> <p>Percona Xtrabackup 8.0.13 (2020-06-17)</p> </li> <li> <p>Percona XtraBackup 8.0.12 (2020-05-27)</p> </li> <li> <p>Percona Xtrabackup 8.0.11 (2020-04-13)</p> </li> <li> <p>Percona XtraBackup 8.0.10 (2020-03-16)</p> </li> <li> <p>Percona Xtrabackup 8.0.9 (2019-12-16)</p> </li> <li> <p>Percona XtraBackup 8.0.8 (2019-11-21)</p> </li> <li> <p>Percona Xtrabackup 8.0.7 (2019-08-07)</p> </li> <li> <p>Percona Xtrabackup 8.0.6 (2019-05-09)</p> </li> <li> <p>Percona XtraBackup 8.0.5 (2019-03-04)</p> </li> <li> <p>Percona Xtrabackup 8.0.4 (2018-12-10)</p> </li> <li> <p>Percona XtraBackup 8.0-3-rc1 (2018-10-31)</p> </li> </ul> <p></p>"},{"location":"release-notes.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"restore-a-backup.html","title":"Restore a backup","text":"<p>Warning</p> <p>Backup needs to be prepared before it can be restored.</p> <p>For convenience, xtrabackup binary has the <code>--copy-back</code> option to copy the backup to the datadir of the server:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backups/\n</code></pre> <p>If you don\u2019t want to save your backup, you can use the <code>--move-back</code> option which will move the backed up data to the datadir.</p> <p>If you don\u2019t want to use any of the above options, you can additionally use rsync or cp to restore the files.</p> <p>Note</p> <p>The datadir must be empty before restoring the backup. Also, it\u2019s important to note that MySQL server needs to be shut down before restore is performed. You cannot restore to a datadir of a running mysqld instance (except when importing a partial backup).</p> <p>Example of the rsync command that can be used to restore the backup can look like this:</p> <pre><code>$ rsync -avrP /data/backup/ /var/lib/mysql/\n</code></pre> <p>You should check that the restored files have the correct ownership and permissions.</p> <p>As files\u2019 attributes will be preserved, in most cases you will need to change the files\u2019 ownership to <code>mysql</code> before starting the database server, as they will be owned by the user who created the backup:</p> <pre><code>$ chown -R mysql:mysql /var/lib/mysql\n</code></pre> <p>Data is now restored, and you can start the server.</p> <p></p>"},{"location":"restore-a-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"restore-individual-partitions.html","title":"Restore the partition from the backup","text":"<p>Restoring should be done by importing the tables in the partial backup to the server.</p> <p>First step is to create new table in which data will be restored.</p> <pre><code>mysql&gt; CREATE TABLE `name_p4` (\n`id` int(11) NOT NULL AUTO_INCREMENT,\n`name` text NOT NULL,\n`imdb_index` varchar(12) DEFAULT NULL,\n`imdb_id` int(11) DEFAULT NULL,\n`name_pcode_cf` varchar(5) DEFAULT NULL,\n`name_pcode_nf` varchar(5) DEFAULT NULL,\n`surname_pcode` varchar(5) DEFAULT NULL,\nPRIMARY KEY (`id`)\n) ENGINE=InnoDB AUTO_INCREMENT=2812744 DEFAULT CHARSET=utf8\n</code></pre> <p>Note</p> <p>Generate a .cfg metadata file by running <code>FLUSH TABLES ... FOR EXPORT</code>. The command can only be run on a table, not on the individual table partitions. The file is located in the table schema directory and is used for schema verification when importing the tablespace. </p> <p>To restore the partition from the backup, the tablespace must be discarded for that table:</p> <pre><code>mysql&gt; ALTER TABLE name_p4 DISCARD TABLESPACE;\n</code></pre> <p>The next step is to copy the <code>.ibd</code> file from the backup to the MySQL data directory:</p> <pre><code>cp /mnt/backup/2012-08-28_10-29-09/imdb/name#P#p4.ibd /var/lib/mysql/imdb/name_p4.ibd\n</code></pre> <p>Note</p> <p>Make sure that the copied files can be accessed by the user running MySQL. </p> <p>The last step is to import the tablespace:</p> <pre><code>mysql&gt; ALTER TABLE name_p4 IMPORT TABLESPACE;\n</code></pre> <p></p>"},{"location":"restore-individual-partitions.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"restore-individual-tables.html","title":"Restore individual tables","text":"<p>Percona XtraBackup can export individual tables from any InnoDB database, if they are individual <code>.ibd</code> files, and import them into Percona Server for MySQL with XtraDB or MySQL 8.0. The source doesn\u2019t have to be XtraDB or MySQL 8.0, but the destination must be.</p> <p>The example exports and imports the following table:</p> <pre><code>CREATE TABLE export_test (\na int(11) DEFAULT NULL\n) ENGINE=InnoDB DEFAULT CHARSET=latin1;\n</code></pre>"},{"location":"restore-individual-tables.html#export-the-table","title":"Export the table","text":"<p>To generate an <code>.ibd</code> file in the target directory, create the table using the <code>innodb_file_per_table</code> mode:</p> <pre><code>$ find /data/backups/mysql/ -name export_test.*\n/data/backups/mysql/test/export_test.ibd\n</code></pre> <p>During the <code>--prepare</code> step, add the \u2013export option to the command. For example:</p> <pre><code>$ xtrabackup --prepare --export --target-dir=/data/backups/mysql/\n</code></pre> <p>When restoring an encrypted InnoDB tablespace table, add the keyring file:</p> <pre><code>$ xtrabackup --prepare --export --target-dir=/tmp/table \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>The following files are the only files required to import the table into a server running Percona Server for MySQL with XtraDB or MySQL 8.0. If the server uses InnoDB Tablespace Encryption, add the <code>.cfp</code> file, which contains the transfer key and an encrypted tablespace key.</p> <p>The files are located in the target directory:</p> <pre><code>/data/backups/mysql/test/export_test.ibd\n/data/backups/mysql/test/export_test.cfg\n</code></pre>"},{"location":"restore-individual-tables.html#import-the-table","title":"Import the table","text":"<p>Import the table by doing the following:</p> <ul> <li>Create a copy of the table</li> <li>Discard the table\u2019s original tablespace</li> <li>Copy the <code>.ibd</code> and <code>.cfg</code> files to the location</li> <li>Import the tablespace</li> </ul> <p>To import that table, do the following steps:</p> <ol> <li> <p>On the destination server, running Percona Server for MySQL with XtraDB or MySQL 8.0, create a table with the same structure.</p> </li> <li> <p>Run the <code>ALTER TABLE ... DISCARD TABLESPACE</code> command to discard the new table\u2019s tablespace:</p> <pre><code>mysql&gt; ALTER TABLE test.export_test DISCARD TABLESPACE;\n</code></pre> <p>If you see the an error message like \u201cERROR 1809 (HY000): Table \u2018test/export_test\u2019 in system tablespace\u201d, enable the <code>innodb_file_per_table</code> option on the server and do step 1 and 2 again.</p> </li> <li> <p>Copy the exported files to the <code>test/</code> subdirectory of the destination server\u2019s data directory.</p> </li> <li> <p>Run <code>ALTER TABLE ... IMPORT TABLESPACE</code>.</p> <pre><code>mysql&gt; ALTER TABLE test.export_test IMPORT TABLESPACE;\n</code></pre> <p>The table is imported, and you can run a <code>SELECT</code> to see the imported data.</p> </li> </ol> <p></p>"},{"location":"restore-individual-tables.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"restore-partial-backup.html","title":"Restore a partial backup","text":"<p>Restoring should be done by restoring individual tables in the partial backup to the server.</p> <p>It can also be done by copying back the prepared backup to a \u201cclean\u201d datadir (in that case, make sure to include the <code>mysql</code> database) to the datadir you are moving the backup to. A system database can be created with the following:</p> <pre><code>$ sudo mysql --initialize --user=mysql\n</code></pre> <p>Once you start the server, you may see mysql complaining about missing tablespaces:</p> Expected output <pre><code>2021-07-19T12:42:11.077200Z 1 [Warning] [MY-012351] [InnoDB] Tablespace 4, name 'test1/t1', file './d2/test1.ibd' is missing!\n2021-07-19T12:42:11.077300Z 1 [Warning] [MY-012351] [InnoDB] Tablespace 4, name 'test1/t1', file './d2/test1.ibd' is missing!\n</code></pre> <p>In order to clean the orphan database from the data dictionary, you must manually create the missing database directory and then <code>DROP</code> this database from the server.</p> <p>Example of creating the missing database:</p> <pre><code>$ mkdir /var/lib/mysql/test1/d2\n</code></pre> <p>Example of dropping the database from the server:</p> <pre><code>mysql&gt; DROP DATABASE d2;\n</code></pre> Expected output <pre><code>Query OK, 2 rows affected (0.5 sec)\n</code></pre> <p></p>"},{"location":"restore-partial-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"server-backup-version-comparison.html","title":"Percona XtraBackup Version Compatibility and Server Version Checks","text":"<p>When the server undergoes internal changes, such as modifying the structure of the redo log records, older versions of Percona XtraBackup may either fail or produce corrupted backups. To prevent these issues, XtraBackup checks the version of the source system before starting the backup and compares it to the Percona XtraBackup version.</p> <p>Here are the possible scenarios and the actions taken:</p> Scenario Actions Taken Server version is the same as Percona XtraBackup version The backup process continues without any issues. This is the ideal scenario because both the server and the backup tool are fully compatible. Server version is older than Percona XtraBackup version The backup process continues without any issues. Percona XtraBackup is designed to handle older versions of the server without problems. Server version is newer than Percona XtraBackup version The backup process stops with an error unless you explicitly override the version check. This happens because the backup tool may not support new features or changes introduced in the newer server version. Server version is newer than Percona XtraBackup version, and the version check is overridden The backup process continues, but there is a risk of failure or corruption. Overriding the version check can be risky because the backup tool might not be able to handle new features or changes correctly. <p>Until version 8.0.34, to ensure successful backups and restores, it is recommended to use a Percona XtraBackup version that matches or is newer than your server version. However, version 8.0.34 can back up newer server versions and older server versions if you set the <code>lock-ddl=ON</code> option.</p>"},{"location":"server-backup-version-comparison.html#version-updates","title":"Version updates","text":"<p>Percona XtraBackup 8.0.34: disabled the server-version-check.</p> <p>Percona XtraBackup 8.0.22-15: introduced <code>--no-server-version-check</code>. This option allows you to override the version comparison process. This option is off by default, meaning the comparison occurs unless explicitly overridden.</p>"},{"location":"server-backup-version-comparison.html#override-server-version-check","title":"Override Server Version check","text":"<p>You can add the <code>--no-server-version-check</code> option to your backup command to override the server version check and proceed with the backup. Here\u2019s an example of how to use this option:</p> <pre><code>$ xtrabackup --backup --no-server-version-check --target-dir=$mysql/backup1\n</code></pre>"},{"location":"server-backup-version-comparison.html#additional-resources","title":"Additional resources","text":"<p>For more details, refer to the documentation on How XtraBackup Works.</p> <p>For more information, refer to Supported versions.</p> <p></p>"},{"location":"server-backup-version-comparison.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"set-up-replication.html","title":"How to set up a replica for replication in 6 simple steps with Percona XtraBackup","text":"<p>Data is, by far, the most valuable part of a system. Having a backup done systematically and available for a rapid recovery in case of failure is admittedly essential to a system. However, it is not common practice because of its costs, infrastructure needed or even the boredom associated to the task. Percona XtraBackup is designed to solve this problem.</p> <p>You can have almost real-time backups in 6 simple steps by setting up a replication environment with Percona XtraBackup.</p>"},{"location":"set-up-replication.html#all-the-things-you-will-need","title":"All the things you will need","text":"<p>Setting up a replica for replication with Percona XtraBackup is a straightforward procedure. In order to keep it simple, here is a list of the things you need to follow the steps without hassles:</p> <p><code>Source</code></p> <p>A system with a MySQL-based server installed, configured and running. This system will be called <code>Source</code>, as it is where your data is stored and the one to be replicated. We will assume the following about this system:</p> <ul> <li> <p>the MySQL server is able to communicate with others by the standard TCP/IP port;</p> </li> <li> <p>the SSH server is installed and configured;</p> </li> <li> <p>you have a user account in the system with the appropriate permissions;</p> </li> <li> <p>you have a MySQL\u2019s user account with appropriate privileges.</p> </li> <li> <p>server has binlogs enabled and server-id set up to 1.</p> </li> </ul> <p><code>Replica</code></p> <p>Another system, with a MySQL-based server installed on it. We will refer to this machine as <code>Replica</code> and we will assume the same things we did about <code>Source</code>, except that the server-id on <code>Replica</code> is 2.</p> <p><code>Percona XtraBackup</code></p> <p>The backup tool we will use. It should be installed in both computers for convenience.</p> <p>Note</p> <p>It is not recommended to mix MySQL variants (Percona Server, MySQL) in your replication setup. This may produce incorrect <code>xtrabackup_slave_info</code> file when adding a new replica. </p>"},{"location":"set-up-replication.html#version-updates","title":"Version updates","text":"<p>The 8.0.23 version deprecates the <code>CHANGE_MASTER_TO</code> command. In that  version and later, use the CHANGE_REPLICATION_SOURCE_TO and the appropriate options instead.</p> <p>The 8.0.22 version deprecates the<code>START SLAVE</code> command. In that version or  later, use <code>START REPLICA</code> instead.</p>"},{"location":"set-up-replication.html#1-make-a-backup-on-the-source-and-prepare-it","title":"1. Make a backup on the <code>Source</code> and prepare it","text":"<p>At the  <code>Source</code>, issue the following to a shell:</p> <pre><code>$ xtrabackup --backup --user=yourDBuser --password=MaGiCdB1 --target-dir=/path/to/backupdir\n</code></pre> <p>After this is finished you should get:</p> Expected output <pre><code>xtrabackup: completed OK!\n</code></pre> <p>This will make a copy of your MySQL data dir to the <code>/path/to/backupdir</code> directory. You have told Percona XtraBackup to connect to the database server using your database user and password, and do a hot backup of all your data in it (all MyISAM, InnoDB tables and indexes in them).</p> <p>In order for snapshot to be consistent you need to prepare the data on the source:</p> <pre><code>$ xtrabackup --prepare --target-dir=/path/to/backupdir\n</code></pre> <p>You need to select path where your snapshot has been taken. If everything is ok you should get the same OK message. Now the transaction logs are applied to the data files, and new ones are created: your data files are ready to be used by the MySQL server.</p> <p>Percona XtraBackup knows where your data is by reading your my.cnf file. If you have your configuration file in a non-standard place, you should use the flag <code>--defaults-file</code> <code>=/location/of/my.cnf</code>.</p> <p>If you want to skip writing the username and password every time you want to access MySQL, you can set it up in <code>.mylogin.cnf</code> as follows:</p> <pre><code>mysql_config_editor set --login-path=client --host=localhost --user=root --password\n</code></pre> <p>For more information, see MySQL Configuration Utility.</p> <p>This statement provides root access to MySQL.</p>"},{"location":"set-up-replication.html#2-copy-backed-up-data-to-the-replica","title":"2.  Copy backed up data to the Replica","text":"<p>On the Source, use rsync or scp to copy the data from the Source to the Replica. If you are syncing the data directly to replica\u2019s data directory, we recommend that you stop the <code>mysqld</code> there.</p> <pre><code>$ rsync -avpP -e ssh /path/to/backupdir Replica:/path/to/mysql/\n</code></pre> <p>After data has been copied, you can back up the original or previously installed MySQL datadir (NOTE: Make sure mysqld is shut down before you move the contents of its datadir, or move the snapshot into its datadir.). Run the following commands on the Replica:</p> <pre><code>$ mv /path/to/mysql/datadir /path/to/mysql/datadir_bak\n</code></pre> <p>and move the snapshot from the <code>Source</code> in its place:</p> <pre><code>$ xtrabackup --move-back --target-dir=/path/to/mysql/backupdir\n</code></pre> <p>After you copy data over, make sure the Replica MySQL has the proper permissions to access them.</p> <pre><code>$ chown mysql:mysql /path/to/mysql/datadir\n</code></pre> <p>If the ibdata and iblog files are located in directories outside the datadir, you must put these files in their proper place after the logs have been applied.</p>"},{"location":"set-up-replication.html#3-configure-the-sources-mysql-server","title":"3. Configure the Source\u2019s MySQL server","text":"<p>On the source, run the following command to add the appropriate grant. This grant allows the replica to be able to connect to source:</p> <pre><code>mysql&gt; GRANT REPLICATION SLAVE ON *.*  TO 'repl'@'$replicaip'\nIDENTIFIED BY '$replicapass';\n</code></pre> <p>Also make sure that firewall rules are correct and that the <code>Replica</code> can connect to the <code>Source</code>. Run the following command on the Replica to test that you can run the mysql client on <code>Replica</code>, connect to the <code>Source</code>, and authenticate.</p> <pre><code>mysql&gt; mysql --host=Source --user=repl --password=$replicapass\n</code></pre> <p>Verify the privileges.</p> <pre><code>mysql&gt; SHOW GRANTS;\n</code></pre>"},{"location":"set-up-replication.html#4-configure-the-replicas-mysql-server","title":"4. Configure the Replica\u2019s MySQL server","text":"<p>Copy the <code>my.cnf</code> file from the <code>Source</code> to the <code>Replica</code>:</p> <pre><code>$ scp user@Source:/etc/mysql/my.cnf /etc/mysql/my.cnf\n</code></pre> <p>and change the following options in /etc/mysql/my.cnf:</p> <pre><code>server-id=2\n</code></pre> <p>and start/restart mysqld on the <code>Replica</code>.</p> <p>In case you\u2019re using init script on Debian-based system to start mysqld, be sure that the password for <code>debian-sys-maint</code> user has been updated, and it\u2019s the same as that user\u2019s password on the <code>Source</code>. Password can be seen and updated in <code>/etc/mysql/debian.cnf</code>.</p>"},{"location":"set-up-replication.html#5-start-the-replication","title":"5. Start the replication","text":"<p>On the <code>Replica</code>, review the content of the file <code>xtrabackup_binlog_info</code>, it will be something like:</p> <pre><code>$ cat /var/lib/mysql/xtrabackup_binlog_info\n</code></pre> <p>The results should resemble the following:</p> Expected output <pre><code>Source-bin.000001     481\n</code></pre> <p>The term <code>master</code> is deprecated. Do the following on a  MySQL console and use the username and password you\u2019ve set up in STEP 3 :</p> <ul> <li> <p>Version 8.0.23 or later, use the <code>CHANGE_REPLICATION_SOURCE_TO</code> statement</p> </li> <li> <p>Before 8.0.23, use the <code>CHANGE MASTER</code> statement</p> </li> </ul> <pre><code>CHANGE REPLICATION SOURCE TO\n    SOURCE_HOST='$sourceip',\n    SOURCE_USER='repl',\n    SOURCE_PASSWORD='$replicapass',\n    SOURCE_LOG_FILE='Source-bin.000001',\n    SOURCE_LOG_POS=481;\n</code></pre> <p>Start the replica:</p> <pre><code>START REPLICA;\n</code></pre> <p>The term <code>slave</code> is deprecated. Do the following:</p> <ul> <li>Version 8.0.22 or later, use <code>START REPLICA</code></li> <li>Before version 8.0.22, use <code>START SLAVE</code></li> </ul>"},{"location":"set-up-replication.html#6-check","title":"6. Check","text":"<p>On the <code>Replica</code>, check that everything went OK with:</p> <pre><code>SHOW REPLICA STATUS\\G\n</code></pre> <p>The result shows the status:</p> Expected output <pre><code>Slave_IO_Running: Yes\nSlave_SQL_Running: Yes\nSeconds_Behind_Master: 13\n</code></pre> <p>Both <code>IO</code> and <code>SQL</code> threads need to be running. The <code>Seconds_Behind_Master</code> means the <code>SQL</code> currently being executed has a <code>current_timestamp</code> of 13 seconds ago. It is an estimation of the lag between the <code>Source</code> and the <code>Replica</code>. Note that at the beginning, a high value could be shown because the <code>Replica</code> has to \u201ccatch up\u201d with the <code>Source</code>.</p>"},{"location":"set-up-replication.html#adding-more-replicas-to-the-source","title":"Adding more replicas to the Source","text":"<p>You can use this procedure with slight variation to add new replicas to a source. We will use Percona XtraBackup to clone an already configured replica. We will continue using the previous scenario for convenience, but we will add a <code>NewReplica</code> to the plot.</p> <p>At the <code>Replica</code>, do a full backup:</p> <pre><code>$ xtrabackup --user=yourDBuser --password=MaGiCiGaM \\\n   --backup --slave-info --target-dir=/path/to/backupdir\n</code></pre> <p>By using the <code>--slave-info</code> Percona XtraBackup creates additional file called <code>xtrabackup_slave_info</code>.</p> <p>Apply the logs:</p> <pre><code>$ xtrabackup --prepare --use-memory=2G --target-dir=/path/to/backupdir/\n</code></pre> <p>Note</p> <p>In the <code>prepare</code> phase, the <code>--use-memory</code> parameter speeds up the process if the amount of RAM assigned to the option is available. Use the parameter only in the <code>prepare</code> phase. In the other phases the parameter makes the application lazy allocate this memory (reserve) but does not affect database pages.</p> <p>Copy the directory from the <code>Replica</code> to the <code>NewReplica</code> (NOTE: Make sure mysqld is shut down on the <code>NewReplica</code> before you copy the contents the snapshot into its datadir.):</p> <pre><code>rsync -avprP -e ssh /path/to/backupdir NewReplica:/path/to/mysql/datadir\n</code></pre> <p>For example, to set up a new user, <code>user2</code>, you add another grant on the Source:</p> <pre><code>&gt; GRANT REPLICATION SLAVE ON *.*  TO 'user2'@'$newreplicaip'\n IDENTIFIED BY '$replicapass';\n</code></pre> <p>On the <code>NewReplica</code>, copy the configuration file from the <code>Replica</code>:</p> <pre><code>$ scp user@Replica:/etc/mysql/my.cnf /etc/mysql/my.cnf\n</code></pre> <p>Make sure you change the server-id variable in <code>/etc/mysql/my.cnf</code> to 3 and disable the replication on start:</p> <pre><code>skip-slave-start\nserver-id=3\n</code></pre> <p>After setting <code>server_id</code>, start mysqld.</p> <p>Fetch the master_log_file and master_log_pos from the file <code>xtrabackup_slave_info</code>, execute the statement for setting up the source and the log file for the NewReplica:</p> <pre><code>&gt; CHANGE MASTER TO\n     MASTER_HOST='$Sourceip',\n     MASTER_USER='repl',\n     MASTER_PASSWORD='$replicapass',\n     MASTER_LOG_FILE='Source-bin.000001',\n     MASTER_LOG_POS=481;\n</code></pre> <p>The term <code>master</code> is deprecated. Do the following  and then start the replica:</p> <ul> <li> <p>Version 8.0.23 or later, use the <code>CHANGE_REPLICATION_SOURCE_TO</code> statement</p> </li> <li> <p>Before 8.0.23, use the <code>CHANGE MASTER</code> statement</p> </li> </ul> <p>The term <code>slave</code> is deprecated. Do the following:</p> <ul> <li>Version 8.0.22 or later, use <code>START REPLICA</code>.</li> <li>Before version 8.0.22, use <code>START SLAVE</code></li> </ul> <pre><code>&gt; START REPLICA;\n</code></pre> <p>If both IO and SQL threads are running when you check the <code>NewReplica</code>, server is replicating the <code>Source</code>.</p> <p>See also</p> <p>How to create a new (or repair a broken) GTID based slave</p> <p></p>"},{"location":"set-up-replication.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"smart-memory-estimation.html","title":"Smart memory estimation","text":"<p>The Smart memory estimation is tech preview feature. Before using Smart memory estimation in production, we recommend that you test restoring production from physical backups in your environment and also use the alternative backup method for redundancy.</p> <p>Percona XtraBackup 8.0.30-23 adds support for the Smart memory estimation feature. With this feature, Percona XtraBackup computes the memory required for <code>prepare</code> phase, while copying redo log entries during the <code>backup</code> phase. Percona XtraBackup also considers the number of InnoDB pages to be fetched from the disk.  </p> <p>Percona XtraBackup performs the backup procedure in two steps: </p> <ul> <li> <p>Creates a backup</p> <p>To create a backup, Percona XtraBackup copies your InnoDB data files. While copying the files, Percona XtraBackup runs a background process that watches the InnoDB redo log, also called the transaction log, and copies changes from it. </p> </li> <li> <p>Prepares a backup</p> <p>During the <code>prepare</code> phase, Percona XtraBackup performs crash recovery against the copied data files using the copied transaction log file. Percona XtraBackup reads all the redo log entries into memory, categorizes them by space id and page id, reads the relevant pages into memory, and checks the log sequence number (LSN) on the page and on the redo log record. If the redo log LSN is more recent than the page LSN, Percona XtraBackup applies the redo log changes to the page.</p> <p>To <code>prepare</code> a backup, Percona Xtrabackup uses InnoDB Buffer Pool memory. Percona Xtrabackup reserves memory to load 256 pages into the buffer pool. The remaining memory is used for hashing/categorizing the redo log entries.</p> <p>The available memory is controlled by the \u2013use-memory option. If the available memory on the buffer pool is insufficient, the work is performed in multiple batches. After the batch is processed, the memory is freed to release space for the next batch. This process greatly impacts performance as an InnoDB page holds data from multiple rows. If a change on a page happens in different batches, that page is fetched and evicted numerous times.</p> </li> </ul>"},{"location":"smart-memory-estimation.html#how-does-smart-memory-estimation-work","title":"How does Smart memory estimation work","text":"<p>In the <code>prepare</code> phase, Percona XtraBackup checks the server\u2019s available free memory and uses that memory up to the limit specified in the <code>--use-free-memory-pct</code> option to run <code>--prepare</code>. Due to backward compatibility, the default value for the <code>--use-free-memory-pct</code> option is 0 (zero), which defines the option as disabled. For example, if you set <code>--use-free-memory-pct=50</code>, then 50% of the free memory is used to <code>prepare</code> a backup.</p> <p>Starting with Percona XtraBackup 8.0.32-26, you can enable or disable the memory estimation during the <code>backup</code> phase with the <code>--estimate-memory</code> option. The default value is <code>OFF</code>. Enable the memory estimation with  <code>--estimate-memory=ON</code>:</p> <pre><code>$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/\n</code></pre> <p>In the <code>prepare</code> phase, enable the \u2013use-free-memory-pct option by specifying the percentage of free memory to be used to <code>prepare</code> a backup. The \u2013use-free-memory-pct value must be larger than 0.</p> <p>For example:</p> <pre><code>$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/\n</code></pre>"},{"location":"smart-memory-estimation.html#example-of-smart-memory-estimation-usage","title":"Example of Smart memory estimation usage","text":"<p>The examples of how Smart memory estimation can improve the time spent on <code>prepare</code> in different versions of Percona XtraBackup:</p> In Percona XtraBackup 8.0.32-26 and higherIn Percona XtraBackup 8.0.30-23 and higher <p>We back up 16, 32, and 64 tables using sysbench. Each set contains 1M rows. In the <code>backup</code> phase, we enable Smart memory estimation with <code>--estimate-memory=ON</code>. In the <code>prepare</code> phase, we set <code>--use-free-memory-pct=50</code>, and Percona XtraBackup uses 50% of the free memory to prepare a backup. The backup is run on an ec2 c4.8xlarge instance (36 vCPUs / 60GB memory / General Purpose SSD (gp2)). </p> <p>We back up 16, 32, and 64 tables using sysbench. Each set contains 1M rows. In the <code>prepare</code> phase, we set <code>--use-free-memory-pct=50</code>, and Percona XtraBackup uses 50% of the free memory to prepare a backup. The backup is run on an ec2 c4.8xlarge instance (36 vCPUs / 60GB memory / General Purpose SSD (gp2)). </p> <p>During each <code>--backup</code>, the following sysbench is run:</p> <pre><code>sysbench --db-driver=mysql --db-ps-mode=disable --mysql-user=sysbench --mysql-password=sysbench --table_size=1000000 --tables=${NUM_OF_TABLES} --threads=24 --time=0 --report-interval=1 /usr/share/sysbench/oltp_write_only.lua run\n</code></pre> <p>The following table shows the backup details (all measurements are in Gigabytes):</p> Used memory Size of XtraBackup log Size of backup 16 tables 3.375 0.7 4.7 32 tables 8.625 2.6 11 64 tables 18.5 5.6 22 <ul> <li> <p>Used memory - the amount of memory required by Percona XtraBackup with <code>--use-free-memory-pct=50</code></p> </li> <li> <p>Size of XtraBackup log - the size of Percona XtraBackup log file (redo log entries copied during the backup)</p> </li> <li> <p>Size of backup - the size of the resulting backup folder</p> </li> </ul> <p><code>Prepare</code> executed without Smart memory estimation uses the default of 128MB for the buffer pool.</p> <p>The results are the following:</p> <p>Note</p> <p>The following results are based on tests in a specific environment. Your results may vary.</p> <p></p> <ul> <li> <p>16 tables result - prepare time dropped to ~5.7% of the original time. An improvement in recovery time of about 17x.</p> </li> <li> <p>32 tables result - prepare time dropped to ~8,2% of the original time. An improvement in recovery time of about 12x.</p> </li> <li> <p>64 tables result - prepare time dropped to ~9.9% of the original time. An improvement in recovery time of about 10x.</p> </li> </ul> <p></p>"},{"location":"smart-memory-estimation.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"store-backup-history.html","title":"Store backup history on the server","text":"<p>Percona XtraBackup supports storing the backups history on the server to provide users with additional information about backups that are being taken. Backup history information is in the PERCONA_SCHEMA.XTRABACKUP_HISTORY table.</p> <p>To use this feature the following options are available:</p> <ul> <li> <p>\u2013history = &lt;name&gt; : This option enables the history feature and allows the user to specify a backup series name that will be placed within the history record.</p> </li> <li> <p>\u2013incremental-history-name =&lt;name&gt; : This option allows an incremental backup to be made based on a specific history series by name. xtrabackup will search the history table looking for the most recent (highest <code>to_lsn</code>) backup in the series and take the <code>to_lsn</code> value to use as it\u2019s starting lsn. This is mutually exclusive with \u2013incremental-history-uuid, \u2013incremental-basedir and \u2013incremental-lsn options. If no valid LSN can be found (no series by that name) xtrabackup will return with an error.</p> </li> <li> <p>\u2013incremental-history-uuid =&lt;uuid&gt; : Allows an incremental backup to be made based on a specific history record identified by UUID. xtrabackup will search the history table looking for the record matching UUID and take the <code>to_lsn</code> value to use as it\u2019s starting LSN. This options is mutually exclusive with \u2013incremental-basedir, \u2013incremental-lsn and \u2013incremental-history-name options. If no valid LSN can be found (no record by that UUID or missing <code>to_lsn</code>), xtrabackup will return with an error.</p> </li> </ul> <p>Note</p> <p>Backup that\u2019s currently being performed will NOT exist in the xtrabackup_history table within the resulting backup set as the record will not be added to that table until after the backup has been taken.</p> <p>If you want access to backup history outside of your backup set in the case of some catastrophic event, you will need to either perform a <code>mysqldump</code>, partial backup or <code>SELECT</code> * on the history table after xtrabackup completes and store the results with you backup set.</p> <p>For the necessary privileges, see Permissions and Privileges Needed.</p>"},{"location":"store-backup-history.html#percona_schemaxtrabackup_history-table","title":"PERCONA_SCHEMA.XTRABACKUP_HISTORY table","text":"<p>This table contains the information about the previous server backups. Information about the backups will only be written if the backup was taken with \u2013history option.</p> Column Name Description uuid Unique backup id name User provided name of backup series. There may be multiple entries with the same name used to identify related backups in a series. tool_name Name of tool used to take backup tool_command Exact command line given to the tool with \u2013password and \u2013encrypt_key obfuscated tool_version Version of tool used to take backup ibbackup_version Version of the xtrabackup binary used to take backup server_version Server version on which backup was taken start_time Time at the start of the backup end_time Time at the end of the backup lock_time Amount of time, in seconds, spent calling and holding locks for <code>FLUSH TABLES WITH READ LOCK</code> binlog_pos Binary log file and position at end of <code>FLUSH TABLES WITH READ LOCK</code> innodb_from_lsn LSN at beginning of backup which can be used to determine prior backups innodb_to_lsn LSN at end of backup which can be used as the starting lsn for the next incremental partial Is this a partial backup, if <code>N</code> that means that it\u2019s the full backup incremental Is this an incremental backup format Description of result format (<code>xbstream</code>) compressed Is this a compressed backup encrypted Is this an encrypted backup"},{"location":"store-backup-history.html#limitations","title":"Limitations","text":"<ul> <li> <p>\u2013history option must be specified only on the command line and not within a configuration file in order to be effective.</p> </li> <li> <p>\u2013incremental-history-name and \u2013incremental-history-uuid options must be specified only on the command line and not within a configuration file in order to be effective.</p> </li> </ul> <p></p>"},{"location":"store-backup-history.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"supported-versions.html","title":"Supported versions","text":"<p>Percona XtraBackup 8.0.34-29 supports backing up databases compatible with server version 8.0.34 and later. Percona XtraBackup 8.0.34-29 can create backups of older server versions if specific conditions are met. This capability is useful for maintaining compatibility and ensuring backups can be performed across different server versions. You might need to override server version check and set specific options, such as <code>lock-ddl=ON</code>.</p> <p>Specifically, Percona XtraBackup 8.0.35-31 supports taking backups of the following MySQL-compatible databases:</p> <ul> <li> <p>Percona Server for MySQL 8.0.34, and MySQL 8.0.34</p> </li> <li> <p>Percona Server for MySQL 8.0.35, and MySQL 8.0.35</p> </li> <li> <p>Percona Server for MySQL 8.0.36 and MySQL 8.0.36 (and any later versions in the 8.0 series)</p> </li> </ul> <p>For more information, see Percona XtraBackup Version Compatibility and Server Version Checks.</p> <p>For details on the backup process, see How XtraBackup Works.</p> <p></p>"},{"location":"supported-versions.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"take-streaming-backup.html","title":"Take a streaming backup","text":"<p>Percona XtraBackup supports streaming mode. Streaming mode sends a backup to <code>STDOUT</code> in the xbstream format instead of copying the files to the backup directory.</p> <p>This method enables you to utilize other programs to filter the backup output, enhancing flexibility in backup storage. For instance, compression can be achieved by directing the output to a compression utility. One advantage of streaming backups and employing Unix pipes is that backups can be automatically encrypted.</p>"},{"location":"take-streaming-backup.html#version-changes","title":"Version changes","text":"<ul> <li> <p>Starting with Percona XtraBackup 8.0.33-28, the <code>--stream</code> option does not require an <code>xbstream</code> parameter. The <code>xbstream</code> parameter is optional.</p> </li> <li> <p>Using <code>--encrypt</code> might create larger backups than expected when used with InnoDB Page Compression.</p> <p>To avoid this issue with compressed backups, use the <code>--compress</code> option with the <code>--xbstream</code> option in Percona XtraBackup 8.0.31-24 and later.</p> </li> </ul>"},{"location":"take-streaming-backup.html#use-streaming","title":"Use streaming","text":"<p>To utilize the streaming feature, you need to employ the <code>--stream</code> option, specifying the stream format (xbstream). Specifying the stream format (xbstream) is optional, starting with Percona XtraBackup 8.0.33-28.</p> <pre><code>$ xtrabackup --stream=xbstream\n</code></pre> <p>xtrabackup uses xbstream to stream all of the data files to <code>STDOUT</code>, in a special <code>xbstream</code> format. After all data is streamed, xtrabackup stops and also streams the saved transaction log.</p> <p>When compression is enabled, xtrabackup compresses the output data, except for the metadata, using the specified compression algorithm. Read about the supported compression algorithms in the Create a compressed backup document.</p> <p>With xbstream, backups can be copied and compressed simultaneously, significantly speeding up the process. However, if backups are both compressed and encrypted, they need to be decrypted before uncompressing.</p> Task Command Stream the backup into an archive named <code>backup.xbstream</code> <code>xtrabackup --backup --stream=xbstream &gt; backup.xbstream</code> Stream the backup into a compressed archive named <code>backup.xbstream</code> <code>xtrabackup --backup --stream=xbstream --compress &gt; backup.xbstream</code> Encrypt the backup <code>xtrabackup --backup --stream=xbstream  \\|gzip \\| openssl des3 -salt -k 'password' -out backup.xbstream.gz.des3</code> Unpack the backup to the current directory <code>xbstream -x &lt;  backup.xbstream</code> Send the backup compressed directly to another host and unpack it <code>xtrabackup --backup --compress --stream=xbstream | ssh user@otherhost \"xbstream -x\"</code> Send the backup to another server using <code>netcat</code> On the destination host:<code>nc -l 9999 | cat - &gt; /data/backups/backup.xbstream</code>On the source host:<code>xtrabackup --backup --stream=xbstream | nc desthost 9999</code> Send the backup to another server using a one-liner <code>ssh user@desthost \u201c( nc -l 9999 &gt; /data/backups/backup.xbstream &amp; )\u201d &amp;&amp; xtrabackup --backup --stream=xbstream | nc desthost 9999</code> Throttle the throughput to 10MB/sec using the pipe viewer tool <code>xtrabackup --backup --stream=xbstream | pv -q -L10m ssh user@desthost \u201ccat - &gt; /data/backups/backup.xbstream\u201d</code> Checksum the backup during the streaming On the destination host:<code>nc -l 9999 | tee &gt;(sha1sum &gt; destination_checksum) &gt; /data/backups/backup.xbstream</code>On the source host:<code>xtrabackup --backup --stream=xbstream | tee &gt;(sha1sum &gt; source_checksum) | nc desthost 9999</code>Compare the checksums on the source host:<code>cat source_checksum 65e4f916a49c1f216e0887ce54cf59bf3934dbad</code>Compare the checksums on the destination host:<code>cat destination_checksum 65e4f916a49c1f216e0887ce54cf59bf3934dbad</code> Parallel compression with parallel copying backup <code>xtrabackup --backup --compress --compress-threads=8 --stream=xbstream --parallel=4 &gt; backup.xbstream</code> <p>Important</p> <p>The streamed backup must be prepared before restoration. Streaming mode does not prepare the backup.</p> <p></p>"},{"location":"take-streaming-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"throttling-backups.html","title":"Throttling backups","text":"<p>Although xtrabackup does not block your database\u2019s operation, any backup can add load to the system being backed up. On systems that do not have much spare I/O capacity, it might be helpful to throttle the rate at which xtrabackup reads and writes data. You can do this with the \u2013throttle option. This option limits the number of chunks copied per second. The chunk +size is 10 MB.</p> <p>The image below shows how throttling works when \u2013throttle is set to <code>1</code>.</p> <p></p> <p>When specified with the <code>--backup</code> option, this option limits the number of pairs of read-and-write operations per second that xtrabackup will perform. If you are creating an incremental backup, then the limit is the number of read I/O operations per second.</p> <p>By default, there is no throttling, and xtrabackup reads and writes data as quickly as it can. If you set too strict of a limit on the IOPS, the backup might be so slow that it will never catch up with the transaction logs that InnoDB is writing, so the backup might never complete.</p> <p></p>"},{"location":"throttling-backups.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"toolkit-version-check.html","title":"Percona Toolkit version checking","text":"<p>Some Percona software contains \u201cversion checking\u201d functionality which is a feature that enables Percona software users to be notified of available software updates to improve your environment security and performance. Alongside this, the version check functionality also provides Percona with information relating to which software versions you are running, coupled with the environment confirmation which the software is running within. This helps enable Percona to focus our development effort accordingly based on trends within our customer community.</p> <p>The purpose of this document is to articulate the information that is collected, as well as to provide guidance on how to disable this functionality if desired.</p>"},{"location":"toolkit-version-check.html#usage","title":"Usage","text":"<p>Version Check was implemented in Percona Toolkit 2.1.4, and was enabled by default in version 2.2.1. Currently, it is supported as a <code>--[no]version-check</code> option by a number of tools in Percona Toolkit, Percona XtraBackup, and Percona Monitoring and Management (PMM).</p> <p>When launched with Version Check enabled, the tool that supports this feature connects to a Percona\u2019s version check service via a secure HTTPS channel. It compares the locally installed version for possible updates, and also checks versions of the following software:</p> <ul> <li> <p>Operating System</p> </li> <li> <p>Percona Monitoring and Management (PMM)</p> </li> <li> <p>MySQL</p> </li> <li> <p>Perl</p> </li> <li> <p>MySQL driver for Perl (DBD::mysql)</p> </li> <li> <p>Percona Toolkit</p> </li> </ul> <p>Then it checks for and warns about versions with known problems if they are identified as running in the environment.</p> <p>Each version check request is logged by the server. Stored information consists of the checked system unique ID followed by the software name and version.  The ID is generated either at installation or when the version checking query is submitted for the first time.</p> <p>Note</p> <p>Prior to version 3.0.7 of Percona Toolkit, the system ID was calculated as an MD5 hash of a hostname, and starting from Percona Toolkit 3.0.7 it is generated as an MD5 hash of a random number. Percona XtraBackup continues to use hostname-based MD5 hash.</p> <p>As a result, the content of the sent query is as follows:</p> Expected output <pre><code>85624f3fb5d2af8816178ea1493ed41a;DBD::mysql;4.044\nc2b6d625ef3409164cbf8af4985c48d3;MySQL;MySQL Community Server (GPL) 5.7.22-log\n85624f3fb5d2af8816178ea1493ed41a;OS;Manjaro Linux\n85624f3fb5d2af8816178ea1493ed41a;Percona::Toolkit;3.0.11-dev\n85624f3fb5d2af8816178ea1493ed41a;Perl;5.26.2\n</code></pre>"},{"location":"toolkit-version-check.html#disabling-version-check","title":"Disabling version check","text":"<p>Although the version checking feature does not collect any personal information, you might prefer to disable this feature, either one time or permanently.  To disable it one time, use <code>--no-version-check</code> option when invoking the tool from a Percona product which supports it. Here is a simple example which shows running pt-diskstats tool from the Percona Toolkit with version checking turned off:</p> <pre><code>pt-diskstats --no-version-check\n</code></pre> <p>Disabling version checking permanently can be done by placing <code>no-version-check</code> option into the configuration file of a Percona product (see correspondent documentation for exact file name and syntax). For example, in case of Percona Toolkit this can be done in a global configuration file <code>/etc/percona-toolkit/percona-toolkit.conf</code>:</p> <pre><code># Disable Version Check for all tools:\nno-version-check\n</code></pre> <p>In case of Percona XtraBackup this can be done in its configuration file in a similar way:</p> <pre><code>[xtrabackup]\nno-version-check\n</code></pre>"},{"location":"toolkit-version-check.html#frequently-asked-questions","title":"Frequently asked questions","text":""},{"location":"toolkit-version-check.html#why-is-this-functionality-enabled-by-default","title":"Why is this functionality enabled by default?","text":"<p>We believe having this functionality enabled improves security and performance of environments running Percona Software and it is good choice for majority of the users.</p>"},{"location":"toolkit-version-check.html#why-not-rely-on-operating-systems-built-in-functionality-for-software-updates","title":"Why not rely on Operating System\u2019s built in functionality for software updates?","text":"<p>In many environments the Operating Systems repositories may not carry the latest version of software and newer versions of software often installed manually, so not being covered by operating system wide check for updates.</p>"},{"location":"toolkit-version-check.html#why-do-you-send-more-information-than-just-the-version-of-software-being-run-as-a-part-of-version-check-service","title":"Why do you send more information than just the version of software being run as a part of version check service?","text":"<p>Compatibility problems can be caused by versions of various components in the environment, for example problematic versions of Perl, DBD or MySQL could cause operational problems with Percona Toolkit.</p> <p></p>"},{"location":"toolkit-version-check.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"topic-index.html","title":"Topic index","text":"<ul> <li>About Percona Xtrabackup</li> <li>Accelerate the backup process</li> <li>Analyze table statistics</li> <li> <p>Apt pinning the Percona XtraBackup 8.0 packages</p> </li> <li> <p>Binary tarball file names available</p> </li> <li> <p>Compile and install Percona XtraBackup 8.0 from source</p> </li> <li>Configure xtrabackup</li> <li>Connection and privileges needed</li> <li>Copyright and licensing information</li> <li>Create a compressed backup</li> <li> <p>Create a full backup</p> </li> <li> <p>Create an incremental backup</p> </li> <li>Create an individual partitions backup</li> <li>Create a partial backup</li> <li>Decompress and prepare a compressed backup</li> <li> <p>Dictionary cache</p> </li> <li> <p>Encrypt backups</p> </li> <li>Encrypted InnoDB tablespace backups</li> <li>Error message: Found tables with row versions due to INSTANT ADD/DROP columns</li> <li>Exponential backup</li> <li>FIFO data sink</li> <li>Files in the DEB package built for Percona XtraBackup 8.0</li> <li>Files in the RPM package built for Percona XtraBackup 8.0</li> <li>FLUSH TABLES WITH READ LOCK option</li> <li> <p>Frequently asked questions</p> </li> <li> <p>Glossary</p> </li> <li> <p>Home</p> </li> <li>How Percona XtraBackup works</li> <li>How to create a new (or repair a broken) GTID-based replica</li> <li>How to set up a replica for replication in 6 simple steps with Percona XtraBackup</li> <li>Improved log statements</li> <li>Install Percona XtraBackup 8.0 from a binary tarball</li> <li>Install Percona XtraBackup 8.0 overview</li> <li>Install Percona XtraBackup 8.0 using downloaded DEB packages</li> <li>Install Percona XtraBackup 8.0 using downloaded RPM packages</li> <li> <p>Index of files created by Percona XtraBackup</p> </li> <li> <p>lock-ddl-per-table option improvements</p> </li> <li>LRU dump backup</li> <li> <p>Make backups in replication environments</p> </li> <li> <p>Permissions needed</p> </li> <li> <p>Point-in-time recovery</p> </li> <li> <p>Prepare a full backup</p> </li> <li>Prepare an incremental backup</li> <li>Prepare an individual partitions backup</li> <li> <p>Prepare a partial backup</p> </li> <li> <p>Percona Toolkit version checking</p> </li> <li>Percona XtraBackup binaries overview</li> <li>Quickstart Guide for Percona XtraBackup</li> <li>Release notes index</li> <li>Restore a backup</li> <li>Restore a partial backup</li> <li>Restore individual tables</li> <li> <p>Restore the partition from a backup</p> </li> <li> <p>Run Percona XtraBackup 8.0 in a Docker container</p> </li> <li> <p>Server version and backup version comparison</p> </li> <li> <p>Smart memory estimation</p> </li> <li> <p>Store backup history on the server</p> </li> <li> <p>Take a streaming backup</p> </li> <li>Take an incremental backup using page tracking</li> <li> <p>Throttling backups</p> </li> <li> <p>Trademark policy</p> </li> <li>The xtrabackup option reference</li> <li>The xtrabackup binary overview</li> <li>The xbcloud binary overview</li> <li>Understand version numbers</li> <li>Uninstall Percona XtraBackup 8.0 on Debian and Ubuntu</li> <li>Uninstall Percona XtraBackup 8.0 on Red Hat Enterprise Linux and CentOS</li> <li>Update curl utility</li> <li> <p>Use an APT repository to install Percona XtraBackup 8.0</p> </li> <li> <p>Use the xbcloud binary with Amazon S3</p> </li> <li>Use the xbcloud binary with Google Cloud Storage</li> <li>Use the xbcloud binary with an IAM instance profile</li> <li>Use the xbcloud binary with Microsoft Azure Cloud Storage</li> <li>Use the xbcloud binary with MinIO</li> <li>Use the xbcloud binary with Swift</li> <li>Use a YUM repository to install Percona XtraBackup</li> <li>The xbcrypt binary overview</li> <li>The xbstream binary overview</li> <li>Verify backups with replication and pt-checksum</li> <li>Work with AppArmor</li> <li>Work with binary logs</li> <li> <p>Work with SELinux</p> </li> <li> <p>xtrabackup exit codes</p> </li> <li> <p>xtrabackup implementation details</p> </li> </ul> <p></p>"},{"location":"topic-index.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"trademark-policy.html","title":"Trademark policy","text":"<p>This Trademark Policy is to ensure that users of Percona-branded products or services know that what they receive has really been developed, approved, tested and maintained by Percona. Trademarks help to prevent confusion in the marketplace, by distinguishing one company\u2019s or person\u2019s products and services from another\u2019s.</p> <p>Percona owns a number of marks, including but not limited to Percona, XtraDB, Percona XtraDB, XtraBackup, Percona XtraBackup, Percona Server, and Percona Live, plus the distinctive visual icons and logos associated with these marks. Both the unregistered and registered marks of Percona are protected.</p> <p>Use of any Percona trademark in the name, URL, or other identifying characteristic of any product, service, website, or other use is not permitted without Percona\u2019s written permission with the following three limited exceptions.</p> <p>First, you may use the appropriate Percona mark when making a nominative fair use reference to a bona fide Percona product.</p> <p>Second, when Percona has released a product under a version of the GNU General Public License (\u201cGPL\u201d), you may use the appropriate Percona mark when distributing a verbatim copy of that product in accordance with the terms and conditions of the GPL.</p> <p>Third, you may use the appropriate Percona mark to refer to a distribution of GPL-released  Percona software that has been modified with minor changes for the sole purpose of allowing the software to operate on an operating system or hardware platform for which Percona has not yet released the software, provided that those third party changes do not affect the behavior, functionality, features, design or performance of the software. Users who acquire this Percona-branded software receive substantially exact implementations of the Percona software.</p> <p>Percona reserves the right to revoke this authorization at any time in its sole discretion. For example, if Percona believes that your modification is beyond the scope of the limited license granted in this Policy or that your use of the Percona mark is detrimental to Percona, Percona will revoke this authorization. Upon revocation, you must immediately cease using the applicable Percona mark. If you do not immediately cease using the Percona mark upon revocation, Percona may take action to protect its rights and interests in the Percona mark. Percona does not grant any license to use any Percona mark for any other modified versions of Percona software; such use will require our prior written permission.</p> <p>Neither trademark law nor any of the exceptions set forth in this Trademark Policy permit you to truncate, modify or otherwise use any Percona mark as part of your own brand. For example, if XYZ creates a modified version of the Percona Server, XYZ may not brand that modification as \u201cXYZ Percona Server\u201d or \u201cPercona XYZ Server\u201d, even if that modification otherwise complies with the third exception noted above.</p> <p>In all cases, you must comply with applicable law, the underlying license, and this Trademark Policy, as amended from time to time. For instance, any mention of Percona trademarks should include the full trademarked name, with proper spelling and capitalization, along with attribution of ownership to Percona LLC and/or its affiliates. For example, the full proper name for XtraBackup is Percona XtraBackup. However, it is acceptable to omit the word \u201cPercona\u201d for brevity on the second and subsequent uses, where such omission does not cause confusion.</p> <p>In the event of doubt as to any of the conditions or exceptions outlined in this Trademark Policy, please contact trademarks@percona.com for assistance and we will do our very best to be helpful.</p> <p></p>"},{"location":"trademark-policy.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"update-curl-utility.html","title":"Update curl utility","text":""},{"location":"update-curl-utility.html#update-the-curl-utility-in-debian-10","title":"Update the curl utility in Debian 10","text":"<p>The default curl version, 7.64.0, in Debian 10 has known issues when attempting to reuse an already closed connection. This issue directly affects <code>xbcloud</code> and users may see intermittent backup failures.</p> <p>For more details, see curl #3750 or curl #3763.</p> <p>Follow these steps to upgrade curl to version 7.74.0:</p> <ol> <li> <p>Edit the <code>/etc/apt/sources.list</code> to add the following:</p> <pre><code>deb http://ftp.de.debian.org/debian buster-backports main\n</code></pre> </li> <li> <p>Refresh the <code>apt</code> sources:</p> <pre><code>$ sudo apt update\n</code></pre> </li> <li> <p>Install the version from <code>buster-backports</code>:</p> <pre><code>$ sudo apt install curl/buster-backports\n</code></pre> </li> <li> <p>Verify the version number:</p> <pre><code>$ curl --version\n</code></pre> Expected output <pre><code>curl 7.74.0 (x86_64-pc-linux-gnu) libcurl/7.74.0\n</code></pre> </li> </ol> <p></p>"},{"location":"update-curl-utility.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"verify-backup.html","title":"Verify backups with replication and pt-checksum","text":"<p>One way to verify if the backup is consistent is by setting up the replication and running pt-table-checksum. This can be used to verify any type of backups, but before setting up replication, backup should be prepared and be able to run (this means that incremental backups should be merged to full backups, encrypted backups decrypted etc.).</p>"},{"location":"verify-backup.html#set-up-the-replication","title":"Set up the replication","text":"<p>How to set up a replica for replication in 6 simple steps with Percona XtraBackup guide provides a detailed instructions on how to take the backup and set up the replication.</p> <p>For checking the backup consistency you can use either the original server where the backup was taken, or another test server created by using a different backup method (such as cold backup, mysqldump or LVM snapshots) as the source server in the replication setup.</p>"},{"location":"verify-backup.html#use-pt-table-checksum","title":"Use pt-table-checksum","text":"<p>This tool is part of the Percona Toolkit. It performs an online replication consistency check by executing checksum queries on the source, which produces different results on replicas that are inconsistent with the source.</p> <p>After you confirmed that replication has been set up successfully, you can install or download pt-table-checksum. This example shows downloading the latest version of pt-table-checksum:</p> <pre><code>$ wget percona.com/get/pt-table-checksum\n</code></pre> <p>Note</p> <p>In order for pt-table-checksum to work correctly <code>libdbd-mysql-perl</code> will need to be installed on Debian/Ubuntu systems or <code>perl-DBD-MySQL</code> on RHEL/CentOS. If you installed the percona-toolkit package from the Percona repositories package manager should install those libraries automatically.</p> <p>After this command has been run, pt-table-checksum will be downloaded to your current working directory.</p> <p>Running the pt-table-checksum on the source will create <code>percona</code> database with the <code>checksums</code> table which will be replicated to the replicas as well. Example of the pt-table-checksum will look like this:</p> <pre><code>$ ./pt-table-checksum\n</code></pre> <p>The results are similar to the following:</p> Expected output <pre><code>TS ERRORS  DIFFS     ROWS  CHUNKS SKIPPED    TIME TABLE\n04-30T11:31:50      0      0   633135       8       0   5.400 exampledb.aka_name\n04-30T11:31:52      0      0   290859       1       0   2.692 exampledb.aka_title\nChecksumming exampledb.user_info:  16% 02:27 remain\nChecksumming exampledb.user_info:  34% 01:58 remain\nChecksumming exampledb.user_info:  50% 01:29 remain\nChecksumming exampledb.user_info:  68% 00:56 remain\nChecksumming exampledb.user_info:  86% 00:24 remain\n04-30T11:34:38      0      0 22187768     126       0 165.216 exampledb.user_info\n04-30T11:38:09      0      0        0       1       0   0.033 mysql.time_zone_name\n04-30T11:38:09      0      0        0       1       0   0.052 mysql.time_zone_transition\n04-30T11:38:09      0      0        0       1       0   0.054 mysql.time_zone_transition_type\n04-30T11:38:09      0      0        8       1       0   0.064 mysql.user\n</code></pre> <p>If all the values in the <code>DIFFS</code> column are 0 that means that backup is consistent with the current setup.</p> <p>In case backup was not consistent  pt-table-checksum should spot the difference and point to the table that does not match. Following example shows adding new user on the backed up replica in order to simulate the inconsistent backup:</p> <pre><code>mysql&gt; grant usage on exampledb.* to exampledb@localhost identified by 'thisisnewpassword';\n</code></pre> <p>If we run the pt-table-checksum now difference should be spotted</p> <pre><code>$ ./pt-table-checksum\n</code></pre> <p>The results are similar to the following:</p> Expected output <pre><code>TS ERRORS  DIFFS     ROWS  CHUNKS SKIPPED    TIME TABLE\n04-30T11:31:50      0      0   633135       8       0   5.400 exampledb.aka_name\n04-30T11:31:52      0      0   290859       1       0   2.692 exampledb.aka_title\nChecksumming exampledb.user_info:  16% 02:27 remain\nChecksumming exampledb.user_info:  34% 01:58 remain\nChecksumming exampledb.user_info:  50% 01:29 remain\nChecksumming exampledb.user_info:  68% 00:56 remain\nChecksumming exampledb.user_info:  86% 00:24 remain\n04-30T11:34:38      0      0 22187768     126       0 165.216 exampledb.user_info\n04-30T11:38:09      0      0        0       1       0   0.033 mysql.time_zone_name\n04-30T11:38:09      0      0        0       1       0   0.052 mysql.time_zone_transition\n04-30T11:38:09      0      0        0       1       0   0.054 mysql.time_zone_transition_type\n04-30T11:38:09      1      0        8       1       0   0.064 mysql.user\n</code></pre> <p>This output shows that source and the replica aren\u2019t in consistent state and that the difference is in the <code>mysql.user</code> table.</p> <p>More information on different options that pt-table-checksum provides can be found in the pt-table-checksum documentation.</p> <p></p>"},{"location":"verify-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"work-with-apparmor.html","title":"Work with AppArmor","text":"<p>The Linux Security Module implements mandatory access controls (MAC) with AppArmor. Debian and Ubuntu systems install AppArmor by default. AppArmor uses profiles which define which files and permissions are needed for application.</p> <p>Percona XtraBackup does not have a profile and is not confined by AppArmor.</p> <p>For a list of common AppArmor commands, see Percona Server for MySQL - AppArmor</p>"},{"location":"work-with-apparmor.html#develop-a-profile","title":"Develop a profile","text":"<p>Download the profile from:</p> <p>https://github.com/percona/percona-xtrabackup/tree/8.0/packaging/percona/apparmor/apparmor.d</p> <p>The following profile sections should be updated with your system information, such as location of the backup destination directory.</p> Expected output <pre><code># enable storing backups only in /backups directory\n# /backups/** rwk,\n\n# enable storing backups anywhere in caller user home directory\n/@{HOME}/** rwk,\n\n\n# enable storing backups only in /backups directory\n# /backups/** rwk,\n\n# enable storing backups anywhere in caller user home directory\n/@{HOME}/** rwk,\n}\n\n# enable storing backups only in /backups directory\n# /backups/** rwk,\n\n# enable storing backups anywhere in caller user home directory\n/@{HOME}/** rwk,\n}\n</code></pre> <p>Move the updated file:</p> <pre><code>$ sudo mv usr.sbin.xtrabackup /etc/apparmor.d/\n</code></pre> <p>Install the profile with the following command:</p> <pre><code>$ sudo apparmor_parser -r -T -W /etc/apparmor.d/usr.sbin.xtrabackup\n</code></pre> <p>Run the backup as usual.</p> <p>No additional AppArmor-related actions are required to restore a backup.</p> <p></p>"},{"location":"work-with-apparmor.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"work-with-selinux.html","title":"Work with SELinux","text":"<p>Percona XtraBackup is installed as an unconfined process running in an undefined domain. SELinux allows unconfined processes almost all access and the processes only use Discretionary Access Control (DAC) rules.</p> <p>You find the current state of the Percona XtraBackup file with the following command:</p> <pre><code>$ ls -Z /usr/bin | grep xtrabackup\n</code></pre> Expected output <pre><code>-rwxr-xr-x. root root   system_u:object_r:bin_t:s0       xtrabackup\n</code></pre> <p>The SELinux context is the following:</p> <ul> <li> <p>user (root)</p> </li> <li> <p>role (object_r)</p> </li> <li> <p>type (bin_t)</p> </li> <li> <p>level (s0)</p> </li> </ul> <p>The unconfined domain supports the network-facing services, which are protected by SELinux. These domains are not exposed. In this configuration, SELinux protects against remote intrusions but local intrusions, which require local access, are not confined.</p> <p>Percona XtraBackup works locally. The service is not network-facing and cannot be exploited externally. The service interacts only with the local user, who provides the parameters. Percona XtraBackup requires access to the <code>target-dir</code> location.</p>"},{"location":"work-with-selinux.html#confine-xtrabackup","title":"Confine XtraBackup","text":"<p>You can modify your security configuration to confine Percona XtraBackup. The first question is where to store the backup files. The service requires read and write access to the selected location.</p> <p>You can use either of the following methods:</p> <ul> <li> <p>Allow Percona XtraBackup to write to any location. The user provides any path to the <code>target-dir</code> parameter.</p> </li> <li> <p>Allow Percona XtraBackup to write to a specific location, such as /backups or the user\u2019s home directory.</p> </li> </ul> <p>The first option opens the entire system to read and write. Select the second option to harden your security.</p>"},{"location":"work-with-selinux.html#install-selinux-tools","title":"Install SELinux tools","text":"<p>To work with policies, you must install the SELinux tools. To find which package provides the <code>semanage</code> command and install the package. The following is an example on CentOS 7.</p> <p><pre><code>$ yum provides *bin/semanage\n</code></pre> The result should list the packages.</p> Expected output <pre><code>...\npolicycoreutils-python-2.5-34.el7.x86_64 : SELinux policy core python utilities\n...\n</code></pre> <p>To install missing packages, run the following:</p> <pre><code>$ sudo yum install -y policycoreutils-python\n</code></pre> <p>The following is an example on CentOS 8:</p> <p><pre><code>$ yum provides *bin/semanage\n</code></pre> The result should list the missing packages.</p> Expected output <pre><code>...\npolicycoreutils-python-utils-2.8-16.1.el8.noarch : SELinux policy core python utilities\n</code></pre> <p>Run the following to install the missing packages: </p> <pre><code>$ sudo yum install -y policycoreutils-python-utils\n</code></pre>"},{"location":"work-with-selinux.html#create-a-policy","title":"Create a policy","text":"<p>Use a modular approach to create an SELinux policy. Create a policy module to manage XtraBackup. You must create a <code>.te</code> file for type enforcement, and an optional <code>.fc</code> file for the file contexts.</p> <p>Use <code>$ ps -efZ | grep xtrabackup</code> to verify the service is not confined by SELinux.</p> <p>Create the <code>xtrabackup.fc</code> file and add content. This file defines the security contexts.</p> <pre><code>/usr/bin/xtrabackup    -- gen_context(system_u:object_r:xtrabackup_exec_t,s0)\n/usr/bin/xbcrypt    -- gen_context(system_u:object_r:xtrabackup_exec_t,s0)\n/usr/bin/xbstream    -- gen_context(system_u:object_r:xtrabackup_exec_t,s0)\n/usr/bin/xbcloud    -- gen_context(system_u:object_r:xtrabackup_exec_t,s0)\n/backups(/.*)?       system_u:object_r:xtrabackup_data_t:s0\n</code></pre> <p>Note</p> <p>If you are using the <code>/backups</code> directory you must have the last line. If you are storing the backups in the user\u2019s home directory, you can omit this line.</p> <p>Download the <code>xtrabackup.te</code> file from the following location:</p> <p>https://github.com/percona/percona-xtrabackup/tree/8.0/packaging/percona/selinx</p> <p>Note</p> <p>In the file, the sections in bold should be modified for your system. The fc file can also be downloaded from the same location.</p> <p>Compile the policy module:</p> <pre><code>$ make -f /usr/share/selinux/devel/Makefile xtrabackup.pp\n</code></pre> <p>Install the module:</p> <pre><code>$ semodule -i xtrabackup.pp\n</code></pre> <p>Tag the PXB binaries with the proper SELinux tags, such as <code>xtrabackup_exec_t</code>.</p> <pre><code>$ restorecon -v /usr/bin/*\n</code></pre> <p>If you store your backups at <code>/backups</code>, restore the tag in that location:</p> <pre><code>$ restorecon -v /backups\n</code></pre> <p>Note</p> <p>Remember to add the standard Linux DAC permissions for this directory.</p> <p>Perform the backup in the standard way.</p> <p></p>"},{"location":"work-with-selinux.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"working-with-binary-logs.html","title":"Work with binary logs","text":"<p>The <code>xtrabackup</code> binary integrates with the <code>log_status table</code>. This integration enables <code>xtrabackup</code> to print out the backup\u2019s corresponding binary log position, so that you can use this binary log position to provision a new replica or perform point-in-time recovery.</p>"},{"location":"working-with-binary-logs.html#find-the-binary-log-position","title":"Find the binary log position","text":"<p>You can find the binary log position corresponding to a backup after the backup has been taken. If your backup is from a server with binary logging enabled, <code>xtrabackup</code> creates a file named <code>xtrabackup_binlog_info</code> in the target directory. This file contains the binary log file name and position of the exact point when the backup was taken.</p> Expected output during the backup stage <pre><code>210715 14:14:59 Backup created in directory '/backup/'\nMySQL binlog position: filename 'binlog.000002', position '156'\n. . .\n210715 14:15:00 completed OK!\n</code></pre> <p>Note</p> <p>As of Percona XtraBackup 8.0.26-18.0, xtrabackup no longer creates the <code>xtrabackup_binlog_pos_innodb</code> file. This change is because MySQL and Percona Server no longer update the binary log information on global transaction system section of <code>ibdata</code>. You should rely on <code>xtrabackup_binlog_info</code> regardless of the storage engine in use.</p>"},{"location":"working-with-binary-logs.html#point-in-time-recovery","title":"Point-in-time recovery","text":"<p>To perform a point-in-time recovery from an <code>xtrabackup</code> backup, you should prepare and restore the backup, and then replay binary logs from the point shown in the <code>xtrabackup_binlog_info</code> file.</p> <p>Find a more detailed procedure in the Point-in-time recovery document.</p>"},{"location":"working-with-binary-logs.html#set-up-a-new-replication-replica","title":"Set up a new replication replica","text":"<p>To set up a new replica, you should prepare the backup, and restore it to the data directory of your new replication replica. If you are using version 8.0.22 or earlier, in your <code>CHANGE MASTER TO</code> command, use the binary log filename and position shown in the <code>xtrabackup_binlog_info</code> file to start replication.</p> <p>If you are using 8.0.23 or later, use the CHANGE_REPLICATION_SOURCE_TO and the appropriate options. <code>CHANGE_MASTER_TO</code> is deprecated.</p> <p>A more detailed procedure is found in  How to setup a replica for replication in 6 simple steps with Percona XtraBackup.</p> <p></p>"},{"location":"working-with-binary-logs.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-azure.html","title":"Use the xbcloud binary with Microsoft Azure Cloud Storage","text":"<p>Implemented in Percona XtraBackup 8.0.27-19, the xbcloud binary adds support for the Microsoft Azure Cloud Storage using the REST API.</p>"},{"location":"xbcloud-azure.html#options","title":"Options","text":"<p>The following are the options, environment variables, and descriptions for uploading a backup to Azure using the REST API. The environment variables are recognized by xbcloud, which maps them automatically to the corresponding parameters:</p> Option name Environment variables Description \u2013azure-storage-account=name AZURE_STORAGE_ACCOUNT An Azure storage account is a unique namespace to access and store your Azure data objects. \u2013azure-container-name=name AZURE_CONTAINER_NAME A container name is a valid DNS name that conforms to the Azure naming rules \u2013azure-access-key=name AZURE_ACCESS_KEY A generated key that can be used to authorize access to data in your account using the Shared Key authorization. \u2013azure-endpoint=name AZURE_ENDPOINT The endpoint allows clients to securely access data \u2013azure-tier-class=name AZURE_STORAGE_CLASS Cloud tier can decrease the local storage required while maintaining the performance. When enabled, this feature has the following categories: Hot - Frequently accessed or modified data Cool - Infrequently accessed or modified data Archive - Rarely accessed or modified data <p>Test your Azure applications with the Azurite open-source emulator. For testing purposes, the xbcloud binary adds the <code>--azure-development-storage</code> option that uses the default <code>access_key</code> and <code>storage account</code> of azurite and <code>testcontainer</code> for the container. You can overwrite these options, if needed.</p>"},{"location":"xbcloud-azure.html#usage","title":"Usage","text":"<p>All the available options for xbcloud, such as parallel,  max-retries, and others, can be used. For more information, see the xbcloud binary overview.</p>"},{"location":"xbcloud-azure.html#examples","title":"Examples","text":"<p>An example of an xbcloud backup.</p> <pre><code>$ xtrabackup --backup --stream=xbstream  | \nxbcloud put backup_name --azure-storage-account=pxbtesting --azure-access-key=$AZURE_KEY --azure-container-name=test --storage=azure\n</code></pre> <p>An example of restoring a backup from xbcloud.</p> <pre><code>$ xbcloud get backup_name  --azure-storage-account=pxbtesting \n--azure-access-key=$AZURE_KEY --azure-container-name=test --storage=azure --parallel=10 2&gt;download.log | xbstream -x -C restore\n</code></pre> <p>An example of deleting a backup from xbcloud.</p> <pre><code>$ xbcloud delete backup_name --azure-storage-account=pxbtesting \n--azure-access-key=$AZURE_KEY --azure-container-name=test --storage=azure\n</code></pre> <p>An example of using a shortcut restore.</p> <pre><code>$ xbcloud get azure://operator-testing/bak22 ...\n</code></pre> <p></p>"},{"location":"xbcloud-azure.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-binary-fifo-datasink.html","title":"FIFO data sink","text":"<p>The feature is in tech preview.</p> <p>Percona XtraBackup 8.0.33-28 implements a new data sink that uses the first in, first out (FIFO) method. With the <code>FIFO</code> data sink feature, users with a streaming capacity of 10Gbps (typically on a Local Area Network (LAN)) can benefit from faster backups by streaming data in parallel to an object storage.</p>"},{"location":"xbcloud-binary-fifo-datasink.html#fifo-data-sink-options","title":"FIFO data sink options","text":"<p>Percona XtraBackup 8.0.33-28 implements the following options:</p> <ul> <li><code>--fifo-streams=#</code> - specifies the number of FIFO files to use for parallel data stream. To disable FIFO data sink and send stream to STDOUT, set <code>--fifo-streams=1</code>. The default value is <code>1</code> (STDOUT) to ensure the backward compatibility. The <code>--fifo-streams</code> value must match on both the XtraBackup and xbcloud sides.</li> <li><code>--fifo-dir=name</code> - specifies a directory to write Named Pipe.</li> <li><code>--fifo-timeout=#</code> - specifies the number of seconds to wait for the other end to open the stream for reading. The default value is <code>60</code> seconds.</li> </ul>"},{"location":"xbcloud-binary-fifo-datasink.html#how-to-enable-fifo-data-sink","title":"How to enable FIFO data sink","text":"<p>To use FIFO data sink, you can either run two commands in separate terminal sessions or run xtrabackup in the background.</p> <p>For example, run the following commands in separate terminal sessions:</p> <pre><code>$ xtrabackup --backup --stream --fifo-streams=2 --fifo-dir=/tmp/fifo\n</code></pre> <pre><code>$ xbcloud put --fifo-streams=2 --fifo-dir=/tmp/fifo full\n</code></pre> <p>Run xtrabackup in the background with the following commands:</p> <pre><code>$ xtrabackup --backup --stream --fifo-streams=2 --fifo-dir=/tmp/fifo &amp;\n$ xbcloud put --fifo-streams=2 --fifo-dir=/tmp/fifo full\n</code></pre>"},{"location":"xbcloud-binary-fifo-datasink.html#stream-to-an-object-storage","title":"Stream to an object storage","text":"<p>When taking a backup, you can save the files locally or stream the files to either a different server or an object storage. </p> <p>Before Percona XtraBackup 8.0.33-28, XtraBackup streams data to an object storage writing to STDOUT (a pipe) and using <code>xbcloud</code> to read from STDIN (standard input device). </p> <p>XtraBackup spawns multiple copy threads and each copy thread reads a data chunk from a specific file. Then each copy thread writes the data chunks to a pipe (STDOUT). An xbcloud read thread reads each chunk of STDIN data. Then xbcloud uploads the chunks to an object storage using an async request, and adds a callback to an event handler list. The xbcloud event handler executes the callback depending on the response from the object storage (success or failure).</p> <p></p> <p>The streaming capacity for XtraBackup using STDOUT is 1.8G. This capacity is sufficient for streaming data using Wide Area Network (WAN) into, for example, Amazon Web Services or Google Cloud Platform. </p> <p>Starting with Percona XtraBackup 8.0.33-28, when you stream backups to Amazon S3 compatible storage using LAN with a streaming capacity of 10Gbps, XtraBackup can use multiple FIFO streams to stream the backups faster. </p> <p>XtraBackup spawns multiple copy threads and each copy thread reads a data chunk from a specific file. Then multiple FIFO files are created to store the data from XtraBackup. Each XtraBackup copy thread writes the data chunks to a specific FIFO file. Xbcloud reads from the FIFO streams and uploads data to an object storage using an async request. The xbcloud event handler executes the callback depending on the response from the object storage (success or failure). </p> <p></p>"},{"location":"xbcloud-binary-fifo-datasink.html#performance-improvement","title":"Performance improvement","text":"<p>Consider an example of using a FIFO data sink compared to the STDOUT method.</p> <p>The database has 1TB of data in multiple tables. The link speed between the source server and destination server using MinIO is ~ 9.2 Gbps.</p> <p>Both STDOUT and FIFO data sink scenarios push 1TB of data from two servers.</p> <p>For the FIFO data sink we configure 8 parallel streams with <code>--fifo-streams=8</code> both for XtraBackup and xbcloud.</p> <p>The results are the following:</p> <ul> <li>The <code>STDOUT</code> method takes 01:25:24 to push 1TB of data using 239 MBps (1.8 Gbps).</li> <li>The <code>FIFO</code> method, using 8 streams, takes 00:16:01 to push 1TB of data using 1.15 GBps (9.2 Gbps).</li> </ul> <p></p>"},{"location":"xbcloud-binary-fifo-datasink.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-binary-overview.html","title":"The xbcloud binary overview","text":"<p>The purpose of xbcloud is to download from the cloud and upload to  the cloud the full or part of an xbstream archive. xbcloud will not  overwrite the backup with the same name. xbcloud accepts input via a pipe from xbstream so that it can be invoked as a pipeline with xtrabackup to stream directly to the cloud without needing a local storage.</p> <p>Note</p> <p>In a Bash shell, the <code>$?</code> parameter returns the exit code from the last binary. If you use pipes, the ${PIPESTATUS[x]} array parameter returns the exit code for each  binary in the pipe string.</p> <pre><code>$ xtrabackup --backup --stream=xbstream --target-dir=/storage/backups/ | xbcloud put [options] full_backup\n...\n$ ${PIPESTATUS[x]}\n0 0\n$ true | false\n$ echo $?\n1\n\n# with PIPESTATUS\n$ true | false\n$ echo ${PIPESTATUS[0]} ${PIPESTATUS[1]}\n0 1\n</code></pre> <p>The xbcloud binary stores each chunk as a separate object with a name <code>backup_name/database/table.ibd.NNN...</code>, where <code>NNN...</code> is a 0-padded serial number of chunk within a file. The size of chunk produced by xtrabackup and xbstream changed to 10M.</p> <p>To adjust the chunk size use <code>--read-buffer-size</code>. To adjust the chunk size for encrypted files, use <code>--read-buffer-size</code> and <code>--encrypt-chunk-size</code>.</p> <p>xbcloud has three essential operations: put, get, and delete. With these operations, backups are created, stored, retrieved, restored, and deleted. xbcloud operations clearly map to similar operations within  the AWS Amazon S3 API.</p> <p>For details on the command-line options, see the xbcloud command line options.</p> <p>The Exponential Backoff feature was implemented in Percona XtraBackup 8.0.26-18. During the backup, a chunk fails to upload or download operation; this feature adds an exponential backoff, a sleep time, and retries the operation. This feature increases the chances of completing a backup or a restore operation.</p> <p>The FIFO datasink feature was implemented in Percona XtraBackup 8.0.33-28. With the <code>FIFO</code> data sink feature, users with a streaming capacity of 10Gbps (typically on a Local Area Network (LAN)) can benefit from faster backups by streaming data in parallel to object storage.</p> <p>Important</p> <p>To prevent intermittent backup failures, update the curl utility in Debian 10.</p>"},{"location":"xbcloud-binary-overview.html#supported-cloud-storage-types","title":"Supported cloud storage types","text":"<p>The following cloud storage types are supported:</p> <ul> <li> <p>OpenStack Object Storage (Swift) - see Using the xbcloud binary with Swift</p> </li> <li> <p>Amazon Simple Storage (S3) - see Using the xbcloud binary with Amazon S3</p> </li> <li> <p>Azure Cloud Storage - see Using the xbcloud binary with Microsoft Azure Cloud Storage</p> </li> <li> <p>Google Cloud Storage (gcs) - see Using the xbcloud binary with Google Cloud Storage</p> </li> <li> <p>MinIO - see Using the xbcloud binary with MinIO</p> </li> </ul> <p>In addition to OpenStack Object Storage (Swift), which has been the only option for storing backups in a cloud storage until Percona XtraBackup 2.4.14, xbcloud supports Amazon S3, MinIO, and Google Cloud Storage. Other Amazon S3-compatible storages, such as Wasabi or Digital Ocean Spaces, are also supported.</p> <p>See also</p> <p>OpenStack Object Storage(\u201cSwift\u201d)</p> <p>Amazon Simple Storage Service</p> <p>MinIO</p> <p>Google Cloud Storage</p> <p>Wasabi</p> <p>Digital Ocean Spaces</p>"},{"location":"xbcloud-binary-overview.html#usage","title":"Usage","text":"<p>The following sample command creates a full backup:</p> <pre><code>$ xtrabackup --backup --stream=xbstream --target-dir=/storage/backups/ --extra-lsndirk=/storage/backups/| xbcloud \\\nput [options] full_backup\n</code></pre> <p>An incremental backup only includes the changes since the last backup. The last backup can be either a full or incremental backup.</p> <p>The following sample command creates an incremental backup:</p> <pre><code>$ xtrabackup --backup --stream=xbstream --incremental-basedir=/storage/backups \\\n--target-dir=/storage/inc-backup | xbcloud  put [options] inc_backup\n</code></pre> <p>To prepare an incremental backup, you must first download the full backup with the following command:</p> <pre><code>$ xbcloud get [options] full_backup | xbstream -xv -C /tmp/full-backup\n</code></pre> <p>You must prepare the full backup:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/tmp/full-backup\n</code></pre> <p>After the full backup has been prepared, download the incremental backup:</p> <pre><code>xbcloud get [options] inc_backup | xbstream -xv -C /tmp/inc-backup\n</code></pre> <p>The downloaded backup is prepared by running the following command:</p> <pre><code>$ xtrabackup --prepare --target-dir=/tmp/full-backup --incremental-dir=/tmp/inc-backup\n</code></pre> <p>You do not need the full backup to restore only a specific database. You can specify only the tables to be restored:</p> <p><pre><code>xbcloud get [options] ibdata1 sakila/payment.ibd /tmp/partial/partial.xbs\n</code></pre> An example of the code: </p> <pre><code>xbstream -xv -C /tmp/partial &lt; /tmp/partial/partial.xbs\n</code></pre>"},{"location":"xbcloud-binary-overview.html#supplying-parameters","title":"Supplying parameters","text":"<p>Each storage type has mandatory parameters that you can supply on the command line, in a configuration file, and via environment variables.</p>"},{"location":"xbcloud-binary-overview.html#configuration-files","title":"Configuration files","text":"<p>The parameters the values of which do not change frequently can be stored in <code>my.cnf</code> or in a custom configuration file. The following example is a template of configuration options under the <code>[xbcloud]</code> group:</p> <pre><code>[xbcloud]\nstorage=s3\ns3-endpoint=http://localhost:9000/\ns3-access-key=minio\ns3-secret-key=minio123\ns3-bucket=backupsx\ns3-bucket-lookup=path\ns3-api-version=4\n</code></pre> <p>Note</p> <p>If you explicitly use a parameter on the command line and in a configuration file, xbcloud uses the value provided on the command line.</p>"},{"location":"xbcloud-binary-overview.html#environment-variables","title":"Environment variables","text":"<p>If you explicitly use a parameter on the command line, in a configuration file, and the corresponding environment variable contains a value, xbcloud uses the value provided on the command line or in the configuration file.</p>"},{"location":"xbcloud-binary-overview.html#shortcuts","title":"Shortcuts","text":"<p>For all operations (put, get, and delete), you can use a shortcut to specify the storage type, bucket name, and backup name as one parameter instead of using three distinct parameters (\u2013storage, \u2013s3-bucket, and backup name per se).</p> <p>Note</p> <p>Use the following format: <code>storage-type://bucket-name/backup-name</code></p> <p>In this example s3 refers to a storage type, operator-testing  is a bucket name, and bak22 is the backup name. </p> <pre><code>$ xbcloud get s3://operator-testing/bak22 ...\n</code></pre> <p>This shortcut expands as follows:</p> <pre><code>$ xbcloud get --storage=s3 --s3-bucket=operator-testing bak22 ...\n</code></pre> <p>You can supply the mandatory parameters on the command line, configuration files, and in environment variables.</p>"},{"location":"xbcloud-binary-overview.html#additional-parameters","title":"Additional parameters","text":"<p>xbcloud accepts additional parameters that you can use with any storage type. The <code>--md5</code> parameter computes the MD5 hash value of the backup chunks. The result is stored in files that following the <code>backup_name.md5</code> pattern.</p> <pre><code>$ xtrabackup --backup --stream=xbstream \\\n--parallel=8 2&gt;backup.log | xbcloud put s3://operator-testing/bak22 \\\n--parallel=8 --md5 2&gt;upload.log\n</code></pre> <p>You may use the <code>--header</code> parameter to pass an additional HTTP header with the server side encryption while specifying a customer key.</p> <p>An example of using the <code>--header</code> for AES256 encryption.</p> <pre><code>$ xtrabackup --backup --stream=xbstream --parallel=4 | \\\nxbcloud put s3://operator-testing/bak-enc/ \\\n--header=\"X-Amz-Server-Side-Encryption-Customer-Algorithm: AES256\" \\\n--header=\"X-Amz-Server-Side-Encryption-Customer-Key: CuStoMerKey=\" \\\n--header=\"X-Amz-Server-Side-Encryption-Customer-Key-MD5: CuStoMerKeyMd5==\" \\\n--parallel=8\n</code></pre> <p>The <code>--header</code> parameter is also useful to set the access control list (ACL) permissions: <code>--header=\"x-amz-acl: bucket-owner-full-control</code></p>"},{"location":"xbcloud-binary-overview.html#incremental-backups","title":"Incremental backups","text":"<p>First, you need to make the full backup on which the incremental one is going to be based:</p> <pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/storage/backups/ \\\n--target-dir=/storage/backups/ | xbcloud put \\\n--storage=swift --swift-container=test_backup \\\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ --parallel=10 \\\nfull_backup\n</code></pre> <p>Then you can make the incremental backup:</p> <pre><code>$ xtrabackup --backup --incremental-basedir=/storage/backups \\\n--stream=xbstream --target-dir=/storage/inc_backup | xbcloud put \\\n--storage=swift --swift-container=test_backup \\\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ --parallel=10 \\\ninc_backup\n</code></pre>"},{"location":"xbcloud-binary-overview.html#preparing-incremental-backups","title":"Preparing incremental backups","text":"<p>To prepare a backup you first need to download the full backup:</p> <pre><code>$ xbcloud get --swift-container=test_backup \\\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ --parallel=10 \\\nfull_backup | xbstream -xv -C /storage/downloaded_full\n</code></pre> <p>Once you download the full backup it should be prepared:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/storage/downloaded_full\n</code></pre> <p>After the full backup has been prepared you can download the incremental backup:</p> <pre><code>$ xbcloud get --swift-container=test_backup \\\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ --parallel=10 \\\ninc_backup | xbstream -xv -C /storage/downloaded_inc\n</code></pre> <p>Once the incremental backup has been downloaded you can prepare it by running:</p> <pre><code>$ xtrabackup --prepare --apply-log-only \\\n--target-dir=/storage/downloaded_full \\\n--incremental-dir=/storage/downloaded_inc\n\n$ xtrabackup --prepare --target-dir=/storage/downloaded_full\n</code></pre>"},{"location":"xbcloud-binary-overview.html#partial-download-of-the-cloud-backup","title":"Partial download of the cloud backup","text":"<p>If you do not want to download the entire backup to restore the specific database you can specify only the tables you want to restore:</p> <pre><code>$ xbcloud get --swift-container=test_backup\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ full_backup \\\nibdata1 sakila/payment.ibd \\\n&gt; /storage/partial/partial.xbs\n\n$ xbstream -xv -C /storage/partial &lt; /storage/partial/partial.xbs\n</code></pre> <p></p>"},{"location":"xbcloud-binary-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-exbackoff.html","title":"Exponential backoff","text":"<p>This feature was implemented in Percona XtraBackup 8.0.26-18.0 in the xbcloud binary.</p> <p>Exponential backoff increases the chances for the completion of a backup or a restore operation. For example, a chunk upload or download may fail if you have an unstable network connection or other network issues. This feature adds an exponential backoff, or sleep, time and then retries the upload or download.</p> <p>When a chunk upload or download operation fails, xbcloud checks the reason for the failure. This failure can be a CURL error or an HTTP error, or a client-specific error. If the error is listed in the Retriable errors list, xbcloud pauses for a calculated time before retrying the operation until that time reaches the <code>--max-backoff</code> value.</p> <p>The operation is retried until the <code>--max-retries</code> value is reached. If the chunk operation fails on the last retry, xbcloud aborts the process.</p> <p>The default values are the following:</p> <ul> <li> <p>\u2013max-backoff = 300000 (5 minutes)</p> </li> <li> <p>\u2013max-retries = 10</p> </li> </ul> <p>You can adjust the number of retries by adding the <code>--max-retries</code> parameter and adjust the maximum length of time between retries by adding the <code>--max-backoff</code> parameter to an xbcloud command.</p> <p>Since xbcloud does multiple asynchronous requests in parallel, a calculated value, measured in milliseconds, is used for <code>max-backoff</code>. This algorithm calculates how many milliseconds to sleep before the next retry. A number generated is based on the combining the power of two (2), the number of retries already attempted and adds a random number between 1 and 1000. This number avoids network congestion if multiple chunks have the same backoff value. If the default values are used, the final retry attempt to be approximately 17 minutes after the first try. The number is no longer calculated when the milliseconds reach the <code>--max-backoff</code> setting. At that point, the retries continue by using the <code>--max-backoff</code> setting until the <code>max-retries</code> parameter is reached.</p>"},{"location":"xbcloud-exbackoff.html#retriable-errors","title":"Retriable errors","text":"<p>We retry for the following CURL operations:</p> <ul> <li> <p>CURLE_GOT_NOTHING</p> </li> <li> <p>CURLE_OPERATION_TIMEOUT</p> </li> <li> <p>CURLE_RECV_ERROR</p> </li> <li> <p>CURLE_SEND_ERROR</p> </li> <li> <p>CURLE_SEND_FAIL_REWIND</p> </li> <li> <p>CURLE_PARTIAL_FILE</p> </li> <li> <p>CURLE_SSL_CONNECT_ERROR</p> </li> </ul> <p>We retry for the following HTTP operation status codes:</p> <ul> <li> <p>503</p> </li> <li> <p>500</p> </li> <li> <p>504</p> </li> <li> <p>408</p> </li> </ul> <p>Each cloud provider may return a different CURL error or an HTTP error, depending on the issue. Add new errors by setting the following variables <code>--curl-retriable-errors</code> or <code>--http-retriable-errors</code> on the command line or in <code>my.cnf</code> or in a custom configuration file under the [xbcloud] section. You can add multiple errors using a comma-separated list of codes.</p> <p>The error handling is enhanced when using the <code>--verbose</code> output. This output specifies which error caused xbcloud to fail and what parameter a user must add to retry on this error.</p> <p>The following is an example of a verbose output:</p> Expected output <pre><code>210701 14:34:23 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Server returned nothing (no headers, no data)\n210701 14:34:23 /work/pxb/ins/8.0/bin/xbcloud: Curl error (52) Server returned nothing (no headers, no data) is not configured as retriable. You can allow it by adding --curl-retriable-errors=52 parameter\n</code></pre>"},{"location":"xbcloud-exbackoff.html#example","title":"Example","text":"<p>The following example adjusts the maximum number of retries and the maximum time between retries.</p> <pre><code>xbcloud [options] --max-retries=5 --max-backoff=10000\n</code></pre> <p>The following list describes the process using <code>--max-backoff=10000</code>:</p> <ul> <li> <p>The chunk <code>xtrabackup_logfile.00000000000000000006</code> fails to upload the first time and sleeps for 2384 milliseconds.</p> </li> <li> <p>The same chunk fails for the second time and the sleep time is increased to 4387 milliseconds.</p> </li> <li> <p>The same chunk fails for the third time and the sleep time is increased to 8691 milliseconds.</p> </li> <li> <p>The same chunk fails for the fourth time. The <code>max-backoff</code> parameter has been reached. All retries sleep the same amount of time after reaching the parameter.</p> </li> <li> <p>The same chunk is successfully uploaded.</p> </li> </ul> An example of the output for this setting <pre><code>210702 10:07:05 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Server returned nothing (no headers, no data)\n210702 10:07:05 /work/pxb/ins/8.0/bin/xbcloud: Sleeping for 2384 ms before retrying backup3/xtrabackup_logfile.00000000000000000006\n. . .\n210702 10:07:23 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Server returned nothing (no headers, no data)\n210702 10:07:23 /work/pxb/ins/8.0/bin/xbcloud: Sleeping for 4387 ms before retrying backup3/xtrabackup_logfile.00000000000000000006\n. . .\n210702 10:07:52 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Failed sending data to the peer\n210702 10:07:52 /work/pxb/ins/8.0/bin/xbcloud: Sleeping for 8691 ms before retrying backup3/xtrabackup_logfile.00000000000000000006\n. . .\n210702 10:08:47 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Failed sending data to the peer\n210702 10:08:47 /work/pxb/ins/8.0/bin/xbcloud: Sleeping for 10000 ms before retrying backup3/xtrabackup_logfile.00000000000000000006\n. . .\n210702 10:10:12 /work/pxb/ins/8.0/bin/xbcloud: successfully uploaded chunk: backup3/xtrabackup_logfile.00000000000000000006, size: 8388660\n</code></pre> <p></p>"},{"location":"xbcloud-exbackoff.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-gcs.html","title":"Use the xbcloud binary with Google Cloud Storage","text":""},{"location":"xbcloud-gcs.html#create-a-full-backup-with-google-cloud-storage","title":"Create a full backup with Google Cloud Storage","text":"<p>The support for Google Cloud Storage is implemented using the interoperability mode. This mode was especially designed to interact with cloud services compatible with Amazon S3.</p> <p>See also</p> <p>Cloud Storage Interoperability</p> <pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\nxbcloud put --storage=google \\\n--google-endpoint=`storage.googleapis.com` \\\n--google-access-key='YOUR-ACCESSKEYID' \\\n--google-secret-key='YOUR-SECRETACCESSKEY' \\\n--google-bucket='mysql_backups'\n--parallel=10 \\\n$(date -I)-full_backup\n</code></pre> <p>The following options are available when using Google Cloud Storage:</p> <ul> <li> <p>\u2013google-access-key =  <li> <p>\u2013google-secret-key =  <li> <p>\u2013google-bucket =  <li> <p>\u2013google-storage-class=name</p> </li> <p>Note</p> <p>The Google storage class name options are the following:</p> <ul> <li> <p>STANDARD</p> </li> <li> <p>NEARLINE</p> </li> <li> <p>COLDLINE</p> </li> <li> <p>ARCHIVE</p> </li> </ul> <p>See also</p> <p>Google storage classes - the default Google storage class depends on  the storage class of the bucket</p> <p></p>"},{"location":"xbcloud-gcs.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-iam-profile.html","title":"Use the xbcloud binary with an IAM instance profile","text":"<p>This feature is tech preview. Before using this feature in production, we recommend that you test restoring from physical backups in your environment and also use the alternative backup method for redundancy.</p> <p>Percona XtraBackup 8.0.31-24 adds the ability to use the IAM instance profile when running xbcloud from an EC2 instance.</p> <p>An authentication system has two elements:</p> <ul> <li>Who am I?</li> <li>What can I do?</li> </ul> <p>A role defines \u201cwhat can I do.\u201d A role provides a method to define a collection of permissions. Roles are assigned to users, services and EC2 instances, the \u201cwho am I\u201d element.</p> <p>The IAM instance profile is the \u201cwho\u201d for an EC2 instance and assumes the IAM role, which has permissions. The instance profile has the same name as the IAM role.</p> <p>An IAM instance profile does not need the <code>--s3-secret-key</code> nor the <code>--s3-access-key</code> if they are running <code>xbcloud</code> from an Amazon EC2 instance. To configure or attach an instance metadata to an EC2 instance, see How can I grant my Amazon EC2 instance access to an Amazon S3 bucket. </p> <p>An example of the command:</p> <pre><code>$ xtrabackup ... | xbcloud put --storage=s3 --s3-bucket=bucket-name backup-name\n</code></pre> <p>The xbcloud binary outputs a connect message when successful.</p> Expected output <pre><code>221121 13:16:26 Using instance metadata for access and secret key\n221121 13:16:26 xbcloud: Successfully connected.\n</code></pre> <p>An important consideration is that the instance metadata has a time to live (TTL) of 6 hours. A backup that takes more than that time contains Expired token errors. Use Exponential Backoff to retry the upload after fetching new keys from the instance metadata.</p> Output when keys have expired <pre><code>221121 13:04:52 xbcloud: S3 error message: The provided token has expired.\n221121 13:04:52 xbcloud: Sleeping for 2384 ms before retrying test/mysql.ibd.00000000000000000002 [1]\n221121 13:04:55 xbcloud: S3 error message: The provided token has expired.\n221121 13:04:55 xbcloud: Sleeping for 2887 ms before retrying test/mysql.ibd.00000000000000000003 [1]\n221121 13:04:58 xbcloud: S3 error message: The provided token has expired.\n221121 13:04:58 xbcloud: Sleeping for 2778 ms before retrying test/undo_002.00000000000000000000 [1]\n221121 13:05:00 xbcloud: S3 error message: The provided token has expired.\n221121 13:05:00 xbcloud: Sleeping for 2916 ms before retrying test/undo_002.00000000000000000001 [1]\n221121 13:05:03 xbcloud: S3 error message: The provided token has expired.\n221121 13:05:03 xbcloud: Sleeping for 2794 ms before retrying test/undo_002.00000000000000000002 [1]\n221121 13:05:06 xbcloud: S3 error message: The provided token has expired.\n221121 13:05:06 xbcloud: Sleeping for 2336 ms before retrying test/undo_001.00000000000000000000 [1]\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/mysql.ibd.00000000000000000002, size: 5242923\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/mysql.ibd.00000000000000000003, size: 23\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/undo_002.00000000000000000000, size: 10485802\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/undo_002.00000000000000000001, size: 6291498\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/undo_002.00000000000000000002, size: 22\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/undo_001.00000000000000000000, size: 10485802\n221121 13:05:10 xbcloud: successfully uploaded chunk: test/undo_001.00000000000000000001, size: 6291498\n221121 13:05:10 xbcloud: successfully uploaded chunk: test/undo_001.00000000000000000002, size: 22\n. . .\n221121 13:05:18 xbcloud: successfully uploaded chunk: test/xtrabackup_tablespaces.00000000000000000001, size: 36\n221121 13:05:19 xbcloud: Upload completed. \n</code></pre> <p></p>"},{"location":"xbcloud-iam-profile.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-minio.html","title":"Use the xbcloud binary with MinIO","text":""},{"location":"xbcloud-minio.html#create-a-full-backup-with-minio","title":"Create a full backup with MinIO","text":"<pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\nxbcloud put --storage=s3 \\\n--s3-endpoint='play.minio.io:9000' \\\n--s3-access-key='YOUR-ACCESSKEYID' \\\n--s3-secret-key='YOUR-SECRETACCESSKEY' \\\n--s3-bucket='mysql_backups'\n--parallel=10 \\\n$(date -I)-full_backup\n</code></pre>"},{"location":"xbcloud-minio.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-options.html","title":"The xbcloud command-line options","text":"<p>Usage: </p> <pre><code>$ xbcloud put [OPTIONS]\n$ xbcloud get [OPTIONS]\n$ xbcloud delete [OPTIONS]\n</code></pre> <p>This document contains information on general options and the options available when you select the Swift authentication version using <code>swift-auth-version</code>.</p> <p>The xbcloud binary has the following general command line options:</p>"},{"location":"xbcloud-options.html#azure-access-key","title":"azure-access-key","text":"<p>Usage: <code>--azure-access-key=name</code></p> <p>The name of the Azure access-key</p>"},{"location":"xbcloud-options.html#azure-container-name","title":"azure-container-name","text":"<p>Usage: <code>--azure-container-name=name</code></p> <p>The name of the Azure container</p>"},{"location":"xbcloud-options.html#azure-development-storage","title":"azure-development-storage","text":"<p>Usage: <code>--azure-development-storage=name</code></p> <p>If you run the Azurite emulator, use this option, and it works with the default credentials provided by Azurite. You can overwrite these default credentials with other options.</p>"},{"location":"xbcloud-options.html#azure-endpoint","title":"azure-endpoint","text":"<p>Usage: <code>--azure-endpoint=name</code></p> <p>The name of the Azure endpoint</p>"},{"location":"xbcloud-options.html#azure-storage-account","title":"azure-storage-account","text":"<p>Usage: <code>--azure-storage-account=name</code></p> <p>The name of the Azure storage account</p>"},{"location":"xbcloud-options.html#azure-tier-class","title":"azure-tier-class","text":"<p>Usage: <code>--azure-tier-class=name</code></p> <p>The name of the Azure tier-class. The possible values are:</p> <ul> <li> <p>Hot</p> </li> <li> <p>Cool</p> </li> <li> <p>Archive</p> </li> </ul>"},{"location":"xbcloud-options.html#cacert","title":"cacert","text":"<p>Usage: <code>--cacert=name</code></p> <p>The path to the file with Certificate Authority (CA) certificates.</p>"},{"location":"xbcloud-options.html#curl-retriable-errors","title":"curl-retriable-errors","text":"<p>Usage: <code>--curl-retriable-errors=name</code></p> <p>Add a new cURL error code as retriable. For multiple codes, use a comma-separated list.</p>"},{"location":"xbcloud-options.html#fifo-dir","title":"fifo-dir","text":"<p>Usage: <code>--fifo-dir=name</code></p> <p>The directory used to read or write named pipes. In the put mode, xbcloud reads from the named pipes. In the get mode, xbcloud writes to the named pipes.</p>"},{"location":"xbcloud-options.html#fifo-streams","title":"fifo-streams","text":"<p>Usage: <code>--fifo-streams=#</code></p> <p>The number of parallel FIFO stream threads.</p>"},{"location":"xbcloud-options.html#fifo-timeout","title":"fifo-timeout","text":"<p>Usage: <code>--fifo-timeout=#</code></p> <p>The number of seconds to wait for the other end to open the stream. The default value is 60.</p>"},{"location":"xbcloud-options.html#google-access-key","title":"google-access-key","text":"<p>Usage: <code>--google-access-key=name</code></p> <p>The Google Cloud storage access key</p>"},{"location":"xbcloud-options.html#google-bucket-name","title":"google-bucket-name","text":"<p>Usage: <code>--google-bucket-name=name</code></p> <p>The Google Cloud storage bucket name</p>"},{"location":"xbcloud-options.html#google-endpoint","title":"google-endpoint","text":"<p>Usage: <code>--google-endpoint=name</code></p> <p>The Google Cloud storage endpoint</p>"},{"location":"xbcloud-options.html#google-region","title":"google-region","text":"<p>Usage: <code>--google-region=name</code></p> <p>The Google Cloud storage region</p>"},{"location":"xbcloud-options.html#google-secret-key","title":"google-secret-key","text":"<p>Usage: <code>--google-secret-key=name</code></p> <p>The Google Cloud storage secret key</p>"},{"location":"xbcloud-options.html#google-session-token","title":"google-session-token","text":"<p>Usage: <code>--google-session-token=name</code></p> <p>The Google Cloud storage session-token</p>"},{"location":"xbcloud-options.html#google-storage-class","title":"google-storage-class","text":"<p>Usage: <code>--google-storage-class=name</code></p> <p>The Google Cloud storage storage class</p> <p>The possible values are the following:</p> <ul> <li> <p>STANDARD</p> </li> <li> <p>NEARLINE</p> </li> <li> <p>COLDLINE</p> </li> <li> <p>ARCHIVE</p> </li> </ul>"},{"location":"xbcloud-options.html#header","title":"header","text":"<p>Usage: <code>--header=name</code></p> <p>Extra header</p>"},{"location":"xbcloud-options.html#http-retriable-errors","title":"http-retriable-errors","text":"<p>Usage: <code>--http-retriable-errors=name</code></p> <p>Add a new http error code as retriable. For multiple codes, use a comma-separated list.</p>"},{"location":"xbcloud-options.html#insecure","title":"insecure","text":"<p>Usage: <code>--insecure</code></p> <p>Do not verify the certificate of the server.</p>"},{"location":"xbcloud-options.html#max-backoff","title":"max-backoff","text":"<p>Usage: <code>--max-backoff=#</code></p> <p>The maximum backoff delay, in milliseconds, between chunk upload or chunk download retries. The default value is 300000.</p>"},{"location":"xbcloud-options.html#max-retries","title":"max-retries","text":"<p>Usage: <code>--max-retires=#</code></p> <p>The number of retries for chunk uploads or downloads after a failure. The default value is 10.</p>"},{"location":"xbcloud-options.html#md5","title":"md5","text":"<p>Usage: <code>--md5=name</code></p> <p>Uploads an MD5 file into the backup directory.</p>"},{"location":"xbcloud-options.html#parallel","title":"parallel","text":"<p>Usage: <code>--parallel=#</code></p> <p>Defines the maximum number of concurrent upload/download requests. The default value is <code>1</code>.</p>"},{"location":"xbcloud-options.html#s3-access-key","title":"s3-access-key","text":"<p>Usage: <code>--s3-access-key=name</code></p> <p>The name of the s3 access key</p>"},{"location":"xbcloud-options.html#s3-api-version","title":"s3-api-version","text":"<p>Usage: <code>--s3-api-version=name</code></p> <p>The name of the s3 API version</p>"},{"location":"xbcloud-options.html#s3-bucket","title":"s3-bucket","text":"<p>Usage: <code>--s3-bucket=name</code></p> <p>The name of the s3 bucket</p>"},{"location":"xbcloud-options.html#s3-bucket-lookup","title":"s3-bucket-lookup","text":"<p>Usage: <code>--s3-bucket-lookup=name</code></p> <p>The name of the s3 bucket lookup method</p>"},{"location":"xbcloud-options.html#s3-endpoint","title":"s3-endpoint","text":"<p>Usage: <code>--s3-endpoint=name</code></p> <p>The name of the s3 endpoint</p>"},{"location":"xbcloud-options.html#s3-region","title":"s3-region","text":"<p>Usage: <code>--s3-region=name</code></p> <p>The name of the s3 region</p>"},{"location":"xbcloud-options.html#s3-secret-key","title":"s3-secret-key","text":"<p>Usage: <code>--s3-secret-key=name</code></p> <p>The name of the s3 secret key</p>"},{"location":"xbcloud-options.html#s3-session-token","title":"s3-session-token","text":"<p>Usage: <code>--s3-session-token=name</code></p> <p>The name of the s3 session token</p>"},{"location":"xbcloud-options.html#s3-storage-class","title":"s3-storage-class","text":"<p>Usage: <code>--s3-storage-class=name</code></p> <p>The name of the s3 storage class and is used to pass custom storage class names provided by the other s3 implementations, such as MinIO.</p> <p>The possible values are:</p> <ul> <li> <p>STANDARD</p> </li> <li> <p>STANDARD_ID</p> </li> <li> <p>GLACIER</p> </li> </ul>"},{"location":"xbcloud-options.html#storage","title":"storage","text":"<p>Usage: <code>--storage=[S3|SWIFT|GOOGLE|AZURE]</code></p> <p>Defines the Cloud storage option. xbcloud supports Swift, MinIO, Google, Azure, and AWS S3. The default value is <code>swift</code>.</p>"},{"location":"xbcloud-options.html#swift-auth-url","title":"swift-auth-url","text":"<p>Usage: <code>--swift-auth-url=name</code></p> <p>The Base URL of the Swift authentication service.</p>"},{"location":"xbcloud-options.html#swift-container","title":"swift-container","text":"<p>Usage: <code>--swift-container=name</code></p> <p>The Swift container used to store backups.</p>"},{"location":"xbcloud-options.html#swift-key","title":"swift-key","text":"<p>Usage: <code>--swift-key</code></p> <p>The Swift key/password (X-Auth-Key)</p>"},{"location":"xbcloud-options.html#swift-storage-url","title":"swift-storage-url","text":"<p>Usage: <code>--swift-storage-url=name</code></p> <p>If a name is specified, the xbcloud attempts to get the object-store endpoint for a given region from the keystone response. This option overrides that value.</p>"},{"location":"xbcloud-options.html#swift-user","title":"swift-user","text":"<p>Usage: <code>--swift-user=name</code></p> <p>The Swift user name (X-Auth-User).</p>"},{"location":"xbcloud-options.html#timeout","title":"timeout","text":"<p>Usage: <code>--timeout=#</code></p> <p>The number of seconds to wait for activity on the TCP connection. The default value is 120. If the value is 0 (zero), there is no timeout.</p>"},{"location":"xbcloud-options.html#verbose","title":"verbose","text":"<p>Usage: <code>--verbose</code></p> <p>Turns on the cURL tracing.</p>"},{"location":"xbcloud-options.html#swift-authentication-options","title":"Swift authentication options","text":"<p>The Swift specification describes several authentication options. The xbcloud tool can authenticate against keystone with API version 2 and 3.</p>"},{"location":"xbcloud-options.html#swift-auth-version","title":"swift-auth-version","text":"<p>Usage: <code>--swift-auth-version=name</code></p> <p>Defines the swift authentication version used. </p> <p>The possible values are the following: </p> <ul> <li> <p><code>1.0</code> - TempAuth</p> </li> <li> <p><code>2.0</code> - Keystone v2.0</p> </li> <li> <p><code>3</code> - Keystone v3. </p> </li> </ul> <p>The default value is <code>1.0</code>.</p>"},{"location":"xbcloud-options.html#if-swift-auth-version2-the-additional-options-are","title":"If <code>--swift-auth-version=2</code>, the additional options are:","text":""},{"location":"xbcloud-options.html#swift-password","title":"swift-password","text":"<p>Usage: <code>--swift-password=name</code></p> <p>Swift password for the user</p>"},{"location":"xbcloud-options.html#swift-region","title":"swift-region","text":"<p>Usage: <code>--swift-region=name</code></p> <p>Swift region object-store endpoint</p>"},{"location":"xbcloud-options.html#swift-tenant","title":"swift-tenant","text":"<p>Usage: <code>--swift-tenant=name</code></p> <p>The Swift tenant name </p> <p>Either of the <code>--swift-tenant</code> or <code>--swift-tenant-id</code> can be defined, but you should not use both options together. Both of these options are optional.</p>"},{"location":"xbcloud-options.html#swift-tenant-id","title":"swift-tenant-id","text":"<p>Usage: <code>--swift-tenant-id=name</code></p> <p>The Swift tenant ID</p> <p>Either of the <code>--swift-tenant</code> or <code>--swift-tenant-id</code> can be defined, but you should not use both options together. Both of these options are optional.</p>"},{"location":"xbcloud-options.html#if-swift-auth-version3-the-additional-options-are","title":"If <code>--swift-auth-version=3</code>, the  additional options are:","text":""},{"location":"xbcloud-options.html#swift-domain","title":"swift-domain","text":"<p>Usage: <code>--swift-domain=name</code></p> <p>The Swift domain name</p>"},{"location":"xbcloud-options.html#swift-domain-id","title":"swift-domain-id","text":"<p>Usage: <code>--swift-domain-id=name</code></p> <p>The Swift domain ID</p>"},{"location":"xbcloud-options.html#swift-project","title":"swift-project","text":"<p>Usage: <code>--swift-project=name</code></p> <p>The Swift project name</p>"},{"location":"xbcloud-options.html#swift-project-domain","title":"swift-project-domain","text":"<p>Usage: <code>--swift-project-domain=name</code></p> <p>The Swift domain name</p>"},{"location":"xbcloud-options.html#swift-project-domain-id","title":"swift-project-domain-id","text":"<p>Usage: <code>--swift-project-domain-id=name</code></p> <p>The Swift domain ID</p>"},{"location":"xbcloud-options.html#swift-project-id","title":"swift-project-id","text":"<p>Usage: <code>--swift-project-id=name</code></p> <p>The Swift project ID</p>"},{"location":"xbcloud-options.html#swift-user-id","title":"swift-user-id","text":"<p>Usage: <code>--swift-user-id=name</code></p> <p>The Swift user ID</p> <p></p>"},{"location":"xbcloud-options.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-s3.html","title":"Use the xbcloud binary with Amazon S3","text":""},{"location":"xbcloud-s3.html#create-a-full-backup-with-amazon-s3","title":"Create a full backup with Amazon S3","text":"<pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\nxbcloud put --storage=s3 \\\n--s3-endpoint='s3.amazonaws.com' \\\n--s3-access-key='YOUR-ACCESSKEYID' \\\n--s3-secret-key='YOUR-SECRETACCESSKEY' \\\n--s3-bucket='mysql_backups'\n--parallel=10 \\\n$(date -I)-full_backup\n</code></pre> <p>The following options are available when using Amazon S3:</p> Option Details \u2013s3-access-key Use to supply the AWS access key ID \u2013s3-secret-key Use to supply the AWS secret access key \u2013s3-bucket Use supply the AWS bucket name \u2013s3-region Use to specify the AWS region. The default value is us-east-1 \u2013s3-api-version =  Select the signing algorithm. The default value is AUTO. In this case, xbcloud will probe. \u2013s3-bucket-lookup =  Specify whether to use bucket.endpoint.com or endpoint.com/bucket*style requests. The default value is AUTO. In this case, xbcloud will probe. \u2013s3-storage-class= Specify the S3 storage class. The default storage class depends on the provider. The name options are the following:<ul><li>STANDARD</li><li>STANDARD_IA</li><li>GLACIER</li></ul> NOTE If you use the GLACIER storage class, the object must be restored to S3 before restoring the backup. Also supports using custom S3 implementations such as MinIO or CephRadosGW."},{"location":"xbcloud-s3.html#permissions-setup","title":"Permissions setup","text":"<p>Following the principle of \u201cleast-privilege\u201d, these are the minimum bucket permissions needed for xbcloud to write backups to S3: LIST/PUT/GET/DELETE.</p> <p>The following example shows the policy definition for writing to the <code>xbcloud-testing</code> bucket on the AWS S3 storage.</p> <pre><code>{\n    \"Version\": \"2012-10-17\",\n    \"Statement\": [\n        {\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"s3:ListBucket\"\n            ],\n            \"Resource\": \"arn:aws:s3:::xbcloud-testing\"\n        },\n        {\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"s3:PutObject\",\n                \"s3:PutObjectAcl\",\n                \"s3:GetObject\",\n                \"s3:GetObjectAcl\",\n                \"s3:DeleteObject\"\n            ],\n            \"Resource\": \"arn:aws:s3:::xbcloud-testing/*\"\n        }\n    ]\n}\n</code></pre>"},{"location":"xbcloud-s3.html#environment-variables","title":"Environment variables","text":"<p>The following environment variables are recognized. xbcloud maps them automatically to corresponding parameters applicable to the selected storage.</p> <ul> <li> <p>AWS_ACCESS_KEY_ID (or ACCESS_KEY_ID)</p> </li> <li> <p>AWS_SECRET_ACCESS_KEY (or SECRET_ACCESS_KEY)</p> </li> <li> <p>AWS_DEFAULT_REGION (or DEFAULT_REGION)</p> </li> <li> <p>AWS_ENDPOINT (or ENDPOINT)</p> </li> <li> <p>AWS_CA_BUNDLE</p> </li> </ul>"},{"location":"xbcloud-s3.html#restore-with-s3","title":"Restore with S3","text":"<pre><code>$ xbcloud get s3://operator-testing/bak22 \\\n--s3-endpoint=https://storage.googleapis.com/ \\\n--parallel=10 2&gt;download.log | xbstream -x -C restore --parallel=8\n</code></pre>"},{"location":"xbcloud-s3.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-swift.html","title":"Use the xbcloud binary with Swift","text":""},{"location":"xbcloud-swift.html#create-a-full-backup-with-swift","title":"Create a full backup with Swift","text":"<p>For details on the command-line options,  see the xbcloud command-line options</p> <p>The following example shows how to make a full backup and upload it to Swift.</p> <pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\nxbcloud put --storage=swift \\\n--swift-container=test \\\n--swift-user=test:tester \\\n--swift-auth-url=http://192.168.8.80:8080/ \\\n--swift-key=testing \\\n--parallel=10 \\\nfull_backup\n</code></pre> <p>The following OpenStack environment variables are also recognized and mapped automatically to the corresponding swift parameters (<code>--storage=swift</code>):</p> <ul> <li> <p>OS_AUTH_URL</p> </li> <li> <p>OS_TENANT_NAME</p> </li> <li> <p>OS_TENANT_ID</p> </li> <li> <p>OS_USERNAME</p> </li> <li> <p>OS_PASSWORD</p> </li> <li> <p>OS_USER_DOMAIN</p> </li> <li> <p>OS_USER_DOMAIN_ID</p> </li> <li> <p>OS_PROJECT_DOMAIN</p> </li> <li> <p>OS_PROJECT_DOMAIN_ID</p> </li> <li> <p>OS_REGION_NAME</p> </li> <li> <p>OS_STORAGE_URL</p> </li> <li> <p>OS_CACERT</p> </li> </ul>"},{"location":"xbcloud-swift.html#restore-with-swift","title":"Restore with Swift","text":"<pre><code>$ xbcloud get [options] &lt;name&gt; [&lt;list-of-files&gt;] | xbstream -x\n</code></pre> <p>The following example shows how to fetch and restore the backup from Swift:</p> <pre><code>$ xbcloud get --storage=swift \\\n--swift-container=test \\\n--swift-user=test:tester \\\n--swift-auth-url=http://192.168.8.80:8080/ \\\n--swift-key=testing \\\nfull_backup | xbstream -xv -C /tmp/downloaded_full\n\n$ xbcloud delete --storage=swift --swift-user=xtrabackup \\\n--swift-password=xtrabackup123! --swift-auth-version=3 \\\n--swift-auth-url=http://openstack.ci.percona.com:5000/ \\\n--swift-container=mybackup1 --swift-domain=Default\n</code></pre> <p></p>"},{"location":"xbcloud-swift.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcrypt-binary-overview.html","title":"The xbcrypt binary overview","text":"<p>To support encryption and decryption of the backups, a new tool <code>xbcrypt</code> was introduced to Percona XtraBackup.</p> <p>Percona XtraBackup 8.0.28-20 implements the <code>XBCRYPT_ENCRYPTION_KEY</code> environment variable. The variable is only used in place of the <code>--encrypt_key=name</code> option. You can use the environment variable or command line option. If you use both, the command line option takes precedence over the value specified in the environment variable.</p> <p>This utility has been modeled after The xbstream binary to perform encryption and decryption outside of Percona XtraBackup. `</p> <p>For more details on the command-line options, see xbcrypt command-line options</p> <p></p>"},{"location":"xbcrypt-binary-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcrypt-options.html","title":"The xbcrypt command-line options","text":"<p>Usage: </p> <pre><code>$ xbcrypt[OPTIONS]\n</code></pre> <p>The <code>xbcrypt</code> binary has the following command line options:</p>"},{"location":"xbcrypt-options.html#decrypt","title":"decrypt","text":"<p>usage: <code>-d</code> <code>--decrypt</code></p> <p>Decrypt data input to output.</p>"},{"location":"xbcrypt-options.html#encrypt-algo","title":"encrypt-algo","text":"<p>usage: <code>-a=name</code> <code>--encrypt-algo=name</code></p> <p>Defines the name of the encryption algorithm.</p>"},{"location":"xbcrypt-options.html#encrypt-chunk-size","title":"encrypt-chunk-size","text":"<p>usage: <code>-s=#</code> <code>--encrypt-chunk-size=#</code></p> <p>Defines the size of the working buffer for encryption in bytes. The default value is <code>64000</code>.</p>"},{"location":"xbcrypt-options.html#encrypt-key","title":"encrypt-key","text":"<p>usage: <code>-k=name</code> <code>--encrypt-key=name</code></p> <p>The name of the encryption key.</p>"},{"location":"xbcrypt-options.html#encrypt-key-file","title":"encrypt-key-file","text":"<p>usage: <code>-f=name</code> <code>--encrypt-key-file=name</code></p> <p>The name of the file that contains the encryption key.</p>"},{"location":"xbcrypt-options.html#encrypt-threads","title":"encrypt-threads","text":"<p>usage: <code>--encrypt-threads=#</code></p> <p>This option specifies the number of worker threads used for parallel encryption/decryption. The default value is 1.</p>"},{"location":"xbcrypt-options.html#input","title":"input","text":"<p>usage: <code>-i=name</code> <code>--input=name</code></p> <p>Defines the name of the optional input file. If the name is not specified, the input reads from the standard input.</p>"},{"location":"xbcrypt-options.html#output","title":"output","text":"<p>usage: <code>-o=name</code> <code>--output=name</code></p> <p>Defines the name of the optional output file. If this name is not specified, the output is written to the standard output.</p>"},{"location":"xbcrypt-options.html#read-buffer-size","title":"read-buffer-size","text":"<p>usage: <code>--read-buffer-size=#</code></p> <p>Read the buffer size. The default value is 10MB. </p>"},{"location":"xbcrypt-options.html#verbose","title":"verbose","text":"<p>usage: <code>-v</code> <code>--verbose</code></p> <p>Display status in verbose mode.</p> <p></p>"},{"location":"xbcrypt-options.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbstream-binary-overview.html","title":"The xbstream binary overview","text":"<p>To support simultaneous compression and streaming, a new custom streaming format called xbstream was introduced to Percona XtraBackup in addition to the TAR format. That was required to overcome some limitations of traditional archive formats such as tar, cpio and others which did not allow streaming dynamically generated files, for example dynamically compressed files. Other advantages of xbstream over traditional streaming/archive format include ability to stream multiple files concurrently (so it is possible to use streaming in the xbstream format together with the \u2013parallel option) and more compact data storage.</p> <p>For details on the command-line options, see xbcloud command-line options.</p> <p>The utility tries to minimize its impact on the OS page cache by using the appropriate <code>posix_fadvise()</code> calls when available.</p> <p>When compression is enabled with xtrabackup all data is compressed, including the transaction log file and meta data files, using the specified compression algorithm. Read more about supported compression algorithms in the Create a compressed backup document.</p> <p></p>"},{"location":"xbstream-binary-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbstream-options.html","title":"The xbstream command-line options","text":"<pre><code>$ xbstream -c [OPTIONS]\n$ xbstream -x [OPTIONS]\n</code></pre> <p>This utility has a tar-like interface.</p> <p>The xbstream binary has the following options:</p>"},{"location":"xbstream-options.html#absolute-names","title":"absolute-names","text":"<p>Usage: <code>-absolute-names</code></p> <p>Do not strip the leading // (slashes) from the file names when creating archives.</p>"},{"location":"xbstream-options.html#c","title":"c","text":"<p>Usage: <code>-c</code></p> <p>Streams files specified on the command line to its standard output.</p>"},{"location":"xbstream-options.html#decompress","title":"decompress","text":"<p>Usage: <code>--decompress</code></p> <p>Decompress the individual backup files</p>"},{"location":"xbstream-options.html#decompress-threads","title":"decompress-threads","text":"<p>Usage: <code>--decompress-threads=#</code></p> <p>The number of threads for parallel data decompression. The default value is 1.</p>"},{"location":"xbstream-options.html#decrypt","title":"decrypt","text":"<p>Usage: <code>--decrypt=name</code></p> <p>Specifies that xbstream automatically decrypts encrypted files when extracting input stream. The supported values are: <code>AES128</code>, <code>AES192</code>, and <code>AES256</code>. </p> <p>You can specify either <code>--encrypt-key</code> or <code>--encrypt-key-file</code> to provide the encryption key, but do not use both options. </p>"},{"location":"xbstream-options.html#directory","title":"directory","text":"<p>Usage: <code>--directory=name</code></p> <p>Change the current directory to this named directory before streaming or extracting.</p>"},{"location":"xbstream-options.html#encrypt-key","title":"encrypt-key","text":"<p>Usage: <code>--encrypt-key=name</code></p> <p>Specify the encryption key used. Do not use this option with <code>--encrypt-key-file</code>; these options are mutually exclusive.</p>"},{"location":"xbstream-options.html#encrypt-key-file","title":"encrypt-key-file","text":"<p>Usage: <code>--encrypt-key-file=name</code></p> <p>Specify the file that contains the encryption key. Do not use this option with <code>--encrypt-key</code>; these options are mutually exclusive.</p>"},{"location":"xbstream-options.html#encrypt-threads","title":"encrypt-threads","text":"<p>Usage: <code>--encrypt-threads-=#</code></p> <p>Specify the number of threads for parallel data encryption. The default value is <code>1</code>. </p>"},{"location":"xbstream-options.html#extract","title":"extract","text":"<p>Usage: <code>--extract</code></p> <p>Extract to disk the files from the stream to the standard input.</p>"},{"location":"xbstream-options.html#fifo-dir","title":"fifo-dir","text":"<p>Usage: <code>--fifo-dir=name</code></p> <p>The directory used to read or write named pipes.</p>"},{"location":"xbstream-options.html#fifo-streams","title":"fifo-streams","text":"<p>Usage: <code>--fifo-streams=#</code></p> <p>The number of FIFO files (named pipes) to use for parallel data file streaming. To disable the option and send the stream to STDOUT, set the value to 1. </p>"},{"location":"xbstream-options.html#fifo-timeout","title":"fifo-timeout","text":"<p>Usage: <code>--fifo-timeout=#</code></p> <p>The number of seconds to wait for the other end to open the stream. The default value is 60.</p>"},{"location":"xbstream-options.html#parallel","title":"parallel","text":"<p>Usage: <code>--parallel=#</code></p> <p>Defines the number of worker threads for reading or writing.</p>"},{"location":"xbstream-options.html#x","title":"x","text":"<p>Usage: <code>-x</code></p> <p>Extracts files from the stream read from its standard input to the current directory unless specified otherwise with the <code>-c</code> option. Support for parallel extraction with the <code>--parallel</code> option</p>"},{"location":"xbstream-options.html#verbose","title":"verbose","text":"<p>Usage: <code>--verbose</code></p> <p>Print verbose output</p> <p></p>"},{"location":"xbstream-options.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-binary-overview.html","title":"The xtrabackup binary overview","text":"<p>The xtrabackup binary is a compiled C program that is linked with the InnoDB libraries and the standard MySQL client libraries.</p> <p>For details on the xtrabackup command-line options, see xtrabackup command-line options.</p> <p>xtrabackup enables point-in-time backups of InnoDB / XtraDB tables together with the schema definitions, MyISAM tables, and other portions of the server.</p> <p>The InnoDB libraries provide the functionality to apply a log to data files. The MySQL client libraries are used to parse command-line options and configuration file.</p> <p>The tool runs in either <code>--backup</code> or <code>--prepare</code> mode, corresponding to the two main functions it performs. There are several variations on these functions to accomplish different tasks, and there are two less commonly used modes, <code>--stats</code> and <code>--print-param</code>.</p> <p></p>"},{"location":"xtrabackup-binary-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-exit-codes.html","title":"xtrabackup exit codes","text":"<p>The xtrabackup binary exits with the traditional success value of 0 after a backup when no error occurs. If an error occurs during the backup, the exit value is 1.</p> <p>In certain cases, the exit value can be something other than 0 or 1, due to the command-line option code included from the MySQL libraries. An unknown command-line option, for example, will cause an exit code of 255.</p> <p></p>"},{"location":"xtrabackup-exit-codes.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-files.html","title":"Index of files created by Percona XtraBackup","text":"<ul> <li>Information related to the backup and the server</li> </ul> File Name Description <code>backup-my.cnf</code> This file contains information to start the mini-instance of InnoDB during the <code>--prepare</code>. This not a backup of the original <code>my.cnf</code>. The InnoDB configuration is read from the file <code>backup-my.cnf</code> created by xtrabackup when the backup was made. The <code>--prepare</code> uses InnoDB configuration from <code>backup-my.cnf</code> by default, or from <code>--defaults-file</code>, if specified. The InnoDB\u2019s configuration in this context means server variables that affect dataformat, i.e. <code>innodb_page_size</code> option, <code>innodb_log_block_size</code>, etc. Location-related variables, like <code>innodb_log_group_home_dir</code> or <code>innodb_data_file_path</code> are always ignored by <code>--prepare</code>, so preparing a backup always works with data files from the back directory, rather than any external ones. <code>xtrabackup_checkpoints</code> The type of the backup (for example, full or incremental), its state (for example, prepared) and the LSN range contained in it. This information is used for incremental backups. Example of the <code>xtrabackup_checkpoints</code> after taking a full backup: <code>backup_type = full-backuped from lsn= 0 to_lsn = 15188961605 last_lsn = 15188961605</code> Example of the <code>xtrabackup_checkpoints</code> after taking an incremental backup: <code>backup_type = incremental from_lsn = 15188961605 to_lsn = 15189350111 last_lsn = 15189350111</code> <code>xtrabackup_binlog_info</code> The binary log file used by the server and its position at the moment of the backup. A result of the following query: <code>SELECT server_uuid, local, replication, storage_engines FROM performance_schema.log_status;</code> <code>xtrabackup_binlog</code> The xtrabackup binary used in the process. <code>xtrabackup_logfile</code> Contains data needed for running the: <code>--prepare</code>. The bigger this file is the <code>--prepare</code> process will take longer to finish. <code>&lt;table_name&gt;.delta.meta</code> This file is going to be created when performing the incremental backup. It contains the per-table delta metadata: page size, size of compressed page (if the value is 0 it means the tablespace isn\u2019t compressed) and space id. Example of this file: <code>page_size = 16384 zip_size = 0 space_id = 0</code> <ul> <li> <p>Information related to the replication environment (if using the<code>--slave-info</code> option):</p> <p><code>xtrabackup_slave_info</code></p> <p>The <code>CHANGE MASTER</code> statement needed for setting up a replica.</p> </li> <li> <p>Information related to the Galera and Percona XtraDB Cluster (if using the <code>--galera-info</code> option):</p> <p><code>xtrabackup_galera_info</code></p> <p>Contains the values of <code>wsrep_local_state_uuid</code> and<code>wsrep_last_committed</code> status variables</p> </li> </ul> <p></p>"},{"location":"xtrabackup-files.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-implementation-details.html","title":"xtrabackup implementation details","text":"<p>This page contains notes on various internal aspects of the xtrabackup tool\u2019s operation.</p>"},{"location":"xtrabackup-implementation-details.html#file-permissions","title":"File permissions","text":"<p>xtrabackup opens the source data files in read-write mode, although it does not modify the files. This means that you must run xtrabackup as a user who has permission to write the data files. The reason for opening the files in read-write mode is that xtrabackup uses the embedded InnoDB libraries to open and read the files, and InnoDB opens them in read-write mode because it normally assumes it is going to write to them.</p>"},{"location":"xtrabackup-implementation-details.html#tune-the-os-buffers","title":"Tune the OS buffers","text":"<p>Because xtrabackup reads large amounts of data from the filesystem, it uses <code>posix_fadvise()</code> where possible, to instruct the operating system not to try to cache the blocks it reads from disk. Without this hint, the operating system would prefer to cache the blocks, assuming that <code>xtrabackup</code> is likely to need them again, which is not the case. Caching such large files can place pressure on the operating system\u2019s virtual memory and cause other processes, such as the database server, to be swapped out. The <code>xtrabackup</code> tool avoids this with the following hint on both the source and destination files:</p> <pre><code>posix_fadvise(file, 0, 0, POSIX_FADV_DONTNEED)\n</code></pre> <p>In addition, xtrabackup asks the operating system to perform more aggressive read-ahead optimizations on the source files:</p> <pre><code>posix_fadvise(file, 0, 0, POSIX_FADV_SEQUENTIAL)\n</code></pre>"},{"location":"xtrabackup-implementation-details.html#copy-data-files","title":"Copy data files","text":"<p>When copying the data files to the target directory, xtrabackup reads and writes 1 MB of data at a time. This is not configurable. When copying the log file, xtrabackup reads and writes 512 bytes at a time. This is also not possible to configure, and matches InnoDB\u2019s behavior (workaround exists in Percona Server for MySQL because it has an option to tune <code>innodb_log_block_size</code> for XtraDB, and in that case Percona XtraBackup will match the tuning).</p> <p>After reading from the files, <code>xtrabackup</code> iterates over the 1MB buffer a page at a time, and checks for page corruption on each page with InnoDB\u2019s <code>buf_page_is_corrupted()</code> function. If the page is corrupt, it re-reads and retries up to 10 times for each page. It skips this check on the doublewrite buffer.</p> <p></p>"},{"location":"xtrabackup-implementation-details.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-option-reference.html","title":"The xtrabackup command-line options","text":"<p>Here you can find all of the command-line options for the xtrabackup binary.</p>"},{"location":"xtrabackup-option-reference.html#modes-of-operation","title":"Modes of operation","text":"<p>You invoke xtrabackup in one of the following modes:</p> <ul> <li> <p><code>--backup</code> mode to make a backup in a target directory</p> </li> <li> <p><code>--prepare</code> mode to restore data from a backup (created in <code>--backup</code> mode)</p> </li> <li> <p><code>--copy-back</code> to copy data from a backup to the location   that contained the original data; to move data instead of copying use   the alternate <code>--move-back</code> mode.</p> </li> <li> <p><code>--stats</code> mode to scan the specified data files and print out index statistics.</p> </li> </ul> <p>When you intend to run xtrabackup in any of these modes, use the following syntax:</p> <pre><code>$ xtrabackup [--defaults-file=#] --backup|--prepare|--copy-back|--stats [OPTIONS]\n</code></pre> <p>For example, the <code>--prepare</code> mode is applied as follows:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup/mysql/\n</code></pre> <p>For all modes, the default options are read from the xtrabackup and mysqld configuration groups from the following files in the given order:</p> <ol> <li> <p><code>/etc/my.cnf</code></p> </li> <li> <p><code>/etc/mysql/my.cnf</code></p> </li> <li> <p><code>/usr/etc/my.cnf</code></p> </li> <li> <p><code>~/.my.cnf</code>.</p> </li> </ol> <p>As the first parameter to xtrabackup (in place of the <code>--defaults-file</code>, you may supply one of the following:</p> <ul> <li> <p><code>--print-defaults</code> to have xtrabackup print the argument list and exit.</p> </li> <li> <p><code>--no-defaults</code> to forbid reading options from any file but the login file.</p> </li> <li> <p><code>--defaults-file</code> to read the default options from the given file.</p> </li> <li> <p><code>--defaults-extra-file</code> to read the specified additional file after   the global files have been read.</p> </li> <li> <p><code>--defaults-group-suffix</code> to read the configuration groups with the   given suffix. The effective group name is constructed by concatenating the default   configuration groups (xtrabackup and mysqld) with the given suffix.</p> </li> <li> <p><code>--login-path</code> to read the given path from the login file.</p> </li> </ul>"},{"location":"xtrabackup-option-reference.html#innodb-options","title":"InnoDB options","text":"<p>A large group of InnoDB options are generally read from the <code>my.cnf</code> configuration file, so xtrabackup boots up its embedded InnoDB in the same configuration as your current server. You usually do not need to specify them explicitly. These options have the same behavior in InnoDB and XtraDB. See <code>--innodb-miscellaneous</code> for more information.</p>"},{"location":"xtrabackup-option-reference.html#options","title":"Options","text":""},{"location":"xtrabackup-option-reference.html#apply-log-only","title":"apply-log-only","text":"<p>Usage: <code>--apply-log-only</code></p> <p>This option causes only the redo stage to be performed when preparing a backup. It is very important for incremental backups.</p>"},{"location":"xtrabackup-option-reference.html#backup","title":"backup","text":"<p>Usage: <code>--backup</code></p> <p>Make a backup and place it in <code>--target-dir</code>. See Create a full backup.</p>"},{"location":"xtrabackup-option-reference.html#backup-lock-timeout","title":"backup-lock-timeout","text":"<p>Usage: <code>--backup-lock-timeout</code></p> <p>The timeout in seconds for attempts to acquire metadata locks.</p>"},{"location":"xtrabackup-option-reference.html#backup-lock-retry-count","title":"backup-lock-retry-count","text":"<p>Usage: <code>--backup-lock-retry-count</code></p> <p>The number of attempts to acquire metadata locks.</p>"},{"location":"xtrabackup-option-reference.html#backup-locks","title":"backup-locks","text":"<p>Usage: <code>--backup-locks</code></p> <p>This option controls if backup locks should be used instead of <code>FLUSH TABLES WITH READ LOCK</code> on the backup stage. The option has no effect when the server does not support backup locks. This option is enabled by default, disable with <code>--no-backup-locks</code>.</p>"},{"location":"xtrabackup-option-reference.html#check-privileges","title":"check-privileges","text":"<p>Usage: <code>check-privileges</code></p> <p>This option checks if Percona XtraBackup has all required privileges. If a required privilege is missing for the current operation, the operation terminates and prints an error message. If a privilege is not needed for the current operation, but is missing and may be necessary for another XtraBackup operation, the operation is not aborted, and prints a warning.</p> Example output <pre><code>```{.text .no-copy}\nxtrabackup: Error: missing required privilege LOCK TABLES on *.*\nxtrabackup: Warning: missing required privilege REPLICATION CLIENT on *.*\n```\n</code></pre>"},{"location":"xtrabackup-option-reference.html#close-files","title":"close-files","text":"<p>Usage: <code>--close-files</code></p> <p>Do not keep files opened. When xtrabackup opens a tablespace, xtrabackup normally doesn\u2019t close its file handle. This operation allows xtrabackup to handle the DDL operations correctly. However, if the number of tablespaces is huge and can not fit into any limit, there is an option to close file handles once they are no longer accessed. Percona XtraBackup can produce inconsistent backups with this option enabled. Use at your own risk.</p>"},{"location":"xtrabackup-option-reference.html#compress","title":"compress","text":"<p>Usage: <code>--compress</code></p> <p>xtrabackup compresses all output data, including the transaction log and metadata files. </p> Version updates Option changes Percona XtraBackup 8.0.34-29 * The <code>qpress/QuickLZ</code> compression algorithm is no longer supported for compress operations.  * The <code>ZSTD</code> compression algorithm is moved to  General Availability  . This version makes <code>ZSTD</code> the default compression method for the <code>--compress</code> option.  * <code>--compress</code> produces <code>\\*.zst</code> files. You can specify <code>ZSTD</code> compression level with the <code>--compress-zstd-level=#</code> option.  * <code>--compress=lz4</code> produces <code>\\*.lz4</code> files. You can extract the contents of these files by using <code>lz4</code> program.  You can extract the contents of the files by using the <code>--decompress</code> option. To decompress backups taken by older versions of Percona XtraBackup that used a QuickLZ compression algorithm, the <code>--decompress</code> option still supports <code>qpress</code> for backward compatibility. Percona XtraBackup 8.0.33-28 and lower versions The <code>--compress</code> option uses either the <code>quicklz</code> , <code>lz4</code> , or <code>ZSTD</code> compression algorithm to compress all output data. The <code>quicklz</code> algorithm is chosen by default. When using <code>--compress=quicklz</code> or <code>--compress</code> , the resulting files have the qpress archive format. Every <code>\\*.qp</code> file produced by xtrabackup is essentially a one-file qpress archive and can be extracted and uncompressed by the <code>qpress</code> file archiver.  * <code>--compress=zstd</code> produces <code>\\*.zst</code> files. You can specify <code>ZSTD</code> compression level with the <code>[--compress-zstd-level=#</code>](#compress-zstd-level) option.  * <code>--compress=lz4</code> produces <code>\\*.lz4</code> files. You can extract the contents of these files by using <code>lz4</code> program.  You can extract the contents of the files by using the <code>--decompress</code> option. Percona XtraBackup 8.0.30-23 Adds the Zstandard ( <code>ZSTD</code> ) compression algorithm in  tech preview  . The <code>ZSTD</code> algorithm is a fast lossless compression algorithm that targets real-time compression scenarios and better compression ratios.  To compress files using the ZSTD compression algorithm, set the <code>--compress</code> option to zstd. The <code>--compress=zstd</code> option produces <code>*.zst</code> files. You can extract the contents of these files with the <code>--decompress</code> option. Also, you can specify the ZSTD compression level with the  \u2013compress-zstd-level=#) option."},{"location":"xtrabackup-option-reference.html#compress-chunk-size","title":"compress-chunk-size","text":"<p>Usage: <code>--compress-chunk-size=#</code></p> <p>Size of working buffer(s) for compression threads in bytes. The default value is 64K.</p>"},{"location":"xtrabackup-option-reference.html#compress-threads","title":"compress-threads","text":"<p>Usage: <code>--compress-threads=#</code> This option specifies the number of worker threads xtrabackup uses for parallel data compression. This option defaults to <code>1</code>. Parallel compression (<code>--compress-threads</code>) can be used with <code>--parallel</code>. </p> <p>For example, <code>--parallel=4 --compress --compress-threads=2</code>  creates 4 I/O threads that read and then pipe that data to 2 compression threads.</p>"},{"location":"xtrabackup-option-reference.html#compress-zstd-level","title":"compress-zstd-level","text":"<p>Usage: <code>--compress-zstd-level=#</code></p> <p>This option specifies the <code>ZSTD</code> compression level. Compression levels provide a trade-off between the compression speed and the size of the compressed file. A lower compression level provides faster compression speed but larger file sizes. A higher compression level provides lower compression speed but smaller file sizes. For example, set level 1 if the compression speed is the most important for you. Set level 19 if the size of the compressed files is the most important.</p> <p>The default value is 1. The allowed range is from 1 to 19.</p> <p>Percona XtraBackup 8.0.30-22 implemented this option.</p>"},{"location":"xtrabackup-option-reference.html#copy-back","title":"copy-back","text":"<p>Usage: <code>--copy-back</code></p> <p>Copy all the files in a previously made backup from the backup directory to their original locations. This option will not copy over existing files unless <code>--force-non-empty-directories</code> option is specified.</p>"},{"location":"xtrabackup-option-reference.html#core-file","title":"core-file","text":"<p>Usage: <code>--core-file</code></p> <p>Write core on fatal signals.</p>"},{"location":"xtrabackup-option-reference.html#databases","title":"databases","text":"<p>Usage: <code>--databases=#</code></p> <p>This option specifies a list of databases and tables that should be backed up. The option accepts the list of the form <code>\"databasename1[.table_name1] databasename2[.table_name2] . . .\"</code>.</p>"},{"location":"xtrabackup-option-reference.html#databases-exclude","title":"databases-exclude","text":"<p>Usage: <code>--databases-exclude=name</code></p> <p>Databases are excluded based on name. This option operates the same way as <code>--databases</code>, but excludes the matched names from the backup. </p> <p>This option has a higher priority than <code>--databases</code>.</p>"},{"location":"xtrabackup-option-reference.html#databases-file","title":"databases-file","text":"<p>Usage: <code>--databases-file=#</code></p> <p>This option specifies the path to the file containing the list of databases and tables that should be backed up. The file can contain the list elements of the form <code>databasename1[.table_name1]</code>, one element per line.</p>"},{"location":"xtrabackup-option-reference.html#datadir","title":"datadir","text":"<p>Usage: <code>--datadir=DIRECTORY</code></p> <p>The source directory for the backup. This directory should be the same as the datadir for your MySQL server, so it should be read from <code>my.cnf</code> if that exists; otherwise, you must specify it on the command line.</p> <p>When combined with the <code>--copy-back</code> or <code>--move-back</code> option, <code>--datadir</code> refers to the destination directory.</p> <p>Once connected to the server, to perform a backup, you will need <code>READ</code> and <code>EXECUTE</code> permissions at a filesystem level in the server\u2019s datadir.</p>"},{"location":"xtrabackup-option-reference.html#debug-sleep-before-unlock","title":"debug-sleep-before-unlock","text":"<p>Usage: <code>--debug-sleep-before-unlock=#</code></p> <p>This is a debug-only option used by the xtrabackup test suite.</p>"},{"location":"xtrabackup-option-reference.html#debug-sync","title":"debug-sync","text":"<p>Usage: <code>--debug-sync=name</code></p> <p>The debug sync point. This option is only used by the xtrabackup test suite.</p>"},{"location":"xtrabackup-option-reference.html#decompress","title":"decompress","text":"<p>Usage: <code>--decompress</code></p> <p>Decompresses all files in a backup previously made with the <code>--compress</code> option. The <code>--parallel</code> option will allow multiple files to be decrypted simultaneously. To decompress files compressed with <code>quicklz</code> compression algorithm, install the qpress utility. It must be accessible within the path. Percona XtraBackup does not automatically remove the compressed files. To clean up the backup directory users should use <code>--remove-original</code> option.</p> <p>The <code>--decompress</code> option may be used with xbstream to decompress individual qpress files.</p>"},{"location":"xtrabackup-option-reference.html#decompress-threads","title":"decompress-threads","text":"<p>Usage: <code>--decompress-threads=#</code></p> <p>Force xbstream to use the specified number of threads for decompressing.</p>"},{"location":"xtrabackup-option-reference.html#decrypt","title":"decrypt","text":"<p>Usage: <code>--decrypt=ENCRYPTION-ALGORITHM</code></p> <p>Decrypts all files with the <code>.xbcrypt</code> extension in a backup previously made with <code>--encrypt</code> option. The <code>--parallel</code> option will allow multiple files to be decrypted simultaneously. Percona XtraBackup doesn\u2019t automatically remove the encrypted files. To clean up the backup directory users should use <code>--remove-original</code> option.</p>"},{"location":"xtrabackup-option-reference.html#defaults-extra-file","title":"defaults-extra-file","text":"<p>Usage: <code>--defaults-extra-file=[MY.CNF]</code></p> <p>Read this file after the global files are read. This option must be written as the first option on the command line.</p>"},{"location":"xtrabackup-option-reference.html#defaults-file","title":"defaults-file","text":"<p>Usage: <code>--defaults-file=[MY.CNF]</code></p> <p>Only read default options from the given file. Must be given as the first option on the command-line. Must be a real file; it cannot be a symbolic link.</p>"},{"location":"xtrabackup-option-reference.html#defaults-group","title":"defaults-group","text":"<p>Usage: <code>--defaults-group=GROUP-NAME</code>This option sets the group that should be read from the configuration file. This option is used by xtrabackup if you use the <code>--defaults-group</code> option. It is needed for <code>mysqld_multi</code> deployments.</p>"},{"location":"xtrabackup-option-reference.html#defaults-group-suffix","title":"defaults-group-suffix","text":"<p>Usage: <code>--defaults-group-suffix=#</code></p> <p>Also reads groups with concat(group, suffix).</p>"},{"location":"xtrabackup-option-reference.html#dump-innodb-buffer-pool","title":"dump-innodb-buffer-pool","text":"<p>Usage: <code>--dump-innodb-buffer-pool</code></p> <p>This option controls whether or not a new dump of buffer pool content should be done.</p> <p>With <code>--dump-innodb-buffer-pool</code>, xtrabackup makes a request to the server to start the buffer pool dump (it takes some time to complete and is done in the background) at the beginning of a backup provided the status variable <code>innodb_buffer_pool_dump_status</code> reports that the dump has been completed.</p> <pre><code>$ xtrabackup --backup --dump-innodb-buffer-pool --target-dir=/home/user/backup\n</code></pre> <p>By default, this option is set to OFF.</p> <p>If <code>innodb_buffer_pool_dump_status</code> reports that there is running dump of the buffer pool, xtrabackup waits for the dump to complete using the value of <code>--dump-innodb-buffer-pool-timeout</code></p> <p>The file <code>ib_buffer_pool</code> stores tablespace ID and page ID data to warm up the buffer pool sooner.</p>"},{"location":"xtrabackup-option-reference.html#dump-innodb-buffer-pool-timeout","title":"dump-innodb-buffer-pool-timeout","text":"<p>Usage: <code>--dump-innodb-buffer-pool-timeout</code></p> <p>This option contains the number of seconds that xtrabackup should monitor the value of <code>innodb_buffer_pool_dump_status</code> to determine if buffer pool dump has completed.</p> <p>This option is used in combination with <code>--dump-innodb-buffer-pool</code>. By default, it is set to 10 seconds.</p>"},{"location":"xtrabackup-option-reference.html#dump-innodb-buffer-pool-pct","title":"dump-innodb-buffer-pool-pct","text":"<p>Usage: <code>--dump-innodb-buffer-pool-pct</code></p> <p>This option contains the percentage of the most recently used buffer pool pages to dump.</p> <p>This option is effective if <code>--dump-innodb-buffer-pool</code> option is set to ON. If this option contains a value, xtrabackup sets the MySQL system variable <code>innodb_buffer_pool_dump_pct</code>. As soon as the buffer pool dump completes or it is stopped (see <code>--dump-innodb-buffer-pool-timeout</code>), the value of the MySQL system variable is restored.</p>"},{"location":"xtrabackup-option-reference.html#encrypt","title":"encrypt","text":"<p>Usage: <code>--encrypt=ENCRYPTION_ALGORITHM</code></p> <p>This option instructs xtrabackup to encrypt backup copies of InnoDB data files using the algorithm specified in the ENCRYPTION_ALGORITHM. Currently supported algorithms are: <code>AES128</code>, <code>AES192</code> and <code>AES256</code></p>"},{"location":"xtrabackup-option-reference.html#encrypt-key","title":"encrypt-key","text":"<p>Usage: <code>--encrypt-key=ENCRYPTION_KEY</code></p> <p>A proper length encryption key to use. It is not recommended to use this option where there is uncontrolled access to the machine as the command line and thus the key can be viewed as part of the process info.</p>"},{"location":"xtrabackup-option-reference.html#encrypt-key-file","title":"encrypt-key-file","text":"<p>Usage: <code>--encrypt-key-file=ENCRYPTION_KEY_FILE</code></p> <p>The name of a file where the raw key of the appropriate length can be read from. The file must be a simple binary (or text) file that contains exactly the key to be used.</p> <p>It is passed directly to the xtrabackup child process. See the xtrabackup documentation for more details.</p>"},{"location":"xtrabackup-option-reference.html#encrypt-threads","title":"encrypt-threads","text":"<p>Usage: <code>--encrypt-threads=#</code></p> <p>This option specifies the number of worker threads that will be used for parallel encryption/decryption. See the xtrabackup documentation for more details.</p>"},{"location":"xtrabackup-option-reference.html#encrypt-chunk-size","title":"encrypt-chunk-size","text":"<p>Usage: <code>--encrypt-chunk-size=#</code></p> <p>This option specifies the size of the internal working buffer for each encryption thread, measured in bytes. It is passed directly to the xtrabackup child process.</p> <p>To adjust the chunk size for encrypted files, use <code>--read-buffer-size</code> and <code>--encrypt-chunk-size</code>.</p>"},{"location":"xtrabackup-option-reference.html#estimate-memory","title":"estimate-memory","text":"<p>Usage: <code>--estimate-memory=#</code></p> <p>This option is in tech preview. Before using this option in production, we recommend that you test restoring production from physical backups in your environment, and also use the alternative backup method for redundancy.</p> <p>Implemented in Percona XtraBackup 8.0.32-26, the option lets you enable or disable the Smart memory estimation feature. The default value is OFF. Enable the feature by setting <code>--estimate-memory=ON</code> in the backup phase and setting the <code>--use-free-memory-pct</code> option in the <code>--prepare</code> phase. If the <code>--estimate-memory</code> setting is disabled, the <code>--use-free-memory-pct</code> setting is ignored.</p> <p>An example of how to enable the Smart memory estimation feature:</p> <pre><code>$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/\n</code></pre> <pre><code>$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/\n</code></pre>"},{"location":"xtrabackup-option-reference.html#export","title":"export","text":"<p>Usage: <code>--export</code></p> <p>Create files necessary for exporting tables. See restore individual tables.</p>"},{"location":"xtrabackup-option-reference.html#extra-lsndir","title":"extra-lsndir","text":"<p>Usage: <code>--extra-lsndir=DIRECTORY</code></p> <p>(for \u2013backup): save an extra copy of the <code>xtrabackup_checkpoints</code> and <code>xtrabackup_info</code> files in this directory.</p>"},{"location":"xtrabackup-option-reference.html#force-non-empty-directories","title":"force-non-empty-directories","text":"<p>Usage: <code>--force-non-empty-directories</code></p> <p>When specified, it makes <code>--copy-back</code> and <code>--move-back</code> option transfer files to non-empty directories. No existing files will be overwritten. If files that need to be copied/moved from the backup directory already exist in the destination directory, it will still fail with an error.</p>"},{"location":"xtrabackup-option-reference.html#ftwrl-wait-timeout","title":"ftwrl-wait-timeout","text":"<p>Usage: <code>--ftwrl-wait-timeout=SECONDS</code></p> <p>This option specifies time in seconds that xtrabackup should wait for queries that would block <code>FLUSH TABLES WITH READ LOCK</code> before running it. If there are still such queries when the timeout expires, xtrabackup terminates with an error. Default is <code>0</code>, in which case it does not wait for queries to complete and starts <code>FLUSH TABLES WITH READ LOCK</code> immediately. Where supported xtrabackup will automatically use Backup Locks as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p>"},{"location":"xtrabackup-option-reference.html#ftwrl-wait-threshold","title":"ftwrl-wait-threshold","text":"<p>Usage: <code>--ftwrl-wait-threshold=SECONDS</code></p> <p>This option specifies the query run time threshold which is used by xtrabackup to detect long-running queries with a non-zero value of <code>--ftwrl-wait-timeout</code>. <code>FLUSH TABLES WITH READ LOCK</code> is not started until such long-running queries exist. This option has no effect if <code>--ftwrl-wait-timeout</code> is <code>0</code>. Default value is <code>60</code> seconds. Where supported xtrabackup will automatically use Backup Locks as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p>"},{"location":"xtrabackup-option-reference.html#ftwrl-wait-query-type","title":"ftwrl-wait-query-type","text":"<p>Usage: <code>--ftwrl-wait-query-type=all|update</code></p> <p>This option specifies which types of queries are allowed to complete before xtrabackup will issue the global lock. Default is <code>all</code>.</p>"},{"location":"xtrabackup-option-reference.html#galera-info","title":"galera-info","text":"<p>Usage: <code>--galera-info</code></p> <p>This option creates the <code>xtrabackup_galera_info</code> file which contains the local node state at the time of the backup. Option should be used when performing the backup of Percona XtraDB Cluster. It has no effect when backup locks are used to create the backup.</p>"},{"location":"xtrabackup-option-reference.html#generate-new-master-key","title":"generate-new-master-key","text":"<p>Usage: <code>--generate-new-master-key</code></p> <p>Generate a new master key when doing a copy-back.</p>"},{"location":"xtrabackup-option-reference.html#generate-transition-key","title":"generate-transition-key","text":"<p>Usage: <code>--generate-transition-key</code></p> <p>xtrabackup needs to access the same keyring file or vault server during prepare and copy-back but it should not depend on whether the server keys have been purged.</p> <p><code>--generate-transition-key</code> creates and adds to the keyring a transition key for xtrabackup to use if the master key used for encryption is not found because it has been rotated and purged.</p>"},{"location":"xtrabackup-option-reference.html#get-server-public-key","title":"get-server-public-key","text":"<p>Usage: <code>--get-server-public-key</code></p> <p>Get the server public key</p>"},{"location":"xtrabackup-option-reference.html#help","title":"help","text":"<p>Usage: <code>--help</code></p> <p>When run with this option or without any options xtrabackup displays information about how to run the program on the command line along with all supported options and variables with default values where appropriate.</p>"},{"location":"xtrabackup-option-reference.html#history","title":"history","text":"<p>Usage: <code>--history=NAME</code></p> <p>This option enables the tracking of backup history in the <code>PERCONA_SCHEMA.xtrabackup_history</code> table. An optional history series name may be specified that will be placed with the history record for the current backup being taken.</p>"},{"location":"xtrabackup-option-reference.html#host","title":"host","text":"<p>Usage: <code>--host=HOST</code></p> <p>This option accepts a string argument that specifies the host to use when connecting to the database server with TCP/IP. It is passed to the mysql child process without alteration. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#incremental-basedir","title":"incremental-basedir","text":"<p>Usage: <code>--incremental-basedir=DIRECTORY</code></p> <p>When creating an incremental backup, this is the directory containing the full backup that is the base dataset for the incremental backups.</p>"},{"location":"xtrabackup-option-reference.html#incremental-dir","title":"incremental-dir","text":"<p>Usage: <code>--incremental-dir=DIRECTORY</code></p> <p>When preparing an incremental backup, this is the directory where the incremental backup is combined with the full backup to make a new full backup.</p>"},{"location":"xtrabackup-option-reference.html#incremental-force-scan","title":"incremental-force-scan","text":"<p>Usage: <code>--incremental-force-scan</code></p> <p>When creating an incremental backup, force a full scan of the data pages in that instance.</p>"},{"location":"xtrabackup-option-reference.html#incremental-history-name","title":"incremental-history-name","text":"<p>Usage: <code>--incremental-history-name=name</code></p> <p>This option specifies the name of the backup series stored in the <code>PERCONA_SCHEMA.xtrabackup_history</code> history record to base an incremental backup on. xtrabackup will search the history table looking for the most recent (highest <code>innodb_to_lsn</code>), successful backup in the series and take the to_lsn value to use as the starting <code>lsn</code> for the incremental backup. This will be mutually exclusive with <code>--incremental-history-uuid</code>, <code>--incremental-basedir</code> and <code>--incremental-lsn</code>. If no valid lsn can be found (no series by that name, no successful backups by that name) xtrabackup will return with an error. It is used with the <code>--incremental</code> option.</p>"},{"location":"xtrabackup-option-reference.html#incremental-history-uuid","title":"incremental-history-uuid","text":"<p>Usage: <code>--incremental-history-uuid=name</code></p> <p>This option specifies the UUID of the specific history record stored in the <code>PERCONA_SCHEMA.xtrabackup_history</code> to base an incremental backup on. <code>--incremental-history-name</code>, <code>--incremental-basedir</code> and <code>--incremental-lsn</code>. If no valid lsn can be found (no success record with that UUID) xtrabackup will return with an error. It is used with the \u2013incremental option.</p>"},{"location":"xtrabackup-option-reference.html#incremental-lsn","title":"incremental-lsn","text":"<p>Usage: <code>--incremental-lsn=LSN</code></p> <p>When creating an incremental backup, you can specify the log sequence number (LSN) instead of specifying <code>--incremental-basedir</code>. For databases created in 5.1 and later, specify the LSN as a single 64-bit integer. </p> <p>Important</p> <p>If a wrong LSN value is specified (a user error which Percona XtraBackup does not detect), the backup is unusable. Be careful!</p>"},{"location":"xtrabackup-option-reference.html#innodb","title":"innodb","text":"<p>Usage: <code>--innodb=name</code></p> <p>This option is ignored for MySQL option compatibility.</p>"},{"location":"xtrabackup-option-reference.html#innodb-miscellaneous","title":"innodb-miscellaneous","text":"<p>Usage: <code>--innodb-miscellaneous</code></p> <p>There is a large group of InnoDB options that are normally read from the <code>my.cnf</code> configuration file, so that xtrabackup boots up its embedded InnoDB in the same configuration as your current server. You normally do not need to specify these explicitly. These options have the same behavior in InnoDB and XtraDB:</p>"},{"location":"xtrabackup-option-reference.html#keyring-file-data","title":"keyring-file-data","text":"<p>Usage: <code>--keyring-file-data=FILENAME</code></p> <p>The path to the keyring file. Combine this option with <code>--xtrabackup-plugin-dir</code>.</p>"},{"location":"xtrabackup-option-reference.html#kill-long-queries-timeout","title":"kill-long-queries-timeout","text":"<p>Usage: <code>--kill-long-queries-timeout=SECONDS</code></p> <p>This option specifies the number of seconds xtrabackup waits between starting <code>FLUSH TABLES WITH READ LOCK</code> and killing those queries that block it. Default is 0 seconds, which means xtrabackup will not attempt to kill any queries. In order to use this option xtrabackup user should have the <code>PROCESS</code> and <code>SUPER</code> privileges. Where supported, xtrabackup automatically uses Backup locks as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p>"},{"location":"xtrabackup-option-reference.html#kill-long-query-type","title":"kill-long-query-type","text":"<p>Usage: <code>--kill-long-query-type=all|select</code></p> <p>This option specifies which types of queries should be killed to unblock the global lock. Default is \u201cselect\u201d.</p>"},{"location":"xtrabackup-option-reference.html#lock-ddl","title":"lock-ddl","text":"<p>Usage: <code>--lock-ddl</code></p> <p>Issue <code>LOCK TABLES FOR BACKUP</code> if it is supported by server (otherwise use <code>LOCK INSTANCE FOR BACKUP</code>) at the beginning of the backup to block all DDL operations.</p> <p>Note</p> <p>Prior to Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup stops the SQL replica thread after the InnoDB tables and before the non-InnoDB tables are backed up.</p> <p>As of Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup option stops the SQL replica thread before copying the InnoDB files.</p>"},{"location":"xtrabackup-option-reference.html#lock-ddl-per-table","title":"lock-ddl-per-table","text":"<p>Usage: <code>--lock-ddl-per-table</code></p> <p>Lock DDL for each table before xtrabackup starts to copy it and until the backup is completed.</p> <p>Note</p> <p>The [\u2013lock-ddl-per-table] option is deprecated. Use the [\u2013lock-ddl] option instead.</p>"},{"location":"xtrabackup-option-reference.html#lock-ddl-timeout","title":"lock-ddl-timeout","text":"<p>Usage: <code>--lock-ddl-timeout</code></p> <p>If <code>LOCK TABLES FOR BACKUP</code> or <code>LOCK INSTANCE FOR BACKUP</code> does not return within given timeout, abort the backup.</p>"},{"location":"xtrabackup-option-reference.html#log","title":"log","text":"<p>Usage: <code>--log</code></p> <p>This option is ignored for MySQL</p>"},{"location":"xtrabackup-option-reference.html#log-bin","title":"log-bin","text":"<p>Usage: <code>--log-bin</code></p> <p>The base name for the log sequence.</p>"},{"location":"xtrabackup-option-reference.html#log-bin-index","title":"log-bin-index","text":"<p>Usage: <code>--log-bin-index=name</code></p> <p>File that holds the names for binary log files.</p>"},{"location":"xtrabackup-option-reference.html#log-copy-interval","title":"log-copy-interval","text":"<p>Usage: <code>--log-copy-interval=#</code></p> <p>This option specifies the time interval between checks done by the log copying thread in milliseconds (default is 1 second).</p>"},{"location":"xtrabackup-option-reference.html#login-path","title":"login-path","text":"<p>Usage: <code>--login-path</code></p> <p>Read the given path from the login file.</p>"},{"location":"xtrabackup-option-reference.html#move-back","title":"move-back","text":"<p>Usage: <code>--move-back</code></p> <p>Move all the files in a previously made backup from the backup directory to their original locations. As this option removes backup files, it must be used with caution.</p>"},{"location":"xtrabackup-option-reference.html#no-backup-locks","title":"no-backup-locks","text":"<p>Usage: <code>--no-backup-locks</code></p> <p>Explicity disables the <code>--backup-locks</code> option which is enabled by default.</p>"},{"location":"xtrabackup-option-reference.html#no-defaults","title":"no-defaults","text":"<p>Usage: <code>--no-defaults</code></p> <p>The default options are only read from the login file.</p>"},{"location":"xtrabackup-option-reference.html#no-lock","title":"no-lock","text":"<p>Usage: <code>--no-lock</code></p> <p>Disables table lock with <code>FLUSH TABLES WITH READ LOCK</code>. Use it only if all your tables are InnoDB and you do not care about the binary log position of the backup. This option shouldn\u2019t be used if there are any <code>DDL</code> statements being executed or if any updates are happening on non-InnoDB tables (this includes the system MyISAM tables in the mysql database), otherwise it could lead to an inconsistent backup. Where supported xtrabackup will automatically use Backup locks as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.  If you are considering to use this because your backups are failing to acquire the lock, this could be because of incoming replication events are preventing the lock from succeeding. Please try using <code>--safe-slave-backup</code> to momentarily stop the replication replica thread, this may help the backup to succeed and you do not need to use this option.</p>"},{"location":"xtrabackup-option-reference.html#no-server-version-check","title":"no-server-version-check","text":"<p>Usage: <code>--no-server-version-check</code></p> <p>Implemented in Percona XtraBackup 8.0.21.</p> <p>The <code>--no-server-version-check</code> option disables the server version check.</p> <p>The default behavior runs a check that compares the source system version to the Percona XtraBackup version. If the source system version is higher than the XtraBackup version, the backup is aborted with a message.</p> <p>Adding the option overrides this check, and the backup proceeds, but there may be issues with the backup.</p> <p>See Server Version and Backup Version Comparison for more information.</p>"},{"location":"xtrabackup-option-reference.html#no-version-check","title":"no-version-check","text":"<p>Usage: <code>--no-version-check</code></p> <p>This option disables the version check. If you do not pass this option, the automatic version check is enabled implicitly when xtrabackup runs in the <code>--backup</code> mode. To disable the version check, you should pass explicitly the <code>--no-version-check</code> option when invoking xtrabackup.</p> <p>When the automatic version check is enabled, xtrabackup performs a version check against the server on the backup stage after creating a server connection. xtrabackup sends the following information to the server:</p> <ul> <li> <p>MySQL flavor and version</p> </li> <li> <p>Operating system name</p> </li> <li> <p>Percona Toolkit version</p> </li> <li> <p>Perl version</p> </li> </ul> <p>Each piece of information has a unique identifier. This is a MD5 hash value that Percona Toolkit uses to obtain statistics about how it is used. This is a random UUID; no client information is either collected or stored.</p>"},{"location":"xtrabackup-option-reference.html#open-files-limit","title":"open-files-limit","text":"<p>Usage: <code>--open-files-limit=#</code></p> <p>The maximum number of file descriptors to reserve with setrlimit().</p>"},{"location":"xtrabackup-option-reference.html#parallel","title":"parallel","text":"<p>Usage: <code>--parallel=#</code></p> <p>This option specifies the number of threads to use to copy multiple data files concurrently when creating a backup. The default value is 1 (i.e., no concurrent transfer). In Percona XtraBackup 2.3.10 and newer, this option can be used with the <code>--copy-back</code> option to copy the user data files in parallel (redo logs and system tablespaces are copied in the main thread).</p>"},{"location":"xtrabackup-option-reference.html#password","title":"password","text":"<p>Usage: <code>--password=PASSWORD</code></p> <p>This option specifies the password to use when connecting to the database. It accepts a string argument. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#plugin-load","title":"plugin-load","text":"<p>Usage: <code>--plugin-load</code></p> <p>List of plugins to load.</p>"},{"location":"xtrabackup-option-reference.html#port","title":"port","text":"<p>Usage: <code>--port=PORT</code></p> <p>This option accepts a string argument that specifies the port to use when connecting to the database server with TCP/IP. It is passed to the mysql child process without alteration. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#prepare","title":"prepare","text":"<p>Usage: <code>--prepare</code></p> <p>Makes xtrabackup perform a recovery on a backup created with <code>--backup</code>, so that it is ready to use. See preparing a backup.</p>"},{"location":"xtrabackup-option-reference.html#print-defaults","title":"print-defaults","text":"<p>Usage: <code>--print-defaults</code></p> <p>Print the program argument list and exit. Must be given as the first option on the command-line.</p>"},{"location":"xtrabackup-option-reference.html#print-param","title":"print-param","text":"<p>Usage: <code>--print-param</code></p> <p>Makes xtrabackup print out parameters that can be used for copying the data files back to their original locations to restore them.</p>"},{"location":"xtrabackup-option-reference.html#read-buffer-size","title":"read-buffer-size","text":"<p>Usage: <code>--read-buffer-size</code></p> <p>Sets the read buffer size. The given value is scaled up to page size. The default size is 10MB. Use this option to increase the xbcloud/xbstream chunk size from the default size. To adjust the chunk size for encrypted files, use <code>--read-buffer-size</code> and <code>--encrypt-chunk-size</code>.</p>"},{"location":"xtrabackup-option-reference.html#redo-log-arch-dir","title":"redo-log-arch-dir","text":"<p>Usage: <code>--redo-log-arch-dir=name</code></p> <p>This option sets the redo log archive directory if this directory is not already set on the server. To use this option, you must run Percona XtraBackup as the owner of <code>mysqld</code>. Additionally, the user must have at least one of the following privileges: <code>SUPER</code> or <code>SYSTEM_VARIABLES_ADMIN</code>.</p> <p>Implemented in Percona XtraBackup 8.0.34-29.</p>"},{"location":"xtrabackup-option-reference.html#register-redo-log-consumer","title":"register-redo-log-consumer","text":"<p>Usage: <code>--register-redo-log-consumer</code></p> <p>The <code>--register-redo-log-consumer</code> parameter is disabled by default. When enabled, this parameter lets Percona XtraBackup register as a redo log consumer at the start of the backup. The server does not remove a redo log that Percona XtraBackup (the consumer) has not yet copied. The consumer reads the redo log and manually advances the log sequence number (LSN). The server blocks the writes during the process. Based on the redo log consumption, the server determines when it can purge the log.</p> <p>Implemented in Percona XtraBackup 8.0.30-23.</p>"},{"location":"xtrabackup-option-reference.html#remove-original","title":"remove-original","text":"<p>Usage: <code>--remove-original</code></p> <p>Implemented in Percona XtraBackup 2.4.6, this option when specified will remove <code>.qp</code>, <code>.xbcrypt</code> and <code>.qp.xbcrypt</code> files after decryption and decompression.</p>"},{"location":"xtrabackup-option-reference.html#rocksdb-datadir","title":"rocksdb-datadir","text":"<p>Usage: <code>--rocksdb-datadir</code></p> <p>RocksDB data directory</p>"},{"location":"xtrabackup-option-reference.html#rocksdb-wal-dir","title":"rocksdb-wal-dir","text":"<p>Usage: <code>--rocksdb-wal-dir</code></p> <p>RocksDB WAL directory.</p>"},{"location":"xtrabackup-option-reference.html#rocksdb-checkpoint-max-age","title":"rocksdb-checkpoint-max-age","text":"<p>Usage: <code>--rocksdb-checkpoint-max-age</code></p> <p>The checkpoint cannot be older than this number of seconds when the backup completes.</p>"},{"location":"xtrabackup-option-reference.html#rocksdb-checkpoint-max-count","title":"rocksdb-checkpoint-max-count","text":"<p>Usage: <code>--rocksdb-checkpoint-max-count</code></p> <p>Complete the backup even if the checkpoint age requirement has not been met after this number of checkpoints.</p>"},{"location":"xtrabackup-option-reference.html#rollback-prepared-trx","title":"rollback-prepared-trx","text":"<p>Usage: <code>--rollback-prepared-trx</code></p> <p>Force rollback prepared InnoDB transactions.</p>"},{"location":"xtrabackup-option-reference.html#rsync","title":"rsync","text":"<p>Usage: <code>--rsync</code></p> <p>Uses the rsync utility to optimize local file transfers. When this option is specified, xtrabackup uses rsync to copy all non-InnoDB files instead of spawning a separate cp for each file, which can be much faster for servers with a large number of databases or tables.  This option cannot be used together with <code>--stream</code>.</p>"},{"location":"xtrabackup-option-reference.html#safe-slave-backup","title":"safe-slave-backup","text":"<p>Usage: <code>--safe-slave-backup</code></p> <p>When specified, xtrabackup will stop the replica SQL thread just before running <code>FLUSH TABLES WITH READ LOCK</code> and wait to start backup until <code>Slave_open_temp_tables</code> in <code>SHOW STATUS</code> is zero. If there are no open temporary tables, the backup will take place, otherwise the SQL thread will be started and stopped until there are no open temporary tables. The backup will fail if <code>Slave_open_temp_tables</code> does not become zero after <code>--safe-slave-backup-timeout</code> seconds. The replication SQL thread will be restarted when the backup finishes. This option is implemented in order to deal with replicating temporary tables and isn\u2019t necessary with Row-Based-Replication.</p> <p>Note</p> <p>Prior to Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup stops the SQL replica thread after the InnoDB tables and before the non-InnoDB tables are backed up.</p> <p>As of Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup option stops the SQL replica thread before copying the InnoDB files.</p>"},{"location":"xtrabackup-option-reference.html#safe-slave-backup-timeout","title":"safe-slave-backup-timeout","text":"<p>Usage: <code>--safe-slave-backup-timeout=SECONDS</code></p> <p>How many seconds <code>--safe-slave-backup</code> should wait for <code>Slave_open_temp_tables</code> to become zero. Defaults to 300 seconds.</p>"},{"location":"xtrabackup-option-reference.html#secure-auth","title":"secure-auth","text":"<p>Usage: <code>--secure-auth</code></p> <p>Refuse client connecting to server if it uses old (pre-4.1.1) protocol. (Enabled by default; use \u2013skip-secure-auth to disable.)</p>"},{"location":"xtrabackup-option-reference.html#server-id","title":"server-id","text":"<p>Usage: <code>--server-id=#</code></p> <p>The server instance being backed up.</p>"},{"location":"xtrabackup-option-reference.html#server-public-key-path","title":"server-public-key-path","text":"<p>Usage: <code>--server-public-key-path</code></p> <p>The file path to the server public RSA key in the PEM format.</p>"},{"location":"xtrabackup-option-reference.html#skip-tables-compatibility-check","title":"skip-tables-compatibility-check","text":"<p>Usage: <code>--skip-tables-compatibility-check</code></p> <p>See <code>--tables-compatibility-check</code>.</p>"},{"location":"xtrabackup-option-reference.html#slave-info","title":"slave-info","text":"<p>Usage: <code>--slave-info</code></p> <p>This option is useful when backing up a replication replica server. It prints the binary log position of the source server. It also writes the binary log coordinates to the <code>xtrabackup_slave_info</code> file as a <code>CHANGE MASTER</code> command. A new replica for this source can be set up by starting a replica server on this backup and issuing a <code>CHANGE MASTER</code> command with the binary log position saved in the <code>xtrabackup_slave_info</code> file.</p>"},{"location":"xtrabackup-option-reference.html#socket","title":"socket","text":"<p>Usage: <code>--socket</code></p> <p>This option accepts a string argument that specifies the socket to use when connecting to the local database server with a UNIX domain socket. It is passed to the mysql child process without alteration. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#ssl","title":"ssl","text":"<p>Usage: <code>--ssl</code></p> <p>Enable secure connection.</p>"},{"location":"xtrabackup-option-reference.html#ssl-ca","title":"ssl-ca","text":"<p>Usage: <code>--ssl-ca</code></p> <p>Path of the file which contains list of trusted SSL CAs.</p>"},{"location":"xtrabackup-option-reference.html#ssl-capath","title":"ssl-capath","text":"<p>Usage: <code>--ssl-capath</code></p> <p>Directory path that contains trusted SSL CA certificates in PEM format.</p>"},{"location":"xtrabackup-option-reference.html#ssl-cert","title":"ssl-cert","text":"<p>Usage: <code>--ssl-cert</code></p> <p>Path of the file which contains X509 certificate in PEM format.</p>"},{"location":"xtrabackup-option-reference.html#ssl-cipher","title":"ssl-cipher","text":"<p>Usage: <code>--ssl-cipher</code></p> <p>List of permitted ciphers to use for connection encryption.</p>"},{"location":"xtrabackup-option-reference.html#ssl-crl","title":"ssl-crl","text":"<p>Usage: <code>--ssl-crl</code></p> <p>Path of the file that contains certificate revocation lists. MySQL server documentation.</p>"},{"location":"xtrabackup-option-reference.html#ssl-crlpath","title":"ssl-crlpath","text":"<p>Usage: <code>--ssl-crlpath</code></p> <p>Path of directory that contains certificate revocation list files. </p>"},{"location":"xtrabackup-option-reference.html#ssl-fips-mode","title":"ssl-fips-mode","text":"<p>Usage: <code>--ssl-fips-mode</code></p> <p>SSL FIPS mode (applies only for OpenSSL); permitted values are: OFF, ON, STRICT.</p>"},{"location":"xtrabackup-option-reference.html#ssl-key","title":"ssl-key","text":"<p>Usage: <code>--ssl-key</code></p> <p>Path of file that contains X509 key in PEM format.</p>"},{"location":"xtrabackup-option-reference.html#ssl-mode","title":"ssl-mode","text":"<p>Usage: <code>--ssl-mode</code></p> <p>Security state of connection to server.</p>"},{"location":"xtrabackup-option-reference.html#ssl-verify-server-cert","title":"ssl-verify-server-cert","text":"<p>Usage: <code>--ssl-verify-server-cert</code></p> <p>Verify server certificate Common Name value against host name used when connecting to server.</p>"},{"location":"xtrabackup-option-reference.html#stats","title":"stats","text":"<p>Usage: <code>--stats</code></p> <p>Causes xtrabackup to scan the specified data files and print out index statistics.</p>"},{"location":"xtrabackup-option-reference.html#stream","title":"stream","text":"<p>Usage: <code>--stream=FORMAT</code></p> <p>Stream all backup files to the standard output in the specified format. Currently, this option only supports the xbstream format.</p>"},{"location":"xtrabackup-option-reference.html#strict","title":"strict","text":"<p>Usage: <code>--strict</code></p> <p>If this option is specified, xtrabackup fails with an error when invalid parameters are passed.</p>"},{"location":"xtrabackup-option-reference.html#tables","title":"tables","text":"<p>Usage: <code>--tables=name</code></p> <p>A regular expression against which the full tablename, in <code>databasename.tablename</code> format, is matched. If the name matches, the table is backed up. See partial backups.</p>"},{"location":"xtrabackup-option-reference.html#tables-compatibility-check","title":"tables-compatibility-check","text":"<p>Usage: <code>--tables-compatibility-check</code></p> <p>Enables the engine compatibility warning. The default value is ON. To disable the engine compatibility warning use <code>--skip-tables-compatibility-check</code>.</p>"},{"location":"xtrabackup-option-reference.html#tables-exclude","title":"tables-exclude","text":"<p>Usage: <code>--tables-exclude=name</code></p> <p>Filtering by regexp for table names. Operates the same way as <code>--tables</code>, but matched names are excluded from backup. Note that this option has a higher priority than <code>--tables</code>.</p>"},{"location":"xtrabackup-option-reference.html#tables-file","title":"tables-file","text":"<p>Usage: <code>--tables-file=name</code></p> <p>A file containing one table name per line, in databasename.tablename format. The backup will be limited to the specified tables.</p>"},{"location":"xtrabackup-option-reference.html#target-dir","title":"target-dir","text":"<p>Usage: <code>--target-dir=DIRECTORY</code></p> <p>This option specifies the destination directory for the backup. If the directory does not exist, xtrabackup creates it. If the directory does exist and is empty, xtrabackup will succeed. xtrabackup will not overwrite existing files, however; it will fail with operating system error 17, <code>file exists</code>.</p> <p>If this option is a relative path, it is interpreted as being relative to the current working directory from which xtrabackup is executed.</p> <p>In order to perform a backup, you need <code>READ</code>, <code>WRITE</code>, and <code>EXECUTE</code> permissions at a filesystem level for the directory that you supply as the value of <code>--target-dir</code>.</p>"},{"location":"xtrabackup-option-reference.html#innodb-temp-tablespaces-dir","title":"innodb-temp-tablespaces-dir","text":"<p>Usage: <code>--innodb-temp-tablespaces-dir=DIRECTORY</code></p> <p>Directory where temp tablespace files live, this path can be absolute.</p>"},{"location":"xtrabackup-option-reference.html#throttle","title":"throttle","text":"<p>Usage: <code>--throttle=#</code></p> <p>This option limits the number of chunks copied per second. The chunk size is 10 MB. </p> <p>To limit the bandwidth to 10 MB/s, set the option to 1.</p>"},{"location":"xtrabackup-option-reference.html#tls-ciphersuites","title":"tls-ciphersuites","text":"<p>Usage: <code>--tls-ciphersuites</code></p> <p>TLS v1.3 cipher to use.</p>"},{"location":"xtrabackup-option-reference.html#tls-version","title":"tls-version","text":"<p>Usage: <code>--tls-version</code></p> <p>TLS version to use, permitted values are: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3.</p>"},{"location":"xtrabackup-option-reference.html#tmpdir","title":"tmpdir","text":"<p>Usage: <code>--tmpdir=name</code></p> <p>Specify the directory that will be used to store temporary files during the backup</p>"},{"location":"xtrabackup-option-reference.html#transition-key","title":"transition-key","text":"<p>Usage: <code>--transition-key=name</code></p> <p>This option is used to enable processing the backup without accessing the keyring vault server. In this case, xtrabackup derives the AES encryption key from the specified passphrase and uses it to encrypt tablespace keys of tablespaces being backed up.</p> <p>If <code>--transition-key</code> does not have any value, xtrabackup will ask for it. The same passphrase should be specified for the <code>--prepare</code> command.</p>"},{"location":"xtrabackup-option-reference.html#use-free-memory-pct","title":"use-free-memory-pct","text":"<p>Usage: <code>--use-free-memory-pct</code></p> <p>The <code>--use-free-memory-pct</code> is a tech preview option. Before using this option in production, we recommend that you test restoring production from physical backups in your environment, and also use the alternative backup method for redundancy.</p> <p>Implemented in Percona XtraBackup 8.0.30-23, this option lets you configure the Smart memory estimation feature. The option controls the amount of free memory that can be used to <code>--prepare</code> a backup. The default value is 0 (zero) which defines the option as disabled. For example, if you set <code>--use-free-memory-pct=50</code>, then 50% of the free memory is used to <code>prepare</code> a backup. The maximum allowed value is 100. </p> <p>This option works, only if <code>--estimate-memory</code> option is enabled. If the <code>--estimate-memory</code> option is disabled, the <code>--use-free-memory-pct</code> setting is ignored.</p> <p>An example of how to enable the Smart memory estimation feature:</p> <pre><code>$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/\n</code></pre> <pre><code>$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/\n</code></pre>"},{"location":"xtrabackup-option-reference.html#use-memory","title":"use-memory","text":"<p>Usage: <code>--use-memory</code></p> <p>This option affects how much memory is allocated and is similar to <code>innodb_buffer_pool_size</code>. This option is only relevant in the <code>--prepare</code> phase or when analyzing statistics with <code>--stats</code>. The default value is 100MB. The recommended value is between 1GB to 2GB. Multiple values are supported if you provide the unit (for example, 1MB, 1M, 1GB, 1G).</p>"},{"location":"xtrabackup-option-reference.html#user","title":"user","text":"<p>Usage: <code>--user=USERNAME</code></p> <p>This option specifies the MySQL username used when connecting to the server, if that\u2019s not the current user. The option accepts a string argument. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#version","title":"version","text":"<p>Usage: <code>--version</code></p> <p>This option prints xtrabackup version and exits.</p>"},{"location":"xtrabackup-option-reference.html#xtrabackup-plugin-dir","title":"xtrabackup-plugin-dir","text":"<p>Usage: <code>--xtrabackup-plugin-dir=DIRNAME</code></p> <p>The absolute path to the directory that contains the <code>keyring</code> plugin.</p> <p></p>"},{"location":"xtrabackup-option-reference.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-version-numbers.html","title":"Understand version numbers","text":"<p>A version number identifies the product release. The product contains the latest Generally Available (GA) features at the time of that release.</p> 8.0.30 -23 Base version Minor build version <p>Percona uses semantic version numbering, which follows the pattern of base version and build version. Percona assigns unique, non-negative integers in increasing order for each version release. The version number combines the base MySQL 8.0 version number and the minor build version.</p> <p>Note that Percona XtraBackup numbering changed after the 8.0.14 version to align Percona XtraBackup versions with Percona Server and MySQL. Find more information in Aligning Percona XtraBackup Versions with Percona Server for MySQL blog post.</p> <p>The version numbers for Percona XtraBackup 8.0.30-23 define the following information:</p> <ul> <li> <p>Base version - the leftmost numbers indicate the MySQL 8.0 version used as a base. An increase in base version resets the minor build version to 0.  </p> </li> <li> <p>Minor build version - an internal number that denotes the version of the software. A build version increases by one each time the Percona XtraBackup is released.</p> </li> </ul> <p>Percona XtraBackup 8.0.28-20 and 8.0.28-21 are multiple releases based on MySQL 8.0.28.</p> <p></p>"},{"location":"xtrabackup-version-numbers.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"yum-download-rpm.html","title":"Install Percona XtraBackup 8.0 using downloaded RPM packages","text":"<p>Download <code>RPM</code> packages of the desired series for your architecture from the download page. </p> <p>The following example downloads Percona XtraBackup 8.0.4 release package for CentOS 7:</p> <pre><code>$ wget https://www.percona.com/downloads/XtraBackup/Percona-XtraBackup-8.0.4/binary/redhat/7/x86_64/percona-xtrabackup-80-8.0.4-1.el7.x86_64.rpm\n</code></pre> <p>Install Percona XtraBackup by running:</p> <pre><code>$ yum localinstall percona-xtrabackup-80-8.0.4-1.el7.x86_64.rpm\n</code></pre> <p>When installing packages manually like this, you\u2019ll need to make sure to resolve all the dependencies and install missing packages yourself.</p> <p></p>"},{"location":"yum-download-rpm.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"yum-files.html","title":"Files in the RPM package built for Percona XtraBackup 8.0","text":"<p>The following tables show what data each <code>RPM</code> package contains:</p> Package Contains percona-xtrabackup-80 The latest Percona XtraBackup GA binaries and associated files percona-xtrabackup-80-debuginfo The debug symbols for binaries in percona-xtrabackup-80 percona-xtrabackup-test-80 The test suite for Percona XtraBackup percona-xtrabackup The older version of the Percona XtraBackup <p></p>"},{"location":"yum-files.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"yum-repo.html","title":"Use a YUM repository to install Percona XtraBackup","text":"<p>Ready-to-use packages are available from the Percona XtraBackup software repositories and the download page. The Percona yum repository supports popular <code>RPM</code>-based operating systems, including the <code>Amazon Linux AMI</code>.</p> <p>The easiest way to install the Percona Yum repository is to install an <code>RPM</code> that configures yum and installs the Percona GPG key.</p> <p>Specific information on the supported platforms, products, and versions is described in Percona Software and Platform Lifecycle.</p>"},{"location":"yum-repo.html#version-changes","title":"Version changes","text":"<p>Starting with Percona XtraBackup 8.0.35-31, the RPM builds for RHEL 8 and RHEL 9 include ARM packages with the <code>aarch64.rpm</code> extension. This extension means Percona XtraBackup is now available for users on ARM-based systems.</p> <p>We recommend downloading Percona XtraBackup for the same platform as your MySQL-compatible server. For instance, if your server runs on an ARM64 platform, you should download and use the Percona XtraBackup with the <code>aarch64.rpm</code> extension for that operating system.</p>"},{"location":"yum-repo.html#install-percona-xtrabackup-from-percona-yum-repository","title":"Install Percona XtraBackup from Percona <code>yum</code> repository","text":"<ol> <li> <p>Install the Percona yum repository by running the following command as the <code>root</code> user or with sudo: </p> <pre><code>$ sudo yum install \\\nhttps://repo.percona.com/yum/percona-release-latest.\\\nnoarch.rpm\n</code></pre> </li> <li> <p>Enable the repository: </p> <pre><code>$ sudo percona-release enable-only tools release\n</code></pre> <p>If Percona XtraBackup is intended to be used in combination with the upstream MySQL Server, you only need to enable the `tools repository: </p> <pre><code>$ sudo percona-release enable-only tools\n</code></pre> </li> <li> <p>Install Percona XtraBackup by running:</p> <pre><code>$ sudo yum install percona-xtrabackup-80\n</code></pre> <p>Warning</p> <p>Make sure that you have the <code>libev</code> package installed before installing Percona XtraBackup on CentOS 6. For this operating system, the <code>libev</code> package is available from the EPEL repositories.</p> </li> <li> <p>To decompress backups made using <code>LZ4</code> or <code>ZSTD</code> compression algorithm, install the corresponding package:</p> Install the <code>lz4</code> packageInstall the <code>zstd</code> package <pre><code>$ sudo yum install lz4\n</code></pre> <pre><code>$ sudo yum install zstd\n</code></pre> </li> </ol> <p>See also</p> <p>To install Percona XtraBackup using downloaded rpm packages, see Install with package manager.</p> <p>To uninstall Percona XtraBackup, see Uninstall Percona XtraBackup </p> <p></p>"},{"location":"yum-repo.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"yum-uninstall-xtrabackup.html","title":"Uninstall Percona XtraBackup 8.0 on Red Hat Enterprise Linux and CentOS","text":"<p>To completely uninstall Percona XtraBackup, remove all the installed packages:</p> <pre><code>$ yum remove percona-xtrabackup\n</code></pre> <p></p>"},{"location":"yum-uninstall-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0-3-rc1.html","title":"Percona XtraBackup 8.0-3-rc1","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0-3-rc1 on October 31 2018. Downloads are available from our download site and from apt and yum repositories.</p> <p>This is a Release Candidate quality release and it is not intended for production. If you want a high quality, Generally Available release, use the current Stable version (the most recent stable version at the time of writing is 2.4.12 in the 2.4 series).</p>"},{"location":"release-notes/8.0/8.0-3-rc1.html#things-to-note","title":"Things to Note","text":"<ul> <li> <p><code>innobackupex</code> was previously deprecated and has been removed</p> </li> <li> <p>Due to the new MySQL redo log and data dictionary formats the Percona XtraBackup 8.0.x versions will only be compatible with MySQL 8.0.x and the upcoming Percona Server for MySQL 8.0.x</p> </li> <li> <p>For experimental migrations from earlier database server versions, you will need to backup and restore and using XtraBackup 2.4 and then use <code>mysql_upgrade</code> from MySQL 8.0.x</p> </li> </ul>"},{"location":"release-notes/8.0/8.0-3-rc1.html#improvements","title":"Improvements","text":"<ul> <li>PXB-1655: The <code>--lock-ddl</code> option is supported when backing up MySQL 8</li> </ul>"},{"location":"release-notes/8.0/8.0-3-rc1.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1678: Incremental backup prepare with the <code>--apply-log-only</code> option could roll back uncommitted transactions</p> </li> <li> <p>PXB-1672: The MTS slave without GTID could be backed up when the <code>--safe-slave-backup</code> option was applied.</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0-3-rc1.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.10.html","title":"Percona XtraBackup 8.0.10","text":"<ul> <li> <p>Date</p> <p>March 16, 2020</p> </li> </ul> <p>Installing Percona XtraBackup 8.0</p> <p>Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.10.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1982: The history table showed a wrong value for <code>lock_time</code>.</p> </li> <li> <p>PXB-2099: <code>copy-back</code> did not move undo files to the data directory.</p> </li> <li> <p>PXB-2107: If the undo tablespace was created in a directory which is a symbolic link to another directory then the backup failed at backup stage.</p> </li> <li> <p>PXB-2118: Undo log file was renamed incorrectly to undo tablespace name after restore</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.10.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.11.html","title":"Percona XtraBackup 8.0.11","text":"<ul> <li> <p>Date</p> <p>April 13, 2020</p> </li> </ul> <p>Installing Percona XtraBackup 8.0</p> <p>Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>All Percona software is open-source and free.</p> <p>This release fixes security vulnerability CVE-2020-10997.</p> <p></p>"},{"location":"release-notes/8.0/8.0.11.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.12.html","title":"Percona XtraBackup 8.0.12","text":"<ul> <li> <p>Date</p> <p>May 27, 2020</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>Percona XtraBackup 8.0.12 now supports backup and restore processing for all versions of MySQL; previous versions of Percona XtraBackup will not work with MySQL 8.0.20 and higher.</p>"},{"location":"release-notes/8.0/8.0.12.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2133: Correct prtype stored for DECIMAL columns in .cfg file by \u2013export</p> </li> <li> <p>PXB-2146: Amazon S3 session token support added to xbcloud</p> </li> <li> <p>PXB-2179: Modify <code>xtrabackup prepare</code> to shut down keyring plugin when run with \u2013generate-transition-key</p> </li> <li> <p>PXB-2157: Modify <code>xtrabackup \u2013prepare</code> to generate cfg files for partition tables when \u2013export is used</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.12.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.13.html","title":"Percona XtraBackup 8.0.13","text":"<ul> <li> <p>Date</p> <p>June 17, 2020</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>Percona XtraBackup 8.0.13 supports backup and restore processing for all versions of MySQL and has been tested with the latest MySQL 8.0.20.</p>"},{"location":"release-notes/8.0/8.0.13.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2165: Modify xbcloud to store backups using s3 access key parameters if AWS access key env variables are set</p> </li> <li> <p>PXB-2164: Modify xbcloud to return the error when the backup doesn\u2019t exist in s3 bucket</p> </li> <li> <p>PXB-2127: Modify xbcloud to upload backups with empty database to min.io storage</p> </li> <li> <p>PXB-2198: Modify xbcloud delete to return the error when the backup doesn\u2019t exist in s3 bucket</p> </li> <li> <p>PXB-2155: Correct corruption when redo logs are encrypted using xtrabackup \u2013backup \u2013compress=lz4</p> </li> <li> <p>PXB-2166: Modify xbcloud to check for bucket existence and return <code>ok</code> status when domain name can be resolved</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.13.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.14.html","title":"Percona XtraBackup 8.0.14","text":"<ul> <li> <p>Date</p> <p>August 31, 2020</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>Percona XtraBackup 8.0.14 supports backup and restore processing for all versions of MySQL and has been tested with the latest MySQL 8.0.21.</p>"},{"location":"release-notes/8.0/8.0.14.html#improvements","title":"Improvements","text":"<ul> <li> <p>PXB-1605: Document how to use Percona Xtrabackup with Docker</p> </li> <li> <p>PXB-2252: Introduce debug option to print redo log records scanned and applied</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.14.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2215: Modify Import tablespace process to correctly calculate pack_length</p> </li> <li> <p>PXB-2114: Document when table is ignored by full backup it is not automatically ignored for incremental backup</p> </li> <li> <p>PXB-2255: Modify processing to Error out if undo truncation during backup</p> </li> <li> <p>PXB-2249: Verify perl binary exists before completing version check</p> </li> <li> <p>PXB-2243: Correct processing when undo truncation happens between full backup and incremental</p> </li> <li> <p>PXB-2238: Provide binary tarball with shared libs and glibc suffix &amp; minimal tarballs</p> </li> <li> <p>PXB-2202: Modify Xbcloud to display an error when xtrabackup fails to create a backup</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.14.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.22-15.0.html","title":"Percona XtraBackup 8.0.22-15.0","text":"<ul> <li> <p>Date</p> <p>December 14, 2020</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>NOTE: The naming structure for the releases has changed. See the aligning Percona XtraBackup versions with Percona Server for MySQL blog post for more information.</p>"},{"location":"release-notes/8.0/8.0.22-15.0.html#new-features","title":"New Features","text":"<ul> <li> <p>PXB-2112: xbcloud: support storage_class option with \u2013storage=s3 (Thanks to user rluisr for reporting this issue)</p> </li> <li> <p>PXB-2242: Prevent back up if Source system (DB) version is higher then current PXB version</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.22-15.0.html#improvements","title":"Improvements","text":"<ul> <li>PXB-2254: Redesign \u2013lock-ddl-per-table</li> </ul>"},{"location":"release-notes/8.0/8.0.22-15.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-793: Fix syntax error when executing \u2013lock-ddl-per-table queries</p> </li> <li> <p>PXB-953: Improve stdout for the end of usage of \u2013lock-ddl-per-table</p> </li> <li> <p>PXB-787: Modify scan to provide correct status when finding corrupted tablespace</p> </li> <li> <p>PXB-2314: Handle Disk format changes introduced in MySQL 8.0.22 release</p> </li> <li> <p>PXB-2279: Modify to look for prefixes in xtrabackup_tablespaces* without extensions (Thanks to user mrmainnet for reporting this issue)</p> </li> <li> <p>PXB-2336: Modify to check to see if first block is an all-zero block and process accordingly</p> </li> <li> <p>PXB-2275: Modify backup processing to add validations if an encrypted table is created</p> </li> <li> <p>PXB-2272: Modify regexp to consider all #sql as temporary tables</p> </li> <li> <p>PXB-2257: Modify \u2013lock-ddl-per-table to properly close database connection</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.22-15.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.23-16.0.html","title":"Percona XtraBackup 8.0.23-16.0","text":"<ul> <li> <p>Date</p> <p>March 22, 2021</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>This release fixes the security vulnerability CVE-2020-29488</p>"},{"location":"release-notes/8.0/8.0.23-16.0.html#improvements","title":"Improvements","text":"<ul> <li> <p>PXB-2280: Provide SELinux and AppArmor default policies</p> </li> <li> <p>PXB-1979: Enable \u2013lock-ddl by default to prevent corruption of the backup</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.23-16.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2274: Correct restore processing when there are DML statements running during backup stage by writing the last_checkpoint and LSN from ps.log_status instead of the redo log (Thanks to user Li Biao for reporting this issue)</p> </li> <li> <p>PXB-2430: Correct build failure by removing the dependency of no-server-version-check with version-check (Thanks to user agarner for reporting this issue)</p> </li> <li> <p>PXB-2415: Add build dependencies to correct Debian/Ubuntu packages in docker (Thanks to user Matt Cole for reporting this issue)</p> </li> <li> <p>PXB-2429: Correct Backup failure for encrypted tablespace by skipping the encryption reset operation during the redo scan phase</p> </li> <li> <p>PXB-2418: Remove PROTOBUF_LITE_LIBRARY - it is not used and is not needed</p> </li> <li> <p>PXB-2395: Update versions for xbstream and xbcrypt</p> </li> <li> <p>PXB-2394: Correct spellings in xbcloud help</p> </li> <li> <p>PXB-2357: Correct hang in backup with redo log archive by using block number instead of checksum (checksum of redo file and archive file can be different)</p> </li> <li> <p>PXB-2180: Correct incremental prepare failure with logical redo by skipping the apply of logical redos (MLOG_TABLE_DYNAMIC_META) during the incremental prepare (except the last prepare).</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.23-16.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.25-17.0.html","title":"Percona XtraBackup 8.0.25-17.0","text":"<ul> <li> <p>Date</p> <p>June 3, 2021</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.25-17.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2442 : Backup cannot be decompressed using the AppArmor profile</p> </li> <li> <p>PXB-2444 : The xbcloud binary fails to upload backup with enforcing SELinux mode</p> </li> <li> <p>PXB-2443 : Version check fails with AppArmor profile</p> </li> <li> <p>PXB-2445 : Initializing the libgcrypt in xbcloud</p> </li> <li> <p>PXB-2455 : XtraBackup prepare fails if the checkpoint LSN is greater than the last LSN</p> </li> <li> <p>PXB-2473 : SELinux errors in audit logs</p> </li> <li> <p>PXB-1462 : Long gtid_executed breaks \u2014history functionality</p> </li> <li> <p>PXB-2369 : Issues with \u201cInstalling\u201d page in XtraBackup documentation</p> </li> <li> <p>PXB-2457 : Incorrect binlog names if binlog name contains periods</p> </li> <li> <p>PXB-2106 : Copy-back creates wrong binlog.index</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.25-17.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.26-18.0.html","title":"Percona XtraBackup 8.0.26-18.0","text":"<ul> <li> <p>Date</p> <p>September 2, 2021</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.26-18.0.html#improvements","title":"Improvements","text":"<ul> <li> <p>PXB-2477: The xbcloud should retry on error and utilize incremental backoff (Thanks to Baptiste Mille-Mathias for reporting this issue)</p> </li> <li> <p>PXB-2580: With the xbcloud binary, a chunk-upload on an SSL connect error to S3 was not retried (Thanks to Tim Vaillancourt for providing the patch)</p> </li> <li> <p>PXB-2317: Remove the obsolete LOCKLESS binary log functionality since the <code>performance_schema.log_status</code> table is now used to get the log information on all the storages without locking them</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.26-18.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2101: The Prepare step fails due to duplicate Serialized Dictionary Information (SDI) (Thanks to Fungo Wang for reporting this issue)</p> </li> <li> <p>PXB-1504: The FIND_GCRYPT macro is broken (Thanks to Maxim Bublis for reporting this issue)</p> </li> <li> <p>PXB-1961: The Prepare step of a full backup fails for encrypted tables with a generic error</p> </li> <li> <p>PXB-2585: XtraBackup fails to backup archive RocksDB Write-Ahead Log (WAL) files</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.26-18.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.27-19.0.html","title":"Percona XtraBackup 8.0.27-19","text":"<ul> <li> <p>Date</p> <p>February 2, 2022</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.27-19.0.html#release-highlights","title":"Release Highlights","text":"<p>The following list contains a number of the bug fixes for MySQL 8.0.27, provided by Oracle, and included in Percona Server for MySQL:</p> <ul> <li> <p>The <code>default_authentication_plugin</code> is deprecated. Support for this plugin may be removed in future versions. Use the <code>authentication_policy</code> variable.</p> </li> <li> <p>The <code>binary</code> operator is deprecated. Support for this operator may be removed in future versions. Use <code>CAST(... AS BINARY)</code>.</p> </li> <li> <p>When a parent table updated or deleted a row, this operation initiated a cascading <code>SET NULL</code> operation on the child table. On the child table, a virtual column value could be set to NULL instead of the value derived from the base column value.</p> </li> </ul> <p>Find the full list of bug fixes and changes in the MySQL 8.0.27 Release Notes.</p>"},{"location":"release-notes/8.0/8.0.27-19.0.html#new-features","title":"New Features","text":"<ul> <li>PXB-1883: Added support for Microsoft Azure Cloud Storage in the xbcloud binary. (Thanks to Ivan for reporting this issue)</li> </ul>"},{"location":"release-notes/8.0/8.0.27-19.0.html#improvements","title":"Improvements","text":"<ul> <li>PXB-2434: Use MySQL page tracking for incremental backup</li> </ul>"},{"location":"release-notes/8.0/8.0.27-19.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1741: PS startup displays errors for databases excluded during partial backup</p> </li> <li> <p>PXB-2614: The <code>xbstream</code> binary was enhanced to support sparse files  on the XFS file system.</p> </li> <li> <p>PXB-2608: Upgrade the Vault API to V2 (Thanks to Benedito Marques Magalhaes for reporting this issue)</p> </li> <li> <p>PXB-2543: Fix that adds <code>IB_EXPORT_CFG_VERSION_V6</code> when exporting a <code>.cfg</code> file for a table (Thanks to Peng Gao for reporting this issue)</p> </li> <li> <p>PXB-2465: Fix for querying the <code>ps.log_status</code> when group replication channels are items on that list. XtraBackup skips the name if it matches either <code>group_replication_applier</code>or <code>group_replication_recovery</code>.(Thanks to Galamb Gerg\u0151 for reporting this issue)</p> </li> <li> <p>PXB-2625: The default version of CURL in Debian Buster failed to identify a TLS HTTP2 connection as closed and attempted to reuse the connection. (Thanks to Johan Andersson for reporting this issue)</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.27-19.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.28-20.0.html","title":"Percona XtraBackup 8.0.28-20","text":"<ul> <li> <p>Date</p> <p>April 26, 2022</p> </li> </ul> <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.28-20.0.html#release-highlights","title":"Release Highlights","text":"<p>The log statements structure in Percona XtraBackup has been improved. Now, the error logs have a standard structure. The uniformity of the headers makes it easier to follow an operation\u2019s progress or review the log to diagnose issues. The improved log structure is displayed in the backup, prepare, move-back/copy-back error logs.</p> <p>Each log statement has the following attributes:</p> <ul> <li> <p>Timestamp - a timestamp for when the event occurred in a UTC format.</p> </li> <li> <p>Severity - the severity level of a statement indicates the importance of an event.</p> </li> <li> <p>ID - this identifier is currently not used but may be used in future versions.</p> </li> <li> <p>Context - the name of the module that issued the log statement, such as XtraBackup, InnoDB, or Server.</p> </li> <li> <p>Message - a description of the event generated by the module.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.28-20.0.html#new-features","title":"New Features","text":"<ul> <li>PXB-2670: Improves the error logging framework in Percona XtraBackup.</li> </ul>"},{"location":"release-notes/8.0/8.0.28-20.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1676: The error message after creating a backup was incorrect.</p> </li> <li> <p>PXB-2716: Fix for a compilation error on systems without fallocate. (Thanks to user Bo98 for providing the patch to fix this issue.)</p> </li> <li> <p>PXB-2506: During copy back and move back operations, added a check if the backup is fully prepared. Percona XtraBackup throws an error if the backup is not prepared or was prepared with \u2013apply-log-only.</p> </li> <li> <p>PXB-2662: Percona XtraBackup exited during prepare when creating an incremental backup using page tracking.</p> </li> <li> <p>PXB-2714: Fix for a memory leak on the keyring component.</p> </li> <li> <p>PXB-2697: Undefined symbols in macOS resulted in an error when linked with Percona XtraBackup 8.0.27.</p> </li> <li> <p>PXB-2722: Fix for when via command line, a password, passed using the -p option, was written into the backup tool_command in xtrabackup_info.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.28-20.0.html#useful-links","title":"Useful Links","text":"<ul> <li> <p>The Percona XtraBackup installation instructions</p> </li> <li> <p>The Percona XtraBackup downloads</p> </li> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>To contribute to the documentation, review the Documentation Contribution Guide</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.28-20.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.28-21.0.html","title":"Percona XtraBackup 8.0.28-21 (2022-05-25)","text":"<p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.28-21.0.html#release-highlights","title":"Release Highlights","text":"<p>Percona XtraBackup adds support for the Amazon Key Management Service (KMS) component.</p>"},{"location":"release-notes/8.0/8.0.28-21.0.html#new-features","title":"New Features","text":"<ul> <li>PXB-2721: Implements support for the Amazon Key Management Service component in Percona XtraBackup.</li> </ul>"},{"location":"release-notes/8.0/8.0.28-21.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2761: Fix for a compilation error in GCC 11. (Thanks to user tcoyvwac for providing the patch to fix this issue.)</p> </li> <li> <p>PXB-2422: The extraction of files failed when a file was located in another directory.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.28-21.0.html#useful-links","title":"Useful Links","text":"<ul> <li> <p>The Percona XtraBackup installation instructions</p> </li> <li> <p>The Percona XtraBackup downloads</p> </li> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>To contribute to the documentation, review the Documentation Contribution Guide</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.28-21.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.29-22.0.html","title":"Percona XtraBackup 8.0.29-22 (2022-07-19)","text":"<p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.29-22.0.html#release-highlights","title":"Release Highlights","text":"<p>Percona XtraBackup 8.0.29-22 adds new redo log types to support the changes in the <code>INSTANT</code> algorithm behavior. MySQL 8.0.29 extended the support for <code>ALGORITHM=INSTANT</code> to allow columns to be added to any position in a table and column drops. Older versions of Percona XtraBackup are incompatible with MySQL 8.0.29 because of this new functionality.</p> <p>Note</p> <p>MySQL 8.0.29 extended the support of the <code>ALTER TABLE \u2026 DROP COLUMNS</code> statement to use <code>ALGORITHM=INSTANT</code>. These operations only modify the metadata in the data directory and do not affect the physical structure. The <code>ALGORITHM=INSTANT</code> is the default setting for supported <code>DDL</code> operations. Prior to MySQL 8.0.29, an <code>ALGORITHM=INSTANT</code> column could only be added as the last table column. As of MySQL 8.0.29, the column can be added to any table position. The ability to add or drop a column in any position increases the complexity of crash recovery since the redo log does not have the logical positions from the data dictionary. The redo log contains the physical order for the table.</p> <p>Percona Server for MySQL 8.0.29-21 contains fixes for these issues. Percona XtraBackup 8.0.29 can backup and restore tables that used the <code>INSTANT</code> algorithm in ADD/DROP in Percona Server for MySQL. However, MySQL 8.0.29, if the server contains tables modified by INSTANT ADD/DROP, is unsafe for backups at this time. Percona XtraBackup detects the tables modified by <code>INSTANT</code> ADD/DROP and generates an error. This error lists the affected tables and provides instructions to convert the modified tables to regular tables.</p>"},{"location":"release-notes/8.0/8.0.29-22.0.html#useful-links","title":"Useful Links","text":"<ul> <li> <p>The Percona XtraBackup installation instructions</p> </li> <li> <p>The Percona XtraBackup downloads</p> </li> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>To contribute to the documentation, review the Documentation Contribution Guide</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.29-22.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html","title":"Percona XtraBackup 8.0.30-23 (2022-11-14)","text":"Release date November 14, 2022 Install instructions Install Percona XtraBackup Download this version Percona XtraBackup 8.0 <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p> <p>For paid support, managed services or consulting services, contact Percona Sales.</p> <p>For training, contact Percona Training - Start learning now.</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#release-highlights","title":"Release highlights","text":"<p>The Take an incremental backup using page tracking feature is Generally Available (GA).</p> <p>The following features and improvements introduced in Percona XtraBackup 8.0.30-23 are available only in tech preview:</p> <ul> <li> <p>Percona XtraBackup adds support for <code>Zstandard (ZSTD)</code> compression algorithm. <code>ZSTD</code> is a fast lossless compression algorithm, targeting real-time compression scenarios at zlib-level and better compression ratios. </p> </li> <li> <p>Percona XtraBackup implements the <code>Smart memory estimation</code> feature to compute the memory required to <code>--prepare</code> a backup. Percona XtraBackup has extended the crash recovery logic to extract the formula used to allocate memory. Now, in the backup phase, while copying redo log entries, Percona XtraBackup computes the required memory for <code>--prepare</code>. Percona XtraBackup also takes into consideration the number of InnoDB pages to be fetched from the disk. Percona XtraBackup checks the server\u2019s available free memory and uses that memory up to the limit specified in the <code>--use-free-memory-pct</code> option to run <code>--prepare</code>.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.30-23.0.html#new-features","title":"New features","text":"<p>PXB-2669: Implements support for <code>Zstandard (ZSTD)</code> compression algorithm.</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#improvements","title":"Improvements","text":"<p>PXB-2710: Implements support for <code>Smart Memory Estimation</code>.</p> <p>PXB-2844: Adjusts the logic to detect multi-threaded slave.</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#bug-fixes","title":"Bug fixes","text":"<p>PXB-2681: Percona XtraBackup got stuck during incremental backup prepare of encrypted tables.</p> <p>PXB-2517: Check if files-from is successfully closed before rsync (Thanks to Garen Chan for the patch.)</p> <p>PXB-2702: Backup failed when undo truncation log is present (Thanks to Dmitry Smal for his contribution to the initial patch.)</p> <p>PXB-2729: Percona XtraBackup compilation failed if GTest packages are installed.</p> <p>PXB-2810: Percona XtraBackup crashed when AIO initialization failed (Thanks to Yan Huang for the patch.) </p> <p>PXB-2840: Xbcloud attempted to create a non-existing bucket. </p> <p>PXB-2874: When Percona XtraBackup generated a new master key on \u2013copy-back or \u2013move-back, the master key id was reset back to 1.</p> <p>PXB-2809: <code>wsrep_sync_wait&lt;&gt;0</code> caused <code>Lock wait timeout exceeded; try restarting transaction</code> error (Thanks to Frank Well for providing the initial patch.)</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#platform-support","title":"Platform support","text":"<p>Percona XtraBackup 8.0.30 supports Oracle Linux/Red Hat Enterprise Linux 9.</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#useful-links","title":"Useful links","text":"<ul> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>Contribute to the documentation</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html","title":"Percona XtraBackup 8.0.31-24 (2023-02-07)","text":"Release date February 7, 2023 Install instructions Install Percona XtraBackup Download this version Percona XtraBackup 8.0 <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p> <p>For training, contact Percona Training - Start learning now.</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#release-highlights","title":"Release highlights","text":"<p>This release adds the ability to use an IAM instance profile when running xbcloud from an EC2 instance. An IAM instance profile does not need the <code>--s3-secret-key</code> nor the <code>--s3-access-key</code> but the profile has a six-hour lifespan.</p> <p>With this version, <code>qpress</code>/<code>QuickLZ</code> are deprecated. </p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#new-features","title":"New features","text":"<p>PXB-2856: Use IAM instance profile when running xbcloud from an EC2 instance.</p> <p>PXB-2869: A warning is printed on backup that qpress/QuickLZ is deprecated.</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#bug-fixes","title":"Bug fixes","text":"<p>PXB-2890: XtraBackup did not compress already compressed tables.</p> <p>PXB-2928: XtraBackup exits with signal 11 when taking a backup using page tracking.</p> <p>PXB-2854: Fixed a memory corruption issue in QuickLZ.</p> <p>PXB-2925: The PXB start_lsn, during the prepare phase, did not match the redo file start LSN when a wait was added in the backup phase after calling <code>recv_find_max_checkpoint</code> and before copying the checkpoint header.</p> <p>PXB-2964: XtraBackup required a very high open files limit.</p> <p>PXB-2959: XtraBackup now compiles on platforms with OpenSSL 3.0.</p> <p>PXB-2971: XtraBackup copied local manifest files which caused node failures when the files overrode settings on another node.</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#deprecation-and-removal","title":"Deprecation and removal","text":"<p>Starting with Percona XtraBackup 8.0.31-24, using qpress/QuickLZ to compress backups is deprecated and may be removed in future versions. We recommend using either the <code>LZ4</code> or the Zstandard (<code>ZSTD</code>) compression algorithms.</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#useful-links","title":"Useful links","text":"<ul> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>Contribute to the documentation</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.32-25.0.html","title":"Percona XtraBackup 8.0.32-25 (2023-02-27)","text":"Release date February 27, 2023 Install instructions Install Percona XtraBackup <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.32-25.0.html#release-highlights","title":"Release highlights","text":"<p>This release merges the MySQL 8.0.32 code base. Percona has implemented a two-stage release process for each version. The first release primarily ensures compatibility with the latest MySQL version, to help those customers who need an updated version of Percona XtraBackup as soon as possible. The second release contains additional bug fixes and any improvements or new features.</p> <p>Starting with version 8.0.32-25, Percona XtraBackup allows instant columns in the backup for MySQL 8.0.32. This limitation still exists for backing up MySQL 8.0.31 and lower versions.</p> <p>This limitation does not exist for backing up any version of Percona Server for MySQL.</p>"},{"location":"release-notes/8.0/8.0.32-25.0.html#useful-links","title":"Useful links","text":"<p>The Percona XtraBackup GitHub location</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.32-25.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html","title":"Percona XtraBackup 8.0.32-26 (2023-04-04)","text":"Release date April 4, 2023 Install instructions Install Percona XtraBackup <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#release-highlights","title":"Release highlights","text":"<p>This release includes improvements and bug fixes. Percona has implemented a two-stage release process for each version. The first release primarily ensures compatibility with the latest MySQL version, to help those customers who need an updated version of Percona XtraBackup as soon as possible. The second release contains additional bug fixes and any improvements or new features. </p> <p>This release fixes the security vulnerability CVE-2022-25834 with PXB-2977.</p> <p>This version adds the \u2013estimate-memory parameter to enable/disable the Smart memory estimation feature during the backup phase.</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#improvements","title":"Improvements","text":"<p>PXB-2882: Removes bitmap code and variables.</p> <p>PXB-2979: The Smart memory estimation feature parses metadata from the redo log to estimate the required memory to prepare a backup. On write-intensive workloads, this behavior caused the delay of the redo follow thread.</p> <p>PXB-2980: Adds the \u2013estimate-memory parameter to enable/disable the Smart memory estimation feature during the backup phase.</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#bug-fixes","title":"Bug fixes","text":"<p>PXB-2264: When a table with the next auto incremental value <code>2</code> was exported using Percona XtraBackup, the table got the next auto incremental value <code>1</code> instead of <code>2</code>.</p> <p>PXB-2954: During prepare phase Percona XtraBackup uses Serialized Dictionary information (SDI) to create the table metadata. If there was an orphan table, leftover from a upgrade, without SDI information, Percona XtraBackup failed to prepare a backup.</p> <p>PXB-2970: Removed unnecessary check for redo log files at the end of backup in case the redo archive was enabled.</p> <p>PXB-2972: An error after the redo apply phase caused an assertion failure instead of a graceful exit.</p> <p>PXB-2977: Fixed the security vulnerability CVE-2022-25834.</p> <p>PXB-2998: Due to a server bug in the upgrade, the server leaves the dictionary tables in a temporary schema instead of the <code>mysql</code> schema. Percona Xtrabackup can now successfully prepare these backup directories.</p> <p>PXB-2999: Removed the warning message that MLOG_INDEX_LOAD redo log record was found.</p> <p>PXB-3022: Reduced the memory required for <code>--prepare</code> phase.</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#useful-links","title":"Useful links","text":"<p>The Percona XtraBackup GitHub location</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.33-27.0.html","title":"Percona XtraBackup 8.0.33-27 (2023-05-25)","text":"Release date May 25, 2023 Install instructions Install Percona XtraBackup <p>Percona XtraBackup (PXB) is a 100% open source backup solution for all versions of Percona Server for MySQL and MySQL\u00ae that performs online non-blocking, tightly compressed, highly secure full backups on transactional systems. Maintain fully available applications during planned maintenance windows with Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.33-27.0.html#release-highlights","title":"Release highlights","text":"<p>This release merges the MySQL 8.0.33 code base. Percona has implemented a two-stage release process for each version. The first release primarily ensures compatibility with the latest MySQL version, to help those customers who need an updated version of Percona XtraBackup as soon as possible. The second release contains additional bug fixes and any improvements or new features.</p>"},{"location":"release-notes/8.0/8.0.33-27.0.html#bug-fix","title":"Bug fix","text":"<p>PXB-3026: <code>DWITH_NDB=OFF</code> option did not turn off the <code>DWITH_NDB_CLUSTER_STORAGE_ENGINE</code> and compiled <code>NDB</code> files.</p>"},{"location":"release-notes/8.0/8.0.33-27.0.html#useful-links","title":"Useful links","text":"<p>The Percona XtraBackup GitHub location</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.33-27.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html","title":"Percona XtraBackup 8.0.33-28 (2023-07-19)","text":"<p>Percona XtraBackup (PXB) is a 100% open source backup solution for all versions of Percona Server for MySQL and MySQL\u00ae that performs online non-blocking, tightly compressed, highly secure full backups on transactional systems. Maintain fully available applications during planned maintenance windows with Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#release-highlights","title":"Release highlights","text":"<p>This release includes improvements, features, and bug fixes. Percona has implemented a two-stage release process for each version. The first release primarily ensures compatibility with the latest MySQL version, to help those customers who need an updated version of Percona XtraBackup as soon as possible. The second release contains additional bug fixes and any improvements or new features.</p> <p>Percona XtraBackup 8.0.33-28 implements a new data sink that uses the first in, first out (FIF0) method. With the FIFO data sink feature, users with a streaming capacity of 10Gbps (typically on a Local Area Network (LAN)) can benefit from faster backups by streaming data in parallel to object storage. This feature is in tech preview.</p> <p>Percona XtraBackup 8.0.33-28 implements the Dictionary cache feature. Dictionary cache improves the performance of xtrabackup <code>--prepare</code> operation.</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#new-feature","title":"New feature","text":"<p>PXB-2514: Implements a new data sink that uses <code>FIFO</code> (named pipes).</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#improvements","title":"Improvements","text":"<ul> <li> <p>PXB-2955: Implements dictionary cache.</p> </li> <li> <p>PXB-3033: Executes <code>STOP SLAVE</code> conditionally depending on <code>--[lock-ddl]</code>.</p> </li> <li> <p>PXB-3066: Fixes compilation issues on Debian 12.</p> </li> <li> <p>PXB-2993: Makes Percona XtraBackup compatible with procps-4.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.33-28.0.html#bug-fix","title":"Bug fix","text":"<ul> <li> <p>PXB-2811: Fix for several Percona XtraBackup compilation warnings.</p> </li> <li> <p>PXB-3075: Percona XtraBackup 8.0.33 could not prepare backups from 8.0.29 and previous versions.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.33-28.0.html#packaging-notes","title":"Packaging notes","text":"<p>Percona XtraBackup 8.0.33-28 supports Debian 12.</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#useful-links","title":"Useful links","text":"<p>Install Percona XtraBackup 8.0</p> <p>The Percona XtraBackup GitHub location</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.34-29.0.html","title":"Percona XtraBackup 8.0.34-29 (2023-08-21)","text":"<p>Get started with Quickstart Guide for Percona XtraBackup.</p> <p>Percona XtraBackup (PXB) is a 100% open source backup solution for all versions of Percona Server for MySQL and MySQL\u00ae that performs online non-blocking, tightly compressed, highly secure full backups on transactional systems. Maintain fully available applications during planned maintenance windows with Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.34-29.0.html#release-highlights","title":"Release highlights","text":"<p>Starting with Percona XtraBackup 8.0.34 you can take backups of Percona Server for MySQL 8.0.34, MySQL 8.0.34, and higher versions within the 8.0 series.</p> <p>Check the latest list of all Supported versions.</p>"},{"location":"release-notes/8.0/8.0.34-29.0.html#compression","title":"Compression","text":"<p>The ZSTD compression algorithm is moved to General Availability and becomes the default compression algorithm for the <code>--compress</code> option.</p> <p>The <code>QuickLZ</code> compression algorithm is removed and is not used for <code>--backup</code>. The <code>--decompress</code> option still uses <code>qpress</code> for backward compatibility to decompress backups taken by older versions of Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.34-29.0.html#new-features","title":"New features","text":"<ul> <li>PXB-3059: Adds the <code>--redo-log-arch-dir=name</code> option to set the redo log archive destination directory. (Thanks to wangbincmss for providing the patch)</li> </ul>"},{"location":"release-notes/8.0/8.0.34-29.0.html#improvements","title":"Improvements","text":"<ul> <li>PXB-3007: The ZSTD compression algorithm is moved to General Availability and becomes the default compression algorithm for the <code>--compress</code> option.</li> </ul>"},{"location":"release-notes/8.0/8.0.34-29.0.html#bug-fix","title":"Bug fix","text":"<ul> <li> <p>PXB-3073: An unresponsive host may cause <code>xbcloud</code> to become stuck. Added a <code>--timeout</code> option to <code>xbcloud</code>.</p> </li> <li> <p>PXB-3088: Percona XtraBackup could not prepare the backup if the redo log size was more than 128G. (Thanks to Ahmed Et-tanany for providing the fix for this issue)</p> </li> <li> <p>PXB-3079: The prepare phase skipped rollback on encrypted tables and was completed successfully if the keyring plugin was not loaded.</p> </li> <li> <p>PXB-2860: Percona XtraBackup locked table even when the  <code>--tables-exclude</code> and <code>--lock-ddl-per-table</code> options were used.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.34-29.0.html#useful-links","title":"Useful links","text":"<p>Install Percona XtraBackup 8.0</p> <p>The Percona XtraBackup GitHub location</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.34-29.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.35-30.0.html","title":"Percona XtraBackup 8.0.35-30 (2023-12-04)","text":"<p>Get started with Quickstart Guide for Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.35-30.0.html#supported-versions","title":"Supported versions","text":"<p>Check the latest list of all Supported versions.</p>"},{"location":"release-notes/8.0/8.0.35-30.0.html#release-highlights","title":"Release highlights","text":"<p>This release merges the MySQL 8.0.35 code base.</p>"},{"location":"release-notes/8.0/8.0.35-30.0.html#bug-fix","title":"Bug fix","text":"<ul> <li> <p>PXB-3003: Percona XtraBackup discovering redo logs to parse and the server purging redo logs simultaneously could cause a race condition.</p> </li> <li> <p>PXB-3139: Fix for gcc-13 and clang-16 compilation issues.</p> </li> <li> <p>PXB-3147: Percona XtraBackup failed to execute the <code>DO innodb_redo_log_consumer_register(\"PXB\");</code> query.</p> </li> <li> <p>PXB-3181: The use of the <code>innodb-use-native-aio=true</code> option resulted in printing duplicate timestamps.</p> </li> <li> <p>PXB-3173: The xbcloud was refactored to use multiple threads with a global list of files. This list did not allow users to download a subset of files.</p> </li> <li> <p>PXB-3141: Adjusted folder creation on <code>ds_fifo.cc</code> and xbcloud to use proper permission.</p> </li> <li> <p>PXB-3168: Under high write load, a backup could fail with a <code>log block numbers mismatch</code> error.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.35-30.0.html#useful-links","title":"Useful links","text":"<p>Install Percona XtraBackup 8.0</p> <p>The Percona XtraBackup GitHub repository</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p></p>"},{"location":"release-notes/8.0/8.0.35-30.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.35-31.0.html","title":"Percona XtraBackup 8.0.35-31 (2024-06-20)","text":"<p>Get started with Quickstart Guide for Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.35-31.0.html#supported-versions","title":"Supported versions","text":"<p>Starting with Percona XtraBackup 8.0.34, you can take backups of Percona Server for MySQL 8.0.34, MySQL 8.0.34, and higher versions within the 8.0 series.</p> <p>Check the latest list of all Supported versions.</p>"},{"location":"release-notes/8.0/8.0.35-31.0.html#release-highlights","title":"Release highlights","text":"<p>This release adds Percona XtraBackup ARM64 packages and provides bug fixes.</p> <p>We recommend that you download the Percona XtraBackup for the same platform as the MySQL-compatible server. For example, if your server is on an ARM64 platform, you should download and use the Percona XtraBackup for ARM64 for that operating system.</p>"},{"location":"release-notes/8.0/8.0.35-31.0.html#bug-fix","title":"Bug fix","text":"<ul> <li> <p>PXB-3283: If backup contains tables with temporal datatypes and their charset/collation changed (ALTER TABLE CONVERT CHARACTER SET) before the backup is taken, xtrabackup export couldn\u2019t generate the correct configuration (.cfg) files required by the import.</p> </li> <li> <p>PXB-2797: When you import a table with a full-text index from an XtraBackup backup, you might encounter a schema mismatch. This happens when the table\u2019s structure in the backup does not match the structure expected by the database.</p> </li> <li> <p>PXB-3210: Percona XtraBackup version 8.0.33-28 and later fail to build on MacOS because of the FIND_PROCPS() function. This function causes issues during the build process, preventing the software from compiling successfully.</p> </li> <li> <p>PXB-3130: When preparing 8.0.30 backups with newer xtrabackup versions, the prepare step failed. (Thank you to LiNing for the contribution!)</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.35-31.0.html#useful-links","title":"Useful links","text":"<p>Install Percona XtraBackup 8.0</p> <p>The Percona XtraBackup GitHub repository</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p></p>"},{"location":"release-notes/8.0/8.0.35-31.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.35-31.0.upd.html","title":"Percona XtraBackup 8.0.35-31-Update (2024-09-20)","text":""},{"location":"release-notes/8.0/8.0.35-31.0.upd.html#packaging-notes","title":"Packaging notes","text":"<p>This update to the release of Percona XtraBackup includes the addition of <code>arm64.deb</code> packages in Percona Software Downloads for the following platforms:</p> <ul> <li> <p>Debian 12</p> </li> <li> <p>Debian 11</p> </li> <li> <p>Ubuntu 24.04</p> </li> <li> <p>Ubuntu 22.04</p> </li> <li> <p>Ubuntu 20.04</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.35-31.0.upd.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.4.html","title":"Percona XtraBackup 8.0.4","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.4 on December 10, 2018. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>This release of Percona Xtrabackup is a General Availability release ready for use in a production environment.</p>"},{"location":"release-notes/8.0/8.0.4.html#please-note-the-following-about-this-release","title":"Please note the following about this release:","text":"<ul> <li> <p>The deprecated innobackupex has been removed. Use the xtrabackup command to back up your instances: <code>$ xtrabackup --backup --target-dir=/data/backup</code></p> </li> <li> <p>When migrating from earlier database server versions, backup and restore and using Percona XtraBackup 2.4 and then use <code>mysql_upgrade</code> from MySQL 8.0.x</p> </li> <li> <p>If using <code>yum</code> or <code>apt</code> repositories to install Percona XtraBackup 8.0.4, ensure that you have enabled the new tools repository. You can do this with the percona-release enable tools release command and then install the percona-xtrabackup-80 package.</p> </li> </ul> <p>All Percona software is open-source and free. We are grateful to the community for the invaluable contributions to Percona XtraBackup. We would especially like to highlight the input of Alexey Kopytov who has been actively offering improvements and submitting bug reports for Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.4.html#new-features","title":"New Features","text":"<ul> <li>Percona XtraBackup 8.0.4 is based on MySQL 8.0.13 and fully supports Percona Server for MySQL 8.0 series and MySQL 8.0 series.</li> </ul>"},{"location":"release-notes/8.0/8.0.4.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1699: xtrabackup \u2013prepare could fail on backups of MySQL\u00a08.0.13 databases</p> </li> <li> <p>PXB-1704: xtrabackup \u2013prepare could hang while performing insert buffer merge</p> </li> <li> <p>PXB-1668: When the \u2013throttle option was used, the applied value was different from the one specified by the user (off by one error)</p> </li> <li> <p>PXB-1679: PXB could crash when <code>ALTER TABLE ... TRUNCATE PARTITION</code> command was run during a backup without locking DDL</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.4.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.5.html","title":"Percona XtraBackup 8.0.5","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.5 on March 4, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>Percona XtraBackup 8.0.5 introduces the support of undo tablespaces created using the new syntax (<code>CREATE UNDO TABLESPACE</code>) available since MySQL 8.0.14. Percona XtraBackup also supports the binary log encryption introduced in MySQL 8.0.14.</p> <p>Two new options were added to xbstream. Use the <code>--decompress</code> option with xbstream to decompress individual qpress files. With the <code>--decompress-threads</code> option, specify the number of threads to apply when decompressing. Thanks to Rauli Ikonen for this contribution.</p> <p>This release of Percona XtraBackup is a General Availability release ready for use in a production environment.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.5.html#please-note-the-following-about-this-release","title":"Please note the following about this release:","text":"<ul> <li> <p>The deprecated innobackupex has been removed. Use the xtrabackup command to back up your instances: <code>$ xtrabackup --backup --target-dir=/data/backup</code></p> </li> <li> <p>When migrating from earlier database server versions, backup and restore and using Percona XtraBackup 2.4 and then use <code>mysql_upgrade</code> from MySQL 8.0.x</p> </li> <li> <p>If using <code>yum</code> or <code>apt</code> repositories to install Percona Xtrabackup 8.0.5, ensure that you have enabled the new tools repository. You can do this with the percona-release enable tools release command and then install the percona-xtrabackup-80 package.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.5.html#new-features","title":"New Features","text":"<ul> <li> <p>PXB-1548: Percona XtraBackup enables updating the <code>ib_buffer_pool</code> file with the latest pages present in the buffer pool using the <code>--dump-innodb-buffer-pool</code> option. Thanks to Marcelo Altmann for contribution.</p> </li> <li> <p>PXB-1768: Added support for undo tablespaces created with the new MySQL 8.0.14 syntax.</p> </li> <li> <p>PXB-1781: Added support for binary log encryption introduced in MySQL 8.0.14.</p> </li> <li> <p>PXB-1797: For xbstream, two new options were added. The <code>--decompress</code> option enables xbstream to decompress individual qpress files. The <code>--decompress-threads</code> option controls the number of threads to apply when decompressing. Thanks to Rauli Ikonen for this contribution.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.5.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>Using <code>--lock-ddl-per-table</code> caused the server to scan all records of partitioned tables which could lead to the \u201cout of memory\u201d error. Bugs fixed PXB-1691 and PXB-1698.</p> </li> <li> <p>When Percona XtraBackup was started run with the <code>--slave-info</code>, incorrect coordinates were written to the xtrabackup_slave_info file.. Bug fixed PXB-1737</p> </li> <li> <p>Percona XtraBackup could crash at the prepare stage when making an incremental backup if the variable <code>innodb-rollback-segments</code> was changed after starting the MySQL Server. Bug fixed PXB-1785.</p> </li> <li> <p>The full backup could fail when Percona Server for MySQL was started with the <code>--innodb-encrypt-tables</code> parameter. Bug fixed PXB-1793.</p> </li> </ul> <p>Other bugs fixed: PXB-1632, PXB-1715, PXB-1770, PXB-1771, PXB-1773.</p> <p></p>"},{"location":"release-notes/8.0/8.0.5.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.6.html","title":"Percona XtraBackup 8.0.6","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.6 on May 9, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>In version 8.0.6, Percona XtraBackup introduces the support of the MyRocks storage engine with Percona Server for MySQL version 8.0.15-6 or higher.</p> <p>Percona XtraBackup 8.0.6 enables saving backups to an Amazon S3, MinIO, and Google Cloud Storage (using interoperability mode) when using xbcloud. The following example demonstrates how to use an Amazon S3 storage to make a full backup:</p> <pre><code>  $ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\n  xbcloud put --storage=s3 \\\n  --s3-endpoint='s3.amazonaws.com' \\\n  --s3-access-key='YOUR-ACCESSKEYID' \\\n  --s3-secret-key='YOUR-SECRETACCESSKEY' \\\n  --s3-bucket='mysql_backups'\n  --parallel=10 \\\n  ${date -I}-full_backup\n\nAll *Percona* software is open-source and free\n</code></pre>"},{"location":"release-notes/8.0/8.0.6.html#new-features","title":"New Features","text":"<ul> <li> <p>The MyRocks storage engine is now supported with Percona XtraBackup. More information in PXB-1754.</p> </li> <li> <p>Amazon S3 is now supported in xbcloud. More information in PXB-1813.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.6.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>Percona XtraBackup could fail to restore the undo tablespace created during or before incremental backup. Bug fixed PXB-1780.</p> </li> <li> <p>A backup could fail if <code>log_bin_index</code> was defined in <code>my.cnf</code>. Bug fixed PXB-1801.</p> </li> <li> <p>When the row format was changed during the backup, xtrabackup could crash during the incremental prepare stage. Bug fixed PXB-1824.</p> </li> <li> <p>During the <code>prepare</code> phase, Percona XtraBackup could freeze and never finish execution. Bug fixed PXB-1819.</p> </li> <li> <p>Percona XtraBackup could crash during the <code>prepare</code> stage when making a backup of a host running MySQL Server v8.0.16. Bug fixed PXB-1839.</p> </li> </ul> <p>Other bugs fixed: PXB-1809, PXB-1810, PXB-1832, PXB-1837.</p> <p></p>"},{"location":"release-notes/8.0/8.0.6.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.7.html","title":"Percona XtraBackup 8.0.7","text":"<p>Percona is glad to announce the release of Percona XtraBackup  8.0.7 on August 7, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>In release 8.0.7, Percona XtraBackup enables making backups of databases that contain the encrypted system tablespace. Encrypted mysql tablespace is now also supported.</p> <p>Percona XtraBackup 8.0.7 implements the support of the <code>lz4</code> compression algorithm so that you could make compressed backups using lz4 (\u2013compress=lz4) in addition to the default quicklz method.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.7.html#new-features-and-improvements","title":"New Features and Improvements","text":"<ul> <li> <p>Add support of the system tablespace encryption. More information in PXB-1649.</p> </li> <li> <p>Implemented the support of the lz4 compression algorithm. More information in PXB-1857.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.7.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>When the encrypted tablespaces feature was enabled, encrypted and compressed tables were not usable on the joiner node (Percona XtraDB Cluster) via SST (State Snapshot Transfer) with the xtrabackup-v2 method. Bug fixed PXB-1867.</p> </li> <li> <p><code>xbcloud</code> did not update date related fields of the HTTP header when retrying a request. Bug fixed PXB-1874.</p> </li> <li> <p><code>xbcloud</code> did not retry to send the request after receiving the HTTP 408 error (request timeout). Bug fixed PXB-1875.</p> </li> <li> <p><code>xtrabackup</code> did not accept decimal fractions as values of the <code>innodb_max_dirty_pages_pct</code> option. Bug fixed PXB-1807.</p> </li> <li> <p>If the user tried to merge an already prepared incremental backup, a misleading error was produced without informing that incremental backups may not be used twice. Bug fixed PXB-1862.</p> </li> </ul> <p>Other bugs fixed: PXB-1493, PXB-1557, PXB-1887, PXB-1870, PXB-1879, PXB-1901.</p> <p></p>"},{"location":"release-notes/8.0/8.0.7.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.8.html","title":"Percona XtraBackup 8.0.8","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.8 on November 21, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.8.html#new-features-and-improvements","title":"New Features and Improvements","text":"<ul> <li> <p>Support log archiving feature in PXB 8.0. More information in PXB-1912 and in the Redo Log section of MySQL documentation</p> </li> <li> <p>For the MyRocks storage engine, support the creation of renewable checkpoints (controlled via <code>--rocksdb-checkpoint-max-age</code> and <code>--rocksdb-checkpoint-max-count</code>) to minimize the amount of binary logs to apply after the backup was completed. Using renewable checkpoints, Percona XtraBackup only copies the SST files that were created after the previous checkpoint. More information in PXB-1915.</p> </li> <li> <p>Two options (\u2013-backup-lock-timeout and -\u2013backup-lock-retry-count) were added to enable the configuring of the timeout for acquiring metadata locks in <code>FLUSH TABLES WITH READ LOCK</code>, <code>LOCK TABLE FOR BACKUP</code>, and <code>LOCK BINLOG FOR BACKUP</code> statements. More information in PXB-1914</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.8.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>An encrypted table could not be restored when <code>ADD INDEX</code> or <code>DROP INDEX</code> commands had been run on the table. Bug fixed PXB-1905</p> </li> <li> <p>In some cases <code>xtrabackup --prepare</code> could fail to decrypt a table but reported that the operation completed ok. Bug fixed PXB-1936</p> </li> <li> <p><code>xtrabackup --move-back</code> did not complete successfully when the encrypted binlog file. Bug fixed PXB-1937.</p> </li> <li> <p>Percona XtraBackup could crash during the prepare stage when making an incremental</p> </li> </ul> <p>backup when a multi valued index was being added or dropped for JSON data. Bug fixed PXB-1913.</p> <p>Other bugs fixed: PXB-1928, PXB-1938, PXB-1951, PXB-1953, PXB-1954.</p> <p></p>"},{"location":"release-notes/8.0/8.0.8.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.9.html","title":"Percona XtraBackup 8.0.9","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.9 on December 16, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.9.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li>Sometime between December 3<sup>rd</sup> and December 10<sup>th</sup>, a change was introduced in  that caused an incompatibility with our Percona XtraBackup <code>xbcloud</code> utility. Bug fixed PXB-1978.</li> </ul>"},{"location":"release-notes/8.0/8.0.9.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-,:!=\\[\\]()\"`/]+|\\.(?!\\d)|&[lg]t;|(?!\\b)(?=[A-Z][a-z])","pipeline":["stopWordFilter"]},"docs":[{"location":"index.html","title":"Percona XtraBackup - Documentation","text":"<p>This documentation is for the latest release: Percona XtraBackup 8.0.35-31 Update release notes.</p> <p>Percona XtraBackup is an open source hot backup utility for MySQL-based servers, that keeps your database fully available during planned maintenance windows.</p> <p>Whether it is a 24x7 highly loaded server or a low-transaction-volume Percona XtraBackup is designed to make backups seamless without disrupting the performance of the server in a production environment. Percona XtraBackup (PXB) is a 100% open source backup solution with commercial support available for organizations who want to benefit from comprehensive, responsive, and cost-flexible database support for MySQL.</p>"},{"location":"index.html#supported-versions","title":"Supported versions","text":"<p>Percona XtraBackup 8.0.35-31 can take backups of MySQL-compatible databases in older server versions, if specific conditions are met, and the following later versions:</p> <ul> <li> <p>Percona Server for MySQL 8.0.34, and MySQL 8.0.34</p> </li> <li> <p>Percona Server for MySQL 8.0.35, and MySQL 8.0.35</p> </li> <li> <p>Percona Server for MySQL 8.0.36, and MySQL 8.0.36</p> </li> <li> <p>Percona Server for MySQL 8.0.37, and MySQL 8.0.37</p> </li> </ul> <p>For more information, see Percona XtraBackup Version Compatibility and Server Version Checks.</p> <p>Taking your backup with Percona XtraBackup is easy. Follow our documentation guides, and you\u2019ll be set up in quickly.</p>"},{"location":"index.html#quickstart-guide","title":"Quickstart guide","text":"<p>Get started quickly with our Quickstart guide.</p> <p>Quickstart guide </p>"},{"location":"index.html#installation-guides","title":"Installation guides","text":"<p>Find the best installation solution with our step-by-step installation instructions.</p> <p>Installation instructions </p>"},{"location":"index.html#binaries","title":"Binaries","text":"<p>Learn about the Percona XtraBackup binaries: xtrabackup, xbcloud, xbcrypt, and xbstream.</p> <p>Binaries </p>"},{"location":"index.html#backup-management","title":"Backup management","text":"<p>Learn about the different types of backups and how to take them.</p> <p>Backup management </p>"},{"location":"index.html#supported-storage-engines","title":"Supported storage engines","text":"<p>Percona XtraBackup can back up data from InnoDB, XtraDB, MyISAM, and MyRocks tables on MySQL 8.0 servers as well as Percona Server for MySQL with XtraDB, Percona Server for MySQL 8.0, and Percona XtraDB Cluster 8.0.</p> <p>Version updates</p> <p>Version 8.0.6 and later supports the MyRocks storage engine.  An incremental backup on the MyRocks storage engine does not  determine if an earlier full or incremental backup  contains the same files. Percona XtraBackup copies all  MyRocks files each time it takes a backup. Percona XtraBackup does not support the TokuDB storage engine. Find more information in Percona TokuBackup. </p>"},{"location":"index.html#limitations","title":"Limitations","text":"<p>Percona XtraBackup 8.0 does not support making backups of databases created in versions prior to 8.0 of MySQL, Percona Server for MySQL or Percona XtraDB Cluster. As the changes that MySQL 8.0 introduced in data dictionaries, redo log and undo log are incompatible with previous versions, it is currently impossible for Percona XtraBackup 8.0 to also support versions prior to 8.0.</p> <p>Due to changes in MySQL 8.0.20 released by Oracle at the end of April 2020, Percona XtraBackup 8.0, up to version 8.0.11, is not compatible with MySQL version 8.0.20 or higher, or Percona products that are based on it: Percona Server for MySQL and Percona XtraDB Cluster.</p> <p>For more information, see Percona XtraBackup 8.x and MySQL 8.0.20</p> <p>Learn more about other Percona products</p> <p>Percona Distribution for MySQL 8.0 </p> <p></p>"},{"location":"index.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"404.html","title":"404 - Not Found","text":"<p>We can\u2019t find the page you are looking for. Try using the Search or return to the homepage.</p> <p></p>"},{"location":"404.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"about-xtrabackup.html","title":"About Percona XtraBackup","text":"<p>Percona XtraBackup is the world\u2019s only open source, free MySQL hot backup software that performs non-blocking backups for InnoDB and XtraDB databases. </p> <p>With Percona XtraBackup, you can achieve the following benefits:</p> <ul> <li> <p>Backups that complete quickly and reliably</p> </li> <li> <p>Uninterrupted transaction processing during backups</p> </li> <li> <p>Savings on disk space and network bandwidth</p> </li> <li> <p>Automatic backup verification</p> </li> <li> <p>Higher uptime due to faster restore time</p> </li> </ul> <p>Percona XtraBackup makes MySQL hot backups for all versions of Percona Server for MySQL, and MySQL. It performs streaming, compressed, and incremental MySQL backups.</p> <p>Check the latest list of all Supported versions.</p> <p>Important</p> <p>Percona XtraBackup 2.4 supports MySQL and Percona Server for MySQL  5.6 and 5.7 databases. Due to changes in the MySQL redo log and data  dictionary formats, the Percona XtraBackup 8.0.x versions are only  compatible with MySQL 8.0.x, Percona Server for MySQL 8.0.x, and  compatible versions.</p> <p>Percona\u2019s enterprise-grade commercial MySQL Support contracts include support for Percona XtraBackup. We recommend support for critical production deployments. Percona XtraDB Backup supports encryption.</p>"},{"location":"about-xtrabackup.html#supported-storage-engines","title":"Supported storage engines","text":"<p>Percona XtraBackup can back up data from InnoDB, XtraDB, MyISAM, and MyRocks tables on MySQL 8.0 servers as well as Percona Server for MySQL with XtraDB, Percona Server for MySQL 8.0, and Percona XtraDB Cluster 8.0.</p> <p>Version updates</p> <p>Version 8.0.6 and later supports the MyRocks storage engine.  An incremental backup on the MyRocks storage engine does not  determine if an earlier full or incremental backup  contains the same files. Percona XtraBackup copies all  MyRocks files each time it takes a backup. Percona  XtraBackup does not support the TokuDB storage engine.</p> <p>See also</p> <p>Percona TokuBackup</p>"},{"location":"about-xtrabackup.html#limitations","title":"Limitations","text":"<p>Percona XtraBackup 8.0 does not support making backups of databases created in versions prior to 8.0 of MySQL, Percona Server for MySQL or Percona XtraDB Cluster. As the changes that MySQL 8.0 introduced in data dictionaries, redo log and undo log are incompatible with previous versions, it is currently impossible for Percona XtraBackup 8.0 to also support versions prior to 8.0.</p> <p>Due to changes in MySQL 8.0.20 released by Oracle at the end of April 2020, Percona XtraBackup 8.0, up to version 8.0.11, is not compatible with MySQL version 8.0.20 or higher, or Percona products that are based on it: Percona Server for MySQL and Percona XtraDB Cluster.</p> <p>For more information, see Percona XtraBackup 8.x and MySQL 8.0.20</p>"},{"location":"about-xtrabackup.html#what-are-the-features-of-percona-xtrabackup","title":"What are the features of Percona XtraBackup?","text":"<p>Here is a short list of the Percona XtraBackup features. See the documentation for more.</p> <ul> <li> <p>Create hot InnoDB backups without pausing your database</p> </li> <li> <p>Make incremental backups of MySQL</p> </li> <li> <p>Stream compressed MySQL backups to another server</p> </li> <li> <p>Move tables between MySQL servers on-line</p> </li> <li> <p>Create new MySQL replication replicas easily</p> </li> <li> <p>Backup MySQL without adding load to the server</p> </li> <li> <p>Percona XtraBackup performs throttling based on the number of IO operations per second</p> </li> <li> <p>Percona XtraBackup can export individual tables even from a full backup, regardless of the InnoDB version</p> </li> <li> <p>Backup locks is a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> available in Percona Server. Percona XtraBackup uses them automatically to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p> </li> </ul> <p>See also</p> <p>How Percona XtraBackup works</p>"},{"location":"about-xtrabackup.html#additional-information","title":"Additional information","text":"<p>The InnoDB tables are locked while copying non-InnoDB data.</p> <p></p>"},{"location":"about-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"accelerate-backup-process.html","title":"Accelerate the backup process","text":""},{"location":"accelerate-backup-process.html#copy-with-the-parallel-and-compress-threads-options","title":"Copy with the <code>--parallel</code> and <code>--compress-threads</code> options","text":"<p>When making a local or streaming backup with xbstream option, multiple files can be copied at the same time when using the <code>--parallel</code> option. This option specifies the number of threads created by xtrabackup to copy data files.</p> <p>To take advantage of this option either the multiple tablespaces option must be enabled (innodb_file_per_table) or the shared tablespace must be stored in multiple ibdata files with the innodb_data_file_path option. Having multiple files for the database (or splitting one into many) doesn\u2019t have a measurable impact on performance.</p> <p>As this feature is implemented at the file level, concurrent file transfer can sometimes increase I/O throughput when doing a backup on highly fragmented data files, due to the overlap of a greater number of random read requests. You should consider tuning the filesystem also to obtain the maximum performance (e.g. checking fragmentation).</p> <p>If the data is stored on a single file, this option will have no effect.</p> <p>To use this feature, simply add the option to a local backup, for example:</p> <pre><code>$ xtrabackup --backup --parallel=4 --target-dir=/path/to/backup\n</code></pre> <p>By using the xbstream in streaming backups, you can additionally speed up the compression process with the <code>--compress-threads</code> option. This option specifies the number of threads created by xtrabackup for for parallel data compression. The default value for this option is 1.</p> <p>To use this feature, simply add the option to a local backup, for example:</p> <pre><code>$ xtrabackup --backup --stream=xbstream --compress --compress-threads=4 --target-dir=./ &gt; backup.xbstream\n</code></pre> <p>Before applying logs, compressed files will need to be uncompressed.</p>"},{"location":"accelerate-backup-process.html#the-rsync-option","title":"The <code>--rsync</code> option","text":"<p>In order to speed up the backup process and to minimize the time <code>FLUSH TABLES WITH READ LOCK</code> is blocking the writes, the option <code>--rsync</code> should be used. When this option is specified, xtrabackup uses <code>rsync</code> to copy all non-InnoDB files instead of spawning a separate <code>cp</code> for each file, which can be much faster for servers with a large number of databases or tables. xtrabackup will call the <code>rsync</code> twice, once before the <code>FLUSH TABLES WITH READ LOCK</code> and once during to minimize the time the read lock is being held. During the second <code>rsync</code> call, it will only synchronize the changes to non-transactional data (if any) since the first call performed before the <code>FLUSH TABLES WITH READ LOCK</code>. Note that Percona XtraBackup will use Backup locks where available as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code>. This feature is available in Percona Server for MySQL 5.6+. Percona XtraBackup uses this automatically to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p> <p>Note</p> <p>This option cannot be used together with the <code>--stream</code> option.</p> <p></p>"},{"location":"accelerate-backup-process.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"analyze-table-statistics.html","title":"Analyze table statistics","text":"<p>Note</p> <p>As of Percona XtraBackup 8.0.30 the \u2013stats option is deprecated and may be removed in future releases.  We no longer support using the \u2013stats option in Percona XtraBackup 8.0.29 and older versions.</p> <p>The xtrabackup binary can analyze InnoDB data files in read-only mode to give statistics about them. To do this, you should use the \u2013stats option. You can combine this with the \u2013tables option to limit the files to examine. It also uses the \u2013use-memory option.</p> <p>You can perform the analysis on a running server, with some chance of errors due to the data being changed during analysis. Or, you can analyze a backup copy of the database. Either way, to use the statistics feature, you need a clean copy of the database including correctly sized log files, so you need to execute with <code>--prepare</code> twice to use this functionality on a backup.</p> <p>The result of running on a backup might look like the following:</p> Expected output <pre><code>&lt;INDEX STATISTICS&gt;\n  table: test/table1, index: PRIMARY, space id: 12, root page 3\n  estimated statistics in dictionary:\n    key vals: 25265338, leaf pages 497839, size pages 498304\n  real statistics:\n     level 2 pages: pages=1, data=5395 bytes, data/pages=32%\n     level 1 pages: pages=415, data=6471907 bytes, data/pages=95%\n        leaf pages: recs=25958413, pages=497839, data=7492026403 bytes, data/pages=91%\n</code></pre> <p>This can be interpreted as follows:</p> <ul> <li> <p>The first line simply shows the table and index name and its internal identifiers. If you see an index named <code>GEN_CLUST_INDEX</code>, that is the table\u2019s clustered index, automatically created because you did not explicitly create a <code>PRIMARY KEY</code>.</p> </li> <li> <p>The estimated statistics in dictionary information is similar to the data that\u2019s gathered through <code>ANALYZE TABLE</code> inside of InnoDB to be stored as estimated cardinality statistics and passed to the query optimizer.</p> </li> <li> <p>The real statistics information is the result of scanning the data pages and computing exact information about the index.</p> </li> <li> <p><code>The level &lt;X&gt; pages</code>: output means that the line shows information about pages at that level in the index tree. The larger <code>&lt;X&gt;</code> is, the farther it is from the leaf pages, which are level 0. The first line is the root page.</p> </li> <li> <p>The <code>leaf pages</code> output shows the leaf pages, of course. This is where the table\u2019s data is stored.</p> </li> <li> <p>The <code>external pages</code>: output (not shown) shows large external pages that hold values too long to fit in the row itself, such as long <code>BLOB</code> and <code>TEXT</code> values.</p> </li> <li> <p>The <code>recs</code> is the real number of records (rows) in leaf pages.</p> </li> <li> <p>The <code>pages</code> is the page count.</p> </li> <li> <p>The <code>data</code> is the total size of the data in the pages, in bytes.</p> </li> <li> <p>The <code>data/pages</code> is calculated as (<code>data</code> / (<code>pages</code> * <code>PAGE_SIZE</code>)) * 100%. It will never reach 100% because of space reserved for page headers and footers.</p> </li> </ul> <p>A more detailed example is posted as a MySQL Performance Blog post.</p>"},{"location":"analyze-table-statistics.html#script-to-format-output","title":"Script to format output","text":"<p>The following script can be used to summarize and tabulate the output of the statistics information:</p> Expected output <pre><code>tabulate-xtrabackup-stats.pl\n\n#!/usr/bin/env perl\nuse strict;\nuse warnings FATAL =&gt; 'all';\nmy $script_version = \"0.1\";\n\nmy $PG_SIZE = 16_384; # InnoDB defaults to 16k pages, change if needed.\nmy ($cur_idx, $cur_tbl);\nmy (%idx_stats, %tbl_stats);\nmy ($max_tbl_len, $max_idx_len) = (0, 0);\nwhile ( my $line = &lt;&gt; ) {\n   if ( my ($t, $i) = $line =~ m/table: (.*), index: (.*), space id:/ ) {\n      $t =~ s!/!.!;\n      $cur_tbl = $t;\n      $cur_idx = $i;\n      if ( length($i) &gt; $max_idx_len ) {\n         $max_idx_len = length($i);\n      }\n      if ( length($t) &gt; $max_tbl_len ) {\n         $max_tbl_len = length($t);\n      }\n   }\n   elsif ( my ($kv, $lp, $sp) = $line =~ m/key vals: (\\d+), \\D*(\\d+), \\D*(\\d+)/ ) {\n      @{$idx_stats{$cur_tbl}-&gt;{$cur_idx}}{qw(est_kv est_lp est_sp)} = ($kv, $lp, $sp);\n      $tbl_stats{$cur_tbl}-&gt;{est_kv} += $kv;\n      $tbl_stats{$cur_tbl}-&gt;{est_lp} += $lp;\n      $tbl_stats{$cur_tbl}-&gt;{est_sp} += $sp;\n   }\n    elsif ( my ($l, $pages, $bytes) = $line =~ m/(?:level (\\d+)|leaf) pages:.*pages=(\\d+), data=(\\d+) bytes/ ) {\n      $l ||= 0;\n      $idx_stats{$cur_tbl}-&gt;{$cur_idx}-&gt;{real_pages} += $pages;\n      $idx_stats{$cur_tbl}-&gt;{$cur_idx}-&gt;{real_bytes} += $bytes;\n      $tbl_stats{$cur_tbl}-&gt;{real_pages} += $pages;\n      $tbl_stats{$cur_tbl}-&gt;{real_bytes} += $bytes;\n   }\n}\n\nmy $hdr_fmt = \"%${max_tbl_len}s %${max_idx_len}s %9s %10s %10s\\n\";\nmy @headers = qw(TABLE INDEX TOT_PAGES FREE_PAGES PCT_FULL);\nprintf $hdr_fmt, @headers;\n\nmy $row_fmt = \"%${max_tbl_len}s %${max_idx_len}s %9d %10d %9.1f%%\\n\";\nforeach my $t ( sort keys %tbl_stats ) {\n  my $tbl = $tbl_stats{$t};\n  printf $row_fmt, $t, \"\", $tbl-&gt;{est_sp}, $tbl-&gt;{est_sp} - $tbl-&gt;{real_pages},\n      $tbl-&gt;{real_bytes} / ($tbl-&gt;{real_pages} * $PG_SIZE) * 100;\n   foreach my $i ( sort keys %{$idx_stats{$t}} ) {\n      my $idx = $idx_stats{$t}-&gt;{$i};\n      printf $row_fmt, $t, $i, $idx-&gt;{est_sp}, $idx-&gt;{est_sp} - $idx-&gt;{real_pages},\n         $idx-&gt;{real_bytes} / ($idx-&gt;{real_pages} * $PG_SIZE) * 100;\n   }\n}\n</code></pre>"},{"location":"analyze-table-statistics.html#sample-script-output","title":"Sample script output","text":"<p>The output of the above Perl script, when run against the sample shown in the previously mentioned blog post, will appear as follows:</p> Expected output <pre><code>      TABLE           INDEX TOT_PAGES FREE_PAGES   PCT_FULL\nart.link_out104                    832383      38561      86.8%\nart.link_out104         PRIMARY    498304         49      91.9%\nart.link_out104       domain_id     49600       6230      76.9%\nart.link_out104     domain_id_2     26495       3339      89.1%\nart.link_out104 from_message_id     28160        142      96.3%\nart.link_out104    from_site_id     38848       4874      79.4%\nart.link_out104   revert_domain    153984      19276      71.4%\nart.link_out104    site_message     36992       4651      83.4%\n</code></pre> <p>The columns are the table and index, followed by the total number of pages in that index, the number of pages not actually occupied by data, and the number of bytes of real data as a percentage of the total size of the pages of real data. The first line in the above output, in which the <code>INDEX</code> column is empty, is a summary of the entire table.</p> <p></p>"},{"location":"analyze-table-statistics.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-download-deb.html","title":"Install with DEB packages","text":"<p>This guide walks you through installing Percona XtraBackup 8.0 using DEB packages on Ubuntu-based systems.</p> <ol> <li> <p>Download the DEB package</p> <p>On the Percona Software Downloads website, find the Percona XtraBackup 8.0 package for your system. </p> <p>For example, for Ubuntu 20.04, this command downloads the appropriate package:</p> <pre><code>$ wget https://downloads.percona.com/downloads/Percona-XtraBackup-LATEST/Percona-XtraBackup-8.0.26-18/binary/debian/focal/x86_64/percona-xtrabackup-80_8.0.26-18-1.focal_amd64.deb\n</code></pre> </li> <li> <p>Install the package</p> <p>Use the dpkg command to install the downloaded package. You need root privileges for this:</p> <pre><code>$ sudo dpkg -i percona-xtrabackup-80_8.0.26-18-1.focal_amd64.deb\n</code></pre> </li> </ol>"},{"location":"apt-download-deb.html#common-dependencies-for-percona-xtrabackup","title":"Common dependencies for Percona XtraBackup","text":"Library Name Description libmysqlclient A client library for MySQL, providing essential functions for connecting to and communicating with MySQL databases. libssl A cryptographic library used for implementing SSL/TLS encryption, necessary for secure data transmission. libcurl A library that enables data transfer via various protocols such as HTTP, FTP, and others, commonly used for handling web requests. libev A high-performance event-loop library, often used in network applications for handling asynchronous events efficiently. libgcrypt A general-purpose cryptographic library that provides encryption, decryption, and cryptographic hashing algorithms. zlib A compression library used for data compression and decompression, supporting the popular DEFLATE compression algorithm."},{"location":"apt-download-deb.html#identify-and-add-missing-dependencies","title":"Identify and add missing dependencies","text":"<p>If there are missing dependencies, dpkg shows error messages. Install any missing packages with the following command:</p> <pre><code>$ sudo apt-get install -f\n</code></pre> <p>Retry the Percona XtraBackup installation.</p>"},{"location":"apt-download-deb.html#verify-the-installation","title":"Verify the installation","text":"<p>The following command returns the version information.</p> <pre><code>$ xtrabackup --version\n</code></pre>"},{"location":"apt-download-deb.html#troubleshoot-the-installation","title":"Troubleshoot the installation","text":"Issue Description Permission denied Ensure you\u2019re using sudo or have root access for installation commands. Repository issues If packages are not found, check your yum repository configuration. Incompatible OS version Double-check your OS version matches the package requirements. Conflicts with existing packages Consider removing conflicting packages or use a separate environment. <p>If you encounter persistent issues, consult the Percona XtraBackup documentation or reach out to their support forums for assistance.</p> <p>Remember, when installing packages manually, you\u2019re responsible for managing dependencies and potential conflicts. Always back up your data before making significant system changes.</p> <p></p>"},{"location":"apt-download-deb.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-files.html","title":"Files in the DEB package built for Percona XtraBackup 8.0","text":"<p>The following tables show what data each <code>DEB</code> package contains.</p> Package Contains percona-xtrabackup-80 The latest Percona XtraBackup GA binaries and associated files percona-xtrabackup-dbg-80 The debug symbols for binaries in <code>percona-xtrabackup-80</code> percona-xtrabackup-test-80 The test suite for Percona XtraBackup percona-xtrabackup The older version of the Percona XtraBackup <p></p>"},{"location":"apt-files.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-pinning.html","title":"Pin packages in Debian-based systems","text":"<p>You may need to keep a specific package at a certain version and prevent it from being automatically updated by your package manager. This action is called \u201cpinning\u201d a package.</p> <ol> <li> <p>Create a preference file, <code>00percona.pref</code>, in the <code>/etc/apt/preferences.d/</code> directory.</p> </li> <li> <p>Set the Pinning priority</p> <p>To pin a package, set the <code>Pin-Priority</code> to a higher number than the default priority of the packages. This setting makes the packages higher priority over the other sources.</p> <p>For example, add the following lines to the preference file:</p> <pre><code>Package: &lt;package_name&gt;\nPin: release o=Percona Development Team\nPin-Priority: 1001\n</code></pre> <p>Replace the <code>&lt;package_name&gt;</code> with the package\u2019s name. </p> </li> <li> <p>Save the <code>00percona.pref</code> file.</p> </li> </ol> <p>You can pin multiple packages by adding separate entries to the file.</p> <p>Remove the entry from the file if you no longer want to pin the package.</p> <p>For more information about the pinning, check the official debian wiki.</p> <p></p>"},{"location":"apt-pinning.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-repo.html","title":"Install Percona XtraBackup on Debian-based systems","text":"<p>Ready-to-use packages are available from the Percona XtraBackup software repositories and the download page.</p> <p>Specific information on the supported platforms, products, and versions is described in Percona Release Lifecycle Overview.</p> <p>To prevent intermittent backup failures, update the curl utility in Debian 10.</p> <p>This guide walks you through the process of installing Percona XtraBackup 8.0 on Debian-based systems using the Percona-release tool.</p>"},{"location":"apt-repo.html#version-changes","title":"Version changes","text":"<p>Starting with Percona XtraBackup 8.0.35-31, the APT builds for the following platforms include ARM packages with the <code>arm64.deb</code> extension:</p> <ul> <li> <p>Debian 12</p> </li> <li> <p>Debian 11</p> </li> <li> <p>Ubuntu 24.04</p> </li> <li> <p>Ubuntu 22.04</p> </li> <li> <p>Ubuntu 20.04</p> </li> </ul> <p>This extension means Percona XtraBackup is now available for users on ARM-based systems.</p> <p>We recommend downloading Percona XtraBackup for the same platform as your MySQL-compatible server. For instance, if your server runs on an ARM64 platform, you should download and use the Percona XtraBackup with the <code>arm64.deb</code> extension for that operating system.</p>"},{"location":"apt-repo.html#prerequisites","title":"Prerequisites","text":"<ul> <li> <p>Sudo or root access</p> </li> <li> <p>Internet connection</p> </li> </ul>"},{"location":"apt-repo.html#installation-steps","title":"Installation steps","text":"<p>The following procedure installs Percona XtraBackup 8.0.</p> <ol> <li> <p>Update the system package list</p> <pre><code>$ sudo apt update\n</code></pre> Example output <pre><code>Get:1 http://ports.ubuntu.com/ubuntu-ports jammy InRelease [270 kB]\nGet:2 http://ports.ubuntu.com/ubuntu-ports jammy-updates InRelease [128 kB]\nGet:3 http://ports.ubuntu.com/ubuntu-ports jammy-backports InRelease [127 kB]\nGet:4 http://ports.ubuntu.com/ubuntu-ports jammy-security InRelease [129 kB]\nGet:5 http://ports.ubuntu.com/ubuntu-ports jammy/restricted arm64 Packages [24.2 kB]\nGet:6 http://ports.ubuntu.com/ubuntu-ports jammy/multiverse arm64 Packages [224 kB]\nGet:7 http://ports.ubuntu.com/ubuntu-ports jammy/universe arm64 Packages [17.2 MB]\nGet:8 http://ports.ubuntu.com/ubuntu-ports jammy/main arm64 Packages [1758 kB]\nGet:9 http://ports.ubuntu.com/ubuntu-ports jammy-updates/restricted arm64 Packages [2400 kB]\nGet:10 http://ports.ubuntu.com/ubuntu-ports jammy-updates/multiverse arm64 Packages [29.5 kB]\nGet:11 http://ports.ubuntu.com/ubuntu-ports jammy-updates/universe arm64 Packages [1379 kB]\nGet:12 http://ports.ubuntu.com/ubuntu-ports jammy-updates/main arm64 Packages [2217 kB]\nGet:13 http://ports.ubuntu.com/ubuntu-ports jammy-backports/universe arm64 Packages [31.8 kB]\nGet:14 http://ports.ubuntu.com/ubuntu-ports jammy-backports/main arm64 Packages [81.0 kB]\nGet:15 http://ports.ubuntu.com/ubuntu-ports jammy-security/main arm64 Packages [1949 kB]\nGet:16 http://ports.ubuntu.com/ubuntu-ports jammy-security/restricted arm64 Packages [2330 kB]\nGet:17 http://ports.ubuntu.com/ubuntu-ports jammy-security/multiverse arm64 Packages [24.1 kB]\nGet:18 http://ports.ubuntu.com/ubuntu-ports jammy-security/universe arm64 Packages [1096 kB]\nFetched 31.4 MB in 7s (4264 kB/s)\nReading package lists... Done\nBuilding dependency tree... Done\nReading state information... Done\n9 packages can be upgraded. Run 'apt list --upgradable' to see them.\n</code></pre> </li> <li> <p>Install the curl download utility if it\u2019s not installed:</p> <pre><code>$ sudo apt install curl\n</code></pre> Example output <pre><code>Reading package lists... Done\nBuilding dependency tree... Done\nReading state information... Done\nThe following additional packages will be installed:\n  ca-certificates libbrotli1 libcurl4 libldap-2.5-0 libldap-common libnghttp2-14 libpsl5 librtmp1\nSuggested packages:\n...\nUpdating certificates in /etc/ssl/certs...\n0 added, 0 removed; done.######################################################################...]\nRunning hooks in /etc/ca-certificates/update.d...\ndone.\n</code></pre> </li> <li> <p>Download the percona-release the repository package:</p> <pre><code>$ curl -O https://repo.percona.com/apt/percona-release_latest.generic_all.deb\n</code></pre> Example output <pre><code>% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current\n                                Dload  Upload   Total   Spent    Left Speed\n100 16510  100 16510    0     0  31433      0 --:--:-- --:--:-- --:--:-- 31447\n</code></pre> </li> <li> <p>Install the downloaded package and its dependencies using apt:</p> <pre><code>$ sudo apt install gnupg2 lsb-release ./percona-release_latest.generic_all.deb\n</code></pre> Example output <pre><code>Reading package lists... Done\nBuilding dependency tree... Done\nReading state information... Done\nNote, selecting 'percona-release' instead of './percona-release_latest.generic_all.deb'\nThe following additional packages will be installed:\n</code></pre> </li> <li> <p>Refresh the local cache to update the package information:</p> <pre><code>$ sudo apt update\n</code></pre> Example output <pre><code>Hit:1 http://repo.percona.com/pmm2-client/apt jammy InRelease\nHit:2 http://ports.ubuntu.com/ubuntu-ports jammy InRelease\nHit:3 http://repo.percona.com/prel/apt jammy InRelease\n...\n</code></pre> </li> <li> <p>Enable the repository:</p> <pre><code>$ percona-release setup pxb-80\n</code></pre> Example output <pre><code>* Disabling all Percona Repositories\n* Enabling the Percona XtraBackup 8.0 repository\nHit:1 http://repo.percona.com/prel/apt jammy InRelease\nGet:2 http://repo.percona.com/pxb-80/apt jammy InRelease [18.7 kB]\nHit:3 http://ports.ubuntu.com/ubuntu-ports jammy InRelease\nGet:4 http://ports.ubuntu.com/ubuntu-ports jammy-updates InRelease [128 kB]\nHit:5 http://repo.percona.com/telemetry/apt jammy InRelease\nGet:6 http://repo.percona.com/pxb-80/apt jammy/main Sources [3393 B]\nGet:7 http://ports.ubuntu.com/ubuntu-ports jammy-backports InRelease [127 kB]\nGet:8 http://ports.ubuntu.com/ubuntu-ports jammy-security InRelease [129 kB]\nFetched 406 kB in 1s (274 kB/s)\nReading package lists... Done\n</code></pre> </li> <li> <p>Install the package:</p> <pre><code>$ sudo apt install percona-xtrabackup-80\n</code></pre> Example output <pre><code>Reading package lists... Done\nBuilding dependency tree... Done\nReading state information... Done\nThe following additional packages will be installed:\n  libaio1 libcurl4-openssl-dev libdbd-mysql-perl libdbi-perl libev4 libgdbm-compat4 libgdbm6\n  libmysqlclient21 libperl5.34 libpopt0 mysql-common netbase perl perl-modules-5.34 rsync zstd\n...\nSetting up libdbd-mysql-perl:amd64 (4.050-5ubuntu0.22.04.1) ...##########################.........]\nSetting up percona-xtrabackup-80 (8.0.35-31-1.jammy) ...####################################......]\nProcessing triggers for libc-bin (2.35-0ubuntu3.8) ...########################################....]\n</code></pre> </li> <li> <p>Verify the installation:</p> <pre><code>$ xtrabackup --version\n</code></pre> Example output <pre><code>xtrabackup version 8.0.35-31 based on MySQL server 8.0.35 Linux (x86_64) (revision id: 55ec21d7)\n</code></pre> </li> <li> <p>Install optional compression packages if you plan to use LZ4 or ZSTD compression:</p> Install the <code>lz4</code> packageInstall the <code>zstd</code> package <pre><code>$ sudo apt install lz4\n</code></pre> <pre><code>$ sudo apt install zstd\n</code></pre> </li> </ol>"},{"location":"apt-repo.html#troubleshooting","title":"Troubleshooting","text":"<p>If you encounter any errors during the installation process, check your system\u2019s error logs:</p> <pre><code>$ sudo tail -n 50 /var/log/syslog\n</code></pre> <p>Ensure your system meets the minimum requirements for Percona XtraBackup. </p> <p>If you encounter permission errors, ensure you\u2019re running the commands with <code>sudo</code> or have root access.</p> <p>For AppArmor profile information, see Working with AppArmor.</p> <p>Additional resources</p> <p>To install Percona XtraBackup using downloaded deb packages, see Install Percona XtraBackup 8.0.</p> <p>To uninstall Percona XtraBackup, see Uninstall Percona XtraBackup 8.0</p> <p></p>"},{"location":"apt-repo.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"apt-uninstall-xtrabackup.html","title":"Uninstall Percona XtraBackup 8.0 on Debian-based systems","text":"<p>Remember to back up any important data before uninstalling software.</p> <p>To completely uninstall Percona XtraBackup, remove all the installed packages:</p> <pre><code>$ sudo apt remove percona-xtrabackup-80\n</code></pre> <p>Run the following command to remove all configuration files along with the packages:</p> <pre><code>$ sudo apt purge percona-xtrabackup-80\n</code></pre> <p>Remove any unused dependencies:</p> <pre><code>$ sudo apt autoremove\n</code></pre> <p>To verify the removal, check the version:</p> <pre><code>$ xtrabackup --version\n</code></pre> <p>This should return a <code>command not found</code>.</p> <p>You must remove any remaining directories manually:</p> <pre><code>$ sudo rm -rf /var/lib/xtrabackup\n</code></pre> <p>You can also remove any added Percona repositories from your system manager\u2019s configuration.</p> <p></p>"},{"location":"apt-uninstall-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"backup-overview.html","title":"Backup process overview","text":"<p>Percona Xtrabackup is a tool that allows you to create backups of MySQL or MariaDB databases. It works by copying the data files and the binary log files of the server, while ensuring that the data is consistent and not corrupted by ongoing transactions. Percona Xtrabackup can also prepare the backup files for restoration, apply incremental backups, and stream the backup files to another server or storage device.</p>"},{"location":"backup-overview.html#backup-types","title":"Backup types","text":"<p>You can take and prepare the following types of backups:</p> <ul> <li> <p>Full backup - a backup of all the contents of the database</p> </li> <li> <p>Incremental backup - a backup of only the files that have changed since the last full backup</p> </li> <li> <p>Compressed backup - a backup of all the contents of the database with applying a compression algorithm that reduces the size of the data to be stored</p> </li> <li> <p>Partial backup - a backup of only the files that have changed in a specific folder or a set of folders, rather than the entire database</p> </li> <li> <p>Individual partitions backup - a backup of an individual partition</p> </li> </ul>"},{"location":"backup-overview.html#backup-restoration","title":"Backup restoration","text":"<ul> <li> <p>Restore full, incremental, compressed backups</p> </li> <li> <p>Restore a partial backup</p> </li> <li> <p>Restore an individual partitions backup</p> </li> <li> <p>Restore individual tables</p> </li> </ul> <p></p>"},{"location":"backup-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"backup-strategy.html","title":"Backup strategy and backup policy","text":"<p>In conversation, \u2018backup strategy,\u2019 \u2018backup policy,\u2019 and \u2018backup plan\u2019 are used interchangeably, but the terms have distinct meanings.</p> <p>A backup strategy is an overall approach or methodology for backing up the data in a database system. The strategy includes the decisions and considerations for what data to back up, how frequently backups should be taken, what backup methods and technologies to use, where to store the backup files, and what steps should be taken to ensure data integrity and the ability to recover.</p> <p>A backup strategy typically involves business requirements, the Recovery Point Objective (RPO), the maximum acceptable data loss in case of system failure or disaster, and the Recovery Time Objective (RTO), the acceptable downtime for restoring the system after a failure, and compliance regulations.</p> <p>A backup policy defines the guidelines, rules, or standards for specific procedures and practices for implementing the backup strategy.</p> <p>The policy outlines the following:</p> <ul> <li> <p>Detailed steps and parameters for performing backups</p> </li> <li> <p>Retention periods</p> </li> <li> <p>Backup types</p> </li> <li> <p>Backup verification methods</p> </li> <li> <p>Error handling procedures</p> </li> <li> <p>Security measures</p> </li> </ul> <p>A backup plan, based on the backup strategy and the backup policy, is a detailed operation document that specifies how to execute the backup strategy in actionable steps and defines the timelines for backup activities. </p> <p>A backup plan can include the following details:</p> <ul> <li> <p>Who performs the backup</p> </li> <li> <p>When backups are scheduled</p> </li> <li> <p>How backups are monitored and audited</p> </li> <li> <p>What actions to take in case of backup failures or emergencies</p> </li> </ul>"},{"location":"backup-strategy.html#types-of-backup","title":"Types of backup","text":"<p>A full backup copies all data to a storage location. This type of backup creates a complete copy of the data set. The benefit of a full backup is a quick recovery since the data is stored in one place. However, this type of backup is also the most time-consuming and storage-intensive; it duplicates all data regardless of whether it has changed since the last backup.</p> <p>An incremental backup only copies data that has changed since the last backup, whether that was a full or another incremental backup. This method is faster and more storage-efficient than a full backup. However, the recovery can be slower because you must restore each set of changes in sequence.</p> <p>For more information, see the example of using a full backup with incremental backups.</p>"},{"location":"backup-strategy.html#backup-policy-defined","title":"Backup policy defined","text":"<p>The backup policy sets the guidelines and objectives for data protection, while the backup strategy provides the roadmap for achieving those objectives.</p> <p>A backup policy may state that all customer data must be backed up daily, with a full backup at the start of each week and incremental backups taken each business day. These definitions are based on the following: It also defines how long backups should be retained based on legal or regulatory requirements.</p> <p>The difference between a backup policy and a backup strategy lies in their scope and detail. A backup policy is more about the following:</p> <ul> <li> <p>\u2018what\u2019 \u2014 What should be backed up and may include information on compliance and governance</p> </li> <li> <p>\u2018when\u2019 - When should you do backups</p> </li> </ul> <p>The backup strategy contains the \u2018how\u2019 \u2014 how the backups are scheduled and includes information on the backup technologies and the restoration process.  </p> <p>The backup strategy details the use of specific backup software, the configuration of backup schedules, the process for monitoring backup success, and the necessary steps for restoring data.</p>"},{"location":"backup-strategy.html#backup-policy-best-practices","title":"Backup policy best practices","text":"<p>An effective backup policy is crucial for safeguarding an organization\u2019s data integrity and availability. Here are some best practices to consider:</p> <p>Backup Policy Best Practices | Markdown Table</p> Best Practice Description Regularly Update and Review Ensure the backup policy is a living document, updated to reflect changes in technology, business processes, and regulations. Clearly Define Roles and Responsibilities Assign specific individuals or teams for executing backups, monitoring success, and managing restoration. Adopt the 3-2-1 Backup Rule Have 3 data copies, store them on 2 different media types, and keep 1 copy offsite. Ensure Comprehensive Coverage The policy should cover all critical data, applications, and systems to avoid data loss gaps. Encrypt Backup Data Protect backups with encryption, especially for offsite or cloud storage. Test Backups Regularly Regularly test backup processes to ensure data can be effectively restored. Implement a Disaster Recovery Plan Integrate the backup policy with a broader disaster recovery plan for data loss scenarios. Use Reliable Backup Software and Hardware Invest in proven technologies with robust backup and restoration capabilities. Monitor Backup Procedures Continuously monitor procedures to ensure they function as intended and identify issues promptly. Train Staff Educate relevant staff on the importance of backups and their role in the process. Document the Backup Process Maintain thorough documentation of the backup process, including schedules, technologies, and restoration procedures. Define Service Level Agreements (SLAs) Establish clear SLAs for backup and recovery times to set expectations and ensure accountability. Comply with Legal and Regulatory Requirements Ensure the policy complies with relevant laws and regulations regarding data retention and protection. Plan for Scalability Design the policy to accommodate future data volume growth and infrastructure changes. Conduct Periodic Risk Assessments Regularly assess data risks and adjust the backup policy to mitigate those risks. <p>By adhering to these best practices, organizations can create a robust backup policy that protects their data and supports their business continuity and disaster recovery strategies. It\u2019s important to remember that the effectiveness of a backup policy is not just in its creation but in its implementation and ongoing management. Regular reviews, updates, and staff training ensure the backup policy remains relevant and effective in evolving data landscapes and threats. The goal is to have a backup policy that is not only comprehensive and compliant but also practical and responsive to the organization\u2019s needs.</p>"},{"location":"backup-strategy.html#backup-policy-example","title":"Backup policy example","text":"<p>An example of a backup policy might include the following components: </p> Aspect Details Purpose To define the procedures and responsibilities for backing up organizational data to ensure its availability in case of data loss. Scope This policy applies to all data, hardware, and software in the organization\u2019s information systems. Policy Statement The organization shall maintain a regular backup schedule for all critical data. Full backups are to be performed weekly, with incremental backups occurring daily. All backups must be encrypted and stored in a secure, off-site location. Roles and Responsibilities The IT department is responsible for executing backups as scheduled.  The department head will ensure that backup procedures are followed and reviewed regularly. Backup Procedures The IT department must use software and hardware. Data to be backed up includes, but is not limited to, customer information, financial records, and operational data. Data Retention Retain the backup data for five years or as required by law or industry regulations. Disaster Recovery In the event of data loss, the IT department shall follow the disaster recovery plan to restore data from the most recent backup. Review and Testing Review the backup policy and procedures annually.  Test the backup and restoration procedures quarterly to ensure they are effective."},{"location":"backup-strategy.html#test-the-backups","title":"Test the backups","text":"<p>You must test the effectiveness of your backups and demonstrate that you can recover your data in the event of loss or corruption. </p> <p>Here are several methods to assess the reliability of your backup system:</p> Aspect Details Perform Regular Test Restores The most reliable way to test backups is to periodically restore the data to a separate system. This restoration verifies the backup\u2019s integrity and the restoration process\u2019s functionality. Monitor Backup Reports Regularly review backup reports and logs for any errors or failures during the backup process. This can help identify issues early before they become critical problems. Check for Data Consistency Compare the original data with the backed-up data to ensure consistency. This can be done by checking file sizes, using checksums, or employing other data validation techniques. One tool would be to use [<code>pt-table-checksum</code>]. Simulate Disaster Scenarios Conducting a simulated disaster recovery exercise can help determine how well your backup system will perform under stress and identify any gaps in your recovery plan. Audit Backup Procedures Regular audits of the backup procedures can ensure that the backups are being performed in accordance with the established policies and that the backup system is functioning as expected. Validate Backup Configuration Ensure that the backup configuration is correct and that all necessary data is being backed up. This includes checking backup schedules, retention policies, and the scope of the data backed up. Verify Security Measures Confirm that the backup data is secure and that encryption and other security measures are functioning correctly to protect against unauthorized access. Evaluate Recovery Time Objectives Measure how long it takes to restore data from backups and compare this with your recovery time objectives to ensure they align with your business requirements. Assess Backup Media Reliability Regularly check the physical and logical condition of the backup media, whether it\u2019s tape, disk, or cloud storage, to ensure it\u2019s in good working order. Conduct Incremental Backup Tests Test the restoration of incremental backups to ensure that they work in conjunction with full backups and that the data can be restored to a specific point in time. Review Backup Software Updates Keep the backup software updated and test after updates to ensure new versions or patches do not introduce issues with the backup or restoration processes. Check for Compatibility Issues Ensure that the backup system is compatible with all the software and data formats used in your organization to avoid restoration issues. Document Test Results Keep detailed records of all backup tests, including the scope, date, issues encountered, and resolutions. This documentation can be invaluable for troubleshooting and improving the backup process. <p>By implementing these methods, you are confident that your backup system protects your data and can recover your data when necessary. Regular testing and monitoring are key to maintaining an effective backup strategy and ensuring business continuity. Remember, the goal of testing is not just to prove that backups can be restored, but to identify and resolve any issues before an actual disaster occurs. This proactive approach can save valuable time and resources, and ultimately, safeguard your organization\u2019s data integrity.</p>"},{"location":"backup-strategy.html#common-challenges","title":"Common challenges","text":"<p>Common backup challenges often include issues such as damaged backups, missing or failed backups, maintaining legacy systems, adhering to strict privacy and security regulations, and managing the costs associated with data backup. To overcome these challenges, organizations can adopt several strategies. Implementing a modern, reliable backup solution that includes automated data consistency checking can help protect against damaged backups. Regular recovery tests can ensure that data is recoverable and not corrupt.</p> <p>For missing or failed backups, it\u2019s essential to have a robust monitoring system that alerts IT staff to any issues with the backup process. This allows for immediate action to rectify any problems before they escalate. Maintaining legacy systems can be addressed by gradually phasing out older technology and replacing it with more current, supported solutions. This can help avoid the pitfalls of outdated systems that may not be compatible with newer technologies or that may no longer be supported by the vendor.</p> <p>Adhering to privacy and security regulations requires a thorough understanding of the laws and standards that apply to an organization\u2019s industry and geography. Implementing encryption and access controls can help ensure that backups are secure and compliant with regulations. Finally, managing the costs of data backup involves careful planning and budgeting. Organizations should consider the total cost of ownership of their backup solutions, including initial investment, ongoing maintenance, and potential costs associated with data recovery.</p> <p>In addition to these strategies, it\u2019s essential to follow best practices such as the 3-2-1 backup rule, which suggests having three copies of data on two different media, with one copy stored offsite. Regular testing and validation of backups, clear documentation of backup procedures, and continuous training for staff involved in the backup process are also crucial for overcoming common backup challenges. By staying vigilant and proactive, organizations can ensure that their data remains secure and recoverable, even in these challenges.</p>"},{"location":"backup-strategy.html#disaster-recovery-plan","title":"Disaster recovery plan","text":"<p>A disaster recovery plan (DRP) is a structured approach with detailed instructions for responding to unplanned incidents such as natural disasters, power outages, cyber-attacks, and other disruptive events.</p> <p>This table organizes the different sections of the disaster recovery plan, along with brief descriptions of each section.</p> Section Description Introduction This section outlines the purpose of the plan, its scope, and the types of disasters it covers. It also includes the plan\u2019s objectives, such as minimizing downtime and data loss. Roles and Responsibilities This part defines the disaster recovery team\u2019s specific roles. It lists the contact information for each team member and outlines the chain of command. Incident Response This section provides the steps to detect, report, and assess damage caused by a disaster. It includes procedures for immediate response to limit the impact on operations. Plan Activation Here, the criteria for launching the disaster recovery plan are detailed. It specifies who has the authority to activate the plan and under what circumstances. Communication Plan This part details how communication should be handled during a disaster, including internal communication with employees and external communication with customers, suppliers, and the media. Recovery Strategies This section outlines the strategies for restoring hardware, software, and data that are critical to resuming business operations. It includes prioritized actions for recovery and the resources required. Data Backup Procedures Detailed instructions for restoring data from backups are provided here. It includes the locations of backups, the types of backups (full, incremental), and the backup schedule. Site Relocation If the primary business location is compromised, this part of the plan details the process for moving operations to an alternate site. Plan Testing and Maintenance This section describes the schedule for regular testing of the DRP to ensure its effectiveness. It also outlines the process for updating the plan as the business and technology environment changes. Appendices The appendices may include site maps, network diagrams, floor plans, and any other documentation that supports disaster recovery efforts. <p>It\u2019s important to note that a DRP should be tailored to the specific needs of the organization and should be reviewed and tested regularly to ensure it remains effective and up-to-date. The example provided here is a high-level overview and would need to be expanded with detailed, actionable steps specific to the organization\u2019s operational requirements. For more detailed templates and guidance on creating a disaster recovery plan, there are resources available online that can provide a starting point for developing a comprehensive plan.</p> <p></p>"},{"location":"backup-strategy.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"binaries-overview.html","title":"Percona XtraBackup binaries overview","text":"<p>Percona XtraBackup is a set of the following binaries:</p> <ul> <li> <p>xtrabackup - a compiled C binary that provides functionality to backup a whole MySQL database instance with MyISAM, InnoDB, and XtraDB tables.</p> </li> <li> <p>xbcrypt - a utility used for encrypting and decrypting backup files.</p> </li> <li> <p>xbstream - a utility that allows streaming and extracting files to / from the xbstream format.</p> </li> <li> <p>xbcloud - a utility used for downloading and uploading full or part of xbstream archive from / to cloud.</p> </li> </ul> <p>The recommended way to take the backup is by using the xtrabackup script. For more information on script options, see xtrabackup.</p> <p></p>"},{"location":"binaries-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"binary-tarball-names.html","title":"Binary tarball file names available","text":"<p>Download the binary tarballs from Percona Product Downloads. For more information, see the [download instructions]. To install Percona XtraBackup, see install with binary tarball.</p> <p>The following table lists the tarball types available in <code>Linux - Generic</code>. Select the Percona XtraBackup 8.0 version, the software or the operating system, and the tarball type for your installation. Binary tarballs support all AMD64 distributions.</p> <p>After you have downloaded the binary tarballs, extract the tarball in the file location of your choice.</p> Type Name Operating systems Description Full percona-xtrabackup--Linux.x86_64.glibc2.12.tar.gz Built for CentOS 6 Contains binary files, libraries, test files, and debug symbols Minimal percona-xtrabackup--Linux.x86_64.glibc2.12-minimal.tar.gz Built for CentOS 6 Contains binary files, and libraries but does not include test files, or debug symbols Full percona-xtrabackup--Linux.x86_64.glibc2.17.tar.gz Compatible with any operating system except for CentOS 6 Contains binary files, libraries, test files, and debug symbols Minimal percona-xtrabackup--Linux.x86_64.glibc2.17-minimal.tar.gz Compatible with any operating system except for CentOS 6 Contains binary files, and libraries but does not include test files, or debug symbols <p>Select a different software, such as Ubuntu 20.04 (Focal Fossa), for a  tarball for that operating system. You can download the packages together or separately.</p> <p></p>"},{"location":"binary-tarball-names.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"binary-tarball.html","title":"Install Percona XtraBackup 8.0 from a binary tarball","text":"<p>Binary tarballs provide a ready-to-use application since they contain precompiled executables, libraries, and dependencies. Installing from a tarball is straightforward \u2014 extract the files to your desired location. Compiling or building from source is unnecessary, which saves time and effort. You avoid the compilation process, which can be time-consuming and error-prone.</p> <p>Binary tarballs provide only the necessary files, reducing disk space usage. A binary tarball installation allows customization since you can choose installation paths, configure options, and tailor the application to your requirements. Binary tarballs often come with version numbers, letting you track and update the installed version as needed.</p> <p>Be aware of the following when installing from a binary tarball:</p> <ul> <li> <p>Binary tarballs bundle dependencies within themselves. If your system already has specific libraries or versions installed, you may have conflicts.</p> </li> <li> <p>Binary tarball installation bypasses the package manager. Package managers handle updates, dependencies, and conflict resolution. Manual management of updates becomes necessary.</p> </li> <li> <p>Binary tarballs may not receive security patches automatically. You must actively monitor and apply updates.</p> </li> <li> <p>Binary tarball custom installation can scatter files. It may not adhere to standard paths, which makes maintenance challenging.</p> </li> </ul>"},{"location":"binary-tarball.html#download-the-tarball","title":"Download the tarball","text":"<p>You can download the binary tarballs from the <code>Linux - Generic</code> section on the Percona Product Downloads. For more information, see the download instructions. For information on the available binary tarball names, see binary tarball names.</p> <p>The following command is an example of downloading a tarball for Linux/Generic:</p> <pre><code>$ wget https://downloads.percona.com/downloads/Percona-XtraBackup-8.0/Percona-XtraBackup-8.0.35-30/binary/tarball/percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17.tar.gz\n</code></pre> Expected result <pre><code>--2024-03-18 11:34:50--  https://downloads.percona.com/downloads/Percona-XtraBackup-8.0/Percona-XtraBackup-8.0.35-30/binary/tarball/percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17.tar.gz\nResolving downloads.percona.com (downloads.percona.com)... 147.135.54.159, 2604:2dc0:200:69f::2\nConnecting to downloads.percona.com (downloads.percona.com)|147.135.54.159|:443... connected.\n...\npercona-xtrabackup-8.0 100%[==========================&gt;] 448.02M  2.56MB/s    in 5m 5s\n2024-03-18 11:39:56 (1.47 MB/s) - 'percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17.tar.gz' saved [469780148/469780148]\n</code></pre>"},{"location":"binary-tarball.html#extract-the-tarball","title":"Extract the tarball","text":"<p>After downloading the tarball to the selected location, use the following command to extract the tarball:</p> <pre><code>$ tar -xvf percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17.tar.gz\n</code></pre> Expected result <pre><code>percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xbcloud_osenv\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xtrabackup\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xbcrypt\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xbstream\npercona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin/xbcloud\n...\n</code></pre> <p>After the extraction, navigate to the <code>bin</code> directory to find the binary files. </p> <pre><code>$ cd percona-xtrabackup-8.0.35-30-Linux-x86_64.glibc2.17/bin\n</code></pre> <p>In the bin directory, run one of the binary files.</p> <pre><code>$ ./xtrabackup --version\n</code></pre> Expected result <pre><code>./xtrabackup version 8.0.35-30 based on MySQL server 8.0.35 Linux (x86_64) (revision id: 6beb4b49)\n</code></pre> <p></p>"},{"location":"binary-tarball.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"compile-xtrabackup.html","title":"Compile and install Percona XtraBackup 8.0 from source","text":"<p>The following instructions install Percona XtraBackup 8.0.</p>"},{"location":"compile-xtrabackup.html#1-install-percona-xtrabackup-from-the-git-source-tree","title":"1. Install Percona XtraBackup from the Git Source Tree","text":"<p>Percona uses the Github revision control system for development. To build the latest Percona Server for MySQL from the source tree, you will need <code>git</code> installed on your system.</p> <p>You can now fetch the latest Percona XtraBackup 8.0 sources:</p> <pre><code>$ git clone https://github.com/percona/percona-xtrabackup.git\n$ cd percona-xtrabackup\n$ git checkout 8.0\n$ git submodule update --init --recursive\n</code></pre>"},{"location":"compile-xtrabackup.html#2-installation-prerequisites","title":"2. Installation prerequisites","text":"<p>The following packages and tools must be installed to compile Percona XtraBackup from source. These might vary from system to system.</p> <p>Important</p> <p>To build **Percona XtraBackup 8.0 from source, you must use <code>cmake</code>  version 3. To check which version is  currently installed, run <code>cmake --version</code> at a command prompt. If the  version is not <code>3</code>, install <code>cmake3</code>.</p> <p>This <code>cmake</code> version may be available  in your distribution as a separate package <code>cmake3</code>. For more information, see cmake.org</p> Debian or Ubuntu using <code>apt</code>CentOS or Red Hat using <code>yum</code> <pre><code>sudo apt install bison pkg-config cmake devscripts debconf \\\ndebhelper automake bison ca-certificates libprocps-dev \\\nlibcurl4-openssl-dev cmake debhelper libaio-dev \\\nlibncurses-dev libssl-dev libtool libz-dev libgcrypt-dev libev-dev libprocps-dev \\\nlsb-release build-essential rsync libdbd-mysql-perl \\\nlibnuma1 socat librtmp-dev libtinfo5 vim-common \\\nlibudev-dev \\\nliblz4-tool liblz4-1 liblz4-dev zstd python-docutils qpress\n</code></pre> <p>To install the man pages, install the python3-sphinx package first:</p> <pre><code>$ sudo apt install python3-sphinx\n</code></pre> <p>Percona Xtrabackup requires GCC version 5.3 or higher. If the version of GCC installed on your system is lower then you may need to install and enable the Developer Toolset on <code>RPM</code>-based distributions to make sure that you use the latest GCC compiler and development tools.  Then, install <code>cmake</code> and other dependencies:</p> <pre><code>$ sudo yum install cmake openssl-devel libaio libaio-devel automake autoconf \\\nbison libtool ncurses-devel libgcrypt-devel libev-devel libcurl-devel zlib-devel \\\nbibudev-dev \\\nzstd vim-common procps-ng-devel\n</code></pre> <p>To install the man pages, install the python3-sphinx package first:</p> <pre><code>$ sudo yum install python3-sphinx\n</code></pre>"},{"location":"compile-xtrabackup.html#3-generate-the-build-pipeline","title":"3. Generate the build pipeline","text":"<p>At this step, you have <code>cmake</code> run the commands in the <code>CMakeList.txt</code> file to generate the build pipeline, i.e., a native build environment that will be used to compile the source code).</p> <ol> <li> <p>Change to the directory where you cloned the Percona XtraBackup repository</p> <pre><code>$ cd percona-xtrabackup\n</code></pre> </li> <li> <p>Create a directory to store the compiled files and then change to that directory:</p> <pre><code>$ mkdir build\n$ cd build\n</code></pre> </li> <li> <p>Run cmake or cmake3. In either case, the options you need to use are the same.</p> </li> </ol> <p>Note</p> <p>You can build Percona XtraBackup with man pages but this requires <code>python-sphinx</code> package which isn\u2019t available from that main repositories for every distribution. If you installed the <code>python-sphinx</code> package you need to remove the <code>-DWITH_MAN_PAGES=OFF</code> from previous command.</p> <pre><code>$ cmake -DWITH_BOOST=PATH-TO-BOOST-LIBRARY -DDOWNLOAD_BOOST=ON \\\n-DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF -B ..\n</code></pre>"},{"location":"compile-xtrabackup.html#parameter-information","title":"Parameter Information","text":"Parameter Description <code>-DWITH_BOOST</code> For the <code>-DWITH_BOOST</code> parameter, specify the name of a directory to download the boost library to. This directory is created automatically in your current directory. <code>-DWITH_MAN_PAGES</code> To build Percona XtraBackup man pages, use <code>ON</code> or remove this parameter from the command line (it is <code>ON</code> by default). To install the man pages, install the python3-sphinx package first. <code>-B</code> (\u2013build) Percona XtraBackup is configured to forbid generating the build    pipeline for make in the same directory where you store your sources. The <code>-B</code> parameter refers to the directory that contains the source code. In this example, we use the relative path to the parent directory (..). <p>Important</p> <p>CMake Error at CMakeLists.txt:367 (MESSAGE): Please do not build in-source. Out-of source builds are highly recommended: you can have multiple builds for the same source, and there is an easy way to do cleanup, simply remove the build directory (note that \u2018make clean\u2019 or \u2018make distclean\u2019 does <code>not</code> work)</p> <p>You <code>can</code> force in-source build by invoking cmake with <code>-DFORCE_INSOURCE_BUILD=1</code>.</p>"},{"location":"compile-xtrabackup.html#4-compile-the-source-code","title":"4. Compile the source code","text":"<p>To compile the source code in your <code>build</code> directory, use the <code>make</code> command.</p> <ol> <li> <p>Change to the <code>build</code> directory (created at Step 2: Generating the build pipeline).</p> </li> <li> <p>Run the <code>make</code> command. This command may take a long time to complete.</p> <pre><code>$ make\n</code></pre> <p>To use all CPU threads and make compilation faster please use:</p> <pre><code>$ make -j$(nproc --all)\n</code></pre> </li> </ol>"},{"location":"compile-xtrabackup.html#5-install-on-the-target-system","title":"5. Install on the target system","text":"<p>The following command installs all Percona XtraBackup binaries xtrabackup and tests to default location on the target system: <code>/usr/local/xtrabackup</code>.</p> <p>Run <code>make install</code> to install Percona XtraBackup to the default location.</p> <pre><code>$ sudo make install\n</code></pre>"},{"location":"compile-xtrabackup.html#install-to-a-non-default-location","title":"Install to a non-default location","text":"<p>You may use the <code>DESTDIR</code> parameter with <code>make install</code> to install Percona XtraBackup to another location. Make sure that the effective user is able to write to the destination you choose.</p> <pre><code>$ sudo make DESTDIR=&lt;DIR_NAME&gt; install\n</code></pre> <p>In fact, the destination directory is determined by the installation layout (<code>-DINSTALL_LAYOUT</code>) that <code>cmake</code> applies (see Step 2: Generating the build pipeline). In addition to the installation directory, this parameter controls a number of other destinations that you can adjust for your system.</p> <p>By default, this parameter is set to <code>STANDALONE</code>, which implies the installation directory to be <code>/usr/local/xtrabackup</code>.</p> <p>See also</p> <p>MySQL Documentation: -DINSTALL_LAYOUT</p>"},{"location":"compile-xtrabackup.html#6-run-percona-xtrabackup","title":"6. Run Percona XtraBackup","text":"<p>After Percona XtraBackup is installed on your system, you may run it by using the full path to the <code>xtrabackup</code> command:</p> <pre><code>$ /usr/local/xtrabackup/bin/xtrabackup\n</code></pre> <p>Update your PATH environment variable if you would like to use the command on the command line directly.</p> <pre><code>$# Setting $PATH on the command line\n$ PATH=$PATH:/usr/local/xtrabackup/bin/xtrabackup\n\n$# Run xtrabackup directly\n$ xtrabackup\n</code></pre> <p>Alternatively, you may consider placing a soft link (using <code>ln -s</code>) to one of the locations listed in your <code>PATH</code> environment variable.</p> <p>To view the documentation with <code>man</code>, update the <code>MANPATH</code> variable.</p> <p></p>"},{"location":"compile-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"configure-xtrabackup.html","title":"Configure xtrabackup","text":"<p>All the xtrabackup configuration is done through options, which behave exactly like standard MySQL program options: they can be specified either at the command-line, or through a file such as <code>/etc/my.cnf</code>.</p> <p>The xtrabackup binary reads the <code>mysqld</code> and <code>xtrabackup</code> sections from any configuration files, in that order. That is so that it can read its options from your existing MySQL installation, such as the datadir or some InnoDB options. If you want to override these options specify them in the <code>xtrabackup</code> section. These options are read at a later time and take precedence.</p> <p>You don\u2019t need to put any configuration in your <code>my.cnf</code> if you don\u2019t want to. You can simply specify the options on the command-line. Normally, the only thing you might find convenient to place in the <code>xtrabackup</code> section of your <code>my.cnf</code> file is the <code>target_dir</code> option to default the directory in which the backups will be placed, for example:</p> <pre><code>[xtrabackup]\ntarget_dir = /data/backups/mysql/\n</code></pre> <p>This manual will assume that you do not have any file-based configuration for xtrabackup, so it will always show command-line options being used explicitly. Please see the option and variable reference for details on all the configuration options.</p> <p>The xtrabackup binary does not accept exactly the same syntax in the <code>my.cnf</code> file as the mysqld server binary does. For historical reasons, the mysqld server binary accepts parameters with a <code>--set-variable=&lt;variable&gt;=&lt;value&gt;</code> syntax, which xtrabackup does not understand. If your <code>my.cnf</code> file has such configuration directives, you should rewrite them in the <code>--variable=value</code> syntax.</p>"},{"location":"configure-xtrabackup.html#system-configuration-and-nfs-volumes","title":"System configuration and NFS volumes","text":"<p>The xtrabackup tool requires no special configuration on most systems. However, the storage where the <code>--target-dir</code> is located must behave properly when <code>fsync()</code> is called. In particular, we have noticed that if you mount the NFS volume without the <code>sync</code> option the NFS volume does not sync the data. As a result, if you back up to an NFS volume mounted with the async option, and then try to prepare the backup from a different server that also mounts that volume, the data might appear to be corrupt. You can use the <code>sync</code> mount option to avoid this problem.</p> <p></p>"},{"location":"configure-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"copyright-and-licensing-information.html","title":"Copyright and licensing information","text":""},{"location":"copyright-and-licensing-information.html#documentation-licensing","title":"Documentation licensing","text":"<p>Percona XtraBackup documentation is (C)2009-2023 Percona LLC and/or its affiliates and is distributed under the Creative Commons Attribution 4.0 International License.</p> <p></p>"},{"location":"copyright-and-licensing-information.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-compressed-backup.html","title":"Create a compressed backup","text":"<p>Percona XtraBackup supports compressed backups. A local or streaming backup can be compressed or decompressed with xbstream.</p> <p>To make a compressed backup, use the <code>--compress</code> option along with the <code>--backup</code> and <code>--target-dir</code> options. </p>"},{"location":"create-compressed-backup.html#version-updates","title":"Version updates","text":"Percona XtraBackup 8.0.34-29 and later <p>Percona XtraBackup removes <code>qpress/QuickLZ</code> and moves the <code>ZSTD</code> compression method to General Availability. With this version <code>ZSTD</code> becomes the default compression method for the <code>--compress</code> option.</p> <p>The following compression algorithms are supported:</p> <p><code>Zstandard (ZSTD)</code></p> <p><code>ZSTD</code> is a fast lossless compression algorithm that targets real-time compression scenarios and better compression ratios. <code>ZSTD</code> is the default compression method for the <code>--compress</code> option.</p> <p>To compress files using the <code>ZSTD</code> compression algorithm, run the following command:</p> <pre><code>$ xtrabackup --backup --compress --target-dir=/data/backup\n</code></pre> <p>You can specify <code>ZSTD</code> compression level with the <code>--compress-zstd-level(=#)</code> option. The default value is <code>1</code>.</p> <pre><code>$ xtrabackup --backup --compress --compress-zstd-level=1 --target-dir=/data/backup\n</code></pre> <p>If you want to speed up the compression you can use the parallel compression, which can be enabled with <code>--compress-threads</code> option. Following example will use four threads for compression:</p> <pre><code>$ xtrabackup --backup --compress --compress-threads=4 \\\n--target-dir=/data/compressed/\n</code></pre> <p>The expected output:</p> <pre><code>...\n170223 13:00:38 [01] Compressing ./test/sbtest1.frm to /tmp/compressed/test/sbtest1.frm.qp\n170223 13:00:38 [01]        ...done\n170223 13:00:38 [01] Compressing ./test/sbtest2.frm to /tmp/compressed/test/sbtest2.frm.qp\n170223 13:00:38 [01]        ...done\n...\n170223 13:00:39 [00] Compressing xtrabackup_info\n170223 13:00:39 [00]        ...done\nxtrabackup: Transaction log of lsn (9291934) to (9291934) was copied.\n170223 13:00:39 completed OK!\n</code></pre> <p><code>lz4</code></p> <p>To compress files using the <code>lz4</code> compression algorithm, set <code>--compress</code> option to <code>lz4</code>:</p> <pre><code>$ xtrabackup --backup --compress=lz4 --target-dir=/data/backup\n</code></pre> <p>To decompress files, use the <code>--decompress</code> option. </p> Percona XtraBackup 8.0.31-24 to 8.0.34-29  <p>Using qpress/QuickLZ to compress backups is deprecated and may be removed in future versions. We recommend using either <code>LZ4</code> or Zstandard (<code>ZSTD</code>) compression algorithms. <code>ZSTD</code> compression algorithm is in tech preview. </p> Before Percona XtraBackup 8.0.31-24 <p>By default, the <code>--compress</code> option uses the <code>qpress</code> tool that you can install with the <code>percona-release</code> package configuration tool as follows:</p> <pre><code>$ sudo percona-release enable tools\n$ sudo apt update\n$ sudo apt install qpress\n</code></pre> <p>Note</p> <p>Enable the repository: <code>percona-release enable-only tools release</code>.</p> <p>If Percona XtraBackup is intended to be used in combination with the upstream MySQL Server, you only need to enable the <code>tools</code> repository: <code>percona-release enable-only tools</code>.</p> <p>The following compression algorithms are supported:</p> <p><code>quicklz</code></p> <p>To compress files using the <code>quicklz</code> compression algorithm, use <code>--compress</code> option:</p> <pre><code>$ xtrabackup --backup --compress --target-dir=/data/backup\n</code></pre> <p><code>lz4</code></p> <p>To compress files using the <code>lz4</code> compression algorithm, set <code>--compress</code> option to <code>lz4</code>:</p> <pre><code>$ xtrabackup --backup --compress=lz4 --target-dir=/data/backup\n</code></pre> <p><code>Zstandard (ZSTD)</code></p> <p>The Zstandard (ZSTD) compression algorithm is a tech preview feature. Before using ZSTD in production, we recommend that you test restoring production from physical backups in your environment, and also use the alternative backup method for redundancy.</p> <p>Percona XtraBackup 8.0.30-23 adds support for the <code>Zstandard (ZSTD)</code> compression algorithm. <code>ZSTD</code> is a fast lossless compression algorithm that targets real-time compression scenarios and better compression ratios. </p> <p>To compress files using the <code>ZSTD</code> compression algorithm, set <code>--compress</code> option to <code>zstd</code>:</p> <pre><code>$ xtrabackup --backup --compress=zstd --target-dir=/data/backup\n</code></pre> <p>You can specify <code>ZSTD</code> compression level with the <code>--compress-zstd-level(=#)</code> option. The default value is <code>1</code>.</p> <pre><code>$ xtrabackup --backup --compress --compress-zstd-level=1 --target-dir=/data/backup\n</code></pre> <p>If you want to speed up the compression you can use the parallel compression, which can be enabled with <code>--compress-threads</code> option. Following example will use four threads for compression:</p> <pre><code>$ xtrabackup --backup --compress --compress-threads=4 \\\n--target-dir=/data/compressed/\n</code></pre> <p>The expected output:</p> <pre><code>...\n170223 13:00:38 [01] Compressing ./test/sbtest1.frm to /tmp/compressed/test/sbtest1.frm.qp\n170223 13:00:38 [01]        ...done\n170223 13:00:38 [01] Compressing ./test/sbtest2.frm to /tmp/compressed/test/sbtest2.frm.qp\n170223 13:00:38 [01]        ...done\n...\n170223 13:00:39 [00] Compressing xtrabackup_info\n170223 13:00:39 [00]        ...done\nxtrabackup: Transaction log of lsn (9291934) to (9291934) was copied.\n170223 13:00:39 completed OK!\n</code></pre> <p>Using <code>--encrypt</code> might create larger backups than expected when used with InnoDB Page Compression.</p> <p>To avoid this issue with compressed backups, use the <code>--compress</code> option with the <code>--xbstream</code> option in Percona XtraBackup 8.0.31-24 and later.</p> <p>The next step is to prepare the backup in order to restore it. </p> <p></p>"},{"location":"create-compressed-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-full-backup.html","title":"Create a full backup","text":"<p>To create a backup, run xtrabackup with the <code>--backup</code> option. You also need to specify the <code>--target-dir</code> option, which is where the backup will be stored, if the InnoDB data or log files are not stored in the same directory, you might need to specify the location of those, too. If the target directory does not exist, xtrabackup creates it. If the directory does exist and is empty, xtrabackup will succeed.</p> <p>xtrabackup will not overwrite existing files, it will fail with operating system error 17, <code>file exists</code>.</p> <p>To start the backup process run:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/\n</code></pre> <p>This will store the backup at <code>/data/backups/</code>. If you specify a relative path, the target directory will be relative to the current directory.</p> <p>During the backup process, you should see a lot of output showing the data files being copied, as well as the log file thread repeatedly scanning the log files and copying from it. Here is an example that shows the log thread scanning the log in the background, and a file copying thread working on the <code>ibdata1</code> file:</p> Expected output <pre><code>160906 10:19:17 Finished backing up non-InnoDB tables and files\n160906 10:19:17 Executing FLUSH NO_WRITE_TO_BINLOG ENGINE LOGS...\nxtrabackup: The latest check point (for incremental): '62988944'\nxtrabackup: Stopping log copying thread.\n.160906 10:19:18 &gt;&gt; log scanned up to (137343534)\n160906 10:19:18 Executing UNLOCK TABLES\n160906 10:19:18 All tables unlocked\n160906 10:19:18 Backup created in directory '/data/backups/'\n160906 10:19:18 [00] Writing backup-my.cnf\n160906 10:19:18 [00]        ...done\n160906 10:19:18 [00] Writing xtrabackup_info\n160906 10:19:18 [00]        ...done\nxtrabackup: Transaction log of lsn (26970807) to (137343534) was copied.\n160906 10:19:18 completed OK!\n</code></pre> <p>The last thing you should see is something like the following, where the value of the <code>&lt;LSN&gt;</code> will be a number that depends on your system:</p> <pre><code>$ xtrabackup: Transaction log of lsn (&lt;LSN&gt;) to (&lt;LSN&gt;) was copied.\n</code></pre> <p>Note</p> <p>Log copying thread checks the transactional log every second to see if there were any new log records written that need to be copied, but there is a chance that the log copying thread might not be able to keep up with the amount of writes that go to the transactional logs, and will hit an error when the log records are overwritten before they could be read.</p> <p>After the backup is finished, the target directory will contain files such as the following, assuming you have a single InnoDB table <code>test.tbl1</code> and you are using MySQL\u2019s innodb_file_per_table option:</p> <pre><code>$ ls -lh /data/backups/\n</code></pre> <p>The result should look like this:</p> Expected output <pre><code>total 182M\ndrwx------  7 root root 4.0K Sep  6 10:19 .\ndrwxrwxrwt 11 root root 4.0K Sep  6 11:05 ..\n-rw-r-----  1 root root  387 Sep  6 10:19 backup-my.cnf\n-rw-r-----  1 root root  76M Sep  6 10:19 ibdata1\ndrwx------  2 root root 4.0K Sep  6 10:19 mysql\ndrwx------  2 root root 4.0K Sep  6 10:19 performance_schema\ndrwx------  2 root root 4.0K Sep  6 10:19 sbtest\ndrwx------  2 root root 4.0K Sep  6 10:19 test\ndrwx------  2 root root 4.0K Sep  6 10:19 world2\n-rw-r-----  1 root root  116 Sep  6 10:19 xtrabackup_checkpoints\n-rw-r-----  1 root root  433 Sep  6 10:19 xtrabackup_info\n-rw-r-----  1 root root 106M Sep  6 10:19 xtrabackup_logfile\n</code></pre> <p>The backup can take a long time, depending on how large the database is. It is safe to cancel at any time, because xtrabackup does not modify the database.</p> <p>The next step is to prepare the backup in order to restore it. </p> <p></p>"},{"location":"create-full-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-gtid-replica.html","title":"How to create a new (or repair a broken) GTID-based replica","text":"<p>MySQL 5.6 introduced the Global Transaction ID (GTID) support in replication. Percona XtraBackup automatically stores the <code>GTID</code> value in the <code>xtrabackup_binlog_info</code> when doing the backup of MySQL and Percona Server for MySQL 5.7 with the <code>GTID</code> mode enabled. This information can be used to create a new (or repair a broken) <code>GTID</code>-based replica.</p>"},{"location":"create-gtid-replica.html#1-take-a-backup-from-any-server-on-the-replication-environment-source-or-replica","title":"1. Take a backup from any server on the replication environment, source or replica","text":"<p>The following command takes a backup and saves it in the <code>/data/backups/$TIMESTAMP</code> folder:</p> <pre><code>$ xtrabackup --backup --target-dirs=/data/backups/\n</code></pre> <p>In the destination folder, there will be a file with the name <code>xtrabackup_binlog_info</code>. This file contains both binary log coordinates and the <code>GTID</code> information.</p> <p><pre><code>$ cat xtrabackup_binlog_info\n</code></pre> The result could look like this:</p> Expected output <pre><code>mysql-bin.000002    1232        c777888a-b6df-11e2-a604-080027635ef5:1-4\n</code></pre> <p>That information is also printed by xtrabackup after taking the backup:</p> Expected output <pre><code>xtrabackup: MySQL binlog position: filename 'mysql-bin.000002', position 1232, GTID of the last change 'c777888a-b6df-11e2-a604-080027635ef5:1-4'\n</code></pre>"},{"location":"create-gtid-replica.html#2-prepare-the-backup","title":"2. Prepare the backup","text":"<p>The backup will be prepared with the following command on the Source:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup\n</code></pre> <p>You need to select the path where your snapshot has been taken, for example <code>/data/backups/2013-05-07_08-33-33</code>. If everything is ok you should get the same OK message. Now, the transaction logs are applied to the data files, and new ones are created: your data files are ready to be used by the MySQL server.</p>"},{"location":"create-gtid-replica.html#3-move-the-backup-to-the-destination-server","title":"3. Move the backup to the destination server","text":"<p>Use rsync or scp to copy the data to the destination server. If you are synchronizing the data directly to the already running replica\u2019s data directory it is advised to stop the MySQL server there.</p> <pre><code>$ rsync -avprP -e ssh /path/to/backupdir/$TIMESTAMP NewSlave:/path/to/mysql/\n</code></pre> <p>After you copy the data over, make sure MySQL has proper permissions to access them.</p> <pre><code>$ chown mysql:mysql /path/to/mysql/datadir\n</code></pre>"},{"location":"create-gtid-replica.html#4-configure-and-start-replication","title":"4. Configure and start replication","text":"<p>Set the <code>gtid_purged</code> variable to the <code>GTID</code> from <code>xtrabackup_binlog_info</code>. Then, update the information about the source node and, finally, start the replica. Run the following commands on the replica if you are using a version before 8.0.22:</p> <pre><code># Using the mysql shell\n &gt; SET SESSION wsrep_on = 0;\n &gt; RESET MASTER;\n &gt; SET SESSION wsrep_on = 1;\n &gt; SET GLOBAL gtid_purged='&lt;gtid_string_found_in_xtrabackup_binlog_info&gt;';\n &gt; CHANGE MASTER TO\n             MASTER_HOST=\"$masterip\",\n             MASTER_USER=\"repl\",\n             MASTER_PASSWORD=\"$slavepass\",\n             MASTER_AUTO_POSITION = 1;\n &gt; START SLAVE;\n</code></pre> <p>If you are using version 8.0.22 or later, use <code>START REPLICA</code> instead of <code>START SLAVE</code>. <code>START SLAVE</code> is deprecated as of that release. If you are using version 8.0.21 or earlier, use <code>START SLAVE</code>.</p> <p>If you are using a version 8.0.23 or later, run the following commands:</p> <pre><code># Using the mysql shell\n &gt; SET SESSION wsrep_on = 0;\n &gt; RESET MASTER;\n &gt; SET SESSION wsrep_on = 1;\n &gt; SET GLOBAL gtid_purged='&lt;gtid_string_found_in_xtrabackup_binlog_info&gt;';\n &gt; CHANGE REPLICATION SOURCE TO\n             SOURCE_HOST=\"$masterip\",\n             SOURCE_USER=\"repl\",\n             SOURCE_PASSWORD=\"$slavepass\",\n             SOURCE_AUTO_POSITION = 1;\n &gt; START REPLICA;\n</code></pre> <p>If you are using version 8.0.23 or later, use CHANGE_REPLICATION_SOURCE_TO and the appropriate options. <code>CHANGE_MASTER_TO</code> is deprecated as of that release.</p> <p>Note</p> <p>The example above is applicable to Percona XtraDB Cluster. The <code>wsrep_on</code> variable is set to 0 before resetting the source (<code>RESET MASTER</code>). The reason is that Percona XtraDB Cluster will not allow resetting the source if <code>wsrep_on=1</code>.</p>"},{"location":"create-gtid-replica.html#5-check-the-replication-status","title":"5. Check the replication status","text":"<p>The following command returns the replica status:</p> <p><pre><code>mysql&gt; SHOW REPLICA STATUS\\G\n</code></pre> The results should be similar to the following:</p> Expected output <pre><code>[..]\nSlave_IO_Running: Yes\nSlave_SQL_Running: Yes\n[...]\nRetrieved_Gtid_Set: c777888a-b6df-11e2-a604-080027635ef5:5\nExecuted_Gtid_Set: c777888a-b6df-11e2-a604-080027635ef5:1-5\n</code></pre> <p>Note</p> <p>The command SHOW SLAVE STATUS is deprecated. Use SHOW REPLICA STATUS.</p> <p>We can see that the replica has retrieved a new transaction with number 5, so transactions from 1 to 5 are already on this slave.</p> <p>We have created a new replica in our <code>GTID</code> based replication environment.</p> <p></p>"},{"location":"create-gtid-replica.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-incremental-backup.html","title":"Create an incremental backup","text":"<p>xtrabackup supports incremental backups, which means that they can copy only all the data that has changed since the last backup.</p> <p>Note</p> <p>Incremental backups on the MyRocks storage engine do not determine if an earlier full backup or incremental backup contains the same files. Percona XtraBackup copies all the MyRocks files each time it takes a backup.</p> <p>You can perform many incremental backups between each full backup, so you can set up a backup process such as a full backup once a week and an incremental backup every day, or full backups every day and incremental backups every hour.</p> <p>Incremental backups work because each InnoDB page contains a log sequence number, or LSN. The LSN is the system version number for the entire database. Each page\u2019s LSN shows how recently it was changed.</p> <p>An incremental backup copies each page which LSN is newer than the previous incremental or full backup\u2019s LSN. An algorithm finds the pages that match the criteria. The algorithm reads the data pages and checks the page LSN.</p>"},{"location":"create-incremental-backup.html#use-the-changed-page-tracking-algorithm","title":"Use the changed page tracking algorithm","text":"<p>Percona XtraBackup 8.0.30 removes the algorithm that used the changed page tracking feature in Percona Server for MySQL. Percona Server for MySQL 8.0.27 deprecated the changed page tracking feature.</p> <p>With PXB 8.0.27 or earlier, another algorithm enabled the Percona Server for MySQL changed page tracking feature. The algorithm generates a bitmap file. The xtrabackup binary uses that bitmap file to read only those pages needed for the incremental backup. This method potentially saves resources. The backup enables the algorithm by default if the xtrabackup binary discovers the bitmap file. You can override the algorithm with <code>--incremental-force-scan</code> which forces a read of all pages even if the bitmap file is available.</p>"},{"location":"create-incremental-backup.html#create-an-incremental-backup_1","title":"Create an incremental backup","text":"<p>To make an incremental backup, begin with a full backup as usual. The xtrabackup binary writes a file called <code>xtrabackup_checkpoints</code> into the backup\u2019s target directory. This file contains a line showing the <code>to_lsn</code>, which is the database\u2019s LSN at the end of the backup. Create the full backup with a following command:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/base\n</code></pre> <p>If you look at the <code>xtrabackup_checkpoints</code> file, you should see similar content depending on your LSN nuber:</p> Expected output <pre><code>backup_type = full-backuped\nfrom_lsn = 0\nto_lsn = 1626007\nlast_lsn = 1626007\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p>Now that you have a full backup, you can make an incremental backup based on it. Use the following command:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/inc1 \\\n--incremental-basedir=/data/backups/base\n</code></pre> <p>The <code>/data/backups/inc1/</code> directory should now contain delta files, such as <code>ibdata1.delta</code> and <code>test/table1.ibd.delta</code>. These represent the changes since the <code>LSN 1626007</code>. If you examine the <code>xtrabackup_checkpoints</code> file in this directory, you should see similar content to the following:</p> Expected output <pre><code>backup_type = incremental\nfrom_lsn = 1626007\nto_lsn = 4124244\nlast_lsn = 4124244\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p><code>from_lsn</code> is the starting LSN of the backup and for incremental it has to be the same as <code>to_lsn</code> (if it is the last checkpoint) of the previous/base backup.</p> <p>It\u2019s now possible to use this directory as the base for yet another incremental backup:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/inc2 \\\n--incremental-basedir=/data/backups/inc1\n</code></pre> <p>This folder also contains the <code>xtrabackup_checkpoints</code>:</p> Expected output <pre><code>backup_type = incremental\nfrom_lsn = 4124244\nto_lsn = 6938371\nlast_lsn = 7110572\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p>Note</p> <p>In this case you can see that there is a difference between the <code>to_lsn</code> (last checkpoint LSN) and <code>last_lsn</code> (last copied LSN), this means that there was some traffic on the server during the backup process.</p> <p>The next step is to prepare the backup in order to restore it. </p> <p></p>"},{"location":"create-incremental-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-individual-partition-backup.html","title":"Create an individual partitions backup","text":"<p>Percona XtraBackup lets you back up individual partitions because partitions are regular tables with specially formatted names. The only requirement for this feature is to enable the <code>innodb_file_per_table</code> option on the server.</p> <p>There is one caveat about using this kind of backup: you can not copy back the prepared backup. Restoring partial backups should be done by importing the tables.</p> <p>There are three ways of specifying which part of the whole data will be backed up: regular expressions (<code>--tables</code>), enumerating the tables in a file (<code>--tables-file</code>) or providing a list of databases (<code>--databases</code>).</p> <p>The regular expression provided to this option will be matched against the fully qualified database name and table name, in the form of <code>database-name.table-name</code>.</p> <p>If the partition 0 is not backed up, Percona XtraBackup cannot generate a .cfg file. MySQL 8.0 stores the table metadata in partition 0.</p> <p>For example, this operation takes a back-up of the partition <code>p4</code> from  the table <code>name</code> located in the database <code>imdb</code>:</p> <pre><code>$ xtrabackup --tables=^imdb[.]name#p#p4 --backup\n</code></pre> <p>If partition 0 is not backed up, the following errors may occur:</p> The error message <pre><code>xtrabackup: export option not specified\nxtrabackup: error: cannot find dictionary record of table imdb/name#p#p4\n</code></pre> <p>Note that this option is passed to <code>xtrabackup --tables</code> and is matched against each table of each database, the directories of each database will be created even if they are empty.</p> <p></p>"},{"location":"create-individual-partition-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"create-partial-backup.html","title":"Create a partial backup","text":"<p>xtrabackup supports taking partial backups when the <code>innodb_file_per_table</code> option is enabled. There are three ways to create partial backups:</p> <ol> <li> <p>matching the tables names with a regular expression</p> </li> <li> <p>providing a list of table names in a file</p> </li> <li> <p>providing a list of databases</p> </li> </ol> <p>Warning</p> <p>Do not copy back the prepared backup.</p> <p>Restoring partial backups should be done by importing the tables, not by using the \u2013copy-back option. It is not recommended to run incremental backups after running a partial backup.</p> <p>Although there are some scenarios where restoring can be done by copying back the files, this may lead to database inconsistencies in many cases and it is not a recommended way to do it.</p> <p>For the purposes of this manual page, we will assume that there is a database named <code>test</code> which contains tables named <code>t1</code> and <code>t2</code>.</p> <p>Warning</p> <p>If any of the matched or listed tables is deleted during the backup, xtrabackup will fail.</p> <p>There are multiple ways of specifying which part of the whole data is backed up:</p> <ul> <li> <p>Use the <code>--tables</code> option to list the table names</p> </li> <li> <p>Use the <code>--tables-file</code> option to list the tables in a file</p> </li> <li> <p>Use the <code>--databases</code> option to list the databases</p> </li> <li> <p>Use the <code>--databases-file</code> option to list the databases</p> </li> </ul>"},{"location":"create-partial-backup.html#the-tables-option","title":"The <code>\u2013-tables</code> option","text":"<p>The first method involves the xtrabackup \u2013tables option. The option\u2019s value is a regular expression that is matched against the fully-qualified database name and table name using the <code>databasename.tablename</code> format.</p> <p>To back up only tables in the <code>test</code> database, use the following command:</p> <pre><code>$ xtrabackup --backup --datadir=/var/lib/mysql --target-dir=/data/backups/ \\\n--tables=\"^test[.].*\"\n</code></pre> <p>To back up only the <code>test.t1</code> table, use the following command:</p> <pre><code>$ xtrabackup --backup --datadir=/var/lib/mysql --target-dir=/data/backups/ \\\n--tables=\"^test[.]t1\"\n</code></pre>"},{"location":"create-partial-backup.html#the-tables-file-option","title":"The <code>-\u2013tables-file</code> option","text":"<p>The <code>--tables-file</code> option specifies a file that can contain multiple table names, one table name per line in the file. Only the tables named in the file will be backed up. Names are matched exactly, case-sensitive, with no pattern or regular expression matching. The table names must be fully-qualified in <code>databasename.tablename</code> format.</p> <pre><code>$ echo \"mydatabase.mytable\" &gt; /tmp/tables.txt\n$ xtrabackup --backup --tables-file=/tmp/tables.txt\n</code></pre>"},{"location":"create-partial-backup.html#the-databases-and-databases-file-options","title":"The <code>--databases</code> and <code>-\u2013databases-file</code> options","text":"<p>The ` \u2013databases` option accepts a space-separated list of the databases and tables to backup in the <code>databasename[.tablename]</code> format. In addition to this list, make sure to specify the <code>mysql</code>, <code>sys</code>, and</p> <p><code>performance_schema</code> databases. These databases are required when restoring the databases using xtrabackup \u2013copy-back.</p> <p>Note</p> <p>Tables processed during the \u2013prepare step may also be added to the backup even if they are not explicitly listed by the parameter if they were created after the backup started.</p> <pre><code>$ xtrabackup --databases='mysql sys performance_schema test ...'\n</code></pre>"},{"location":"create-partial-backup.html#the-databases-file-option","title":"The <code>--databases-file</code> option","text":"<p>The \u2013databases-file option specifies a file that can contain multiple databases and tables in the <code>databasename[.tablename]</code> format, one element name per line in the file. Names are matched exactly, case-sensitive, with no pattern or regular expression matching.</p> <p>Note</p> <p>Tables processed during the \u2013prepare step may also be added to the backup even if they are not explicitly listed by the parameter if they were created after the backup started.</p> <p>The next step is to prepare the backup in order to restore it. </p> <p></p>"},{"location":"create-partial-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"dictionary-cache.html","title":"Dictionary cache","text":"<p>Percona XtraBackup is based on how <code>crash recovery</code> works. Percona XtraBackup copies the InnoDB data files, which results in data that is internally inconsistent; then the <code>prepare</code> phase performs crash recovery on the files to make a consistent, usable database again.</p> <p>The \u2013prepare phase has the following operations:</p> <ul> <li>Applies the redo log</li> <li>Applies the undo log</li> </ul> <p>As a physical operation, the changes from the redo log modifications are applied to a page. In the redo log operation, there is no concept of row or transaction. The redo apply operation does not make the database consistent with a transaction. An uncommitted transaction can be flushed or written to the redo log by the server. Percona XtraBackup applies changes recorded in the redo log.</p> <p>Percona XtraBackup physically modifies a specific offset of a page within a tablespace (IBD file) when applying a redo log. </p> <p>As a logical operation, Percona XtraBackup applies the undo log on a specific row. When the redo log completes, XtraBackup uses the undo log to roll back changes from uncommitted transactions during the backup.</p>"},{"location":"dictionary-cache.html#undo-log","title":"Undo log","text":"<p>There are two types of undo log records:</p> <ul> <li>INSERT</li> <li>UPDATE</li> </ul> <p>An undo log record contains a <code>table_id</code>. Percona XtraBackup uses this <code>table_id</code> to find the table definition, and then uses that information to parse the records on an index page. The transaction rollback reads the undo log records and applies the changes. </p> <p>After initializing the data dictionary engine and the data dictionary cache, the storage engine can request the <code>table_id</code> and uses this ID to fetch the table schema. An index search tuple (key) is created from the table schema and key fields from the undo log record. The server finds the record using the search tuple (key) and performs the undo operation.</p> <p>For example, InnoDB uses the <code>table_id</code> (also known as the <code>se_private_id</code>) for a table definition. Percona XtraBackup does not behave like a server and does not have access to the data dictionary. XtraBackup initializes the InnoDB engine and uses the <code>InnoDB table object</code> (<code>dict_table_t</code>) when needed. XtraBackup relies on Serialized Dictionary Information (SDI) that is stored in the tablespace. SDI is a JSON representation of a table.</p>"},{"location":"dictionary-cache.html#version-changes","title":"Version changes","text":"<p>Prior to Percona XtraBackup 8.0.33-28, XtraBackup loads the SDI from every <code>.IBD</code> file and all tables into cache as non-evictable. Making the tables non-evictable essentially disables the LRU cache. Every table remains in memory until the operation ends.</p> <p>This method has the following issues:</p> <ul> <li>Unnecessary IO operations from reading SDI pages to load the tables that are not required for rollback</li> <li>All tables loaded into the cache increases the time required in the \u2013prepare phase</li> <li>Unnecessary tables can lead to out-of-memory errors</li> <li>Huge number of tables and IBD files may cause an exit in the \u2013prepare phase</li> </ul> <p>Percona XtraBackup 8.0.33-28 implements a new design and tables are loaded as <code>evictable</code>. XtraBackup scans the B-tree index of the data dictionary tables <code>mysql.indexes</code> and <code>mysql.index_partitions</code> to establish a relationship between the <code>table_id</code> and the tablespace(space_id). XtraBackup uses this relationship during transaction rollback. XtraBackup does not load user tables unless there is a transaction rollback on them.</p> <p>A background thread or a Percona XtraBackup main thread handles the cache eviction when the cache size limit is reached.</p> <p>This new design provides the following benefits during the \u2013prepare phase:</p> <ul> <li>Uses less memory</li> <li>Uses less IO</li> <li>Improves the time taken in the \u2013prepare phase</li> <li>Completes successfully, even if the \u2013prepare phase has a huge number of tables</li> <li>Completes the Percona XtraDB Cluster SST process faster</li> </ul> <p></p>"},{"location":"dictionary-cache.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"differences.html","title":"Differences between a logical backup and Percona XtraBackup","text":"<p>You\u2019ll notice several key differences when transitioning from a logical database to Percona XtraBackup.</p> Type Logical backup Physical backup Definition Contains logical data (tables, schemas, procedures). Copies entire database directories and files. Method Exported as binary files using EXPORT/IMPORT tools. Copies raw data files directly from the database. Data contents Includes data structure (schema, tables, procedures). Contains complete data (structure, tables, transactions) Instance Independence Can be restored on any other machine or environment. Tied to the specific database instance and environment. OS-level restoration Not suitable for OS-level restoration Suitable for full disaster recovery scenarios. Granularity Granular recovery of specific components. Restores the entire database. Performance Slower due to SQL parsing and execution Faster due to direct file copying Use cases Data migration platform-independent copies Full database restoration, disaster recovery Security Less secure More secure <p>XtraBackup is designed to perform hot backups of MySQL, MariaDB, and Percona Server databases without interrupting database services. XtraBackup performs physical backups by copying the data files, ensuring minimal impact on server performance. XtraBackup includes advanced features such as backup compression and encryption, providing efficient and secure data protection. The tool also offers a streaming backup option, which is useful for backing up large databases or transferring backups to another server. XtraBackup integrates with Percona\u2019s additional tools like Percona Toolkit and Percona Monitoring and Management (PMM), offering a comprehensive database performance monitoring, management, and optimization solution. These features are not typically found in logical database backup solutions.</p> <p>Another difference is the support for incremental backups with XtraBackup. You can back up only the data that has changed since the last full backup, significantly reducing the time and storage requirements compared to a full logical backup.</p> <p>A logical backup contains copies of information about a database, such as tables, schemas, and procedures. Commonly, these backups are exported as binary files using EXPORT/IMPORT tools. Logical backups focus on the data structure and SQL statements, and you can back up a selected set of data or exclude specific data during the export, saving time and storage. They contain only structural information about the database, not instance-specific details. Logical backups are slower than physical backups because of the SQL parsing and execution. A logical backup does not preserve the file system-level security settings, user accounts, privileges, or authentication settings. During restoration, you must manually reconfigure these settings.</p> <p>You can restore a logical backup on any other machine and in different environments. Logical backups provide granular recovery capabilities to restore specific components, such as individual tables or schemas. The recovery process can be more difficult because it involves recreating the entire data structure. Use logical backups when restoring or moving a database copy to another environment. They are an option for platform-independent data migration.</p> <p>Unlike physical backups, logical backups are less secure because the data is unencrypted. Anyone with access to the backup could read sensitive information. </p> <p></p>"},{"location":"differences.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"docker.html","title":"Run Percona XtraBackup 8.0 in a Docker container","text":"<p>Docker containers are built from Docker images, which are snapshots of the configuration needed to run an applications, such as the code, and libraries. With Docker, you can build, deploy, run, update, and manage containers, which isolate applications from the host system. A Docker container lets you work with Percona XtraBackup without installing the product on a local drive. You may run Percona Server for MySQL in one container and Percona XtraBackup in another.</p> <p>For this document, container refers to the Docker container and instance refers to the database server in the container.</p> <p>Percona XtraBackup has an official Docker image hosted on Docker Hub. If you want the latest version, use the <code>latest</code> tag. You can reference a specific version using the Docker tag filter for the 8.0 versions.</p> <p>Make sure that you are using the latest version of Docker. The <code>APT</code> and <code>YUM</code> versions may be outdated and cause errors. Use the installation instructions to install Docker on your system.</p>"},{"location":"docker.html#1-run-percona-server-for-mysql-container","title":"1. Run Percona Server for MySQL container","text":"<p>Percona XtraBackup works in combination with a MySQL-compatible database, Percona Server for MySQL, in our example. To take a backup of Percona Server for MySQL, run Percona Server for MySQL in a Docker container and create a database with data. Read the instructions on how to Run Percona Server for MySQL in a Docker Container.</p> <p>As soon as Percona Server for MySQL runs and the database contains data, you are ready to connect the Percona XtraBackup container to the Percona Server for MySQL container and take a backup.</p>"},{"location":"docker.html#2-create-percona-xtrabackup-docker-container-and-connect-to-percona-server-for-mysql-container","title":"2. Create Percona XtraBackup Docker container and connect to Percona Server for MySQL container","text":"<p>You can create a Docker container based on Percona XtraBackup image with either <code>docker create</code> or the <code>docker run</code> command. <code>docker create</code> creates a Docker container and makes it available for starting later.</p> <p>Docker downloads the Percona XtraBackup 8.0 image from the Docker Hub. If it is not the first time you use the selected image, Docker uses the image available locally.</p> <p>Important</p> <p>When running Percona XtraBackup from a container and connecting to a  MySQLserver container, we recommend using the \u2013user=root option in the  Docker command.</p> <pre><code>$ sudo docker create --name percona-xtrabackup --volumes-from percona-server-mysql:8.0 \\\npercona/percona-xtrabackup:8.0  \\\nxtrabackup --backup --datadir=/var/lib/mysql/ --target-dir=/backup \\\n--user=root --password=root\n</code></pre> <p>With parameter name you give a meaningful name to your new Docker container so that you could easily locate it among your other containers.</p> <p>The <code>volumes-from</code> flag refers to Percona Server for MySQL and indicates that you intend to use the same data as the Percona Server for MySQL container.</p>"},{"location":"docker.html#percona-xtrabackup-arm64","title":"Percona XtraBackup ARM64","text":"<p>Starting with Percona XtraBackup 8.0.35-31, you can run the Docker ARM64 version of Percona XtraBackup. You can find the version and architecture on Docker Hub Percona/Percona-Server Tags. The Docker images for ARM64 version contain <code>aarch64</code> in the tag name, for example, <code>8.0.35-aarch64</code>.</p> <p>We recommend that the architectures match. If the server is ARM64, you should also use Percona XtraBackup in ARM64.</p>"},{"location":"docker.html#start-the-percona-xtrabackup-container","title":"Start the Percona XtraBackup container","text":"<p>Start the Percona XtraBackup container with exactly the same parameters that were used when the container was created:</p> <pre><code>$ sudo docker start -ai percona-xtrabackup\n</code></pre> <p>This command starts the <code>percona-xtrabackup</code> container, attaches to its input/output streams, and opens an interactive shell.</p>"},{"location":"docker.html#docker-run-command","title":"Docker run command","text":"<p>The <code>docker run</code> command is a shortcut command that creates a Docker container and then immediately runs it.</p> <pre><code>$ sudo docker run --name percona-xtrabackup --volumes-from percona-server-mysql:8.0 \\\npercona/percona-xtrabackup:8.0\nxtrabackup --backup --datadir=/var/lib/mysql --target-dir=/backup --user=root --password=root\n</code></pre>"},{"location":"docker.html#for-more-information","title":"For more information","text":"<p>Review the Docker Docs</p> <p></p>"},{"location":"docker.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"download-instructions.html","title":"Percona Product Download Instructions","text":""},{"location":"download-instructions.html#select-the-software","title":"Select the software","text":"<p>Do the following steps to select the software:</p> <ol> <li>Open Percona Product Downloads</li> <li>Locate the Percona Software, for example, Percona Server for MySQL</li> <li>In <code>Select Product</code>, select which product, for example, Percona Server 8.0</li> <li>In <code>Select Product Version</code>, select the version, for example, PERCONA-SERVER-8.0.36-28</li> <li>In <code>Select Software</code>, select the operating system, for example, RED HAT ENTERPRISE LINUX / CENTOS/ ORACLE LINUX 9</li> </ol> <p>The easiest method is to download all packages.</p>"},{"location":"download-instructions.html#download-to-a-local-computer","title":"Download to a local computer","text":"<p>In <code>Package Download Options</code>, select a specific package or choose the <code>DOWNLOAD ALL PACKAGES</code> button. This action downloads the selected packages to the local computer.</p>"},{"location":"download-instructions.html#download-to-another-computer","title":"Download to another computer","text":"<p>In <code>Package Download Options</code>, you can do either of the following:</p> <ul> <li> <p>Select a specific package and right-click on the arrow next to <code>DOWNLOAD</code>, and in the drop-down menu, choose <code>Copy Link Address</code></p> </li> <li> <p>Select <code>DOWNLOAD ALL PACKAGES</code> and right-click on the arrow, and in the drop-down menu, choose <code>Copy Link Address</code></p> </li> </ul> <p>Paste the link in your terminal prompt to download the selected package.</p> <p></p>"},{"location":"download-instructions.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"encrypt-backups.html","title":"Encrypt backups","text":"<p>Percona XtraBackup supports encrypting and decrypting local and streaming backups with the upstream option, adding another protection layer. The encryption is implemented using the <code>libgcrypt</code> library from GnuPG.</p>"},{"location":"encrypt-backups.html#create-encrypted-backups","title":"Create encrypted backups","text":"<p>The following options create encrypted backups. The <code>--encrypt-key</code> and <code>--encrypt-key-file</code> options specify the encryption key and are mutually exclusive. You should select one or the other.</p> <ul> <li> <p><code>--encrypt</code></p> </li> <li> <p><code>--encrypt-key</code></p> </li> <li> <p><code>--encrypt-key-file</code></p> </li> </ul> <p>For an encryption key, use a command, such as <code>openssl rand -base64 24</code>, to generate a random alphanumeric string.</p>"},{"location":"encrypt-backups.html#the-encrypt-key-option","title":"The <code>--encrypt-key</code> option","text":"<p>An example of the xtrabackup command using the <code>--encrypt-key</code>:</p> <pre><code>$  xtrabackup --backup --encrypt=AES256 --encrypt-key=\"{randomly-generated-alphanumeric-string}\" --target-dir=/data/backup\n</code></pre>"},{"location":"encrypt-backups.html#the-encrypt-key-file-option","title":"The <code>--encrypt-key-file</code> option","text":"<p>The recommended method uses the command line: <code>echo -n \u201c{randomly-generated-alphanumeric-string}\u201d &gt; /data/backups/keyfile</code> to create the file.</p> <p>Remember that your text editor can automatically insert a CRLF (end of line) character in the <code>KEYFILE</code> when using the\u2013 <code>encrypt-key-file</code> option. This inserted character invalidates the key because the size is wrong. </p> <p>An example of using the <code>--encrypt-key-file</code> option:</p> <pre><code>$ xtrabackup --backup --encrypt=AES256 --encrypt-key-file=/data/backups/keyfile --target-dir=/data/backup\n</code></pre>"},{"location":"encrypt-backups.html#optimize-the-encryption-process","title":"Optimize the encryption process","text":"<p>Additional encrypted backup options, <code>--encrypt-threads</code> and <code>--encrypt-chunk-size</code>, can speed up the encryption process. </p> <p>Use the <code>--encrypt-threads</code> option to enable parallel encryption with multiple threads. </p> <p>The <code>--encrypt-chunk-size</code> option specifies the size, in bytes, of the working encryption buffer for each encryption thread. The default size is 64K.</p>"},{"location":"encrypt-backups.html#decrypt-encrypted-backups","title":"Decrypt encrypted backups","text":"<p>You can decrypt backups with the <code>xbcrypt</code> binary. The following example encrypts a backup.</p> <p>You can use the <code>--parallel</code> option and the <code>--decrypt</code> option to decrypt multiple files simultaneously.</p> <pre><code>$ for i in `find . -iname \"*\\.xbcrypt\"`; do xbcrypt -d --encrypt-key-file=/root/secret_key --encrypt-algo=AES256 &lt; $i &gt; $(dirname $i)/$(basename $i .xbcrypt) &amp;&amp; rm $i; done\n</code></pre> <p>The following example shows a decryption process.</p> <pre><code>$ xtrabackup --decrypt=AES256 --encrypt-key=\"{randomly-generated-alphanumeric-string}\" --target-dir=/data/backup/\n</code></pre> <p>Percona XtraBackup doesn\u2019t automatically remove the encrypted files. You must remove the <code>\\*.xbcrypt</code> files manually.</p>"},{"location":"encrypt-backups.html#prepare-encrypted-backups","title":"Prepare encrypted backups","text":"<p>After decrypting the backups, prepare the backups with the <code>--prepare</code> option:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup/\n</code></pre>"},{"location":"encrypt-backups.html#restore-encrypted-backups","title":"Restore encrypted backups","text":"<p>xtrabackup offers the <code>--copy-back</code> option to restore a backup to the server\u2019s datadir:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup/\n</code></pre> <p>The option copies all the data-related files to the server\u2019s datadir. The server\u2019s <code>my.cnf</code> configuration file determines the location. </p> <p>You should check the last line of the output for a success message:</p> Expected output <pre><code>150318 11:08:13  xtrabackup: completed OK!\n</code></pre> <p></p>"},{"location":"encrypt-backups.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"encrypted-innodb-tablespace-backups.html","title":"Encrypted InnoDB tablespace backups","text":"<p>InnoDB supports data encryption for InnoDB tables stored in file-per-table tablespaces. This feature provides an at-rest encryption for physical tablespace data files.</p> <p>For an authenticated user or application to access an  encrypted  tablespace, InnoDB uses the master encryption key to decrypt  the tablespace key. The master encryption key is stored in a keyring.  xtrabackup supports two keyring plugins: <code>keyring_file</code>, and  <code>keyring_vault</code>. These plugins are installed into the <code>plugin</code> directory.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#version-updates","title":"Version updates","text":"<p>Percona XtraBackup 8.0.25-17 adds support for the <code>keyring_file</code> component, which is part of the component-based infrastructure MySQL which extends the server capabilities. The component is stored in the <code>plugin</code> directory.</p> <p>See a comparison of keyring components and keyring plugins for more information.</p> <p>Percona XtraBackup 8.0.27-19 adds support for the Key Management Interoperability Protocol (KMIP) which enables the communication between the key management system and encrypted database server. </p> <p>Percona XtraBackup 8.0.28-21 adds support for the Amazon Key Management Service (AWS KMS). AWS KMS is cloud-based encryption and key management service. The keys and functionality can be used for other AWS services or your applications that use AWS. No configuration is required to back up a server with AWS KMS-enabled encryption. </p>"},{"location":"encrypted-innodb-tablespace-backups.html#use-keyring_file-plugin","title":"Use <code>keyring_file</code> plugin","text":"<p>In order to back up and prepare a database containing encrypted InnoDB tablespaces, specify the path to a keyring file as the value of the <code>--keyring-file-data</code> option.</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backup/ --user=root \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>After xtrabackup takes the backup, the following message confirms the action:</p> Confirmation message <pre><code>xtrabackup: Transaction log of lsn (5696709) to (5696718) was copied.\n160401 10:25:51 completed OK!\n</code></pre> <p>Warning</p> <p>xtrabackup does not copy the keyring file into the backup directory. To prepare the backup, you must copy the keyring file manually.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-the-backup-with-the-keyring_file-plugin","title":"Prepare the backup with the <code>keyring_file</code> plugin","text":"<p>To prepare the backup specify the keyring-file-data.</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>After xtrabackup takes the backup, the following message confirms the action:</p> Confirmation message <pre><code>InnoDB: Shutdown completed; log sequence number 5697064\n160401 10:34:28 completed OK!\n</code></pre> <p>The backup is now prepared and can be restored with the <code>--copy-back</code> option. In case the keyring has been rotated, you must restore the keyring used when the backup was taken and prepared.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#use-keyring_vault-plugin","title":"Use <code>keyring_vault</code> plugin","text":"<p>Keyring vault plugin settings are described here.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#create-a-backup-with-the-keyring_vault-plugin","title":"Create a backup with the <code>keyring_vault</code> plugin","text":"<p>The following command creates a backup in the <code>/data/backup</code> directory:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backup --user=root\n</code></pre> <p>After xtrabackup completes the action, the following message confirms the action:</p> Confirmation message <pre><code>xtrabackup: Transaction log of lsn (5696709) to (5696718) was copied.\n160401 10:25:51 completed OK!\n</code></pre>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-the-backup-with-the-keyring_vault-plugin","title":"Prepare the backup with the <code>keyring_vault</code> plugin","text":"<p>To prepare the backup, xtrabackup must access the keyring. xtrabackup does not communicate with the MySQL server or read the default <code>my.cnf</code> configuration file. Specify the keyring settings in the command line:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--keyring-vault-config=/etc/vault.cnf\n</code></pre> <p>Review using the keyring vault plugin for a description of keyring vault plugin settings.</p> <p>After xtrabackup completes the action, the following message confirms the action:</p> Confirmation message <pre><code>InnoDB: Shutdown completed; log sequence number 5697064\n160401 10:34:28 completed OK!\n</code></pre> <p>The backup is now prepared and can be restored with the <code>--copy-back</code> option:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql\n</code></pre>"},{"location":"encrypted-innodb-tablespace-backups.html#use-the-keyring_file-component","title":"Use the <code>keyring_file</code> component","text":"<p>A component is not loaded with the <code>--early_plugin_load</code> option. The  server uses a manifest to load the component and the component has its  own configuration file. See the MySQL documentation on the component  installation for more  information.</p> <p>An example of a manifest and a configuration file follows:</p> <p>An example of <code>./bin/mysqld.my</code>:</p> <pre><code>{\n   \"components\": \"file://component_keyring_file\"\n}\n</code></pre> <p>An example of <code>/lib/plugin/component_keyring_file.cnf</code>:</p> <pre><code>{\n   \"path\": \"/var/lib/mysql-keyring/keyring_file\", \"read_only\": false\n}\n</code></pre> <p>For more information, see Keyring Component Installation and Using the keyring_file File-Based Keyring Plugin.</p> <p>With the appropriate privilege, you can <code>SELECT</code> on the performance_schema.keyring_component_status table to view the attributes and status of the installed keyring component  when in use.</p> <p>The component has no special requirements for backing up a database that contains encrypted InnoDB tablespaces.</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backup --user=root\n</code></pre> <p>After xtrabackup completes the action, the following message confirms the action:</p> Confirmation message <pre><code>xtrabackup: Transaction log of lsn (5696709) to (5696718) was copied.\n160401 10:25:51 completed OK!\n</code></pre>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-the-backup-with-component-keyring-config","title":"Prepare the backup with <code>component-keyring-config</code>","text":"<p>You can copy the <code>component_keyring_file.cnf</code> file to the backup directory before starting the <code>prepare</code> step or add the <code>component_keyring_config</code> option. You must specify the path if the <code>component-keyring-config</code> is not in the default location.</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--component-keyring-config=/usr/lib64/mysql/plugin/component_keyring_file.cnf\n</code></pre> <p>After xtrabackup completes preparing the backup, the following message confirms the action:</p> Confirmation message <pre><code>InnoDB: Shutdown completed; log sequence number 5697064\n160401 10:34:28 completed OK!\n</code></pre> <p>The backup is prepared. To restore the backup use the <code>--copy-back</code> option. If the keyring has been rotated, you must restore the specific keyring used to take and prepare the backup.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#incremental-encrypted-innodb-tablespace-backups-with-keyring_file","title":"Incremental encrypted InnoDB tablespace backups with <code>keyring_file</code>","text":"<p>The process of taking incremental backups with InnoDB tablespace encryption is similar to taking the Incremental Backups with unencrypted tablespace. The <code>keyring-file</code> component should not used in production or for regulatory compliance.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#create-an-incremental-backup","title":"Create an incremental backup","text":"<p>To make an incremental backup, begin with a full backup. The xtrabackup binary writes a file called <code>xtrabackup_checkpoints</code> into the backup\u2019s target directory. This file contains a line showing the <code>to_lsn</code>, which is the database\u2019s LSN at the end of the backup. First you need to create a full backup with the following command:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/base \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>In order to prepare the backup, you must make a copy of the keyring file yourself. xtrabackup does not copy the keyring file into the backup directory.  Restoring the backup after the keyring has been changed causes errors like <code>ERROR 3185 (HY000): Can't find master key from keyring, please check keyring plugin is loaded.</code> when the restore process tries accessing an encrypted table.</p> <p>If you look at the <code>xtrabackup_checkpoints</code> file, you should see the output similar to the following:</p> Expected output <pre><code>backup_type = full-backuped\nfrom_lsn = 0\nto_lsn = 7666625\nlast_lsn = 7666634\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p>Now that you have a full backup, you can make an incremental backup based on it. Use a command such as the following:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/inc1 \\\n--incremental-basedir=/data/backups/base \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>To prepare the backup, you must copy the keyring file manually. xtrabackup does not copy the keyring file into the backup directory. </p> <p>If the keyring has not been rotated you can use the same as the one you\u2019ve backed-up with the base backup. If the keyring has been rotated, or you have  upgraded the plugin to a component, you must back up the keyring file.  Otherwise, you cannot prepare the backup.</p> <p>The <code>/data/backups/inc1/</code> directory should now contain delta files, such as <code>ibdata1.delta</code> and <code>test/table1.ibd.delta</code>. These represent the changes since the <code>LSN 7666625</code>. If you examine the <code>xtrabackup_checkpoints</code> file in this directory, you should see  the output similar to the following:</p> Expected output <pre><code>backup_type = incremental\nfrom_lsn = 7666625\nto_lsn = 8873920\nlast_lsn = 8873929\ncompact = 0\nrecover_binlog_info = 1\n</code></pre> <p>Use this directory as the base for yet another incremental backup:</p> <pre><code>$ xtrabackup --backup --target-dir=/data/backups/inc2 \\\n--incremental-basedir=/data/backups/inc1 \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-incremental-backups","title":"Prepare incremental backups","text":"<p>The <code>--prepare</code> step for incremental backups is not the same as for normal backups. In normal backups, two types of operations are performed to make the database consistent: committed transactions are replayed from the log file against the data files, and uncommitted transactions are rolled back. You must skip the rollback of uncommitted transactions when preparing a backup, because transactions that were uncommitted at the time of your backup may be in progress, and it\u2019s likely that they will be committed in the next incremental backup. You should use the <code>--apply-log-only</code> option to prevent the rollback phase.</p> <p>If you do not use the <code>--apply-log-only</code> option to prevent the rollback phase, then your incremental backups are useless. After transactions have been rolled back, further incremental backups cannot be applied.</p> <p>Beginning with the full backup you created, you can prepare it and then apply the incremental differences to it. Recall that you have the following backups:</p> <pre><code>/data/backups/base\n/data/backups/inc1\n/data/backups/inc2\n</code></pre> <p>To prepare the base backup, you need to run <code>--prepare</code> as usual, but prevent the rollback phase:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/data/backups/base \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> Expected output <pre><code>InnoDB: Shutdown completed; log sequence number 7666643\nInnoDB: Number of pools: 1\n160401 12:31:11 completed OK!\n</code></pre> <p>To apply the first incremental backup to the full backup, you should use the following command:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/data/backups/base \\\n--incremental-dir=/data/backups/inc1 \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>The backup should be prepared with the keyring file and type that was used when backup was being taken. This means that if the keyring has been rotated, or you have upgraded from a plugin to a component between the base and incremental backup that you must use the keyring that was in use when the first incremental backup has been taken.</p> <p>Preparing the second incremental backup is a similar process: apply the deltas to the (modified) base backup, and you will roll its data forward in  time to the point of the second incremental backup:</p> <p><pre><code>$ xtrabackup --prepare --target-dir=/data/backups/base \\\n--incremental-dir=/data/backups/inc2 \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> Use <code>--apply-log-only</code> when merging all incremental backups except the last one. That\u2019s why the previous line does not contain the <code>--apply-log-only</code> option. Even if the <code>--apply-log-only</code> was used on the last step, backup would still be consistent but in that case  server would perform the rollback phase.</p> <p>The backup is now prepared and can be restored with <code>--copy-back</code> option. In case the keyring has been rotated you\u2019ll need to restore the keyring which was used to take and prepare the backup.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#use-the-key-management-interoperability-protocol-kmip","title":"Use the Key Management Interoperability Protocol (KMIP)","text":"<p>Percona XtraBackup 8.0.27-19 adds support for the Key Management Interoperability Protocol (KMIP) which enables the communication between the key management system and encrypted database server.</p> <p>Percona XtraBackup has no special requirements for backing up a database that contains encrypted InnoDB tablespaces.</p> <p>Percona XtraBackup performs the following actions:</p> <ol> <li> <p>Connects to the MySQL server</p> </li> <li> <p>Pulls the configuration</p> </li> <li> <p>Connects to the KMIP server</p> </li> <li> <p>Fetches the necessary keys from the KMIP server</p> </li> <li> <p>Stores the KMIP server configuration settings in  the <code>xtrabackup_component_keyring_kmip.cnf</code> file in the backup directory</p> </li> </ol> <p>When preparing the backup, Percona XtraBackup connects to the KMIP server with the settings from the <code>xtrabackup_component_keyring_kmip.cnf</code> file.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#restore-a-backup-when-the-keyring-is-not-available","title":"Restore a backup when the keyring is not available","text":"<p>While the described restore method works, this method requires access to the same keyring that the server is using. It may not be possible if the backup is prepared on a different server or at a much later time, when keys in the keyring are purged, or, in the case of a malfunction, when the keyring vault server is not available at all.</p> <p>The <code>--transition-key=&lt;passphrase&gt;</code> option should be used to make it possible for xtrabackup to process the backup without access to the keyring vault server. In this case, xtrabackup derives the AES encryption key from the specified passphrase and will use it to encrypt tablespace keys of tablespaces that are being backed up.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#create-a-backup-with-a-passphrase","title":"Create a backup with a passphrase","text":"<p>The following example illustrates how the backup can be created in this case:</p> <pre><code>$ xtrabackup --backup --user=root -p --target-dir=/data/backup \\\n--transition-key=MySecretKey\n</code></pre> <p>If <code>--transition-key</code> is specified without a value, xtrabackup will ask for it.</p> <p>xtrabackup scrapes <code>--transition-key</code> so that its value is not visible in the <code>ps</code> command output.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#prepare-a-backup-with-a-passphrase","title":"Prepare a backup with a passphrase","text":"<p>The same passphrase should be specified for the prepare command:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--transition-key=MySecretKey\n</code></pre> <p>There are no <code>--keyring-vault...</code>,``\u2013keyring-file\u2026``, or <code>--component-keyring-file-config</code> options here, because xtrabackup does not talk to the keyring in this case.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#restore-a-backup-with-a-generated-key","title":"Restore a backup with a generated key","text":"<p>When restoring a backup you will need to generate a new master key. Here is the example for <code>keyring_file</code> plugin or component:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql \\\n--transition-key=MySecretKey --generate-new-master-key \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>In case of <code>keyring_vault</code>, it will look like this:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql \\\n--transition-key=MySecretKey --generate-new-master-key \\\n--keyring-vault-config=/etc/vault.cnf\n</code></pre> <p>xtrabackup will generate a new master key, store it in the target keyring vault server and re-encrypt the tablespace keys using this key.</p>"},{"location":"encrypted-innodb-tablespace-backups.html#make-a-backup-with-a-stored-transition-key","title":"Make a backup with a stored transition key","text":"<p>Finally, there is an option to store a transition key in the keyring. In this case, xtrabackup will need to access the same keyring file or vault server during prepare and copy-back but does not depend on whether the server keys have been purged.</p> <p>In this scenario, the three stages of the backup process look as follows.</p> <ul> <li>Backup</li> </ul> <pre><code>$ xtrabackup --backup --user=root -p --target-dir=/data/backup \\\n--generate-transition-key\n</code></pre> <ul> <li> <p>Prepare</p> <ul> <li><code>keyring_file</code> variant:</li> </ul> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <ul> <li><code>keyring_vault</code> variant:</li> </ul> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup \\\n--keyring-vault-config=/etc/vault.cnf\n</code></pre> </li> <li> <p>Copy-back</p> </li> <li> <p><code>keyring_file</code> variant:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql \\\n--generate-new-master-key --keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> </li> <li> <p><code>keyring_vault</code> variant:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backup --datadir=/data/mysql \\\n--generate-new-master-key --keyring-vault-config=/etc/vault.cnf\n</code></pre> </li> </ul> <p></p>"},{"location":"encrypted-innodb-tablespace-backups.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"error-message-instant.html","title":"Error Message: Found tables with row versions due to INSTANT ADD/DROP columns","text":"<p>MySQL 8.0.29 extended the support for <code>ALTER TABLE \u2026 ALGORITHM=INSTANT</code> to allow users to add a column in any table position or drop any column. As part of this update, the redo log format has changed for all server DML operations. This updated redo log format has a design flaw that can cause data corruption for tables with INSTANT ADD/DROP COLUMNS.</p> <p>The corruption happens when the crash recovery occurs. InnoDB applies redo logs at startup. Xtrabackup copies the redo log during the backup and applies the log as part of the <code>--prepare</code> step to bring the backup to a consistent state.</p> <p>Percona fixed the corruption issue and several other issues with the INSTANT ADD/DROP column feature in the upcoming Percona Server for MySQL 8.0.29.</p> <p>For more details, see the following:</p> <ul> <li> <p>PS-8291,</p> </li> <li> <p>PS-8292</p> </li> <li> <p>PS-8303</p> </li> </ul> <p>Percona XtraBackup 8.0.32-25 allows instant columns in the backup for MySQL 8.0.32. This limitation remains for backing up MySQL 8.0.31 and lower versions. This limitation does not exist for backing up Percona Server for any version.</p> <p>Percona XtraBackup 8.0.29 is able to take backups of Percona Server for MySQL 8.0.29 with tables that have INSTANT ADD/DROP COLUMNS. However, the issues in MySQL 8.0.29 make this version unsafe to take backups.</p> <p>It is impossible for XtraBackup to deal with the corrupted redo log generated by MySQL 8.0.29 and, for this reason, XtraBackup 8.0.29 version will not take backups if it detects tables with <code>INSTANT ADD/DROP COLUMNS</code> and generates an error listing the affected tables and providing instructions to convert them to regular tables.</p> <p>Please avoid ALTER ADD/DROP COLUMN without an explicit ALGORITHM=INPLACE. The default ALGORITHM is INSTANT, so ALTER TABLE without the ALGORITHM keyword uses the newly introduced INSTANT algorithm.</p> <p>If you already have such tables (information below on how to find such tables), users are advised to do <code>OPTIMIZE TABLE</code> against these tables before taking backups.</p> <p>To find tables with <code>INSTANT ADD/DROP COLUMNS</code> run the following command:</p> <pre><code>mysql&gt; SELECT NAME FROM INFORMATION_SCHEMA.INNODB_TABLES WHERE TOTAL_ROW_VERSIONS &gt; 0;\n+---------+\n| NAME    |\n+---------+\n| test/t1 |\n| test/t2 |\n| test/t3 |\n+---------+\n3 rows in set (0.02 sec)\n</code></pre> <p>If this query shows an empty result set, you have no issues. Percona Xtrabackup takes the backup of your MySQL 8.0.29 server. If the results are a list of tables, please run OPTIMIZE TABLE on the list before taking the backup.</p>"},{"location":"error-message-instant.html#percona-xtrabackup-error-message","title":"Percona XtraBackup Error Message","text":"<p>If Percona XtraBackup detects that MySQL 8.0.29 server has tables with instant add/drop columns, it aborts with the following error message</p> <pre><code>2022-07-01T15:18:35.127689+05:30 0 [ERROR] [MY-011825] [Xtrabackup] Found tables with row versions due to INSTANT ADD/DROP columns\n2022-07-01T15:18:35.127714+05:30 0 [ERROR] [MY-011825] [Xtrabackup] This feature is not stable and will cause backup corruption.\n2022-07-01T15:18:35.127723+05:30 0 [ERROR] [MY-011825] [Xtrabackup] Tables found:\n2022-07-01T15:18:35.127730+05:30 0 [ERROR] [MY-011825] [Xtrabackup] test/t1\n2022-07-01T15:18:35.127737+05:30 0 [ERROR] [MY-011825] [Xtrabackup] test/t2\n2022-07-01T15:18:35.127744+05:30 0 [ERROR] [MY-011825] [Xtrabackup] test/t3\n2022-07-01T15:18:35.127752+05:30 0 [ERROR] [MY-011825] [Xtrabackup] Please run OPTIMIZE TABLE or ALTER TABLE ALGORITHM=COPY on all listed tables to fix this issue.\n</code></pre>"},{"location":"error-message-instant.html#summary","title":"Summary","text":"<p>The option, <code>ALGORITHM=INSTANT</code> is the default value in MySQL 8.0.29. If you do not specify an algorithm, all <code>ALTER TABLE ADD/DROP COLUMN</code> statements use this algorithm.</p> <p>The <code>INSTANT</code> algorithm is unstable at this point.</p> <p>Percona XtraBackup refuses to take backups from MySQL 8.0.29 tables that have used this algorithm. Percona Server users do not suffer the same limitations as the corruption issues are fixed in the upcoming release of Percona Server for MySQL 8.0.29</p> <p></p>"},{"location":"error-message-instant.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"example-full-incr.html","title":"Backup example","text":"<p>This example demonstrates how a beginner DBA can set up daily full backups and hourly incremental backups for a large organization using Percona XtraBackup 8.0 with a Percona Server for MySQL 8.0 database server.</p>"},{"location":"example-full-incr.html#assumptions","title":"Assumptions","text":"<ul> <li>You have Percona XtraBackup 8.0 installed on your system.</li> <li>You have a Percona Server for MySQL 8.0 database server running.</li> <li>You have created dedicated directories for storing backups:<ul> <li><code>/backups/mysql/full</code> - for daily full backups</li> <li><code>/backups/mysql/incr</code> - for hourly incremental backups</li> </ul> </li> </ul>"},{"location":"example-full-incr.html#daily-full-backup-script","title":"Daily Full Backup Script","text":"<p>This following script defines the server details like hostname, username, password, data directory, and backup directory. Replace these with your actual values.</p> <ul> <li> <p>Defines the server credentials</p> </li> <li> <p>Generates a timestamp with the <code>date</code> command for the full backup filename</p> </li> <li> <p>Uses <code>xtrabackup</code> with the <code>--backup</code> flag for a full backup</p> </li> <li> <p>Specifies the directory to store the backup with <code>--target-dir</code></p> </li> <li> <p><code>--datadir</code> points to the location of your MySQL data files.</p> </li> <li> <p>Provides the credentials with <code>--user</code> and <code>--password</code> to access the database server.</p> </li> <li> <p>Echoes a message confirming the successful backup completion.</p> </li> </ul> <pre><code>#!/bin/bash\n\n# Set server details (replace with your actual values)\nSERVER_HOST=\"your_server_hostname\"\nSERVER_USER=\"your_db_username\"\nSERVER_PASSWORD=\"your_db_password\"\nDATA_DIR=\"/var/lib/mysql\"  # Replace with your data directory path\nBACKUP_DIR=\"/backups/mysql/full\"\n\n# Get current date for filename\nTODAY=$(date +%Y-%m-%d)\nFULL_BACKUP_FILENAME=\"${BACKUP_DIR}/${TODAY}\"\n\n# Run xtrabackup with full backup command\nxtrabackup --backup \\\n  --target-dir=\"${FULL_BACKUP_FILENAME}\" \\\n  --datadir=\"${DATA_DIR}\" \\\n  --user=\"${SERVER_USER}\" \\\n  --password=\"${SERVER_PASSWORD}\"\n\necho \"Daily full backup completed at $(date)\"\n</code></pre>"},{"location":"example-full-incr.html#running-the-daily-script","title":"Running the Daily Script","text":"<p>You can schedule this script to run automatically using cron. For example, to run it every day at midnight (00:00), add this line to your crontab:</p> <pre><code>$ 0 0 * * * /path/to/daily_full_backup.sh\n</code></pre>"},{"location":"example-full-incr.html#hourly-incremental-backup-script","title":"Hourly Incremental Backup Script","text":"<p>This script uses the same server details as the daily script. It retrieves the current date and hour for the incremental backup filename. The core command uses <code>xtrabackup</code> with the <code>--backup</code> and <code>--incremental</code> flags for an incremental backup. <code>--target-dir</code> specifies the directory to store the incremental backup. <code>--base-dir</code> points to the latest full backup directory obtained using <code>ls</code> and <code>tail</code> commands. This ensures the incremental backup references the most recent full backup. Similar to the daily script, it echoes a confirmation message.</p> <pre><code>#!/bin/bash\n\n# Set server details (same as daily script)\nSERVER_HOST=\"your_server_hostname\"\nSERVER_USER=\"your_db_username\"\nSERVER_PASSWORD=\"your_db_password\"\nDATA_DIR=\"/var/lib/mysql\"  # Replace with your data directory path\nBACKUP_DIR=\"/backups/mysql/incr\"\n\n# Get current date and hour for filename\nTODAY=$(date +%Y-%m-%d)\nHOUR=$(date +%H)  # Get current hour (00-23)\nINCR_BACKUP_FILENAME=\"${BACKUP_DIR}/${TODAY}_${HOUR}\"\n\n# Set the base directory for incremental backups (point to the latest full backup)\nBASE_DIR=\"/backups/mysql/full/$(ls -tr /backups/mysql/full | tail -n 1)\"\n\n# Run xtrabackup with incremental backup command\nxtrabackup --backup \\\n  --incremental \\\n  --target-dir=\"${INCR_BACKUP_FILENAME}\" \\\n  --base-dir=\"${BASE_DIR}\" \\\n  --user=\"${SERVER_USER}\" \\\n  --password=\"${SERVER_PASSWORD}\"\n\necho \"Hourly incremental backup completed at $(date)\"\n</code></pre>"},{"location":"example-full-incr.html#run-the-hourly-script","title":"Run the Hourly Script","text":"<p>Schedule this script to run every hour using cron.</p> <pre><code>$ 0 * * * * /path/to/your/script.sh\n</code></pre> <p></p>"},{"location":"example-full-incr.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"faq.html","title":"Frequently asked questions","text":""},{"location":"faq.html#does-percona-xtrabackup-80-support-taking-backups-of-databases-in-versions-prior-to-80","title":"Does Percona XtraBackup 8.0 support taking backups of databases in versions prior to 8.0?","text":"<p>Percona XtraBackup 8.0 does not support making backups of databases created in versions prior to 8.0 of MySQL, Percona Server for MySQL or Percona XtraDB Cluster. As the changes that MySQL 8.0 introduced in data dictionaries, redo log and undo log are incompatible with previous versions, it is currently impossible for Percona XtraBackup 8.0 to also support versions prior to 8.0.</p> <p>Due to changes in MySQL 8.0.20 released by Oracle at the end of April 2020, Percona XtraBackup 8.0, up to version 8.0.11, is not compatible with MySQL version 8.0.20 or higher, or Percona products that are based on it: Percona Server for MySQL and Percona XtraDB Cluster.</p> <p>For more information, see Percona XtraBackup 8.x and MySQL 8.0.20</p>"},{"location":"faq.html#does-percona-xtrabackup-80-support-taking-backups-of-databases-in-higher-versions-within-the-80-series","title":"Does Percona XtraBackup 8.0 support taking backups of databases in higher versions within the 8.0 series?","text":"<p>Yes, starting with Percona XtraBackup 8.0.34, you can back up MySQL-compatible databases of higher versions within the 8.0 series.</p> <p>Check the latest list of all Supported versions.</p>"},{"location":"faq.html#does-percona-xtrabackup-80-support-taking-backups-of-databases-in-lower-versions-within-the-80-series","title":"Does Percona XtraBackup 8.0 support taking backups of databases in lower versions within the 8.0 series?","text":"<p>Yes, if you use Percona XtraBackup 8.0.35 or higher, you can back up MySQL-compatible databases starting from version 8.0.34 or higher.</p> <p>Check the latest list of all Supported versions.</p>"},{"location":"faq.html#why-will-innobackupex-not-run-in-percona-xtrabackup-80","title":"Why will <code>innobackupex</code> not run in Percona XtraBackup 8.0?","text":"<p>innobackupex has been removed from Percona XtraBackup 8.0 in favor of xtrabackup.</p>"},{"location":"faq.html#are-you-aware-of-any-web-based-backup-management-tools-commercial-or-not-built-around-percona-xtrabackup","title":"Are you aware of any web-based backup management tools (commercial or not) built around Percona XtraBackup?","text":"<p>Zmanda Recovery Manager is a commercial tool that uses Percona XtraBackup for Non-Blocking Backups:</p> <p>\u201cZRM provides support for non-blocking backups of MySQL using Percona XtraBackup. ZRM with *Percona XtraBackup provides resource utilization management by providing throttling based on the number of IO operations per second. Percona XtraBackup based backups also allow for table level recovery even though the backup was done at the database level (needs the recovery database server to be Percona Server for MySQL with XtraDB).\u201d*</p>"},{"location":"faq.html#xtrabackup-binary-fails-with-a-floating-point-exception","title":"xtrabackup binary fails with a floating point exception","text":"<p>In most of the cases this is due to not having installed the required libraries (and version) by xtrabackup. Installing the GCC suite with the supporting libraries and recompiling xtrabackup solves the issue. See Compiling and Installing from Source Code for instructions on the procedure.</p>"},{"location":"faq.html#how-xtrabackup-handles-the-ibdataib_log-files-on-restore-if-they-arent-in-mysql-datadir","title":"How xtrabackup handles the ibdata/ib_log files on restore if they aren\u2019t in mysql datadir?","text":"<p>In case the <code>ibdata</code> and <code>ib_log</code> files are located in different directories outside the datadir, you will have to put them in their proper place after the logs have been applied.</p>"},{"location":"faq.html#backup-fails-with-error-24-too-many-open-files","title":"Backup fails with Error 24: \u2018Too many open files\u2019","text":"<p>This usually happens when database being backed up contains large amount of files and Percona XtraBackup can\u2019t open all of them to create a successful backup. In order to avoid this error the operating system should be configured appropriately so that Percona XtraBackup can open all its files. On Linux, this can be done with the <code>ulimit</code> command for specific backup session or by editing the <code>/etc/security/limits.conf</code> to change it globally (NOTE: the maximum possible value that can be set up is <code>1048576</code> which is a hard-coded constant in the Linux kernel).</p>"},{"location":"faq.html#how-to-deal-with-skipping-of-redo-logs-for-ddl-operations","title":"How to deal with skipping of redo logs for DDL operations?","text":"<p>To prevent creating corrupted backups when running DDL operations, Percona XtraBackup aborts if it detects that redo logging is disabled. In this case, the following error is printed:</p> <pre><code>[FATAL] InnoDB: An optimized (without redo logging) DDL operation has been performed. All modified pages may not have been flushed to the disk yet.\nPercona XtraBackup will not be able to take a consistent backup. Retry the backup operation.\n</code></pre> <p>Note</p> <p>Redo logging is disabled during a sorted index build. To avoid this error, Percona XtraBackup can use metadata locks on tables while they are copied:</p> <ul> <li> <p>To block all DDL operations, use the <code>--lock-ddl</code> option   that issues <code>LOCK TABLES FOR BACKUP</code>.</p> </li> <li> <p>If <code>LOCK TABLES FOR BACKUP</code> is not supported,   you can block DDL for each table   before XtraBackup starts to copy it   and until the backup is completed   using the <code>--lock-ddl-per-table</code> option.</p> </li> </ul> <p>Note</p> <p>As of Percona XtraBackup 8.0.15, the \u2013lock-ddl-per-table option is deprecated. Use the <code>--lock-ddl</code> option.</p> <p></p>"},{"location":"faq.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"flush-tables-with-read-lock.html","title":"FLUSH TABLES WITH READ LOCK option","text":"<p>The <code>FLUSH TABLES WITH READ LOCK</code> option does the following with a global read lock:</p> <ul> <li> <p>Closes all open tables</p> </li> <li> <p>Locks all tables for all databases</p> </li> </ul> <p>Release the lock with <code>UNLOCK TABLES</code>.</p> <p>Note</p> <p><code>FLUSH TABLES WITH READ LOCK</code> does not prevent inserting rows into the log tables.</p> <p>To ensure consistent backups, use the <code>FLUSH TABLES WITH READ LOCK</code> option before taking a non-InnoDB file backup. The option does not affect long-running queries.</p> <p>Long-running queries with <code>FLUSH TABLES WITH READ LOCK</code> enabled can leave the server in a read-only mode until the queries finish. Killing the <code>FLUSH TABLES WITH READ LOCK</code> does not help if the database is in either the <code>Waiting for table flush</code> or <code>Waiting for master to send event</code> state. To return to normal operation, you must kill any long-running queries.</p> <p>Note</p> <p>All described in this section has no effect when backup locks are used. Percona XtraBackup will use Backup locks where available as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code>. This feature is available in Percona Server for MySQL 5.6+. Percona XtraBackup uses this automatically to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p> <p>In order to prevent this from happening two things have been implemented:</p> <ul> <li> <p>xtrabackup waits for a good moment to issue the global lock</p> </li> <li> <p>xtrabackup kills all queries or only the SELECT queries which prevent the global lock from being acquired</p> </li> </ul>"},{"location":"flush-tables-with-read-lock.html#wait-for-queries-to-finish","title":"Wait for queries to finish","text":"<p>You should issue a global lock when no long queries are running. Waiting to issue the global lock for extended period of time is not a good method. The wait can extend the time needed for backup to take place. The [\u2013ftwrl-wait-timeout] option can limit the waiting time. If it cannot issue the lock during this time, xtrabackup stops the option, exits with an error message, and backup is not be taken.</p> <p>The default value for this option is zero (0) value which turns off the option.</p> <p>Another possibility is to specify the type of query to wait on. In this case \u2013ftwrl-wait-query-type. Possible values are <code>all</code> and <code>update</code>. When <code>all</code> is used xtrabackup will wait for all long running queries (execution time longer than allowed by \u2013ftwrl-wait-threshold) to finish before running the <code>FLUSH TABLES WITH READ LOCK</code>. When <code>update</code> is used xtrabackup will wait on <code>UPDATE/ALTER/REPLACE/INSERT</code> queries to finish.</p> <p>The time needed for a specific query to complete is hard to predict. We assume that the long-running queries will not finish in a timely manner. Other queries which run for a short time finish quickly. xtrabackup uses the value of the [\u2013ftwrl-wait-threshold] option to specify the long-running queries and will block a global lock. In order to use this option xtrabackup user should have <code>PROCESS</code> and <code>SUPER</code> privileges.</p>"},{"location":"flush-tables-with-read-lock.html#kill-the-blocking-queries","title":"Kill the blocking queries","text":"<p>The second option is to kill all the queries which prevent from acquiring the global lock. In this case, all queries which run longer than <code>FLUSH TABLES WITH READ LOCK</code> are potential blockers. Although all queries can be killed, additional time can be specified for the short running queries to finish using the \u2013kill-long-queries-timeout option. This option specifies the time for queries to complete, after the value is reached, all the running queries will be killed. The default value is zero, which turns this feature off.</p> <p>The \u2013kill-long-query-type option can be used to specify all or only <code>SELECT</code> queries that are preventing global lock from being acquired. In order to use this option xtrabackup user should have <code>PROCESS</code> and <code>SUPER</code> privileges.</p>"},{"location":"flush-tables-with-read-lock.html#options-summary","title":"Options summary","text":"<ul> <li> <p>\u2013ftwrl-wait-timeout (seconds) - how long to wait for a good moment. Default is 0, not to wait.</p> </li> <li> <p>\u2013ftwrl-wait-query-type - which long queries should be finished before <code>FLUSH TABLES WITH READ LOCK</code> is run. Default is all.</p> </li> <li> <p>\u2013ftwrl-wait-threshold (seconds) - how long query should be running before we consider it long running and potential blocker of global lock.</p> </li> <li> <p>\u2013kill-long-queries-timeout (seconds) - how many time we give for queries to complete after <code>FLUSH TABLES WITH READ LOCK</code> is issued before start to kill. Default if <code>0</code>, not to kill.</p> </li> <li> <p>\u2013kill-long-query-type - which queries should be killed once \u2013kill-long-queries-timeout has expired.</p> </li> </ul>"},{"location":"flush-tables-with-read-lock.html#example","title":"Example","text":"<p>Running the xtrabackup with the following options will cause xtrabackup to spend no longer than 3 minutes waiting for all queries older than 40 seconds to complete.</p> <pre><code>$  xtrabackup --backup --ftwrl-wait-threshold=40 \\\n--ftwrl-wait-query-type=all --ftwrl-wait-timeout=180 \\\n--kill-long-queries-timeout=20 --kill-long-query-type=all \\\n--target-dir=/data/backups/\n</code></pre> <p>After <code>FLUSH TABLES WITH READ LOCK</code> is issued, xtrabackup will wait for 20 seconds for lock to be acquired. If lock is still not acquired after 20 seconds, it will kill all queries which are running longer that the <code>FLUSH TABLES WITH READ LOCK</code>.</p> <p></p>"},{"location":"flush-tables-with-read-lock.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"glossary.html","title":"Glossary","text":""},{"location":"glossary.html#csm","title":".CSM","text":"<p>Each table with the CSV Storage Engine has <code>.CSM</code> file which contains the metadata of it.</p>"},{"location":"glossary.html#csv","title":".CSV","text":"<p>Each table with the CSV Storage engine has <code>.CSV</code> file which contains the data of it (which is a standard Comma Separated Value file).</p>"},{"location":"glossary.html#exp","title":".exp","text":"<p>Files with the <code>.exp</code> extension are created by Percona XtraBackup per each InnoDB tablespace when the <code>--export</code> option is used on prepare. See restore individual tables.</p>"},{"location":"glossary.html#frm","title":".frm","text":"<p>For each table, the server will create a file with the <code>.frm</code> extension containing the table definition (for all storage engines).</p>"},{"location":"glossary.html#general-availability-ga","title":"General availability (GA)","text":"<p>A finalized version of the product which is made available to the general public. It is the final stage in the software release cycle.</p>"},{"location":"glossary.html#ibd","title":".ibd","text":"<p>On a multiple tablespace setup ([innodb_file_per_table] enabled), MySQL will store each newly created table on a file with a <code>.ibd</code> extension.</p>"},{"location":"glossary.html#mrg","title":".MRG","text":"<p>Each table using the MERGE storage engine, besides of a <code>.frm</code> file,  will have <code>.MRG</code> file containing the names of the MyISAM tables  associated with it.</p>"},{"location":"glossary.html#myd","title":".MYD","text":"<p>Each MyISAM table has <code>.MYD</code> (MYData) file which contains the data on it.</p>"},{"location":"glossary.html#myi","title":".MYI","text":"<p>Each MyISAM table has <code>.MYI</code> (MYIndex) file which contains the table\u2019s indexes.</p>"},{"location":"glossary.html#opt","title":".opt","text":"<p>MySQL stores options of a database (like charset) in a file with a <code>.opt</code> extension in the database directory.</p>"},{"location":"glossary.html#par","title":".par","text":"<p>Each partitioned table has <code>.par</code> file which contains metadata about the partitions.</p>"},{"location":"glossary.html#trg","title":".TRG","text":"<p>The file contains the triggers associated with a table, for example, <code>\\mytable.TRG</code>. With the <code>.TRN</code> file, they represent all the trigger definitions.</p>"},{"location":"glossary.html#trn","title":".TRN","text":"<p>The file contains the names of triggers that are associated with a table, for example, <code>\\mytable.TRN</code>. With the <code>.TRG</code> file, they represent all the trigger definitions.</p>"},{"location":"glossary.html#backup","title":"backup","text":"<p>The process of copying data or tables to be stored in a different location.</p>"},{"location":"glossary.html#compression","title":"compression","text":"<p>The method that produces backups in a reduced size.</p>"},{"location":"glossary.html#configuration-file","title":"configuration file","text":"<p>The file that contains the server startup options.</p>"},{"location":"glossary.html#crash","title":"crash","text":"<p>An unexpected shutdown which does not allow the normal server shutdown cleanup activities.</p>"},{"location":"glossary.html#crash-recovery","title":"crash recovery","text":"<p>The actions that occur when MySQL is restarted after a crash.</p>"},{"location":"glossary.html#data-dictionary","title":"data dictionary","text":"<p>The metadata for the tables, indexes, and table columns stored in the InnoDB system tablespace.</p>"},{"location":"glossary.html#datadir","title":"datadir","text":"<p>The directory in which the database server stores its data files. Most Linux distribution use <code>/var/lib/mysql</code> by default.</p>"},{"location":"glossary.html#full-backup","title":"full backup","text":"<p>A backup that contains the complete source data from an instance.</p>"},{"location":"glossary.html#ibdata","title":"ibdata","text":"<p>The default prefix for tablespace files. For example, <code>ibdata1</code> is a 10MB auto-extensible file that MySQL creates for a shared tablespace by default.</p>"},{"location":"glossary.html#incremental-backup","title":"incremental backup","text":"<p>A backup stores data from a specific point in time.</p>"},{"location":"glossary.html#innodb","title":"InnoDB","text":"<p>Storage engine which provides ACID-compliant transactions and foreign  key support, among others improvements over MyISAM. It is the default  engine for MySQL as of the 8.0 series.</p>"},{"location":"glossary.html#innodb_buffer_pool_size","title":"innodb_buffer_pool_size","text":"<p>The size in bytes of the memory buffer to cache data and indexes of InnoDB\u2019s tables. This aims to reduce disk access to provide better performance. </p> <p>[mysqld] innodb_buffer_pool_size=8MB</p>"},{"location":"glossary.html#innodb_data_home_dir","title":"innodb_data_home_dir","text":"<p>The directory (relative to <code>datadir</code>) where the database server stores  the files in a shared tablespace setup. This option does not affect the location of <code>innodb\\_file\\_per\\_table</code>. For example:</p> <p>[mysqld] innodb_data_home_dir = ./</p>"},{"location":"glossary.html#innodb_data_file_path","title":"innodb_data_file_path","text":"<p>Specifies the names, sizes and location of shared tablespace files:</p> <p>[mysqld] innodb_data_file_path=ibdata1:50M;ibdata2:50M:autoextend</p>"},{"location":"glossary.html#innodb_file_per_table","title":"innodb_file_per_table","text":"<p>By default, InnoDB creates tables and indexes in a file-per-tablespace. If the <code>innodb_file_per_table</code> variable is disabled, you can enable the variable in your configuration file:</p> <p>[mysqld] innodb_file_per_table  or  start the server with <code>--innodb_file_per_table</code>.</p>"},{"location":"glossary.html#innodb_log_group_home_dir","title":"innodb_log_group_home_dir","text":"<p>Specifies the location of the InnoDB log files:</p> <p>[mysqld] innodb_log_group_home=/var/lib/mysql</p>"},{"location":"glossary.html#logical-backup","title":"logical backup","text":"<p>A backup which contains a set of SQL statements. The statements can be used to recreate the databases.</p>"},{"location":"glossary.html#lsn","title":"LSN","text":"<p>Each InnoDB page contains a log sequence number(LSN). The LSN is the system version number for the database. Each page\u2019s LSN shows how recently it was changed.</p>"},{"location":"glossary.html#mycnf","title":"my.cnf","text":"<p>The database server\u2019s main configuration file. Most Linux distributions place it as <code>/etc/mysql/my.cnf</code> or <code>/etc/my.cnf</code>, but the location and name depends on the particular installation. Note that this method is not the only way of configuring the server, some systems rely on the command options.</p>"},{"location":"glossary.html#myisam","title":"MyISAM","text":"<p>The MySQL default storage engine until version 5.5. It doesn\u2019t fully  support transactions but in some scenarios may be faster than InnoDB.  Each table is stored on disk in 3 files: <code>.frm</code>, <code>.MYD</code>, <code>.MYI</code>.</p>"},{"location":"glossary.html#physical-backup","title":"physical backup","text":"<p>A backup that copies the data files.</p>"},{"location":"glossary.html#point-in-time-recovery","title":"point in time recovery","text":"<p>This method restores the data into the state it was at any selected point of time.</p>"},{"location":"glossary.html#prepared-backup","title":"prepared backup","text":"<p>A consistent set of backup data that is ready to be restored.</p>"},{"location":"glossary.html#restore","title":"restore","text":"<p>Copies the database backups taken using the backup command to the original location or a different location. A restore returns data that has been either lost, corrupted, or stolen to the original condition at a specific point in time.</p>"},{"location":"glossary.html#tech-preview","title":"Tech preview","text":"<p>A tech preview item can be a feature, a variable, or a value within a variable. Before using this feature in production, we recommend that you test restoring production from physical backups in your environment and also use an alternative backup method for redundancy. A tech preview item is included in a release for users to provide feedback. The item is either updated and released as general availability(GA) or removed if not useful. The functionality can change from tech preview to GA.</p>"},{"location":"glossary.html#xbcrypt","title":"xbcrypt","text":"<p>To support the encryption and the decryption of the backups, a new tool xbcrypt was introduced to Percona XtraBackup. This utility has been modeled after the xbstream binary to perform encryption and decryption outside Percona XtraBackup.</p>"},{"location":"glossary.html#xbstream","title":"xbstream","text":"<p>To support simultaneous compression and streaming, Percona XtraBackup uses the xbstream format. For more information see xbstream</p>"},{"location":"glossary.html#xtradb","title":"XtraDB","text":"<p>Percona XtraDB is an enhanced version of the InnoDB storage engine, designed to better scale on modern hardware. Percona XtraDB includes features which are useful in a high performance environment. It is fully backward-compatible, and is a drop-in replacement for the standard InnoDB storage engine. For more information, see The Percona XtraDB Storage Engine.</p>"},{"location":"glossary.html#zstandard-zstd","title":"Zstandard (ZSTD)","text":"<p><code>ZSTD</code> is a fast lossless compression algorithm that targets real-time compression scenarios and better compression ratios.</p> <p><code>ZSTD</code> compression algorithm was implemented in Percona XtraBackup 8.0.30-23.</p> <p></p>"},{"location":"glossary.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"how-xtrabackup-works.html","title":"How Percona XtraBackup works","text":"<p>Percona XtraBackup is based on InnoDB\u2019s crash-recovery functionality. It copies your InnoDB data files, which results in data that is internally inconsistent; but then it performs crash recovery on the files to make them a consistent, usable database again.</p> <p>This works because InnoDB maintains a redo log, also called the transaction log. This contains a record of every change to InnoDB data. When InnoDB starts, it inspects the data files and the transaction log, and performs two steps. It applies committed transaction log entries to the data files, and it performs an undo operation on any transactions that modified data but did not commit.</p> <p>Percona XtraBackup 8.0.30-23 adds the \u2013register-redo-log-consumer parameter. This parameter is disabled by default. When enabled, the parameter lets Percona XtraBackup register as a redo log consumer at the start of the backup. The server does not remove a redo log that Percona XtraBackup (the consumer) has not yet copied. The consumer reads the redo log and manually advances the log sequence number (LSN). The server blocks the writes during the process. Based on the redo log consumption, the server determines when it can purge the log.</p> <p>Percona XtraBackup works by remembering the LSN when it starts, and then copying away the data files. It takes some time to do this, so if the files are changing, then they reflect the state of the database at different points in time. At the same time, Percona XtraBackup runs a background process that watches the transaction log files, and copies changes from it. Percona XtraBackup needs to do this continually because the transaction logs are written in a round-robin fashion, and can be reused after a while. Percona XtraBackup needs the transaction log records for every change to the data files since it began execution.</p> <p>Percona XtraBackup uses Backup locks</p> <p>where available as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code>. This feature is available in Percona Server for MySQL 5.6+. MySQL 8.0 allows acquiring an instance level backup lock via the <code>LOCK INSTANCE FOR BACKUP</code> statement.</p> <p>Locking is only done for MyISAM and other non-InnoDB tables after Percona XtraBackup finishes backing up all InnoDB/XtraDB data and logs. Percona XtraBackup uses this automatically to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p> <p>Important</p> <p>The <code>BACKUP_ADMIN</code> privilege is required to query the  <code>performance_schema_log_status</code> for either <code>LOCK  INSTANCE FOR BACKUP</code> or <code>LOCK TABLES FOR BACKUP</code>.</p> <p>xtrabackup tries to avoid backup locks and <code>FLUSH TABLES WITH READ LOCK</code> when the instance contains only InnoDB tables. In this case, xtrabackup obtains binary log coordinates from <code>performance_schema.log_status</code>. <code>FLUSH TABLES WITH READ LOCK</code> is still required in MySQL 8.0 when xtrabackup is started with the <code>--slave-info</code>. The <code>log_status</code> table in Percona Server for MySQL 8.0 is extended to include the relay log coordinates, so no locks are needed even with the <code>--slave-info</code> option.</p> <p>See also</p> <p>MySQL Documentation: LOCK INSTANCE FOR BACKUP</p> <p>When backup locks are supported by the server, xtrabackup first copies InnoDB data, runs the <code>LOCK TABLES FOR BACKUP</code> and then copies the MyISAM tables. Once this is done, the backup of the files will begin. It will backup .frm, .MRG, .MYD, .MYI, .CSM, .CSV, <code>.sdi</code> and <code>.par</code> files.</p> <p>After that xtrabackup will use <code>LOCK BINLOG FOR BACKUP</code> to block all operations that might change either binary log position or <code>Exec_Master_Log_Pos</code> or <code>Exec_Gtid_Set</code> (i.e. source binary log coordinates corresponding to the current SQL thread state on a replication replica) as reported by <code>SHOW MASTER/SLAVE STATUS</code>. xtrabackup will then finish copying the REDO log files and fetch the binary log coordinates. After this is completed xtrabackup will unlock the binary log and tables.</p> <p>Finally, the binary log position will be printed to <code>STDERR</code> and xtrabackup will exit returning 0 if all went OK.</p> <p>Note that the <code>STDERR</code> of xtrabackup is not written in any file. You will have to redirect it to a file, e.g., <code>xtrabackup OPTIONS 2&gt; backupout.log</code>.</p> <p>It will also create the following files in the directory of the backup.</p> <p>During the <code>prepare</code> phase, Percona XtraBackup performs crash recovery against the copied data files, using the copied transaction log file. After this is done, the database is ready to restore and use.</p> <p>The backed-up MyISAM and InnoDB tables will be eventually consistent with each other, because after the prepare (recovery) process, InnoDB\u2019s data is rolled forward to the point at which the backup completed, not rolled back to the point at which it started. This point in time matches where the <code>FLUSH TABLES WITH READ LOCK</code> was taken, so the MyISAM data and the prepared InnoDB data are in sync.</p> <p>The xtrabackup offers many features not mentioned in the preceding explanation. The functionality of each tool is explained in more detail further in this manual. In brief, though, the tools enable you to do operations such as streaming and incremental backups with various combinations of copying the data files, copying the log files, and applying the logs to the data.</p>"},{"location":"how-xtrabackup-works.html#restoring-a-backup","title":"Restoring a backup","text":"<p>To restore a backup with xtrabackup you can use the \u2013copy-back or \u2013move-back options.</p> <p>xtrabackup will read from the <code>my.cnf</code> the variables datadir, innodb_data_home_dir, innodb_data_file_path, innodb_log_group_home_dir and check that the directories exist.</p> <p>It will copy the MyISAM tables, indexes, etc. (.MRG, .MYD, .MYI, .CSM, .CSV, <code>.sdi</code>, and <code>par</code> files) first, InnoDB tables and indexes next and the log files at last. It will preserve file\u2019s attributes when copying them, you may have to change the files\u2019 ownership to <code>mysql</code> before starting the database server, as they will be owned by the user who created the backup.</p> <p>Alternatively, the \u2013move-back option may be used to restore a backup. This option is similar to \u2013copy-back with the only difference that instead of copying files it moves them to their target locations. As this option removes backup files, it must be used with caution. It is useful in cases when there is not enough free disk space to hold both data files and their backup copies.</p> <p></p>"},{"location":"how-xtrabackup-works.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"installation.html","title":"Install Percona XtraBackup 8.0 overview","text":"<p>We recommend that you install Percona XtraBackup 8.0 from the official Percona software repositories using the appropriate package manager for your system:</p> <ul> <li> <p>Use an APT repo to install Percona XtraBackup</p> </li> <li> <p>Use a YUM repo to install Percona XtraBackup</p> </li> </ul>"},{"location":"installation.html#installation-alternatives","title":"Installation alternatives","text":"<p>Percona also provides the following methods:</p> <ul> <li> <p>Use DEB downloaded packages to install Percona XtraBackup</p> </li> <li> <p>Use RPM downloaded packages to install Percona XtraBackup </p> </li> <li> <p>Install Percona XtraBackup from a Binary Tarball with all the required files and binaries for a manual installation</p> </li> <li> <p>Compile and install Percona XtraBackup from source code</p> </li> <li> <p>Run Percona XtraBackup in a Docker container</p> </li> </ul> <p>Before installing Percona XtraBackup with any of these methods, we recommend that you review the release notes and Server version and backup version comparisonand, if you are using Percona XtraBackup 8.0.34 or later, the latest list of Supported versions.</p> <p></p>"},{"location":"installation.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"lock-options.html","title":"lock-ddl-per-table option improvements","text":"<p>Important</p> <p>The lock-ddl-per-table option is deprecated in Percona Server for MySQL 8.0. Use \u2013lock-ddl instead of this variable.</p> <p>To block DDL statements on an instance, Percona Server implemented LOCK TABLES FOR BACKUP. Percona XtraBackup uses this lock for the duration of the backup. This lock does not affect DML statements.</p> <p>Percona XtraBackup has also implemented \u2013lock-ddl-per-table, which blocks DDL statements by using metadata locks (MDL).</p> <p>The following procedures describe a simplified backup operation when using \u2013lock-ddl-per-table:</p> <ol> <li> <p>Parse and copy all redo logs after the checkpoint mark</p> </li> <li> <p>Fork a dedicated thread to continue following new redo log entries</p> </li> <li> <p>List the tablespaces required to copy</p> </li> <li> <p>Iterate through the list. The following steps occur with each listed tablespace:</p> </li> <li> <p>Query INFORMATION_SCHEMA.INNODB_TABLES to find which tables belong    to the tablespace ID and take an MDL on the underlying table or tables in    case there is a shared tablespace.</p> </li> <li> <p>Copy the tablespace <code>.ibd</code> files.</p> </li> </ol> <p>The backup process may encounter a redo log event, generated by the bulk load operations, which notifies backup tools that data file changes have been omitted from the redo log. This event is an <code>MLOG_INDEX_LOAD</code>. If this event is found by the redo follow thread, the backup continues and assumes the backup is safe because the MDL protects tablespaces already copied and the MLOG_INDEX_LOAD event is for a tablespace that is not copied.</p> <p>These assumptions may not be correct and may lead to inconsistent backups.</p>"},{"location":"lock-options.html#lock-ddl-per-table-redesign","title":"\u2013lock-ddl-per-table redesign","text":"<p>Implemented in Percona XtraBackup version 8.0.22-15.0, the \u2013lock-ddl-per-table has been redesigned to minimize inconsistent backups.</p> <p>The following procedure reorders the steps:</p> <ul> <li> <p>The MDL lock acquired at the beginning of the backup</p> </li> <li> <p>Scan the redo logs. An <code>MLOG_INDEX_LOAD</code> event may be recorded if a <code>CREATE INDEX</code> statement has occurred before the backup starts. At this time, the backup process is safe and can parse and accept the event.</p> </li> <li> <p>After the first scan has completed, the follow redo log thread is initiated. This thread stops the backup process if an <code>MLOG_INDEX_LOAD</code> event is found.</p> </li> <li> <p>Gather the tablespace list to copy</p> </li> <li> <p>Copy the <code>.ibd</code> files.</p> </li> </ul>"},{"location":"lock-options.html#other-improvements","title":"Other improvements","text":"<p>The following improvements have been added:</p> <ul> <li> <p>If the <code>.ibd</code> file belongs to a temporary table, the <code>SELECT</code> query is skipped.</p> </li> <li> <p>For a FullText Index, an MDL is acquired on the base table.</p> </li> <li> <p>A <code>SELECT</code> query that acquires an MDL does not retrieve any data.</p> </li> </ul> <p></p>"},{"location":"lock-options.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"log-enhancements.html","title":"Improved log statements","text":"<p>Percona XtraBackup is an open-source command-line utility. Command-line tools have limited interaction with the background operations and the logs provide the progress of an operation or more information about errors.</p> <p>In earlier versions, the error logs did not have a standard structure. Notice in the following examples the variance in the log statements:</p> <ul> <li>The backup log statement header has the name of the module, <code>xtrabackup</code>, which generated the statement but no timestamp:</li> </ul> <p><pre><code> $ xtrabackup: recognized client arguments: --parallel=4 --target-dir=/data/backups/ --backup=1\n</code></pre> The output should be similar to the following:</p> Expected output <pre><code>./bin/xtrabackup version 8.0.27-19 based on MySQL server 8.0.27 Linux (x86_64) (revision id: b0f75188ca3)\n</code></pre> <ul> <li>The copy-back log statement has a timestamp but no module name. The   timestamp is a mix of UTC and the local timezone.</li> </ul> <pre><code>220322 19:05:13 [01] Copying undo_001 to /data/backups/undo_001\n</code></pre> <ul> <li>The following prepare log statements do not have header information,   which makes diagnosing an issue more difficult.</li> </ul> <pre><code>Completed space ID check of 1008 files.\nInitializing buffer pool, total size = 128.000000M, instances = 1, chunk size =128.000000M\nCompleted initialization of buffer pool\nIf the mysqld execution user is authorized, page cleaner thread priority can be changed. See the man page of setpriority().\n</code></pre>"},{"location":"log-enhancements.html#log-statement-structure","title":"Log statement structure","text":"<p>Starting in Percona XtraBackup 8.0.28-20, changes have been made to improve the log statements. The improved log structure is displayed in the backup, prepare, move-back/copy-back error logs.</p> <p>Each log statement has the following attributes:</p> <ul> <li> <p>Timestamp - a timestamp for when the event occurred in a UTC format.</p> </li> <li> <p>Severity - the severity level of a statement indicates the importance of an event.</p> </li> <li> <p>ID - this identifier is currently not used but may be used in future versions.</p> </li> <li> <p>Context - the name of the module that issued the log statement, such as XtraBackup, InnoDB, or Server.</p> </li> <li> <p>Message - a description of the event generated by the module.</p> </li> </ul> <p>An example of a <code>prepare</code> log that is generated with the improved structure. The uniformity of the headers makes it easier to follow an operation\u2019s progress or review the log to diagnose issues.</p> Expected output <pre><code>2022-03-22T19:15:36.142247+05:30 0 [Note] [MY-011825] [Xtrabackup] This target seems to be not prepared yet.\n2022-03-22T19:15:36.142792+05:30 0 [Note] [MY-013251] [InnoDB] Number of pools: 1\n2022-03-22T19:15:36.149212+05:30 0 [Note] [MY-011825] [Xtrabackup] xtrabackup_logfile detected: size=8388608, start_lsn=(33311656)\n2022-03-22T19:15:36.149998+05:30 0 [Note] [MY-011825] [Xtrabackup] using the following InnoDB configuration for recovery:\n2022-03-22T19:15:36.150023+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_data_home_dir = .\n2022-03-22T19:15:36.150036+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_data_file_path = ibdata1:12M:autoextend\n2022-03-22T19:15:36.150078+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_group_home_dir = .\n2022-03-22T19:15:36.150095+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_files_in_group = 1\n2022-03-22T19:15:36.150111+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_file_size = 8388608\n2022-03-22T19:15:36.151667+05:30 0 [Note] [MY-011825] [Xtrabackup] inititialize_service_handles suceeded\n2022-03-22T19:15:36.151903+05:30 0 [Note] [MY-011825] [Xtrabackup] using the following InnoDB configuration for recovery:\n2022-03-22T19:15:36.151926+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_data_home_dir = .\n2022-03-22T19:15:36.151954+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_data_file_path = ibdata1:12M:autoextend\n2022-03-22T19:15:36.151976+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_group_home_dir = .\n2022-03-22T19:15:36.151991+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_files_in_group = 1\n2022-03-22T19:15:36.152004+05:30 0 [Note] [MY-011825] [Xtrabackup] innodb_log_file_size = 8388608\n2022-03-22T19:15:36.152021+05:30 0 [Note] [MY-011825] [Xtrabackup] Starting InnoDB instance for recovery.\n2022-03-22T19:15:36.152035+05:30 0 [Note] [MY-011825] [Xtrabackup] Using 104857600 bytes for buffer pool (set by --use-memory parameter)\n</code></pre> <p></p>"},{"location":"log-enhancements.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"lru-dump-backup.html","title":"LRU dump backup","text":"<p>Percona XtraBackup includes a saved buffer pool dump into a backup to enable reducing the warm up time. It restores the buffer pool state from <code>ib_buffer_pool</code> file after restart. Percona XtraBackup discovers <code>ib_buffer_pool</code> and backs it up automatically.</p> <p></p> <p>If the buffer restore option is enabled in <code>my.cnf</code> buffer pool will be in the warm state after backup is restored.</p> <p></p>"},{"location":"lru-dump-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"make-backup-in-replication-env.html","title":"Make backups in replication environments","text":"<p>There are options specific to back up from a replication replica.</p>"},{"location":"make-backup-in-replication-env.html#the-slave-info-option","title":"The <code>--slave-info</code> option","text":"<p>This option is useful when backing up a replication replica server. It prints the binary log position and name of the source server. It also writes this information to the <code>xtrabackup_slave_info</code> file as a <code>CHANGE MASTER</code> statement.</p> <p>This option is useful for setting up a new replica for this source. You can start a replica server with this backup and issue the statement saved in the <code>xtrabackup_slave_info</code> file. More details of this procedure can be found in How to setup a replica for replication in 6 simple steps with Percona XtraBackup.</p>"},{"location":"make-backup-in-replication-env.html#the-safe-slave-backup-option","title":"The <code>--safe-slave-backup</code> option","text":"<p>In order to assure a consistent replication state, this option stops the replication SQL thread and waits to start backing up until <code>Slave_open_temp_tables</code> in <code>SHOW STATUS</code> is zero. If there are no open temporary tables, the backup will take place, otherwise the SQL thread will be started and stopped until there are no open temporary tables. The backup will fail if <code>Slave_open_temp_tables</code> does not become zero after <code>--safe-slave-backup-timeout</code> seconds (defaults to 300 seconds). The replication SQL thread will be restarted when the backup finishes.</p> <p>Note</p> <p>Prior to Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup stops the SQL replica thread after the InnoDB tables and before the non-InnoDB tables are backed up.</p> <p>As of Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup option stops the SQL replica thread before copying the InnoDB files.</p> <p>Using this option is always recommended when taking backups from a replica server.</p> <p>Warning</p> <p>Make sure your replica is a true replica of the source before using it as a source for backup. A good tool to validate a replica is pt-table-checksum.</p> <p></p>"},{"location":"make-backup-in-replication-env.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"page-tracking.html","title":"Take an incremental backup using page tracking","text":"<p>Percona XtraBackup 8.0.27 adds support for page tracking functionality for an incremental backup.</p> <p>To create an incremental backup with page tracking, Percona XtraBackup uses the MySQL <code>mysqlbackup</code> component. This component provides a list of pages modified since the last backup, and Percona XtraBackup copies only those pages. This operation removes the need to scan the pages in the database. If the majority of pages have not been modified, the page tracking feature can improve the speed of incremental backups.</p>"},{"location":"page-tracking.html#install-the-component","title":"Install the component","text":"<p>To start using the page tracking functionality, do the following:</p> <ol> <li> <p>Install the <code>mysqlbackup</code> component and enable it on the server:</p> <pre><code>$ INSTALL COMPONENT \"file://component_mysqlbackup\";\n</code></pre> </li> <li> <p>Check whether the <code>mysqlbackup</code> component is installed successfully:</p> <pre><code>$ SELECT COUNT(1) FROM mysql.component WHERE component_urn='file://component_mysqlbackup';\n</code></pre> </li> </ol>"},{"location":"page-tracking.html#use-page-tracking","title":"Use page tracking","text":"<p>You can enable the page tracking functionality for the full and incremental backups with the <code>--page-tracking</code> option.</p> <p>The option has the following benefits:</p> <ul> <li> <p>Resets page tracking to the start of the backup. This reset allows the next incremental backup to use page tracking.</p> </li> <li> <p>Allows the use of page tracking for an incremental backup if the page tracking data is available from the backup\u2019s start checkpoint LSN.</p> </li> </ul> <p>Percona XtraBackup processes a list of all the tracked pages in memory. If Percona XtraBackup does not have enough available memory to process this list, the process throws an error and exits. For example, if an incremental backup uses 200GB, Percona XtraBackup can use an additional 100MB of memory to process and store the page tracking data. </p> <p>The examples of creating full and incremental backups using the <code>--page-tracking</code> option:</p> Full backupIncremental backup <pre><code>$ xtrabackup --backup --target-dir=$FULL_BACK --page-tracking\n</code></pre> <pre><code>$ xtrabackup --backup --target-dir=$INC_BACKUP  \n--incremental-basedir=$FULL_BACKUP --page-tracking\n</code></pre> <p>After enabling the functionality, the next incremental backup finds changed pages using page tracking.</p>"},{"location":"page-tracking.html#limitations","title":"Limitations","text":"<ul> <li> <p>When creating the first full backup using page tracking, Percona XtraBackup may have a delay. The following is an example of the message:</p> <pre><code>xtrabackup: pagetracking: Sleeping for 1 second, waiting for checkpoint lsn 17852922 /\nto reach to page tracking start lsn 21353759\n</code></pre> <p>Enable page tracking before creating the first backup to avoid this delay. This method ensures that the page tracking log sequence number (LSN) is higher than the checkpoint LSN of the server.</p> </li> <li> <p>If an Oracle MySQL Server uses page tracking and runs <code>LOCK=EXCLUSIVE</code> and <code>ALGORITHM=INPLACE</code> DDL operations, Percona XtraBackup may take an inconsistent backup. Oracle MySQL Server does not write these DDL operations (Oracle MySQL bug 106163) to the redo log, and Percona XtraBackup only detects the inconsistency during the <code>--prepare</code> phase.</p> <p>This bug does not influence Percona XtraBackup taking backup of Percona Server for MySQL because the bug is fixed in Percona Server for MySQL 8.0.27.</p> </li> <li> <p>The xtrabackup page tracking requires the system tablespace to be a single file (ibdata1 only). The page tracking feature does not work if the system tablespace is a multi-file tablespace.</p> </li> </ul>"},{"location":"page-tracking.html#start-page-tracking-manually","title":"Start page tracking manually","text":"<p>After the mysqlbackup component is loaded and active on the server, you can start page tracking manually with the following option:</p> <pre><code>$ SELECT mysqlbackup_page_track_set(true);\n</code></pre>"},{"location":"page-tracking.html#check-the-lsn-value","title":"Check the LSN value","text":"<p>Check the LSN value starting from which changed pages are tracked with the following option:</p> <pre><code>$ SELECT mysqlbackup_page_track_get_start_lsn();\n</code></pre>"},{"location":"page-tracking.html#stop-page-tracking","title":"Stop page tracking","text":"<p>To stop page tracking, use the following command:</p> <pre><code>$ SELECT mysqlbackup_page_track_set(false);\n</code></pre>"},{"location":"page-tracking.html#purge-page-tracking-data","title":"Purge page tracking data","text":"<p>When you start page tracking, it creates a file under the server\u2019s datadir to collect data about changed pages. This file grows until you stop the page tracking. If you stop the server and then restart it, page tracking creates a new file but also keeps the old one. The old file continues to grow until you stop the page tracking explicitly.</p> <p>If you purge the page tracking data, you should create a full backup afterward. To purge the page tracking data, do the following steps:</p> <pre><code>$ SELECT mysqlbackup_page_track_set(false);\n$ SELECT mysqlbackup_page_track_purge_up_to(9223372036854775807);\n/* Specify the LSN up to which you want to purge page tracking data. /\n9223372036854775807 is the highest possible LSN which purges all page tracking files.*/\n$ SELECT mysqlbackup_page_track_set(true);\n</code></pre>"},{"location":"page-tracking.html#known-issue","title":"Known issue","text":"<p>If the index is built in place using an exclusive algorithm and then is added to a table after the last LSN checkpoint, you may generate a bad incremental backup using page tracking. For more details see PS-8032.</p>"},{"location":"page-tracking.html#uninstall-the-mysqlbackup-component","title":"Uninstall the mysqlbackup component","text":"<p>To uninstall the mysqlbackup component, use the following statement:</p> <pre><code>$ UNINSTALL COMPONENT \"file://component_mysqlbackup\"\n</code></pre> <p></p>"},{"location":"page-tracking.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"permissions.html","title":"Permissions needed","text":"<p>We will be referring to permissions to the ability of a user to access and perform changes on the relevant parts of the host\u2019s filesystem, starting/stopping services and installing software.</p> <p>By privileges, we refer to the abilities of a database user to perform different kinds of actions on the database server.</p> <p>There are many ways for checking the permission on a file or directory. For example, <code>ls -ls /path/to/file</code> or <code>stat /path/to/file | grep Access</code> will do the job:</p> <p><pre><code>$ stat /etc/mysql | grep Access\n</code></pre> The result could look like this:</p> Expected output <pre><code>Access: (0755/drwxr-xr-x)  Uid: (    0/    root)   Gid: (    0/    root)\nAccess: 2011-05-12 21:19:07.129850437 -0300\n$ ls -ld /etc/mysql/my.cnf\n-rw-r--r-- 1 root root 4703 Apr  5 06:26 /etc/mysql/my.cnf\n</code></pre> <p>As in this example, <code>my.cnf</code> is owned by <code>root</code> and not writable for anyone else. Assuming that you do not have <code>root</code>\u2018s password, you can check what permissions you have on these types of files with <code>sudo -l</code>:</p> <p><pre><code>$ sudo -l\n</code></pre> The results could look like this:</p> Expected output <pre><code>Password:\nYou may run the following commands on this host:\n(root) /usr/bin/\n(root) NOPASSWD: /etc/init.d/mysqld\n(root) NOPASSWD: /bin/vi /etc/mysql/my.cnf\n(root) NOPASSWD: /usr/local/bin/top\n(root) NOPASSWD: /usr/bin/ls\n(root) /bin/tail\n</code></pre> <p>Being able to execute with <code>sudo</code> scripts in <code>/etc/init.d/</code>, <code>/etc/rc.d/</code> or <code>/sbin/service</code> is the ability to start and stop services.</p> <p>Also, If you can execute the package manager of your distribution, you can install or remove software with it. If not, having <code>rwx</code> permission over a directory will let you do a local installation of software by compiling it there. This is a typical situation in many hosting companies\u2019 services.</p> <p>There are other ways for managing permissions, such as using PolicyKit, * Extended ACLs or SELinux*, which may be preventing or allowing your access. You should check them in that case.</p> <p>See also</p> <p>Connection and privileges needed</p> <p></p>"},{"location":"permissions.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"point-in-time-recovery.html","title":"Point-in-time recovery","text":"<p>Recovering up to particular moment in database\u2019s history can be done with xtrabackup and the binary logs of the server.</p> <p>Note that the binary log contains the operations that modified the database from a point in the past. You must have full data directory as a base. Apply a series of operations from the binary log to make the data match the point in time data.</p> <pre><code>$ xtrabackup --backup --target-dir=/path/to/backup\n$ xtrabackup --prepare --target-dir=/path/to/backup\n</code></pre> <p>For more details on these procedures, see Create a full backup and Prepare a full backup.</p> <p>Now, suppose that some time has passed, and you want to restore the database to a certain point in the past, having in mind that there is the constraint of the point where the snapshot was taken.</p> <p>To find out what is the situation of binary logging in the server, execute the following queries:</p> <pre><code>mysql&gt; SHOW BINARY LOGS;\n</code></pre> Expected output <pre><code>+------------------+-----------+\n| Log_name         | File_size |\n+------------------+-----------+\n| mysql-bin.000001 |       126 |\n| mysql-bin.000002 |      1306 |\n| mysql-bin.000003 |       126 |\n| mysql-bin.000004 |       497 |\n+------------------+-----------+\n</code></pre> <p>This query returns the binary log names and file size.</p> <pre><code>mysql&gt; SHOW MASTER STATUS;\n</code></pre> Expected output <pre><code>+------------------+----------+--------------+------------------+\n| File             | Position | Binlog_Do_DB | Binlog_Ignore_DB |\n+------------------+----------+--------------+------------------+\n| mysql-bin.000004 |      497 |              |                  |\n+------------------+----------+--------------+------------------+\n</code></pre> <p>The query returns which file is currently being used to record changes, and the current position within it. Typically,the files are stored in the datadir, unless, when starting the server, another location is specified with the <code>--log-bin=</code> option).</p> <p>To find out the position of the snapshot taken, see the <code>xtrabackup_binlog_info</code> at the backup\u2019s directory:</p> <pre><code>$ cat /path/to/backup/xtrabackup_binlog_info\n</code></pre> Expected output <pre><code>mysql-bin.000003      57\n</code></pre> <p>This result tells you which file was used at the moment of the backup for the binary log and its position. That position will be the effective one when you restore the backup:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/path/to/backup\n</code></pre> <p>As the restoration will not affect the binary log files (you may need to adjust file permissions, see Restore a backup), the next step is extracting the queries from the binary log with mysqlbinlog starting from the position of the snapshot and redirecting the results to a file.</p> <p>If you have multiple files for the binary log, as in the example, you must extract the queries with one process.</p> <pre><code>$ mysqlbinlog /path/to/datadir/mysql-bin.000003 /path/to/datadir/mysql-bin.000004 \\\n    --start-position=57 &gt; mybinlog.sql\n</code></pre> <p>Inspect the file with the queries to determine which position or date corresponds to the wanted point-in-time. Once determined, pipe it to the server. For example, if the point is <code>11-12-25 01:00:00</code>, the command moves the the database forward to that point-in-time.</p> <pre><code>$ mysqlbinlog /path/to/datadir/mysql-bin.000003 /path/to/datadir/mysql-bin.000004 \\\n    --start-position=57 --stop-datetime=\"11-12-25 01:00:00\" | mysql -u root -p\n</code></pre> <p></p>"},{"location":"point-in-time-recovery.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-compressed-backup.html","title":"Decompress and prepare a backup","text":"<p>Before you can prepare the backup you need to decompress all the files.</p>"},{"location":"prepare-compressed-backup.html#decompress-a-backup","title":"Decompress a backup","text":"<ul> <li> <p>To decompress backups made using <code>LZ4</code> or <code>ZSTD</code> compression algorithm, install the corresponding package for your package management system.</p> <p><code>Install on APT systems</code></p> Install the <code>lz4</code> packageInstall the <code>zstd</code> package <pre><code>$ sudo apt install lz4\n</code></pre> <pre><code>$ sudo apt install zstd\n</code></pre> <p><code>Install on YUM systems</code></p> Install the <code>lz4</code> packageInstall the <code>zstd</code> package <pre><code>$ sudo yum install lz4\n</code></pre> <pre><code>$ sudo yum install zstd\n</code></pre> </li> <li> <p>Use the <code>--decompress</code> option to decompress the backup.</p> <pre><code>$ xtrabackup --decompress --target-dir=/data/compressed/\n</code></pre> <p>Note</p> <p><code>--parallel</code> can be used with <code>--decompress</code> option to decompress multiple files simultaneously. </p> <p>Percona XtraBackup does not automatically delete compressed files. To clean up the backup directory, use the <code>--remove-original</code> option. If you do not remove the compressed files, these files will not be copied or moved to the datadir when using the <code>--copy-back</code> or <code>--move-back</code> options.</p> </li> </ul>"},{"location":"prepare-compressed-backup.html#prepare-the-backup","title":"Prepare the backup","text":"<p>When the files are decompressed you can prepare the backup with the <code>--prepare</code> option.</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/compressed/\n</code></pre> Confirmation message <pre><code>InnoDB: Starting shutdown...\nInnoDB: Shutdown completed; log sequence number 9293846\n170223 13:39:31 completed OK!\n</code></pre> <p>Now the files in <code>/data/compressed/</code> are ready to be used by the server.</p> <p>The next step is to Restore a backup. </p> <p></p>"},{"location":"prepare-compressed-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-full-backup.html","title":"Prepare a full backup","text":"<p>After making a backup with the <code>--backup</code> option, you need to prepare it in order to restore it. Data files are not point-in-time consistent until they are prepared, because they were copied at different times as the program ran, and they might have been changed while this was happening.</p> <p>If you try to start InnoDB with these data files, it will detect corruption and stop working to avoid running on damaged data. The <code>--prepare</code> step makes the files perfectly consistent at a single instant in time, so you can run InnoDB on them.</p> <p>You can run the prepare operation on any machine; it does not need to be on the originating server or the server to which you intend to restore. You can copy the backup to a utility server and prepare it there.</p> <p>Note that Percona XtraBackup 8.0 can only prepare backups of MySQL 8.0, Percona Server for MySQL 8.0, and Percona XtraDB Cluster 8.0 databases. Releases prior to 8.0 are not supported.</p> <p>During the prepare operation, xtrabackup boots up a kind of modified embedded InnoDB (the libraries xtrabackup was linked against). The modifications are necessary to disable InnoDB standard safety checks, such as complaining about the log file not being the right size. This warning is not appropriate for working with backups. These modifications are only for the xtrabackup binary; you do not need a modified InnoDB to use xtrabackup for your backups.</p> <p>The prepare step uses this \u201cembedded InnoDB\u201d to perform crash recovery on the copied data files, using the copied log file. The <code>prepare</code> step is very simple to use: you simply run xtrabackup with the <code>--prepare</code> option and tell it which directory to prepare, for example, to prepare the previously taken backup run:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backups/\n</code></pre> <p>When this finishes, you should see an <code>InnoDB shutdown</code> with a message such as the following, where again the value of LSN will depend on your system:</p> Expected output <pre><code>InnoDB: Shutdown completed; log sequence number 137345046\n160906 11:21:01 completed OK!\n</code></pre> <p>All following prepares will not change the already prepared data files, you\u2019ll see that output says:</p> Expected output <pre><code>xtrabackup: This target seems to be already prepared.\nxtrabackup: notice: xtrabackup_logfile was already used to '--prepare'.\n</code></pre> <p>It is not recommended to interrupt xtrabackup process while preparing backup because it may cause data files corruption and backup will become unusable. Backup validity is not guaranteed if prepare process was interrupted.</p> <p>Note</p> <p>If you intend the backup to be the basis for further incremental backups, you should use the <code>--apply-log-only</code> option when preparing the backup, or you will not be able to apply incremental backups to it. See the documentation on preparing incremental backups for more details.</p> <p>After preparing the backup, you can restore the backup.</p> <p></p>"},{"location":"prepare-full-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-incremental-backup.html","title":"Prepare an incremental backup","text":"<p>The <code>--prepare</code> step for incremental backups is not the same as for full backups. In full backups, two types of operations are performed to make the database consistent: committed transactions are replayed from the log file against the data files, and uncommitted transactions are rolled back. You must skip the rollback of uncommitted transactions when preparing an incremental backup, because transactions that were uncommitted at the time of your backup may be in progress, and it\u2019s likely that they will be committed in the next incremental backup. You should use the <code>--apply-log-only</code> option to prevent the rollback phase.</p> <p>Warning</p> <p>If you do not use the <code>--apply-log-only</code> option to prevent the rollback phase, then your incremental backups will be useless. After transactions have been rolled back, further incremental backups cannot be applied.</p> <p>Beginning with the full backup you created, you can prepare it, and then apply the incremental differences to it. Recall that you have the following backups:</p> <pre><code>/data/backups/base\n/data/backups/inc1\n/data/backups/inc2\n</code></pre> <p>To prepare the base backup, you need to run <code>--prepare</code> as usual, but prevent the rollback phase:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/data/backups/base\n</code></pre> <p>The output should end with text similar to the following:</p> Expected output <pre><code>InnoDB: Shutdown completed; log sequence number 1626007\n161011 12:41:04 completed OK!\n</code></pre> <p>The log sequence number should match the <code>to_lsn</code> of the base backup, which you saw previously.</p> <p>Warning</p> <p>This backup is actually safe to restore as-is now, even though the rollback phase has been skipped. If you restore it and start MySQL, InnoDB will detect that the rollback phase was not performed, and it will do that in the background, as it usually does for a crash recovery upon start. It will notify you that the database was not shut down normally.</p> <p>To apply the first incremental backup to the full backup, run the following command:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/data/backups/base \\\n--incremental-dir=/data/backups/inc1\n</code></pre> <p>This applies the delta files to the files in <code>/data/backups/base</code>, which rolls them forward in time to the time of the incremental backup. It then applies the redo log as usual to the result. The final data is in <code>/data/backups/base</code>, not in the incremental directory. You should see an output similar to:</p> Expected output <pre><code>incremental backup from 1626007 is enabled.\nxtrabackup: cd to /data/backups/base\nxtrabackup: This target seems to be already prepared with --apply-log-only.\nxtrabackup: xtrabackup_logfile detected: size=2097152, start_lsn=(4124244)\n...\nxtrabackup: page size for /tmp/backups/inc1/ibdata1.delta is 16384 bytes\nApplying /tmp/backups/inc1/ibdata1.delta to ./ibdata1...\n...\n161011 12:45:56 completed OK!\n</code></pre> <p>Again, the LSN should match what you saw from your earlier inspection of the first incremental backup. If you restore the files from <code>/data/backups/base</code>, you should see the state of the database as of the first incremental backup.</p> <p>Warning</p> <p>Percona XtraBackup does not support using the same incremental backup directory to prepare two copies of backup. Do not run <code>--prepare</code> with the same incremental backup directory (the value of \u2013incremental-dir) more than once.</p> <p>Preparing the second incremental backup is a similar process: apply the deltas to the (modified) base backup, and you will roll its data forward in time to the point of the second incremental backup:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backups/base \\\n--incremental-dir=/data/backups/inc2\n</code></pre> <p>Note</p> <p><code>--apply-log-only</code> should be used when merging the incremental backups except the last one. That\u2019s why the previous line does not contain the <code>--apply-log-only</code> option. Even if the <code>--apply-log-only</code> was used on the last step, backup would still be consistent but in that case server would perform the rollback phase.</p> <p>Once prepared incremental backups are the same as the full backups, and they can be restored in the same way.</p> <p></p>"},{"location":"prepare-incremental-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-individual-partitions-backup.html","title":"Prepare an individual partitions backup","text":"<p>For preparing partial backups, the procedure is analogous to restoring individual tables. Apply the logs and use xtrabackup <code>--export</code>:</p> <pre><code>$ xtrabackup --apply-log --export /mnt/backup/2012-08-28_10-29-09\n</code></pre> <p>You may see warnings in the output about tables that do not exist. This happens because InnoDB-based engines stores its data dictionary inside the tablespace files. xtrabackup removes the missing tables (those that haven\u2019t been selected in the partial backup) from the data dictionary in order to avoid future warnings or errors.</p> <p>The next step is  to restore the backup. </p> <p></p>"},{"location":"prepare-individual-partitions-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"prepare-partial-backup.html","title":"Prepare a partial backup","text":"<p>The procedure is analogous to restoring individual tables: apply the logs and use the <code>--export</code> option:</p> <pre><code>$ xtrabackup --prepare --export --target-dir=/path/to/partial/backup\n</code></pre> <p>When you use the <code>--prepare</code> option on a partial backup, you will see warnings about tables that don\u2019t exist. This is because these tables exist in the data dictionary inside InnoDB, but the corresponding .ibd files don\u2019t exist. They were not copied into the backup directory. These tables will be removed from the data dictionary, and when you restore the backup and start InnoDB, they will no longer exist and will not cause any errors or warnings to be printed to the log file.</p> <p>Could not find any file associated with the tablespace ID: 5</p> <p>Use <code>--innodb-directories</code> to find the tablespace files. If that fails then use <code>-\u2013innodb-force-recovery=1</code> to ignore this and to permanently lose all changes to the missing tablespace(s).</p> <p>The next step is to restore restore the partition from the backup. </p> <p></p>"},{"location":"prepare-partial-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"privileges.html","title":"Connection and privileges needed","text":"<p>Percona XtraBackup needs to be able to connect to the database server and perform operations on the server and the datadir when creating a backup, when preparing in some scenarios and when restoring it. In order to do so, there are privileges and permission requirements on its execution that must be fulfilled.</p> <p>Privilege refers to the operations that a system user is permitted to do in the database server. They are set at the database server and only apply to users in the database server.</p> <p>Permissions are those which permits a user to perform operations on the system, like reading, writing or executing on a certain directory or start/stop a system service. They are set at a system level and only apply to system users.</p> <p>When xtrabackup is used, there are two actors involved: the user invoking the program - a system user - and the user performing action in the database server - a database user. Note that these are different users in different places, even though they may have the same username.</p> <p>All the invocations of xtrabackup in this documentation assume that the system user has the appropriate permissions, and you are providing the relevant options for connecting the database server - besides the options for the action to be performed - and the database user has adequate privileges.</p>"},{"location":"privileges.html#connect-to-the-server","title":"Connect to the server","text":"<p>The database user used to connect to the server and its password are specified by the <code>--user</code> and <code>--password</code> option:</p> <pre><code>$ xtrabackup --user=DVADER --password=14MY0URF4TH3R --backup \\\n--target-dir=/data/bkps/\n</code></pre> <p>If you don\u2019t use the <code>--user</code> option, Percona XtraBackup will assume the database user whose name is the system user executing it.</p>"},{"location":"privileges.html#other-connection-options","title":"Other connection options","text":"<p>According to your system, you may need to specify one or more of the following options to connect to the server:</p> Option Description -port Use this port when connecting to the database with TCP/IP -socket Use this socket when connecting to the local database. -host Use this host when connecting to the database server with TCP/IP <p>These options are passed to the mysql child process without alteration, see <code>mysql --help</code> for details.</p> <p>Note</p> <p>In case of multiple server instances, the correct connection parameters (port, socket, host) must be specified in order for xtrabackup to talk to the correct server.</p>"},{"location":"privileges.html#privileges-needed","title":"Privileges needed","text":"<p>Once connected to the server, in order to perform a backup you need <code>READ</code> and <code>EXECUTE</code> permissions at a filesystem level in the server\u2019s datadir.</p> <p>The database user needs the following privileges to back up tables or databases:</p> <ul> <li> <p><code>RELOAD</code> and <code>LOCK TABLES</code> (unless the <code>--no-lock</code> option is specified) in order to run <code>FLUSH TABLES WITH READ LOCK</code> and <code>FLUSH ENGINE LOGS</code> prior to start copying the files, and requires this privilege when Backup Locks are used</p> </li> <li> <p><code>BACKUP_ADMIN</code> privilege is needed to query the performance_schema.log_status table, and run <code>LOCK INSTANCE FOR BACKUP</code>, <code>LOCK BINLOG FOR BACKUP</code>, or <code>LOCK TABLES FOR BACKUP</code>.</p> </li> <li> <p><code>REPLICATION CLIENT</code> in order to obtain the binary log position,</p> </li> <li> <p><code>CREATE TABLESPACE</code> in order to import tables (see Restoring Individual Tables),</p> </li> <li> <p><code>PROCESS</code> in order to run <code>SHOW ENGINE INNODB STATUS</code> (which is mandatory), and optionally to see all threads which are running on the server (see FLUSH TABLES WITH READ LOCK option),</p> </li> <li> <p><code>SUPER</code> in order to start/stop the replication threads in a replication environment, use XtraDB Changed Page Tracking for Incremental Backups and for handling FLUSH TABLES WITH READ LOCK,</p> </li> <li> <p><code>CREATE</code> privilege in order to create the PERCONA_SCHEMA.xtrabackup_history database and table,</p> </li> <li> <p><code>ALTER</code> privilege in order to upgrade the PERCONA_SCHEMA.xtrabackup_history database and table,</p> </li> <li> <p><code>INSERT</code> privilege in order to add history records to the PERCONA_SCHEMA.xtrabackup_history table,</p> </li> <li> <p><code>SELECT</code> privilege in order to use <code>--incremental-history-name</code> or <code>--incremental-history-uuid</code> in order for the feature to look up the <code>innodb_to_lsn</code> values in the PERCONA_SCHEMA.xtrabackup_history table.</p> </li> <li> <p><code>SELECT</code> privilege on the keyring_component_status table to view the attributes and status of the installed keyring component when in use.</p> </li> <li> <p><code>SELECT</code> privilege on the replication_group_members table to validate if the instance is part of group replication cluster.</p> </li> </ul> <p>A SQL example of creating a database user with the minimum privileges required to take full backups would be:</p> <pre><code>mysql&gt; CREATE USER 'bkpuser'@'localhost' IDENTIFIED BY 's3cr%T';\nmysql&gt; GRANT BACKUP_ADMIN, PROCESS, RELOAD, LOCK TABLES, REPLICATION CLIENT ON *.* TO 'bkpuser'@'localhost';\nmysql&gt; GRANT SELECT ON performance_schema.log_status TO 'bkpuser'@'localhost';\nmysql&gt; GRANT SELECT ON performance_schema.keyring_component_status TO bkpuser@'localhost';\nmysql&gt; GRANT SELECT ON performance_schema.replication_group_members TO bkpuser@'localhost';\nmysql&gt; FLUSH PRIVILEGES;\n</code></pre>"},{"location":"privileges.html#query-the-privileges","title":"Query the privileges","text":"<p>To query the privileges that your database user has been granted at the console of the server execute:</p> <pre><code>mysql&gt; SHOW GRANTS;\n</code></pre> <p>or for a particular user with:</p> <pre><code>mysql&gt; SHOW GRANTS FOR 'db-user'@'host';\n</code></pre> <p>It will display the privileges using the same format as for the GRANT statement.</p> <p>Note that privileges may vary across versions of the server. To list the exact list of privileges that your server support (and a brief description of them) execute:</p> <pre><code>mysql&gt; SHOW PRIVILEGES;\n</code></pre> <p>See also</p> <p>Permissions needed</p> <p></p>"},{"location":"privileges.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-docker.html","title":"Start a Docker container and take a backup","text":"<p>Percona XtraBackup works in combination with a MySQL-compatible database, Percona Server for MySQL, in our scenario. To use Percona XtraBackup, run it in a separate Docker container and then connect the Percona XtraBackup container to the Percona Server for MySQL container. As soon as you start Percona Server for MySQL in a Docker container and create a database and table in Percona Server for MySQL, you are ready to backup your databes with Percona XtraBackup.</p> <p>The following steps create a Docker volume, start Percona XtraBackup in a Docker continer, take and prepare a backup of Percona Server for MySQL database.</p>"},{"location":"quickstart-docker.html#create-a-docker-volume","title":"Create a Docker volume","text":"<p>The benefits of using a Docker volume are the following:</p> <ul> <li> <p>You can keep your data safe and accessible across different containers. For example, if you want to upgrade your database image to a newer version, you can stop the old container and start a new one with the same volume attached without losing any data. </p> </li> <li> <p>You can quickly backup and restore your data using the <code>docker cp</code> command or mount the volume to another container.</p> </li> </ul> <pre><code>$ docker volume create backupvol\n</code></pre> Expected output <pre><code> backupvol\n</code></pre>"},{"location":"quickstart-docker.html#start-percona-xtrabackup-8034-in-a-container-take-and-prepare-a-backup","title":"Start Percona XtraBackup 8.0.34 in a container, take and prepare a backup","text":"<p>The <code>docker run</code> command creates and runs a new container from an image. The command modifies the container\u2019s behavior with options.</p> <p>In our example, the command has the following options:</p> Option Description <code>--name</code> Provides a name to the container. If you do not use this option, Docker adds a random name. <code>--volumes-from</code> Refers to Percona Server for MySQL and indicates that you intend to use the same data as the <code>psmysql</code> container. <code>it</code> Interacts with the container and be a pseudo-terminal. <code>--user root</code> Sets the user to root inside the Percona XtraBackup container. This option is required to access the MySQL data directory and run the xtrabackup command. <code>backup_8034</code> Indicates the directory inside the container where the backup files are stored. <code>-v</code> Mounts a volume from the host machine to volumes in another container that is being run. In our example, the <code>-v</code> option mounts a volume from the <code>psmysql</code> container to the <code>backupvol</code> volume on the host machine. <code>backupvol</code> Indicates the persistent storage for the database. <code>psmysql</code> Indicates the Percona Server for MySQL container. <code>--password</code> Prompts the user to enter the password for the root user. For convenience you can add the password for the root user to this option, for example, <code>--password=secret</code>. Then the password will be passed automaticaly when running the command. Note that if you specify the password with <code>--password=secret</code>, the password is visible in <code>docker ps</code>, <code>docker ps -a</code> (docker history) and regular ps command. <code>8.0.34</code> Use this tag to specify a specific version. Avoid using the <code>latest</code> tag.  In our example, we use the <code>8.0.34</code> tag. In Docker, a tag is a label assigned to an image and is used to maintain different versions of an image. <p>If you do not add a tag, Docker uses <code>latest</code> as the default tag and downloads the newest image from percona/percona-xtrabackup on the Docker Hub. This image can be in a different series or version from what you expect since the latest image changes over time. If you are using Percona XtraBackup version prior to 8.0.34, use tags to ensure that you use compatible versions of Percona Server for MySQL and Percona XtraBackup. </p> <p>Starting with Percona XtraBackup 8.0.35-31, you can run the Docker ARM64 version of Percona XtraBackup. Use the <code>8.0.35-31-aarch64</code> tag instead of <code>8.0.35-31</code>.</p>"},{"location":"quickstart-docker.html#connect-the-percona-xtrabackup-container-to-the-percona-server-container","title":"Connect the Percona XtraBackup container to the Percona Server container","text":"<p>We recommend using the <code>\u2013-user root</code> option in the Docker command.</p> <p>Run a Docker container example</p> <pre><code>$ docker run --name pxb --volumes-from psmysql -v backupvol:/backup_8034 -it --user root percona/percona-xtrabackup:8.0.34 /bin/bash -c \"xtrabackup --backup --datadir=/var/lib/mysql/ --target-dir=/backup_8034 --user=root --password; xtrabackup --prepare --target-dir=/backup_8034\"\n</code></pre> <p>You are prompted to enter the password. In our example, the password is <code>secret</code>.</p> <pre><code>2023-12-21T16:16:10.796716-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized server arguments: --datadir=/var/lib/mysql/2023-12-21T16:16:10.799979-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized client arguments: --backup=1 --target-dir=/backup_8034 --user=root --password\n\nEnter password:\n</code></pre> <p>In this example of expected output, we provide the first and last section of the backup log and use ellipses instead of the entire backup log.</p> Expected output <pre><code>2023-12-14T15:45:16.277503-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized server arguments: --datadir=/var/lib/mysql/ \n\n2023-12-14T15:45:16.280208-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized client arguments: --backup=1 --target-dir=/backup_80 --user=root --password=* \n\nxtrabackup version 8.0.34-29 based on MySQL server 8.0.34 Linux (x86_64) (revision id: 5ba706ee) \n\n2023-12-14T15:45:16.306670-00:00 0 [Note] [MY-011825] [Xtrabackup] perl binary not found. Skipping the version check \n\n2023-12-14T15:45:16.307026-00:00 0 [Note] [MY-011825] [Xtrabackup] Connecting to MySQL server host: localhost, user: root, password: set, port: not set, socket: not set \n\n2023-12-14T15:45:16.320214-00:00 0 [Note] [MY-011825] [Xtrabackup] Using server version 8.0.34-26 \n\n...\n\n2023-12-14T15:45:20.619892-00:00 0 [Note] [MY-011825] [Xtrabackup] completed OK! \n</code></pre> <p>The command runs a Docker container <code>pxb</code> from the <code>percona/percona-xtrabackup:8.0.34</code> image and mounts two volumes: one from another container named <code>psmysql</code>, which contains Percona Server data directory, and another named <code>backupvol</code>, which is where the backup files are stored. The command also sets the user to root and prompts the user to enter the password. </p> <p>The command then executes two steps: </p> <ul> <li> <p>Runs <code>xtrabackup</code> with the <code>--backup</code> option to copy the data files from <code>/var/lib/mysql/</code> to <code>/backup_8034</code></p> </li> <li> <p>Runs <code>xtrabackup</code> with the <code>--prepare</code> option to apply the log files and make the backup consistent and ready for restore</p> </li> </ul> <p>You can check the Xtrabackup logs with the <code>docker container logs &lt;container-name&gt;</code> command.</p> <p>For example:</p> <pre><code>$ docker container logs pxb\n</code></pre>"},{"location":"quickstart-docker.html#next-steps","title":"Next steps","text":"<p>Restore the backup </p> <p></p>"},{"location":"quickstart-docker.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-exit.html","title":"Clean up","text":"<p>In this document you\u2019ll learn how to:</p> <ul> <li> <p>Exit the MySQL command client shell and the Docker container</p> </li> <li> <p>Remove the Docker container and the Docker image</p> </li> <li> <p>Remove the Docker volume.</p> </li> </ul> <p>The steps are as follows:</p> <ol> <li> <p>To exit the MySQL command client shell in <code>psmysql2</code> container, we use <code>exit</code>. You can also use the <code>\\q</code> or <code>quit</code> commands. The execution of the statement also closes the connection.</p> <pre><code>mysql&gt; exit\n</code></pre> Expected output <pre><code>Bye\n</code></pre> </li> <li> <p>Remove docker containers and images, if you no longer need docker containers / images or want to free up disk space. To remove a docker container, use the command <code>docker rm</code> followed by the container name or the container ID. To remove a docker image, use the command <code>docker rmi</code> followed by the image ID or name and the tag. The example uses the <code>-f</code> option to force the removal.</p> <ul> <li> <p>Remove <code>psmysql2</code>, <code>psmysql</code> and <code>pxb</code> Docker containers:</p> <pre><code>$ docker container rm psmysql2 -f\n</code></pre> Expected output <pre><code>psmysql2\n</code></pre> <pre><code>$ docker container rm psmysql -f\n</code></pre> Expected output <pre><code>psmysql\n</code></pre> <pre><code>$ docker container rm pxb -f\n</code></pre> Expected output <pre><code>pxb\n</code></pre> </li> <li> <p>Remove <code>percona/percona-server:8.0.34</code> and <code>percona/percona-xtrabackup:8.0.34</code> Docker images</p> <pre><code>$ docker image rmi percona/percona-server:8.0.34\n</code></pre> Expected output <pre><code>Untagged: percona/percona-server:8.0.34\n</code></pre> <pre><code>$ docker image rmi percona/percona-xtrabackup:8.0.34\n</code></pre> Expected output <pre><code>Untagged: percona/percona-server:8.0.34\nUntagged: percona/percona-server@sha256:4944f9b365e0dc88f41b3b704ff2a02d1459fd07763d7d1a444b263db8498e1f\nDeleted: sha256:b2588da614b1f382468fc9f44600863e324067a9cae57c204a30a2105d61d9d9\nDeleted: sha256:1ceaa6dc89e328281b426854a3b00509b5df13826a9618a09e819a830b752ebd\nDeleted: sha256:77471692427a227eb16d06907357956c3bb43f0fdc3ecf6f8937e1acecae24fe\nDeleted: sha256:8db06cc7b0430437edc7f118b139d2195cb65e2e8025f9a4517d16778f615384\nDeleted: sha256:e5a57a2fafec4ab9482240f28927651d56545c19626e344aceb8be3704c3c397\nDeleted: sha256:f86198f39b893674d44d424c958f23183bf919d2ced20e1f519714d0972d75ed\nDeleted: sha256:db9672f7e12e374d5e9016b758a29d5444e8b0fd1246a6f1fc5c2b3c847dddcf\n</code></pre> </li> </ul> </li> <li> <p>Remove docker volume if a container does not use the volume, and you no longer need it</p> <p>Remove <code>backupvol</code> and <code>myvol2</code> Docker volumes:</p> <pre><code>$ docker volume rm backupvol\n</code></pre> Expected output <pre><code>backupvol\n</code></pre> <pre><code>$ docker volume rm myvol2\n</code></pre> Expected output <pre><code>myvol2\n</code></pre> </li> </ol>"},{"location":"quickstart-exit.html#next-step","title":"Next step","text":"<p>Next steps </p> <p></p>"},{"location":"quickstart-exit.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-next-steps.html","title":"Next steps","text":"<p>After taking your first backup with Percona Xtrabackup, it\u2019s high time to expand your knowledge and skills in using Percona Xtrabackup.</p> <p>Review the Percona Xtrabackup documentation for more information.</p>"},{"location":"quickstart-next-steps.html#learn-more-about-other-percona-products","title":"Learn more about other Percona products","text":""},{"location":"quickstart-next-steps.html#for-superior-and-optimized-performance","title":"For superior and optimized performance","text":"<p>Percona Server for MySQL (PS) is a freely available, fully compatible, enhanced, and open source drop-in replacement for any MySQL database. It provides superior and optimized performance, greater scalability and availability, enhanced backups, increased visibility, and instrumentation. Percona Server for MySQL is trusted by thousands of enterprises to provide better performance and concurrency for their most demanding workloads.</p> <p>Install Percona Server for MySQL.</p>"},{"location":"quickstart-next-steps.html#for-high-availability","title":"For high availability","text":"<p>Percona XtraDB Cluster (PXC) is a 100% open source, enterprise-grade, highly available clustering solution for MySQL multi-master setups based on Galera. PXC helps enterprises minimize unexpected downtime and data loss, reduce costs, and improve performance and scalability of your database environments supporting your critical business applications in the most demanding public, private, and hybrid cloud environments. </p> <p>Install Percona XtraDB Cluster.</p>"},{"location":"quickstart-next-steps.html#for-monitoring-and-management","title":"For Monitoring and Management","text":"<p>Percona Monitoring and Management (PMM) monitors and provides actionable performance data for MySQL variants, including Percona Server for MySQL, Percona XtraDB Cluster, Oracle MySQL Community Edition, Oracle MySQL Enterprise Edition, and MariaDB. PMM captures metrics and data for the InnoDB, XtraDB, and MyRocks storage engines, and has specialized dashboards for specific engine details.</p> <p>Install PMM and connect your MySQL instances to it.</p>"},{"location":"quickstart-next-steps.html#advanced-command-line-tools","title":"Advanced command-line tools","text":"<p>Percona Toolkit is a collection of advanced command-line tools used by the Percona support staff to perform a variety of MySQL, MongoDB, and system tasks that are complex or difficult to perform manually. These tools are ideal alternatives to \u201cone-off\u201d scripts because they are professionally developed, formally tested, and documented. Each tool is self-contained, so installation is quick and easy and does not install libraries.</p> <p>Percona Toolkit documentation</p> <p>Install PMM and connect your MySQL instances to it.</p> <p></p>"},{"location":"quickstart-next-steps.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-overview.html","title":"Overview","text":"<p>Percona XtraBackup is a 100% open source backup solution for all versions of Percona Server for MySQL and MySQL\u00ae that performs online non-blocking, tightly compressed, highly secure full backups on transactional systems.</p> <p>To start with Percona XtraBackup quickly, we recommend using Docker and this Quickstart guide focuses on this installation method. You can explore alternative installation options in the Install section.</p>"},{"location":"quickstart-overview.html#why-to-start-percona-xtrabackup-in-a-docker-container","title":"Why to start Percona XtraBackup in a Docker container","text":"<p>Docker containers are built from Docker images, which are snapshots of the configuration needed to run an applications, such as the code, and libraries. With Docker, you can build, deploy, run, update, and manage containers, which isolate applications from the host system. A Docker container lets you work with Percona XtraBackup without installing the product on a local drive.</p>"},{"location":"quickstart-overview.html#purpose-of-the-quickstart","title":"Purpose of the Quickstart","text":"<p>This section provides you with the basic steps to quiclky start Percona XtraBackup in a Docker continer, take a backup, prepare a backup and restore a backup of Percona Server for MySQL database.</p> <p>You are welcome to change the names of any items in commands. If you do, the results may vary from those we provide in this Quickstart guide.</p> <p>In this section, container refers to the Docker container and instance refers to the database server in the container.</p>"},{"location":"quickstart-overview.html#prerequisites","title":"Prerequisites","text":"<ul> <li>Install Docker on your system.</li> </ul> <p>To take a backup of Percona Server for MySQL, run Percona Server for MySQL in a Docker container and create a database, and a table.</p> <ul> <li>Start Percona Server in a Docker container</li> <li>Create a database and table in Percona Server</li> </ul>"},{"location":"quickstart-overview.html#limitations","title":"Limitations","text":"<p>Percona XtraBackup 8.0 does not support making backups of databases created in versions before the 8.0 series of MySQL, Percona Server for MySQL, or Percona XtraDB Cluster or versions greater than 8.0, such as the 8.1 Innovation release.</p>"},{"location":"quickstart-overview.html#supported-versions","title":"Supported versions","text":"<p>Check the latest list of all Supported versions.</p>"},{"location":"quickstart-overview.html#supported-servers","title":"Supported servers","text":"<p>Percona XtraBackup 8.0 can back up data stored on MySQL servers, Percona Server for MySQL, and Percona XtraDB Cluster.</p>"},{"location":"quickstart-overview.html#supported-storage-engines","title":"Supported storage engines","text":"<p>Percona XtraBackup 8.0 can back up data from InnoDB, XtraDB, MyISAM, and MyRocks tables.</p>"},{"location":"quickstart-overview.html#steps-to-perform","title":"Steps to perform","text":"<p>In this Quickstart, you will learn how to:</p> <ol> <li>Start a Docker container and take a backup</li> <li>Restore a backup</li> <li>Clean up</li> <li>Choose your next steps</li> </ol>"},{"location":"quickstart-overview.html#next-steps","title":"Next steps","text":"<p>Start a Docker container and take a backup </p> <p></p>"},{"location":"quickstart-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"quickstart-restore-backup.html","title":"Restore the backup","text":"<p>The following steps describe how to restore your backup to another Percona Server container and check whether the data is available.</p> <ol> <li> <p>Create another Docker volume</p> <pre><code>$ docker volume create myvol2\n</code></pre> Expected output <pre><code>myvol2\n</code></pre> </li> <li> <p>Run another Percona Server container to restore the backup to</p> Option Description <code>--name</code> Provides a name to the container. If you do not use this option, Docker adds a random name. <code>-d</code> Detaches the container. The container runs in the background. <code>-e</code> Adds an environmental variable. This example adds the  <code>MYSQL_ROOT_PASSWORD</code>  environment variable. The instance refuses to initialize if no environmental variable is added. Choose a more secure password, if needed. <code>myvol2</code> Indicates the persistent storage for the database. <code>8.0.34</code> Use this tag to specify a specific version. <p>You must provide at least one environment variable to access the database, such as <code>MYSQL_ROOT_PASSWORD</code>, <code>MYSQL_DATABASE</code>, <code>MYSQL_USER</code>, and <code>MYSQL_PASSWORD</code> or the instance refuses to initialize.</p> <p>For this document, we are using the <code>8.0.34</code> tag. In Docker, a tag is a label assigned to an image. Tags are used to maintain different versions of an image. If we did not add a tag, Docker uses <code>latest</code> as the default tag and downloads the latest image from [percona/percona-server on the Docker Hub].</p> <p>To use a Docker volume for persistent storage with a database, specify the path where the database stores its data inside the container, usually <code>/var/lib/mysql</code>.</p> <ul> <li> <p>Run a Docker container example</p> <pre><code>$ docker run -d -p 3307:3306 --name psmysql2 -e MYSQL_ROOT_PASSWORD=secret -v myvol2:/var/lib/mysql percona/percona-server:8.0.34\n</code></pre> </li> </ul> Expected output <pre><code>684464ce43d8880500f81abccb1e7440146a43f7d79c983a2a2a622b9a0d2080\n</code></pre> </li> <li> <p>Stop <code>psmysql2</code> container</p> <pre><code>$ docker stop psmysql2\n</code></pre> Expected output <pre><code>psmysql2\n</code></pre> </li> <li> <p>Remove all created files in <code>myvol2</code> to allow xtrabackup restore data to <code>myvol2</code></p> <p>The <code>--rm</code> option automatically removes the temporary container created from percona/percona-xtrabackup:8.0.34 image after the container exits. </p> <pre><code>$ docker run --volumes-from psmysql2 -v backupvol:/backup_8034 -it --rm --user root percona/percona-xtrabackup:8.0.34 /bin/bash -c \"rm -rf /var/lib/mysql/*\"\n</code></pre> <p>If the command executes successfully, the expected output is empty.</p> </li> <li> <p>Restore backup of <code>psmysql</code> from <code>backupvol</code> to a new <code>psmysql2</code> instance.</p> <pre><code>$ docker run --volumes-from psmysql2 -v backupvol:/backup_8034 -it --rm --user root percona/percona-xtrabackup:8.0.34 /bin/bash -c \"xtrabackup --copy-back --datadir=/var/lib/mysql/ --target-dir=/backup_8034\" \n</code></pre> Expected output <pre><code>2023-12-14T16:06:39.845762-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized server arguments: --datadir=/var/lib/mysql/ \n\n2023-12-14T16:06:39.848408-00:00 0 [Note] [MY-011825] [Xtrabackup] recognized client arguments: --copy-back=1 --target-dir=/backup_8034 \n\nxtrabackup version 8.0.34-29 based on MySQL server 8.0.34 Linux (x86_64) (revision id: 5ba706ee) \n\n2023-12-14T16:06:39.849053-00:00 0 [Note] [MY-011825] [Xtrabackup] cd to /backup_8034/ \n\n...\n\n2023-12-14T16:06:40.111577-00:00 1 [Note] [MY-011825] [Xtrabackup] Creating directory ./#innodb_redo \n\n2023-12-14T16:06:40.111603-00:00 1 [Note] [MY-011825] [Xtrabackup] Done: creating directory ./#innodb_redo \n\n2023-12-14T16:06:40.111634-00:00 1 [Note] [MY-011825] [Xtrabackup] Copying ./ibtmp1 to /var/lib/mysql/ibtmp1 \n\n2023-12-14T16:06:40.125971-00:00 1 [Note] [MY-011825] [Xtrabackup] Done: Copying ./ibtmp1 to /var/lib/mysql/ibtmp1 \n\n2023-12-14T16:06:40.144298-00:00 0 [Note] [MY-011825] [Xtrabackup] completed OK! \n</code></pre> <p>This command restores the backup files from the <code>backup_8034</code> volume to the <code>psmysql2</code> container. It uses the <code>percona/percona-xtrabackup:8.0.34</code> image to run a temporary container with root privileges. It executes the xtrabackup tool with the <code>--copy-back</code> option, which copies the files from the <code>backup_8034</code> volume to the /<code>var/lib/mysql/</code> directory in the <code>psmysql2</code> container. The command uses \u2013rm option to delete the temporary container after it exits.</p> </li> </ol>"},{"location":"quickstart-restore-backup.html#validate-the-backup","title":"Validate the backup","text":"<p>This section describes the backup validation steps assuming that you backed up <code>mydb</code> database with the <code>employees</code> table as we have in our example. The validation steps may vary depending on your data set.</p> <ol> <li> <p>Change the owner of the files in <code>myvol2</code> from <code>root</code> to <code>mysql</code></p> <p>To avoid permission issues when running <code>psmysql2</code> container, you need to change the owner because the files were restored by <code>root</code> user and <code>psmysql2</code> will use <code>mysql</code> user.</p> <pre><code>$ docker run --volumes-from psmysql2 -v backupvol:/backup_8034 -it --rm --user root percona/percona-xtrabackup:8.0.34 /bin/bash -c \"chown -R mysql:mysql /var/lib/mysql/\" \n</code></pre> <p>If the command executes successfully, the expected output is empty.</p> </li> <li> <p>Start the <code>psmysql2</code> container</p> <pre><code>$ docker start psmysql2\n</code></pre> Expected output <pre><code>psmysql2\n</code></pre> </li> <li> <p>Connect to the database instance.</p> <p>For this example, we have the following options:</p> Option Description <code>it</code> Interact with the container and be a pseudo-terminal <code>psmysql2</code> Running container name <code>mysql</code> Connects to a database instance <code>-u</code> Specifies the user account used to connect <code>-p</code> Use this password when connecting <ul> <li> <p>Connect to the database instance example</p> <pre><code>$ docker exec -it psmysql2 mysql -uroot -p\n</code></pre> <p>You are prompted to enter the password, which is <code>secret</code>.</p> <pre><code>Enter password:\n</code></pre> <p>You should see the following result.</p> Expected output <pre><code>Welcome to the MySQL monitor.  Commands end with ; or \\g. \n\nYour MySQL connection id is 31 \n\nServer version: 8.0.34-26 Percona Server (GPL), Release 26, Revision 0fe62c85 \n\nCopyright (c) 2009-2023 Percona LLC and/or its affiliates \n\nCopyright (c) 2000, 2023, Oracle and/or its affiliates. \n\nOracle is a registered trademark of Oracle Corporation and/or its \n\naffiliates. Other names may be trademarks of their respective owners. \n\nType 'help;' or '\\h' for help. Type '\\c' to clear the current input statement. \n</code></pre> </li> </ul> </li> <li> <p>Check the list of databases to make sure, the backed up, <code>mydb</code> database is in the list.</p> <pre><code>mysql&gt; show databases; \n</code></pre> Expected output <pre><code>+--------------------+ \n\n| Database           | \n\n+--------------------+ \n\n| information_schema | \n\n| mydb               | \n\n| mysql              | \n\n| performance_schema | \n\n| sys                | \n\n+--------------------+ \n\n5 rows in set (0.03 sec) \n</code></pre> </li> <li> <p>Use the <code>mydb</code> database.</p> <pre><code>mysql&gt; use mydb; \n</code></pre> Expected output <pre><code>Database changed\n</code></pre> </li> <li> <p>Check that your table contains data</p> <pre><code>mysql&gt; SELECT * FROM employees; \n</code></pre> Expected output <pre><code>+----+--------------------+-----------------------------------+-------------+ \n\n| id | name               | email                             | country     | \n\n+----+--------------------+-----------------------------------+-------------+ \n\n|  1 | Erasmus Richardson | posuere.cubilia.curae@outlook.net | England     | \n\n|  2 | Jenna French       | rhoncus.donec@hotmail.couk        | Canada      | \n\n|  3 | Alfred Dejesus     | interdum@aol.org                  | Austria     | \n\n|  4 | Hamilton Puckett   | dapibus.quam@outlook.com          | Canada      | \n\n|  5 | Michal Brzezinski  | magna@icloud.pl                   | Poland      | \n\n|  6 | Zofia Lis          | zofial00@hotmail.pl               | Poland      | \n\n|  7 | Aisha Yakubu       | ayakubu80@outlook.com             | Nigeria     | \n\n|  8 | Miguel Cardenas    | euismod@yahoo.com                 | Peru        | \n\n|  9 | Luke Jansen        | nibh@hotmail.edu                  | Netherlands | \n\n| 10 | Roger Pettersen    | nunc@protonmail.no                | Norway      | \n\n+----+--------------------+-----------------------------------+-------------+ \n\n10 rows in set (0.00 sec)\n</code></pre> </li> </ol>"},{"location":"quickstart-restore-backup.html#next-steps","title":"Next steps","text":"<p>Clean up </p> <p></p>"},{"location":"quickstart-restore-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"redo-log-archiving.html","title":"InnoDB redo log archiving","text":"<p>A physical backup contains raw copies of the database contents and any related files, such as configuration files or logs. During crash recovery, InnoDB corrects the data from incomplete transactions using the redo log. A redo log contains the entries necessary to bring the database back to a consistent state. An LSN value represents the data in the redo log.</p> <p>Data in the redo log is always appended, and the movement of the checkpoint truncates old data. When a file is full, a new file is created and the movement of the checkpoint truncates the old files. If the MySQL server has significant activity during a backup operation and the redo log file storage media operates faster than the backup storage media, the backup operation may fail to keep pace with the redo log generation and cause data loss.</p> <p>Before the redo log archiving feature, the solutions were:</p> <ul> <li> <p>Increasing the redo log size</p> </li> <li> <p>Checking for I/O congestion if the read speed is slow</p> </li> <li> <p>Checking for I/O or network congestion if the write speed is slow</p> </li> <li> <p>Taking the backup at an off-peak time</p> </li> </ul>"},{"location":"redo-log-archiving.html#redo-log-archiving","title":"redo log archiving","text":"<p>MySQL 8.0.17 added redo log archiving. To enable this feature, the following actions are required:</p> <ul> <li> <p>Create a directory for the archiving logs</p> </li> <li> <p>Call the function to start the archiving process</p> </li> </ul> <p>It would help if you created a directory for the redo log archives. The system user running <code>mysqld</code> must have access to this directory.</p> <p>You can verify if MySQL has configured the archive directory with the following command. The result provides the path or returns NULL, meaning you have not set the archiving directory.</p> <pre><code>$ mkdir -p /var/lib/mysql-redo-archive/backup1\n$ chown mysql. -R /var/lib/mysql-redo-archive\n$ chmod _R 700 /var/lib/mysql-redo-archive/\n</code></pre> <p>The <code>innodb_redo_log_archive_dirs</code> global variable contains labeled directories. The format is <code>label:directory-path</code>. Multiple objects can be listed with a semi-colon between each set.</p> <pre><code>mysql&gt; SET PERSIST innodb_redo_log_archive_dirs='backup1:/var/lib/mysql-redo-archive/';\n</code></pre> <p>Verify that the archive was created with the following command:</p> <pre><code>mysql&gt; SHOW GLOBAL VARIABLES LIKE 'innodb_redo_log_ar%';\n</code></pre> Expected output <pre><code>+------------------------------+--------------------------------------+\n| Variable_name                | Value                                |\n+------------------------------+--------------------------------------+\n| innodb_redo_log_archive_dirs | backup1:/var/lib/mysql-redo-archive/ |\n+------------------------------+--------------------------------------+\n1 row in set (0.0025 sec)\n</code></pre> <p>Users with the INNODB_REDO_LOG_ARCHIVE privilege can call the <code>innodb_redo_log_archive_start()</code> or <code>innodb_redo_log_archive_stop()</code> functions. to either start or stop archiving. </p> <pre><code>mysql&gt; SELECT innodb_redo_log_archive_start('backup1','backup1');\n</code></pre> Expected output <pre><code>+-----------------------------------------------------+\n| innodb_redo_log_archive_start('backup1','backup1')  |\n+------------------------------+----------------------+\n|                                                   0 |\n+------------------- ---------------------------------+\n1 row in set (0.00225 sec)\n</code></pre>"},{"location":"redo-log-archiving.html#percona-xtrabackup-and-redo-log-archiving","title":"Percona XtraBackup and redo log archiving","text":"<p>Percona XtraBackup 8.0.34-29 added the redo-log-arch-dir option. If the archiving directory is not configured in MySQL, Percona XtraBackup creates a temporary directory for the archive file. To use this option, you must run Percona XtraBackup as the same owner as <code>mysqld</code>. If Percona XtraBackup does not have the appropriate permissions, the action generates a \u201cPermission denied\u201d error, and archiving is not used.</p>"},{"location":"redo-log-archiving.html#example-of-reading-a-log","title":"Example of reading a log","text":"<pre><code>$ sudo -H -u mysql bash\n$ xtrabackup --no-lock=1 --compress --parallel=4 --host=localhost --user=root --password='password_string' --backup=1 --target-dir=/Backup/13oct 2&gt; /tmp/b0-with-redo-archiving-as-mysql-os-user.log\n</code></pre> <p>Verify that the archiving is used:</p> <pre><code>$ cat /tmp/b0-with-redo-archiving-as-mysql-os-user.log\n</code></pre> Expected output <pre><code>[Note] [MY-011825] [Xtrabackup] recognized server arguments: --datadir=/var/lib/mysql\u00a0 \n[Note] [MY-011825] [Xtrabackup] recognized client arguments: --no-lock=1 --compress --parallel=4 --host=localhost --user=root --password=* --backup=1 --target-dir=/Backup/22Aug\u00a0 xtrabackup version 8.0.34-29 based on MySQL server 8.0.34 Linux (x86_64) (revision id: 5ba706ee) 230822 13:36:02\u00a0 version_check Connecting to MySQL server with DSN 'dbi:mysql:;mysql_read_default_group=xtrabackup;host=localhost' as 'root'\u00a0 (using password: YES). 230822 13:36:02\u00a0 version_check Connected to MySQL server 230822 13:36:02\u00a0 version_check Executing a version check against the server... 230822 13:36:02\u00a0 version_check Done. \n[Note] [MY-011825] [Xtrabackup] Connecting to MySQL server host: localhost, user: root, password: set, port: not set, socket: not set \n[Note] [MY-011825] [Xtrabackup] Using server version 8.0.34 \n.... \n.... \n[Note] [MY-011825] [Xtrabackup] Connecting to MySQL server host: localhost, user: root, password: set, port: not set, socket: not set \n[Note] [MY-011825] [Xtrabackup] xtrabackup redo_log_arch_dir is set to backup1:/var/lib/mysql-redo-archive/ \n[Note] [MY-011825] [Xtrabackup] Waiting for archive file '/var/lib/mysql-redo-archive//1692711362986/archive.94f4ab58-3d1c-11ee-9e4f-0af1fd7c44c9.000001.log' \n[Note] [MY-011825] [Xtrabackup] &gt;&gt; log scanned up to (19630018) \n.... \n.... \n[Note] [MY-011825] [Xtrabackup] Done: Compressing file /Backup/22Aug/xtrabackup_info.zst \n[Note] [MY-011825] [Xtrabackup] Transaction log of lsn (19630018) to (19630028) was copied. \n[Note] [MY-011825] [Xtrabackup] completed OK!\n</code></pre> <p></p>"},{"location":"redo-log-archiving.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes.html","title":"Percona XtraBackup 8.0 release notes index","text":"<ul> <li> <p>Percona XtraBackup 8.0.35-31 Update (2024-09-20)</p> </li> <li> <p>Percona XtraBackup 8.0.35-31 (2024-06-20)</p> </li> <li> <p>Percona XtraBackup 8.0.35-30 (2023-12-04)</p> </li> <li> <p>Percona XtraBackup 8.0.34-29 (2023-08-21)</p> </li> <li> <p>Percona XtraBackup 8.0.33-28 (2023-07-19)</p> </li> <li> <p>Percona XtraBackup 8.0.33-27 (2023-05-25)</p> </li> <li> <p>Percona XtraBackup 8.0.32-26 (2023-04-04)</p> </li> <li> <p>Percona XtraBackup 8.0.32-25 (2023-02-27)</p> </li> <li> <p>Percona XtraBackup 8.0.31-24 (2023-02-07)</p> </li> <li> <p>Percona XtraBackup 8.0.30-23 (2022-11-14)</p> </li> <li> <p>Percona XtraBackup 8.0.29-22 (2022-07-19)</p> </li> <li> <p>Percona XtraBackup 8.0.28-21 (2022-05-25)</p> </li> <li> <p>Percona XtraBackup 8.0.28-20.0 (2022-04-26)</p> </li> <li> <p>Percona Xtrabackup 8.0.27-19.0 (2022-02-02)</p> </li> <li> <p>Percona XtraBackup 8.0.26-18.0 (2021-09-02)</p> </li> <li> <p>Percona Xtrabackup 8.0.25-17.0 (2021-06-03)</p> </li> <li> <p>Percona XtraBackup 8.0.23-16.0 (2021-03-22)</p> </li> <li> <p>Percona Xtrabackup 8.0.22-15.0 (2020-12-14)</p> </li> <li> <p>Percona XtraBackup 8.0.14 (2020-08-31)</p> </li> <li> <p>Percona Xtrabackup 8.0.13 (2020-06-17)</p> </li> <li> <p>Percona XtraBackup 8.0.12 (2020-05-27)</p> </li> <li> <p>Percona Xtrabackup 8.0.11 (2020-04-13)</p> </li> <li> <p>Percona XtraBackup 8.0.10 (2020-03-16)</p> </li> <li> <p>Percona Xtrabackup 8.0.9 (2019-12-16)</p> </li> <li> <p>Percona XtraBackup 8.0.8 (2019-11-21)</p> </li> <li> <p>Percona Xtrabackup 8.0.7 (2019-08-07)</p> </li> <li> <p>Percona Xtrabackup 8.0.6 (2019-05-09)</p> </li> <li> <p>Percona XtraBackup 8.0.5 (2019-03-04)</p> </li> <li> <p>Percona Xtrabackup 8.0.4 (2018-12-10)</p> </li> <li> <p>Percona XtraBackup 8.0-3-rc1 (2018-10-31)</p> </li> </ul> <p></p>"},{"location":"release-notes.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"restore-a-backup.html","title":"Restore a backup","text":"<p>Warning</p> <p>Backup needs to be prepared before it can be restored.</p> <p>For convenience, xtrabackup binary has the <code>--copy-back</code> option to copy the backup to the datadir of the server:</p> <pre><code>$ xtrabackup --copy-back --target-dir=/data/backups/\n</code></pre> <p>If you don\u2019t want to save your backup, you can use the <code>--move-back</code> option which will move the backed up data to the datadir.</p> <p>If you don\u2019t want to use any of the above options, you can additionally use rsync or cp to restore the files.</p> <p>Note</p> <p>The datadir must be empty before restoring the backup. Also, it\u2019s important to note that MySQL server needs to be shut down before restore is performed. You cannot restore to a datadir of a running mysqld instance (except when importing a partial backup).</p> <p>Example of the rsync command that can be used to restore the backup can look like this:</p> <pre><code>$ rsync -avrP /data/backup/ /var/lib/mysql/\n</code></pre> <p>You should check that the restored files have the correct ownership and permissions.</p> <p>As files\u2019 attributes will be preserved, in most cases you will need to change the files\u2019 ownership to <code>mysql</code> before starting the database server, as they will be owned by the user who created the backup:</p> <pre><code>$ chown -R mysql:mysql /var/lib/mysql\n</code></pre> <p>Data is now restored, and you can start the server.</p> <p></p>"},{"location":"restore-a-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"restore-individual-partitions.html","title":"Restore the partition from the backup","text":"<p>Restoring should be done by importing the tables in the partial backup to the server.</p> <p>First step is to create new table in which data will be restored.</p> <pre><code>mysql&gt; CREATE TABLE `name_p4` (\n`id` int(11) NOT NULL AUTO_INCREMENT,\n`name` text NOT NULL,\n`imdb_index` varchar(12) DEFAULT NULL,\n`imdb_id` int(11) DEFAULT NULL,\n`name_pcode_cf` varchar(5) DEFAULT NULL,\n`name_pcode_nf` varchar(5) DEFAULT NULL,\n`surname_pcode` varchar(5) DEFAULT NULL,\nPRIMARY KEY (`id`)\n) ENGINE=InnoDB AUTO_INCREMENT=2812744 DEFAULT CHARSET=utf8\n</code></pre> <p>Note</p> <p>Generate a .cfg metadata file by running <code>FLUSH TABLES ... FOR EXPORT</code>. The command can only be run on a table, not on the individual table partitions. The file is located in the table schema directory and is used for schema verification when importing the tablespace. </p> <p>To restore the partition from the backup, the tablespace must be discarded for that table:</p> <pre><code>mysql&gt; ALTER TABLE name_p4 DISCARD TABLESPACE;\n</code></pre> <p>The next step is to copy the <code>.ibd</code> file from the backup to the MySQL data directory:</p> <pre><code>cp /mnt/backup/2012-08-28_10-29-09/imdb/name#P#p4.ibd /var/lib/mysql/imdb/name_p4.ibd\n</code></pre> <p>Note</p> <p>Make sure that the copied files can be accessed by the user running MySQL. </p> <p>The last step is to import the tablespace:</p> <pre><code>mysql&gt; ALTER TABLE name_p4 IMPORT TABLESPACE;\n</code></pre> <p></p>"},{"location":"restore-individual-partitions.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"restore-individual-tables.html","title":"Restore individual tables","text":"<p>Percona XtraBackup can export individual tables from any InnoDB database, if they are individual <code>.ibd</code> files, and import them into Percona Server for MySQL with XtraDB or MySQL 8.0. The source doesn\u2019t have to be XtraDB or MySQL 8.0, but the destination must be.</p> <p>The example exports and imports the following table:</p> <pre><code>CREATE TABLE export_test (\na int(11) DEFAULT NULL\n) ENGINE=InnoDB DEFAULT CHARSET=latin1;\n</code></pre>"},{"location":"restore-individual-tables.html#export-the-table","title":"Export the table","text":"<p>To generate an <code>.ibd</code> file in the target directory, create the table using the <code>innodb_file_per_table</code> mode:</p> <pre><code>$ find /data/backups/mysql/ -name export_test.*\n/data/backups/mysql/test/export_test.ibd\n</code></pre> <p>During the <code>--prepare</code> step, add the \u2013export option to the command. For example:</p> <pre><code>$ xtrabackup --prepare --export --target-dir=/data/backups/mysql/\n</code></pre> <p>When restoring an encrypted InnoDB tablespace table, add the keyring file:</p> <pre><code>$ xtrabackup --prepare --export --target-dir=/tmp/table \\\n--keyring-file-data=/var/lib/mysql-keyring/keyring\n</code></pre> <p>The following files are the only files required to import the table into a server running Percona Server for MySQL with XtraDB or MySQL 8.0. If the server uses InnoDB Tablespace Encryption, add the <code>.cfp</code> file, which contains the transfer key and an encrypted tablespace key.</p> <p>The files are located in the target directory:</p> <pre><code>/data/backups/mysql/test/export_test.ibd\n/data/backups/mysql/test/export_test.cfg\n</code></pre>"},{"location":"restore-individual-tables.html#import-the-table","title":"Import the table","text":"<p>Import the table by doing the following:</p> <ul> <li>Create a copy of the table</li> <li>Discard the table\u2019s original tablespace</li> <li>Copy the <code>.ibd</code> and <code>.cfg</code> files to the location</li> <li>Import the tablespace</li> </ul> <p>To import that table, do the following steps:</p> <ol> <li> <p>On the destination server, running Percona Server for MySQL with XtraDB or MySQL 8.0, create a table with the same structure.</p> </li> <li> <p>Run the <code>ALTER TABLE ... DISCARD TABLESPACE</code> command to discard the new table\u2019s tablespace:</p> <pre><code>mysql&gt; ALTER TABLE test.export_test DISCARD TABLESPACE;\n</code></pre> <p>If you see the an error message like \u201cERROR 1809 (HY000): Table \u2018test/export_test\u2019 in system tablespace\u201d, enable the <code>innodb_file_per_table</code> option on the server and do step 1 and 2 again.</p> </li> <li> <p>Copy the exported files to the <code>test/</code> subdirectory of the destination server\u2019s data directory.</p> </li> <li> <p>Run <code>ALTER TABLE ... IMPORT TABLESPACE</code>.</p> <pre><code>mysql&gt; ALTER TABLE test.export_test IMPORT TABLESPACE;\n</code></pre> <p>The table is imported, and you can run a <code>SELECT</code> to see the imported data.</p> </li> </ol> <p></p>"},{"location":"restore-individual-tables.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"restore-partial-backup.html","title":"Restore a partial backup","text":"<p>Restoring should be done by restoring individual tables in the partial backup to the server.</p> <p>It can also be done by copying back the prepared backup to a \u201cclean\u201d datadir (in that case, make sure to include the <code>mysql</code> database) to the datadir you are moving the backup to. A system database can be created with the following:</p> <pre><code>$ sudo mysql --initialize --user=mysql\n</code></pre> <p>Once you start the server, you may see mysql complaining about missing tablespaces:</p> Expected output <pre><code>2021-07-19T12:42:11.077200Z 1 [Warning] [MY-012351] [InnoDB] Tablespace 4, name 'test1/t1', file './d2/test1.ibd' is missing!\n2021-07-19T12:42:11.077300Z 1 [Warning] [MY-012351] [InnoDB] Tablespace 4, name 'test1/t1', file './d2/test1.ibd' is missing!\n</code></pre> <p>In order to clean the orphan database from the data dictionary, you must manually create the missing database directory and then <code>DROP</code> this database from the server.</p> <p>Example of creating the missing database:</p> <pre><code>$ mkdir /var/lib/mysql/test1/d2\n</code></pre> <p>Example of dropping the database from the server:</p> <pre><code>mysql&gt; DROP DATABASE d2;\n</code></pre> Expected output <pre><code>Query OK, 2 rows affected (0.5 sec)\n</code></pre> <p></p>"},{"location":"restore-partial-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"server-backup-version-comparison.html","title":"Percona XtraBackup Version Compatibility and Server Version Checks","text":"<p>When the server undergoes internal changes, such as modifying the structure of the redo log records, older versions of Percona XtraBackup may either fail or produce corrupted backups. To prevent these issues, XtraBackup checks the version of the source system before starting the backup and compares it to the Percona XtraBackup version.</p> <p>Here are the possible scenarios and the actions taken:</p> Scenario Actions Taken Server version is the same as Percona XtraBackup version The backup process continues without any issues. This is the ideal scenario because both the server and the backup tool are fully compatible. Server version is older than Percona XtraBackup version The backup process continues without any issues. Percona XtraBackup is designed to handle older versions of the server without problems. Server version is newer than Percona XtraBackup version The backup process stops with an error unless you explicitly override the version check. This happens because the backup tool may not support new features or changes introduced in the newer server version. Server version is newer than Percona XtraBackup version, and the version check is overridden The backup process continues, but there is a risk of failure or corruption. Overriding the version check can be risky because the backup tool might not be able to handle new features or changes correctly. <p>Until version 8.0.34, to ensure successful backups and restores, it is recommended to use a Percona XtraBackup version that matches or is newer than your server version. However, version 8.0.34 can back up newer server versions and older server versions if you set the <code>lock-ddl=ON</code> option.</p>"},{"location":"server-backup-version-comparison.html#version-updates","title":"Version updates","text":"<p>Percona XtraBackup 8.0.34: disabled the server-version-check.</p> <p>Percona XtraBackup 8.0.22-15: introduced <code>--no-server-version-check</code>. This option allows you to override the version comparison process. This option is off by default, meaning the comparison occurs unless explicitly overridden.</p>"},{"location":"server-backup-version-comparison.html#override-server-version-check","title":"Override Server Version check","text":"<p>You can add the <code>--no-server-version-check</code> option to your backup command to override the server version check and proceed with the backup. Here\u2019s an example of how to use this option:</p> <pre><code>$ xtrabackup --backup --no-server-version-check --target-dir=$mysql/backup1\n</code></pre>"},{"location":"server-backup-version-comparison.html#additional-resources","title":"Additional resources","text":"<p>For more details, refer to the documentation on How XtraBackup Works.</p> <p>For more information, refer to Supported versions.</p> <p></p>"},{"location":"server-backup-version-comparison.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"set-up-replication.html","title":"How to set up a replica for replication in 6 simple steps with Percona XtraBackup","text":"<p>Data is, by far, the most valuable part of a system. Having a backup done systematically and available for a rapid recovery in case of failure is admittedly essential to a system. However, it is not common practice because of its costs, infrastructure needed or even the boredom associated to the task. Percona XtraBackup is designed to solve this problem.</p> <p>You can have almost real-time backups in 6 simple steps by setting up a replication environment with Percona XtraBackup.</p>"},{"location":"set-up-replication.html#all-the-things-you-will-need","title":"All the things you will need","text":"<p>Setting up a replica for replication with Percona XtraBackup is a straightforward procedure. In order to keep it simple, here is a list of the things you need to follow the steps without hassles:</p> <p><code>Source</code></p> <p>A system with a MySQL-based server installed, configured and running. This system will be called <code>Source</code>, as it is where your data is stored and the one to be replicated. We will assume the following about this system:</p> <ul> <li> <p>the MySQL server is able to communicate with others by the standard TCP/IP port;</p> </li> <li> <p>the SSH server is installed and configured;</p> </li> <li> <p>you have a user account in the system with the appropriate permissions;</p> </li> <li> <p>you have a MySQL\u2019s user account with appropriate privileges.</p> </li> <li> <p>server has binlogs enabled and server-id set up to 1.</p> </li> </ul> <p><code>Replica</code></p> <p>Another system, with a MySQL-based server installed on it. We will refer to this machine as <code>Replica</code> and we will assume the same things we did about <code>Source</code>, except that the server-id on <code>Replica</code> is 2.</p> <p><code>Percona XtraBackup</code></p> <p>The backup tool we will use. It should be installed in both computers for convenience.</p> <p>Note</p> <p>It is not recommended to mix MySQL variants (Percona Server, MySQL) in your replication setup. This may produce incorrect <code>xtrabackup_slave_info</code> file when adding a new replica. </p>"},{"location":"set-up-replication.html#version-updates","title":"Version updates","text":"<p>The 8.0.23 version deprecates the <code>CHANGE_MASTER_TO</code> command. In that  version and later, use the CHANGE_REPLICATION_SOURCE_TO and the appropriate options instead.</p> <p>The 8.0.22 version deprecates the<code>START SLAVE</code> command. In that version or  later, use <code>START REPLICA</code> instead.</p>"},{"location":"set-up-replication.html#1-make-a-backup-on-the-source-and-prepare-it","title":"1. Make a backup on the <code>Source</code> and prepare it","text":"<p>At the  <code>Source</code>, issue the following to a shell:</p> <pre><code>$ xtrabackup --backup --user=yourDBuser --password=MaGiCdB1 --target-dir=/path/to/backupdir\n</code></pre> <p>After this is finished you should get:</p> Expected output <pre><code>xtrabackup: completed OK!\n</code></pre> <p>This will make a copy of your MySQL data dir to the <code>/path/to/backupdir</code> directory. You have told Percona XtraBackup to connect to the database server using your database user and password, and do a hot backup of all your data in it (all MyISAM, InnoDB tables and indexes in them).</p> <p>In order for snapshot to be consistent you need to prepare the data on the source:</p> <pre><code>$ xtrabackup --prepare --target-dir=/path/to/backupdir\n</code></pre> <p>You need to select path where your snapshot has been taken. If everything is ok you should get the same OK message. Now the transaction logs are applied to the data files, and new ones are created: your data files are ready to be used by the MySQL server.</p> <p>Percona XtraBackup knows where your data is by reading your my.cnf file. If you have your configuration file in a non-standard place, you should use the flag <code>--defaults-file</code> <code>=/location/of/my.cnf</code>.</p> <p>If you want to skip writing the username and password every time you want to access MySQL, you can set it up in <code>.mylogin.cnf</code> as follows:</p> <pre><code>mysql_config_editor set --login-path=client --host=localhost --user=root --password\n</code></pre> <p>For more information, see MySQL Configuration Utility.</p> <p>This statement provides root access to MySQL.</p>"},{"location":"set-up-replication.html#2-copy-backed-up-data-to-the-replica","title":"2.  Copy backed up data to the Replica","text":"<p>On the Source, use rsync or scp to copy the data from the Source to the Replica. If you are syncing the data directly to replica\u2019s data directory, we recommend that you stop the <code>mysqld</code> there.</p> <pre><code>$ rsync -avpP -e ssh /path/to/backupdir Replica:/path/to/mysql/\n</code></pre> <p>After data has been copied, you can back up the original or previously installed MySQL datadir (NOTE: Make sure mysqld is shut down before you move the contents of its datadir, or move the snapshot into its datadir.). Run the following commands on the Replica:</p> <pre><code>$ mv /path/to/mysql/datadir /path/to/mysql/datadir_bak\n</code></pre> <p>and move the snapshot from the <code>Source</code> in its place:</p> <pre><code>$ xtrabackup --move-back --target-dir=/path/to/mysql/backupdir\n</code></pre> <p>After you copy data over, make sure the Replica MySQL has the proper permissions to access them.</p> <pre><code>$ chown mysql:mysql /path/to/mysql/datadir\n</code></pre> <p>If the ibdata and iblog files are located in directories outside the datadir, you must put these files in their proper place after the logs have been applied.</p>"},{"location":"set-up-replication.html#3-configure-the-sources-mysql-server","title":"3. Configure the Source\u2019s MySQL server","text":"<p>On the source, run the following command to add the appropriate grant. This grant allows the replica to be able to connect to source:</p> <pre><code>mysql&gt; GRANT REPLICATION SLAVE ON *.*  TO 'repl'@'$replicaip'\nIDENTIFIED BY '$replicapass';\n</code></pre> <p>Also make sure that firewall rules are correct and that the <code>Replica</code> can connect to the <code>Source</code>. Run the following command on the Replica to test that you can run the mysql client on <code>Replica</code>, connect to the <code>Source</code>, and authenticate.</p> <pre><code>mysql&gt; mysql --host=Source --user=repl --password=$replicapass\n</code></pre> <p>Verify the privileges.</p> <pre><code>mysql&gt; SHOW GRANTS;\n</code></pre>"},{"location":"set-up-replication.html#4-configure-the-replicas-mysql-server","title":"4. Configure the Replica\u2019s MySQL server","text":"<p>Copy the <code>my.cnf</code> file from the <code>Source</code> to the <code>Replica</code>:</p> <pre><code>$ scp user@Source:/etc/mysql/my.cnf /etc/mysql/my.cnf\n</code></pre> <p>and change the following options in /etc/mysql/my.cnf:</p> <pre><code>server-id=2\n</code></pre> <p>and start/restart mysqld on the <code>Replica</code>.</p> <p>In case you\u2019re using init script on Debian-based system to start mysqld, be sure that the password for <code>debian-sys-maint</code> user has been updated, and it\u2019s the same as that user\u2019s password on the <code>Source</code>. Password can be seen and updated in <code>/etc/mysql/debian.cnf</code>.</p>"},{"location":"set-up-replication.html#5-start-the-replication","title":"5. Start the replication","text":"<p>On the <code>Replica</code>, review the content of the file <code>xtrabackup_binlog_info</code>, it will be something like:</p> <pre><code>$ cat /var/lib/mysql/xtrabackup_binlog_info\n</code></pre> <p>The results should resemble the following:</p> Expected output <pre><code>Source-bin.000001     481\n</code></pre> <p>The term <code>master</code> is deprecated. Do the following on a  MySQL console and use the username and password you\u2019ve set up in STEP 3 :</p> <ul> <li> <p>Version 8.0.23 or later, use the <code>CHANGE_REPLICATION_SOURCE_TO</code> statement</p> </li> <li> <p>Before 8.0.23, use the <code>CHANGE MASTER</code> statement</p> </li> </ul> <pre><code>CHANGE REPLICATION SOURCE TO\n    SOURCE_HOST='$sourceip',\n    SOURCE_USER='repl',\n    SOURCE_PASSWORD='$replicapass',\n    SOURCE_LOG_FILE='Source-bin.000001',\n    SOURCE_LOG_POS=481;\n</code></pre> <p>Start the replica:</p> <pre><code>START REPLICA;\n</code></pre> <p>The term <code>slave</code> is deprecated. Do the following:</p> <ul> <li>Version 8.0.22 or later, use <code>START REPLICA</code></li> <li>Before version 8.0.22, use <code>START SLAVE</code></li> </ul>"},{"location":"set-up-replication.html#6-check","title":"6. Check","text":"<p>On the <code>Replica</code>, check that everything went OK with:</p> <pre><code>SHOW REPLICA STATUS\\G\n</code></pre> <p>The result shows the status:</p> Expected output <pre><code>Slave_IO_Running: Yes\nSlave_SQL_Running: Yes\nSeconds_Behind_Master: 13\n</code></pre> <p>Both <code>IO</code> and <code>SQL</code> threads need to be running. The <code>Seconds_Behind_Master</code> means the <code>SQL</code> currently being executed has a <code>current_timestamp</code> of 13 seconds ago. It is an estimation of the lag between the <code>Source</code> and the <code>Replica</code>. Note that at the beginning, a high value could be shown because the <code>Replica</code> has to \u201ccatch up\u201d with the <code>Source</code>.</p>"},{"location":"set-up-replication.html#adding-more-replicas-to-the-source","title":"Adding more replicas to the Source","text":"<p>You can use this procedure with slight variation to add new replicas to a source. We will use Percona XtraBackup to clone an already configured replica. We will continue using the previous scenario for convenience, but we will add a <code>NewReplica</code> to the plot.</p> <p>At the <code>Replica</code>, do a full backup:</p> <pre><code>$ xtrabackup --user=yourDBuser --password=MaGiCiGaM \\\n   --backup --slave-info --target-dir=/path/to/backupdir\n</code></pre> <p>By using the <code>--slave-info</code> Percona XtraBackup creates additional file called <code>xtrabackup_slave_info</code>.</p> <p>Apply the logs:</p> <pre><code>$ xtrabackup --prepare --use-memory=2G --target-dir=/path/to/backupdir/\n</code></pre> <p>Note</p> <p>In the <code>prepare</code> phase, the <code>--use-memory</code> parameter speeds up the process if the amount of RAM assigned to the option is available. Use the parameter only in the <code>prepare</code> phase. In the other phases the parameter makes the application lazy allocate this memory (reserve) but does not affect database pages.</p> <p>Copy the directory from the <code>Replica</code> to the <code>NewReplica</code> (NOTE: Make sure mysqld is shut down on the <code>NewReplica</code> before you copy the contents the snapshot into its datadir.):</p> <pre><code>rsync -avprP -e ssh /path/to/backupdir NewReplica:/path/to/mysql/datadir\n</code></pre> <p>For example, to set up a new user, <code>user2</code>, you add another grant on the Source:</p> <pre><code>&gt; GRANT REPLICATION SLAVE ON *.*  TO 'user2'@'$newreplicaip'\n IDENTIFIED BY '$replicapass';\n</code></pre> <p>On the <code>NewReplica</code>, copy the configuration file from the <code>Replica</code>:</p> <pre><code>$ scp user@Replica:/etc/mysql/my.cnf /etc/mysql/my.cnf\n</code></pre> <p>Make sure you change the server-id variable in <code>/etc/mysql/my.cnf</code> to 3 and disable the replication on start:</p> <pre><code>skip-slave-start\nserver-id=3\n</code></pre> <p>After setting <code>server_id</code>, start mysqld.</p> <p>Fetch the master_log_file and master_log_pos from the file <code>xtrabackup_slave_info</code>, execute the statement for setting up the source and the log file for the NewReplica:</p> <pre><code>&gt; CHANGE MASTER TO\n     MASTER_HOST='$Sourceip',\n     MASTER_USER='repl',\n     MASTER_PASSWORD='$replicapass',\n     MASTER_LOG_FILE='Source-bin.000001',\n     MASTER_LOG_POS=481;\n</code></pre> <p>The term <code>master</code> is deprecated. Do the following  and then start the replica:</p> <ul> <li> <p>Version 8.0.23 or later, use the <code>CHANGE_REPLICATION_SOURCE_TO</code> statement</p> </li> <li> <p>Before 8.0.23, use the <code>CHANGE MASTER</code> statement</p> </li> </ul> <p>The term <code>slave</code> is deprecated. Do the following:</p> <ul> <li>Version 8.0.22 or later, use <code>START REPLICA</code>.</li> <li>Before version 8.0.22, use <code>START SLAVE</code></li> </ul> <pre><code>&gt; START REPLICA;\n</code></pre> <p>If both IO and SQL threads are running when you check the <code>NewReplica</code>, server is replicating the <code>Source</code>.</p> <p>See also</p> <p>How to create a new (or repair a broken) GTID based slave</p> <p></p>"},{"location":"set-up-replication.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"smart-memory-estimation.html","title":"Smart memory estimation","text":"<p>The Smart memory estimation is tech preview feature. Before using Smart memory estimation in production, we recommend that you test restoring production from physical backups in your environment and also use the alternative backup method for redundancy.</p> <p>Percona XtraBackup 8.0.30-23 adds support for the Smart memory estimation feature. With this feature, Percona XtraBackup computes the memory required for <code>prepare</code> phase, while copying redo log entries during the <code>backup</code> phase. Percona XtraBackup also considers the number of InnoDB pages to be fetched from the disk.  </p> <p>Percona XtraBackup performs the backup procedure in two steps: </p> <ul> <li> <p>Creates a backup</p> <p>To create a backup, Percona XtraBackup copies your InnoDB data files. While copying the files, Percona XtraBackup runs a background process that watches the InnoDB redo log, also called the transaction log, and copies changes from it. </p> </li> <li> <p>Prepares a backup</p> <p>During the <code>prepare</code> phase, Percona XtraBackup performs crash recovery against the copied data files using the copied transaction log file. Percona XtraBackup reads all the redo log entries into memory, categorizes them by space id and page id, reads the relevant pages into memory, and checks the log sequence number (LSN) on the page and on the redo log record. If the redo log LSN is more recent than the page LSN, Percona XtraBackup applies the redo log changes to the page.</p> <p>To <code>prepare</code> a backup, Percona Xtrabackup uses InnoDB Buffer Pool memory. Percona Xtrabackup reserves memory to load 256 pages into the buffer pool. The remaining memory is used for hashing/categorizing the redo log entries.</p> <p>The available memory is controlled by the \u2013use-memory option. If the available memory on the buffer pool is insufficient, the work is performed in multiple batches. After the batch is processed, the memory is freed to release space for the next batch. This process greatly impacts performance as an InnoDB page holds data from multiple rows. If a change on a page happens in different batches, that page is fetched and evicted numerous times.</p> </li> </ul>"},{"location":"smart-memory-estimation.html#how-does-smart-memory-estimation-work","title":"How does Smart memory estimation work","text":"<p>In the <code>prepare</code> phase, Percona XtraBackup checks the server\u2019s available free memory and uses that memory up to the limit specified in the <code>--use-free-memory-pct</code> option to run <code>--prepare</code>. Due to backward compatibility, the default value for the <code>--use-free-memory-pct</code> option is 0 (zero), which defines the option as disabled. For example, if you set <code>--use-free-memory-pct=50</code>, then 50% of the free memory is used to <code>prepare</code> a backup.</p> <p>Starting with Percona XtraBackup 8.0.32-26, you can enable or disable the memory estimation during the <code>backup</code> phase with the <code>--estimate-memory</code> option. The default value is <code>OFF</code>. Enable the memory estimation with  <code>--estimate-memory=ON</code>:</p> <pre><code>$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/\n</code></pre> <p>In the <code>prepare</code> phase, enable the \u2013use-free-memory-pct option by specifying the percentage of free memory to be used to <code>prepare</code> a backup. The \u2013use-free-memory-pct value must be larger than 0.</p> <p>For example:</p> <pre><code>$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/\n</code></pre>"},{"location":"smart-memory-estimation.html#example-of-smart-memory-estimation-usage","title":"Example of Smart memory estimation usage","text":"<p>The examples of how Smart memory estimation can improve the time spent on <code>prepare</code> in different versions of Percona XtraBackup:</p> In Percona XtraBackup 8.0.32-26 and higherIn Percona XtraBackup 8.0.30-23 and higher <p>We back up 16, 32, and 64 tables using sysbench. Each set contains 1M rows. In the <code>backup</code> phase, we enable Smart memory estimation with <code>--estimate-memory=ON</code>. In the <code>prepare</code> phase, we set <code>--use-free-memory-pct=50</code>, and Percona XtraBackup uses 50% of the free memory to prepare a backup. The backup is run on an ec2 c4.8xlarge instance (36 vCPUs / 60GB memory / General Purpose SSD (gp2)). </p> <p>We back up 16, 32, and 64 tables using sysbench. Each set contains 1M rows. In the <code>prepare</code> phase, we set <code>--use-free-memory-pct=50</code>, and Percona XtraBackup uses 50% of the free memory to prepare a backup. The backup is run on an ec2 c4.8xlarge instance (36 vCPUs / 60GB memory / General Purpose SSD (gp2)). </p> <p>During each <code>--backup</code>, the following sysbench is run:</p> <pre><code>sysbench --db-driver=mysql --db-ps-mode=disable --mysql-user=sysbench --mysql-password=sysbench --table_size=1000000 --tables=${NUM_OF_TABLES} --threads=24 --time=0 --report-interval=1 /usr/share/sysbench/oltp_write_only.lua run\n</code></pre> <p>The following table shows the backup details (all measurements are in Gigabytes):</p> Used memory Size of XtraBackup log Size of backup 16 tables 3.375 0.7 4.7 32 tables 8.625 2.6 11 64 tables 18.5 5.6 22 <ul> <li> <p>Used memory - the amount of memory required by Percona XtraBackup with <code>--use-free-memory-pct=50</code></p> </li> <li> <p>Size of XtraBackup log - the size of Percona XtraBackup log file (redo log entries copied during the backup)</p> </li> <li> <p>Size of backup - the size of the resulting backup folder</p> </li> </ul> <p><code>Prepare</code> executed without Smart memory estimation uses the default of 128MB for the buffer pool.</p> <p>The results are the following:</p> <p>Note</p> <p>The following results are based on tests in a specific environment. Your results may vary.</p> <p></p> <ul> <li> <p>16 tables result - prepare time dropped to ~5.7% of the original time. An improvement in recovery time of about 17x.</p> </li> <li> <p>32 tables result - prepare time dropped to ~8,2% of the original time. An improvement in recovery time of about 12x.</p> </li> <li> <p>64 tables result - prepare time dropped to ~9.9% of the original time. An improvement in recovery time of about 10x.</p> </li> </ul> <p></p>"},{"location":"smart-memory-estimation.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"store-backup-history.html","title":"Store backup history on the server","text":"<p>Percona XtraBackup supports storing the backups history on the server to provide users with additional information about backups that are being taken. Backup history information is in the PERCONA_SCHEMA.XTRABACKUP_HISTORY table.</p> <p>To use this feature the following options are available:</p> <ul> <li> <p>\u2013history = &lt;name&gt; : This option enables the history feature and allows the user to specify a backup series name that will be placed within the history record.</p> </li> <li> <p>\u2013incremental-history-name =&lt;name&gt; : This option allows an incremental backup to be made based on a specific history series by name. xtrabackup will search the history table looking for the most recent (highest <code>to_lsn</code>) backup in the series and take the <code>to_lsn</code> value to use as it\u2019s starting lsn. This is mutually exclusive with \u2013incremental-history-uuid, \u2013incremental-basedir and \u2013incremental-lsn options. If no valid LSN can be found (no series by that name) xtrabackup will return with an error.</p> </li> <li> <p>\u2013incremental-history-uuid =&lt;uuid&gt; : Allows an incremental backup to be made based on a specific history record identified by UUID. xtrabackup will search the history table looking for the record matching UUID and take the <code>to_lsn</code> value to use as it\u2019s starting LSN. This options is mutually exclusive with \u2013incremental-basedir, \u2013incremental-lsn and \u2013incremental-history-name options. If no valid LSN can be found (no record by that UUID or missing <code>to_lsn</code>), xtrabackup will return with an error.</p> </li> </ul> <p>Note</p> <p>Backup that\u2019s currently being performed will NOT exist in the xtrabackup_history table within the resulting backup set as the record will not be added to that table until after the backup has been taken.</p> <p>If you want access to backup history outside of your backup set in the case of some catastrophic event, you will need to either perform a <code>mysqldump</code>, partial backup or <code>SELECT</code> * on the history table after xtrabackup completes and store the results with you backup set.</p> <p>For the necessary privileges, see Permissions and Privileges Needed.</p>"},{"location":"store-backup-history.html#percona_schemaxtrabackup_history-table","title":"PERCONA_SCHEMA.XTRABACKUP_HISTORY table","text":"<p>This table contains the information about the previous server backups. Information about the backups will only be written if the backup was taken with \u2013history option.</p> Column Name Description uuid Unique backup id name User provided name of backup series. There may be multiple entries with the same name used to identify related backups in a series. tool_name Name of tool used to take backup tool_command Exact command line given to the tool with \u2013password and \u2013encrypt_key obfuscated tool_version Version of tool used to take backup ibbackup_version Version of the xtrabackup binary used to take backup server_version Server version on which backup was taken start_time Time at the start of the backup end_time Time at the end of the backup lock_time Amount of time, in seconds, spent calling and holding locks for <code>FLUSH TABLES WITH READ LOCK</code> binlog_pos Binary log file and position at end of <code>FLUSH TABLES WITH READ LOCK</code> innodb_from_lsn LSN at beginning of backup which can be used to determine prior backups innodb_to_lsn LSN at end of backup which can be used as the starting lsn for the next incremental partial Is this a partial backup, if <code>N</code> that means that it\u2019s the full backup incremental Is this an incremental backup format Description of result format (<code>xbstream</code>) compressed Is this a compressed backup encrypted Is this an encrypted backup"},{"location":"store-backup-history.html#limitations","title":"Limitations","text":"<ul> <li> <p>\u2013history option must be specified only on the command line and not within a configuration file in order to be effective.</p> </li> <li> <p>\u2013incremental-history-name and \u2013incremental-history-uuid options must be specified only on the command line and not within a configuration file in order to be effective.</p> </li> </ul> <p></p>"},{"location":"store-backup-history.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"supported-versions.html","title":"Supported versions","text":"<p>Percona XtraBackup 8.0.34-29 supports backing up databases compatible with server version 8.0.34 and later. Percona XtraBackup 8.0.34-29 can create backups of older server versions if specific conditions are met. This capability is useful for maintaining compatibility and ensuring backups can be performed across different server versions. You might need to override server version check and set specific options, such as <code>lock-ddl=ON</code>.</p> <p>Specifically, Percona XtraBackup 8.0.35-31 supports taking backups of the following MySQL-compatible databases:</p> <ul> <li> <p>Percona Server for MySQL 8.0.34, and MySQL 8.0.34</p> </li> <li> <p>Percona Server for MySQL 8.0.35, and MySQL 8.0.35</p> </li> <li> <p>Percona Server for MySQL 8.0.36 and MySQL 8.0.36 (and any later versions in the 8.0 series)</p> </li> </ul> <p>For more information, see Percona XtraBackup Version Compatibility and Server Version Checks.</p> <p>For details on the backup process, see How XtraBackup Works.</p> <p></p>"},{"location":"supported-versions.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"take-streaming-backup.html","title":"Take a streaming backup","text":"<p>Percona XtraBackup supports streaming mode. Streaming mode sends a backup to <code>STDOUT</code> in the xbstream format instead of copying the files to the backup directory.</p> <p>This method enables you to utilize other programs to filter the backup output, enhancing flexibility in backup storage. For instance, compression can be achieved by directing the output to a compression utility. One advantage of streaming backups and employing Unix pipes is that backups can be automatically encrypted.</p>"},{"location":"take-streaming-backup.html#version-changes","title":"Version changes","text":"<ul> <li> <p>Starting with Percona XtraBackup 8.0.33-28, the <code>--stream</code> option does not require an <code>xbstream</code> parameter. The <code>xbstream</code> parameter is optional.</p> </li> <li> <p>Using <code>--encrypt</code> might create larger backups than expected when used with InnoDB Page Compression.</p> <p>To avoid this issue with compressed backups, use the <code>--compress</code> option with the <code>--xbstream</code> option in Percona XtraBackup 8.0.31-24 and later.</p> </li> </ul>"},{"location":"take-streaming-backup.html#use-streaming","title":"Use streaming","text":"<p>To utilize the streaming feature, you need to employ the <code>--stream</code> option, specifying the stream format (xbstream). Specifying the stream format (xbstream) is optional, starting with Percona XtraBackup 8.0.33-28.</p> <pre><code>$ xtrabackup --stream=xbstream\n</code></pre> <p>xtrabackup uses xbstream to stream all of the data files to <code>STDOUT</code>, in a special <code>xbstream</code> format. After all data is streamed, xtrabackup stops and also streams the saved transaction log.</p> <p>When compression is enabled, xtrabackup compresses the output data, except for the metadata, using the specified compression algorithm. Read about the supported compression algorithms in the Create a compressed backup document.</p> <p>With xbstream, backups can be copied and compressed simultaneously, significantly speeding up the process. However, if backups are both compressed and encrypted, they need to be decrypted before uncompressing.</p> Task Command Stream the backup into an archive named <code>backup.xbstream</code> <code>xtrabackup --backup --stream=xbstream &gt; backup.xbstream</code> Stream the backup into a compressed archive named <code>backup.xbstream</code> <code>xtrabackup --backup --stream=xbstream --compress &gt; backup.xbstream</code> Encrypt the backup <code>xtrabackup --backup --stream=xbstream  \\|gzip \\| openssl des3 -salt -k 'password' -out backup.xbstream.gz.des3</code> Unpack the backup to the current directory <code>xbstream -x &lt;  backup.xbstream</code> Send the backup compressed directly to another host and unpack it <code>xtrabackup --backup --compress --stream=xbstream | ssh user@otherhost \"xbstream -x\"</code> Send the backup to another server using <code>netcat</code> On the destination host:<code>nc -l 9999 | cat - &gt; /data/backups/backup.xbstream</code>On the source host:<code>xtrabackup --backup --stream=xbstream | nc desthost 9999</code> Send the backup to another server using a one-liner <code>ssh user@desthost \u201c( nc -l 9999 &gt; /data/backups/backup.xbstream &amp; )\u201d &amp;&amp; xtrabackup --backup --stream=xbstream | nc desthost 9999</code> Throttle the throughput to 10MB/sec using the pipe viewer tool <code>xtrabackup --backup --stream=xbstream | pv -q -L10m ssh user@desthost \u201ccat - &gt; /data/backups/backup.xbstream\u201d</code> Checksum the backup during the streaming On the destination host:<code>nc -l 9999 | tee &gt;(sha1sum &gt; destination_checksum) &gt; /data/backups/backup.xbstream</code>On the source host:<code>xtrabackup --backup --stream=xbstream | tee &gt;(sha1sum &gt; source_checksum) | nc desthost 9999</code>Compare the checksums on the source host:<code>cat source_checksum 65e4f916a49c1f216e0887ce54cf59bf3934dbad</code>Compare the checksums on the destination host:<code>cat destination_checksum 65e4f916a49c1f216e0887ce54cf59bf3934dbad</code> Parallel compression with parallel copying backup <code>xtrabackup --backup --compress --compress-threads=8 --stream=xbstream --parallel=4 &gt; backup.xbstream</code> <p>Important</p> <p>The streamed backup must be prepared before restoration. Streaming mode does not prepare the backup.</p> <p></p>"},{"location":"take-streaming-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"throttling-backups.html","title":"Throttling backups","text":"<p>Although xtrabackup does not block your database\u2019s operation, any backup can add load to the system being backed up. On systems that do not have much spare I/O capacity, it might be helpful to throttle the rate at which xtrabackup reads and writes data. You can do this with the \u2013throttle option. This option limits the number of chunks copied per second. The chunk +size is 10 MB.</p> <p>The image below shows how throttling works when \u2013throttle is set to <code>1</code>.</p> <p></p> <p>When specified with the <code>--backup</code> option, this option limits the number of pairs of read-and-write operations per second that xtrabackup will perform. If you are creating an incremental backup, then the limit is the number of read I/O operations per second.</p> <p>By default, there is no throttling, and xtrabackup reads and writes data as quickly as it can. If you set too strict of a limit on the IOPS, the backup might be so slow that it will never catch up with the transaction logs that InnoDB is writing, so the backup might never complete.</p> <p></p>"},{"location":"throttling-backups.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"toolkit-version-check.html","title":"Percona Toolkit version checking","text":"<p>Some Percona software contains \u201cversion checking\u201d functionality which is a feature that enables Percona software users to be notified of available software updates to improve your environment security and performance. Alongside this, the version check functionality also provides Percona with information relating to which software versions you are running, coupled with the environment confirmation which the software is running within. This helps enable Percona to focus our development effort accordingly based on trends within our customer community.</p> <p>The purpose of this document is to articulate the information that is collected, as well as to provide guidance on how to disable this functionality if desired.</p>"},{"location":"toolkit-version-check.html#usage","title":"Usage","text":"<p>Version Check was implemented in Percona Toolkit 2.1.4, and was enabled by default in version 2.2.1. Currently, it is supported as a <code>--[no]version-check</code> option by a number of tools in Percona Toolkit, Percona XtraBackup, and Percona Monitoring and Management (PMM).</p> <p>When launched with Version Check enabled, the tool that supports this feature connects to a Percona\u2019s version check service via a secure HTTPS channel. It compares the locally installed version for possible updates, and also checks versions of the following software:</p> <ul> <li> <p>Operating System</p> </li> <li> <p>Percona Monitoring and Management (PMM)</p> </li> <li> <p>MySQL</p> </li> <li> <p>Perl</p> </li> <li> <p>MySQL driver for Perl (DBD::mysql)</p> </li> <li> <p>Percona Toolkit</p> </li> </ul> <p>Then it checks for and warns about versions with known problems if they are identified as running in the environment.</p> <p>Each version check request is logged by the server. Stored information consists of the checked system unique ID followed by the software name and version.  The ID is generated either at installation or when the version checking query is submitted for the first time.</p> <p>Note</p> <p>Prior to version 3.0.7 of Percona Toolkit, the system ID was calculated as an MD5 hash of a hostname, and starting from Percona Toolkit 3.0.7 it is generated as an MD5 hash of a random number. Percona XtraBackup continues to use hostname-based MD5 hash.</p> <p>As a result, the content of the sent query is as follows:</p> Expected output <pre><code>85624f3fb5d2af8816178ea1493ed41a;DBD::mysql;4.044\nc2b6d625ef3409164cbf8af4985c48d3;MySQL;MySQL Community Server (GPL) 5.7.22-log\n85624f3fb5d2af8816178ea1493ed41a;OS;Manjaro Linux\n85624f3fb5d2af8816178ea1493ed41a;Percona::Toolkit;3.0.11-dev\n85624f3fb5d2af8816178ea1493ed41a;Perl;5.26.2\n</code></pre>"},{"location":"toolkit-version-check.html#disabling-version-check","title":"Disabling version check","text":"<p>Although the version checking feature does not collect any personal information, you might prefer to disable this feature, either one time or permanently.  To disable it one time, use <code>--no-version-check</code> option when invoking the tool from a Percona product which supports it. Here is a simple example which shows running pt-diskstats tool from the Percona Toolkit with version checking turned off:</p> <pre><code>pt-diskstats --no-version-check\n</code></pre> <p>Disabling version checking permanently can be done by placing <code>no-version-check</code> option into the configuration file of a Percona product (see correspondent documentation for exact file name and syntax). For example, in case of Percona Toolkit this can be done in a global configuration file <code>/etc/percona-toolkit/percona-toolkit.conf</code>:</p> <pre><code># Disable Version Check for all tools:\nno-version-check\n</code></pre> <p>In case of Percona XtraBackup this can be done in its configuration file in a similar way:</p> <pre><code>[xtrabackup]\nno-version-check\n</code></pre>"},{"location":"toolkit-version-check.html#frequently-asked-questions","title":"Frequently asked questions","text":""},{"location":"toolkit-version-check.html#why-is-this-functionality-enabled-by-default","title":"Why is this functionality enabled by default?","text":"<p>We believe having this functionality enabled improves security and performance of environments running Percona Software and it is good choice for majority of the users.</p>"},{"location":"toolkit-version-check.html#why-not-rely-on-operating-systems-built-in-functionality-for-software-updates","title":"Why not rely on Operating System\u2019s built in functionality for software updates?","text":"<p>In many environments the Operating Systems repositories may not carry the latest version of software and newer versions of software often installed manually, so not being covered by operating system wide check for updates.</p>"},{"location":"toolkit-version-check.html#why-do-you-send-more-information-than-just-the-version-of-software-being-run-as-a-part-of-version-check-service","title":"Why do you send more information than just the version of software being run as a part of version check service?","text":"<p>Compatibility problems can be caused by versions of various components in the environment, for example problematic versions of Perl, DBD or MySQL could cause operational problems with Percona Toolkit.</p> <p></p>"},{"location":"toolkit-version-check.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"topic-index.html","title":"Topic index","text":"<ul> <li>About Percona Xtrabackup</li> <li>Accelerate the backup process</li> <li>Analyze table statistics</li> <li> <p>Apt pinning the Percona XtraBackup 8.0 packages</p> </li> <li> <p>Binary tarball file names available</p> </li> <li> <p>Compile and install Percona XtraBackup 8.0 from source</p> </li> <li>Configure xtrabackup</li> <li>Connection and privileges needed</li> <li>Copyright and licensing information</li> <li>Create a compressed backup</li> <li> <p>Create a full backup</p> </li> <li> <p>Create an incremental backup</p> </li> <li>Create an individual partitions backup</li> <li>Create a partial backup</li> <li>Decompress and prepare a compressed backup</li> <li> <p>Dictionary cache</p> </li> <li> <p>Encrypt backups</p> </li> <li>Encrypted InnoDB tablespace backups</li> <li>Error message: Found tables with row versions due to INSTANT ADD/DROP columns</li> <li>Exponential backup</li> <li>FIFO data sink</li> <li>Files in the DEB package built for Percona XtraBackup 8.0</li> <li>Files in the RPM package built for Percona XtraBackup 8.0</li> <li>FLUSH TABLES WITH READ LOCK option</li> <li> <p>Frequently asked questions</p> </li> <li> <p>Glossary</p> </li> <li> <p>Home</p> </li> <li>How Percona XtraBackup works</li> <li>How to create a new (or repair a broken) GTID-based replica</li> <li>How to set up a replica for replication in 6 simple steps with Percona XtraBackup</li> <li>Improved log statements</li> <li>Install Percona XtraBackup 8.0 from a binary tarball</li> <li>Install Percona XtraBackup 8.0 overview</li> <li>Install Percona XtraBackup 8.0 using downloaded DEB packages</li> <li>Install Percona XtraBackup 8.0 using downloaded RPM packages</li> <li> <p>Index of files created by Percona XtraBackup</p> </li> <li> <p>lock-ddl-per-table option improvements</p> </li> <li>LRU dump backup</li> <li> <p>Make backups in replication environments</p> </li> <li> <p>Permissions needed</p> </li> <li> <p>Point-in-time recovery</p> </li> <li> <p>Prepare a full backup</p> </li> <li>Prepare an incremental backup</li> <li>Prepare an individual partitions backup</li> <li> <p>Prepare a partial backup</p> </li> <li> <p>Percona Toolkit version checking</p> </li> <li>Percona XtraBackup binaries overview</li> <li>Quickstart Guide for Percona XtraBackup</li> <li>Release notes index</li> <li>Restore a backup</li> <li>Restore a partial backup</li> <li>Restore individual tables</li> <li> <p>Restore the partition from a backup</p> </li> <li> <p>Run Percona XtraBackup 8.0 in a Docker container</p> </li> <li> <p>Server version and backup version comparison</p> </li> <li> <p>Smart memory estimation</p> </li> <li> <p>Store backup history on the server</p> </li> <li> <p>Take a streaming backup</p> </li> <li>Take an incremental backup using page tracking</li> <li> <p>Throttling backups</p> </li> <li> <p>Trademark policy</p> </li> <li>The xtrabackup option reference</li> <li>The xtrabackup binary overview</li> <li>The xbcloud binary overview</li> <li>Understand version numbers</li> <li>Uninstall Percona XtraBackup 8.0 on Debian and Ubuntu</li> <li>Uninstall Percona XtraBackup 8.0 on Red Hat Enterprise Linux and CentOS</li> <li>Update curl utility</li> <li> <p>Use an APT repository to install Percona XtraBackup 8.0</p> </li> <li> <p>Use the xbcloud binary with Amazon S3</p> </li> <li>Use the xbcloud binary with Google Cloud Storage</li> <li>Use the xbcloud binary with an IAM instance profile</li> <li>Use the xbcloud binary with Microsoft Azure Cloud Storage</li> <li>Use the xbcloud binary with MinIO</li> <li>Use the xbcloud binary with Swift</li> <li>Use a YUM repository to install Percona XtraBackup</li> <li>The xbcrypt binary overview</li> <li>The xbstream binary overview</li> <li>Verify backups with replication and pt-checksum</li> <li>Work with AppArmor</li> <li>Work with binary logs</li> <li> <p>Work with SELinux</p> </li> <li> <p>xtrabackup exit codes</p> </li> <li> <p>xtrabackup implementation details</p> </li> </ul> <p></p>"},{"location":"topic-index.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"trademark-policy.html","title":"Trademark policy","text":"<p>This Trademark Policy is to ensure that users of Percona-branded products or services know that what they receive has really been developed, approved, tested and maintained by Percona. Trademarks help to prevent confusion in the marketplace, by distinguishing one company\u2019s or person\u2019s products and services from another\u2019s.</p> <p>Percona owns a number of marks, including but not limited to Percona, XtraDB, Percona XtraDB, XtraBackup, Percona XtraBackup, Percona Server, and Percona Live, plus the distinctive visual icons and logos associated with these marks. Both the unregistered and registered marks of Percona are protected.</p> <p>Use of any Percona trademark in the name, URL, or other identifying characteristic of any product, service, website, or other use is not permitted without Percona\u2019s written permission with the following three limited exceptions.</p> <p>First, you may use the appropriate Percona mark when making a nominative fair use reference to a bona fide Percona product.</p> <p>Second, when Percona has released a product under a version of the GNU General Public License (\u201cGPL\u201d), you may use the appropriate Percona mark when distributing a verbatim copy of that product in accordance with the terms and conditions of the GPL.</p> <p>Third, you may use the appropriate Percona mark to refer to a distribution of GPL-released  Percona software that has been modified with minor changes for the sole purpose of allowing the software to operate on an operating system or hardware platform for which Percona has not yet released the software, provided that those third party changes do not affect the behavior, functionality, features, design or performance of the software. Users who acquire this Percona-branded software receive substantially exact implementations of the Percona software.</p> <p>Percona reserves the right to revoke this authorization at any time in its sole discretion. For example, if Percona believes that your modification is beyond the scope of the limited license granted in this Policy or that your use of the Percona mark is detrimental to Percona, Percona will revoke this authorization. Upon revocation, you must immediately cease using the applicable Percona mark. If you do not immediately cease using the Percona mark upon revocation, Percona may take action to protect its rights and interests in the Percona mark. Percona does not grant any license to use any Percona mark for any other modified versions of Percona software; such use will require our prior written permission.</p> <p>Neither trademark law nor any of the exceptions set forth in this Trademark Policy permit you to truncate, modify or otherwise use any Percona mark as part of your own brand. For example, if XYZ creates a modified version of the Percona Server, XYZ may not brand that modification as \u201cXYZ Percona Server\u201d or \u201cPercona XYZ Server\u201d, even if that modification otherwise complies with the third exception noted above.</p> <p>In all cases, you must comply with applicable law, the underlying license, and this Trademark Policy, as amended from time to time. For instance, any mention of Percona trademarks should include the full trademarked name, with proper spelling and capitalization, along with attribution of ownership to Percona LLC and/or its affiliates. For example, the full proper name for XtraBackup is Percona XtraBackup. However, it is acceptable to omit the word \u201cPercona\u201d for brevity on the second and subsequent uses, where such omission does not cause confusion.</p> <p>In the event of doubt as to any of the conditions or exceptions outlined in this Trademark Policy, please contact trademarks@percona.com for assistance and we will do our very best to be helpful.</p> <p></p>"},{"location":"trademark-policy.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"update-curl-utility.html","title":"Update curl utility","text":""},{"location":"update-curl-utility.html#update-the-curl-utility-in-debian-10","title":"Update the curl utility in Debian 10","text":"<p>The default curl version, 7.64.0, in Debian 10 has known issues when attempting to reuse an already closed connection. This issue directly affects <code>xbcloud</code> and users may see intermittent backup failures.</p> <p>For more details, see curl #3750 or curl #3763.</p> <p>Follow these steps to upgrade curl to version 7.74.0:</p> <ol> <li> <p>Edit the <code>/etc/apt/sources.list</code> to add the following:</p> <pre><code>deb http://ftp.de.debian.org/debian buster-backports main\n</code></pre> </li> <li> <p>Refresh the <code>apt</code> sources:</p> <pre><code>$ sudo apt update\n</code></pre> </li> <li> <p>Install the version from <code>buster-backports</code>:</p> <pre><code>$ sudo apt install curl/buster-backports\n</code></pre> </li> <li> <p>Verify the version number:</p> <pre><code>$ curl --version\n</code></pre> Expected output <pre><code>curl 7.74.0 (x86_64-pc-linux-gnu) libcurl/7.74.0\n</code></pre> </li> </ol> <p></p>"},{"location":"update-curl-utility.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"verify-backup.html","title":"Verify backups with replication and pt-checksum","text":"<p>One way to verify if the backup is consistent is by setting up the replication and running pt-table-checksum. This can be used to verify any type of backups, but before setting up replication, backup should be prepared and be able to run (this means that incremental backups should be merged to full backups, encrypted backups decrypted etc.).</p>"},{"location":"verify-backup.html#set-up-the-replication","title":"Set up the replication","text":"<p>How to set up a replica for replication in 6 simple steps with Percona XtraBackup guide provides a detailed instructions on how to take the backup and set up the replication.</p> <p>For checking the backup consistency you can use either the original server where the backup was taken, or another test server created by using a different backup method (such as cold backup, mysqldump or LVM snapshots) as the source server in the replication setup.</p>"},{"location":"verify-backup.html#use-pt-table-checksum","title":"Use pt-table-checksum","text":"<p>This tool is part of the Percona Toolkit. It performs an online replication consistency check by executing checksum queries on the source, which produces different results on replicas that are inconsistent with the source.</p> <p>After you confirmed that replication has been set up successfully, you can install or download pt-table-checksum. This example shows downloading the latest version of pt-table-checksum:</p> <pre><code>$ wget percona.com/get/pt-table-checksum\n</code></pre> <p>Note</p> <p>In order for pt-table-checksum to work correctly <code>libdbd-mysql-perl</code> will need to be installed on Debian/Ubuntu systems or <code>perl-DBD-MySQL</code> on RHEL/CentOS. If you installed the percona-toolkit package from the Percona repositories package manager should install those libraries automatically.</p> <p>After this command has been run, pt-table-checksum will be downloaded to your current working directory.</p> <p>Running the pt-table-checksum on the source will create <code>percona</code> database with the <code>checksums</code> table which will be replicated to the replicas as well. Example of the pt-table-checksum will look like this:</p> <pre><code>$ ./pt-table-checksum\n</code></pre> <p>The results are similar to the following:</p> Expected output <pre><code>TS ERRORS  DIFFS     ROWS  CHUNKS SKIPPED    TIME TABLE\n04-30T11:31:50      0      0   633135       8       0   5.400 exampledb.aka_name\n04-30T11:31:52      0      0   290859       1       0   2.692 exampledb.aka_title\nChecksumming exampledb.user_info:  16% 02:27 remain\nChecksumming exampledb.user_info:  34% 01:58 remain\nChecksumming exampledb.user_info:  50% 01:29 remain\nChecksumming exampledb.user_info:  68% 00:56 remain\nChecksumming exampledb.user_info:  86% 00:24 remain\n04-30T11:34:38      0      0 22187768     126       0 165.216 exampledb.user_info\n04-30T11:38:09      0      0        0       1       0   0.033 mysql.time_zone_name\n04-30T11:38:09      0      0        0       1       0   0.052 mysql.time_zone_transition\n04-30T11:38:09      0      0        0       1       0   0.054 mysql.time_zone_transition_type\n04-30T11:38:09      0      0        8       1       0   0.064 mysql.user\n</code></pre> <p>If all the values in the <code>DIFFS</code> column are 0 that means that backup is consistent with the current setup.</p> <p>In case backup was not consistent  pt-table-checksum should spot the difference and point to the table that does not match. Following example shows adding new user on the backed up replica in order to simulate the inconsistent backup:</p> <pre><code>mysql&gt; grant usage on exampledb.* to exampledb@localhost identified by 'thisisnewpassword';\n</code></pre> <p>If we run the pt-table-checksum now difference should be spotted</p> <pre><code>$ ./pt-table-checksum\n</code></pre> <p>The results are similar to the following:</p> Expected output <pre><code>TS ERRORS  DIFFS     ROWS  CHUNKS SKIPPED    TIME TABLE\n04-30T11:31:50      0      0   633135       8       0   5.400 exampledb.aka_name\n04-30T11:31:52      0      0   290859       1       0   2.692 exampledb.aka_title\nChecksumming exampledb.user_info:  16% 02:27 remain\nChecksumming exampledb.user_info:  34% 01:58 remain\nChecksumming exampledb.user_info:  50% 01:29 remain\nChecksumming exampledb.user_info:  68% 00:56 remain\nChecksumming exampledb.user_info:  86% 00:24 remain\n04-30T11:34:38      0      0 22187768     126       0 165.216 exampledb.user_info\n04-30T11:38:09      0      0        0       1       0   0.033 mysql.time_zone_name\n04-30T11:38:09      0      0        0       1       0   0.052 mysql.time_zone_transition\n04-30T11:38:09      0      0        0       1       0   0.054 mysql.time_zone_transition_type\n04-30T11:38:09      1      0        8       1       0   0.064 mysql.user\n</code></pre> <p>This output shows that source and the replica aren\u2019t in consistent state and that the difference is in the <code>mysql.user</code> table.</p> <p>More information on different options that pt-table-checksum provides can be found in the pt-table-checksum documentation.</p> <p></p>"},{"location":"verify-backup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"work-with-apparmor.html","title":"Work with AppArmor","text":"<p>The Linux Security Module implements mandatory access controls (MAC) with AppArmor. Debian and Ubuntu systems install AppArmor by default. AppArmor uses profiles which define which files and permissions are needed for application.</p> <p>Percona XtraBackup does not have a profile and is not confined by AppArmor.</p> <p>For a list of common AppArmor commands, see Percona Server for MySQL - AppArmor</p>"},{"location":"work-with-apparmor.html#develop-a-profile","title":"Develop a profile","text":"<p>Download the profile from:</p> <p>https://github.com/percona/percona-xtrabackup/tree/8.0/packaging/percona/apparmor/apparmor.d</p> <p>The following profile sections should be updated with your system information, such as location of the backup destination directory.</p> Expected output <pre><code># enable storing backups only in /backups directory\n# /backups/** rwk,\n\n# enable storing backups anywhere in caller user home directory\n/@{HOME}/** rwk,\n\n\n# enable storing backups only in /backups directory\n# /backups/** rwk,\n\n# enable storing backups anywhere in caller user home directory\n/@{HOME}/** rwk,\n}\n\n# enable storing backups only in /backups directory\n# /backups/** rwk,\n\n# enable storing backups anywhere in caller user home directory\n/@{HOME}/** rwk,\n}\n</code></pre> <p>Move the updated file:</p> <pre><code>$ sudo mv usr.sbin.xtrabackup /etc/apparmor.d/\n</code></pre> <p>Install the profile with the following command:</p> <pre><code>$ sudo apparmor_parser -r -T -W /etc/apparmor.d/usr.sbin.xtrabackup\n</code></pre> <p>Run the backup as usual.</p> <p>No additional AppArmor-related actions are required to restore a backup.</p> <p></p>"},{"location":"work-with-apparmor.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"work-with-selinux.html","title":"Work with SELinux","text":"<p>Percona XtraBackup is installed as an unconfined process running in an undefined domain. SELinux allows unconfined processes almost all access and the processes only use Discretionary Access Control (DAC) rules.</p> <p>You find the current state of the Percona XtraBackup file with the following command:</p> <pre><code>$ ls -Z /usr/bin | grep xtrabackup\n</code></pre> Expected output <pre><code>-rwxr-xr-x. root root   system_u:object_r:bin_t:s0       xtrabackup\n</code></pre> <p>The SELinux context is the following:</p> <ul> <li> <p>user (root)</p> </li> <li> <p>role (object_r)</p> </li> <li> <p>type (bin_t)</p> </li> <li> <p>level (s0)</p> </li> </ul> <p>The unconfined domain supports the network-facing services, which are protected by SELinux. These domains are not exposed. In this configuration, SELinux protects against remote intrusions but local intrusions, which require local access, are not confined.</p> <p>Percona XtraBackup works locally. The service is not network-facing and cannot be exploited externally. The service interacts only with the local user, who provides the parameters. Percona XtraBackup requires access to the <code>target-dir</code> location.</p>"},{"location":"work-with-selinux.html#confine-xtrabackup","title":"Confine XtraBackup","text":"<p>You can modify your security configuration to confine Percona XtraBackup. The first question is where to store the backup files. The service requires read and write access to the selected location.</p> <p>You can use either of the following methods:</p> <ul> <li> <p>Allow Percona XtraBackup to write to any location. The user provides any path to the <code>target-dir</code> parameter.</p> </li> <li> <p>Allow Percona XtraBackup to write to a specific location, such as /backups or the user\u2019s home directory.</p> </li> </ul> <p>The first option opens the entire system to read and write. Select the second option to harden your security.</p>"},{"location":"work-with-selinux.html#install-selinux-tools","title":"Install SELinux tools","text":"<p>To work with policies, you must install the SELinux tools. To find which package provides the <code>semanage</code> command and install the package. The following is an example on CentOS 7.</p> <p><pre><code>$ yum provides *bin/semanage\n</code></pre> The result should list the packages.</p> Expected output <pre><code>...\npolicycoreutils-python-2.5-34.el7.x86_64 : SELinux policy core python utilities\n...\n</code></pre> <p>To install missing packages, run the following:</p> <pre><code>$ sudo yum install -y policycoreutils-python\n</code></pre> <p>The following is an example on CentOS 8:</p> <p><pre><code>$ yum provides *bin/semanage\n</code></pre> The result should list the missing packages.</p> Expected output <pre><code>...\npolicycoreutils-python-utils-2.8-16.1.el8.noarch : SELinux policy core python utilities\n</code></pre> <p>Run the following to install the missing packages: </p> <pre><code>$ sudo yum install -y policycoreutils-python-utils\n</code></pre>"},{"location":"work-with-selinux.html#create-a-policy","title":"Create a policy","text":"<p>Use a modular approach to create an SELinux policy. Create a policy module to manage XtraBackup. You must create a <code>.te</code> file for type enforcement, and an optional <code>.fc</code> file for the file contexts.</p> <p>Use <code>$ ps -efZ | grep xtrabackup</code> to verify the service is not confined by SELinux.</p> <p>Create the <code>xtrabackup.fc</code> file and add content. This file defines the security contexts.</p> <pre><code>/usr/bin/xtrabackup    -- gen_context(system_u:object_r:xtrabackup_exec_t,s0)\n/usr/bin/xbcrypt    -- gen_context(system_u:object_r:xtrabackup_exec_t,s0)\n/usr/bin/xbstream    -- gen_context(system_u:object_r:xtrabackup_exec_t,s0)\n/usr/bin/xbcloud    -- gen_context(system_u:object_r:xtrabackup_exec_t,s0)\n/backups(/.*)?       system_u:object_r:xtrabackup_data_t:s0\n</code></pre> <p>Note</p> <p>If you are using the <code>/backups</code> directory you must have the last line. If you are storing the backups in the user\u2019s home directory, you can omit this line.</p> <p>Download the <code>xtrabackup.te</code> file from the following location:</p> <p>https://github.com/percona/percona-xtrabackup/tree/8.0/packaging/percona/selinx</p> <p>Note</p> <p>In the file, the sections in bold should be modified for your system. The fc file can also be downloaded from the same location.</p> <p>Compile the policy module:</p> <pre><code>$ make -f /usr/share/selinux/devel/Makefile xtrabackup.pp\n</code></pre> <p>Install the module:</p> <pre><code>$ semodule -i xtrabackup.pp\n</code></pre> <p>Tag the PXB binaries with the proper SELinux tags, such as <code>xtrabackup_exec_t</code>.</p> <pre><code>$ restorecon -v /usr/bin/*\n</code></pre> <p>If you store your backups at <code>/backups</code>, restore the tag in that location:</p> <pre><code>$ restorecon -v /backups\n</code></pre> <p>Note</p> <p>Remember to add the standard Linux DAC permissions for this directory.</p> <p>Perform the backup in the standard way.</p> <p></p>"},{"location":"work-with-selinux.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"working-with-binary-logs.html","title":"Work with binary logs","text":"<p>The <code>xtrabackup</code> binary integrates with the <code>log_status table</code>. This integration enables <code>xtrabackup</code> to print out the backup\u2019s corresponding binary log position, so that you can use this binary log position to provision a new replica or perform point-in-time recovery.</p>"},{"location":"working-with-binary-logs.html#find-the-binary-log-position","title":"Find the binary log position","text":"<p>You can find the binary log position corresponding to a backup after the backup has been taken. If your backup is from a server with binary logging enabled, <code>xtrabackup</code> creates a file named <code>xtrabackup_binlog_info</code> in the target directory. This file contains the binary log file name and position of the exact point when the backup was taken.</p> Expected output during the backup stage <pre><code>210715 14:14:59 Backup created in directory '/backup/'\nMySQL binlog position: filename 'binlog.000002', position '156'\n. . .\n210715 14:15:00 completed OK!\n</code></pre> <p>Note</p> <p>As of Percona XtraBackup 8.0.26-18.0, xtrabackup no longer creates the <code>xtrabackup_binlog_pos_innodb</code> file. This change is because MySQL and Percona Server no longer update the binary log information on global transaction system section of <code>ibdata</code>. You should rely on <code>xtrabackup_binlog_info</code> regardless of the storage engine in use.</p>"},{"location":"working-with-binary-logs.html#point-in-time-recovery","title":"Point-in-time recovery","text":"<p>To perform a point-in-time recovery from an <code>xtrabackup</code> backup, you should prepare and restore the backup, and then replay binary logs from the point shown in the <code>xtrabackup_binlog_info</code> file.</p> <p>Find a more detailed procedure in the Point-in-time recovery document.</p>"},{"location":"working-with-binary-logs.html#set-up-a-new-replication-replica","title":"Set up a new replication replica","text":"<p>To set up a new replica, you should prepare the backup, and restore it to the data directory of your new replication replica. If you are using version 8.0.22 or earlier, in your <code>CHANGE MASTER TO</code> command, use the binary log filename and position shown in the <code>xtrabackup_binlog_info</code> file to start replication.</p> <p>If you are using 8.0.23 or later, use the CHANGE_REPLICATION_SOURCE_TO and the appropriate options. <code>CHANGE_MASTER_TO</code> is deprecated.</p> <p>A more detailed procedure is found in  How to setup a replica for replication in 6 simple steps with Percona XtraBackup.</p> <p></p>"},{"location":"working-with-binary-logs.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-azure.html","title":"Use the xbcloud binary with Microsoft Azure Cloud Storage","text":"<p>Implemented in Percona XtraBackup 8.0.27-19, the xbcloud binary adds support for the Microsoft Azure Cloud Storage using the REST API.</p>"},{"location":"xbcloud-azure.html#options","title":"Options","text":"<p>The following are the options, environment variables, and descriptions for uploading a backup to Azure using the REST API. The environment variables are recognized by xbcloud, which maps them automatically to the corresponding parameters:</p> Option name Environment variables Description \u2013azure-storage-account=name AZURE_STORAGE_ACCOUNT An Azure storage account is a unique namespace to access and store your Azure data objects. \u2013azure-container-name=name AZURE_CONTAINER_NAME A container name is a valid DNS name that conforms to the Azure naming rules \u2013azure-access-key=name AZURE_ACCESS_KEY A generated key that can be used to authorize access to data in your account using the Shared Key authorization. \u2013azure-endpoint=name AZURE_ENDPOINT The endpoint allows clients to securely access data \u2013azure-tier-class=name AZURE_STORAGE_CLASS Cloud tier can decrease the local storage required while maintaining the performance. When enabled, this feature has the following categories: Hot - Frequently accessed or modified data Cool - Infrequently accessed or modified data Archive - Rarely accessed or modified data <p>Test your Azure applications with the Azurite open-source emulator. For testing purposes, the xbcloud binary adds the <code>--azure-development-storage</code> option that uses the default <code>access_key</code> and <code>storage account</code> of azurite and <code>testcontainer</code> for the container. You can overwrite these options, if needed.</p>"},{"location":"xbcloud-azure.html#usage","title":"Usage","text":"<p>All the available options for xbcloud, such as parallel,  max-retries, and others, can be used. For more information, see the xbcloud binary overview.</p>"},{"location":"xbcloud-azure.html#examples","title":"Examples","text":"<p>An example of an xbcloud backup.</p> <pre><code>$ xtrabackup --backup --stream=xbstream  | \nxbcloud put backup_name --azure-storage-account=pxbtesting --azure-access-key=$AZURE_KEY --azure-container-name=test --storage=azure\n</code></pre> <p>An example of restoring a backup from xbcloud.</p> <pre><code>$ xbcloud get backup_name  --azure-storage-account=pxbtesting \n--azure-access-key=$AZURE_KEY --azure-container-name=test --storage=azure --parallel=10 2&gt;download.log | xbstream -x -C restore\n</code></pre> <p>An example of deleting a backup from xbcloud.</p> <pre><code>$ xbcloud delete backup_name --azure-storage-account=pxbtesting \n--azure-access-key=$AZURE_KEY --azure-container-name=test --storage=azure\n</code></pre> <p>An example of using a shortcut restore.</p> <pre><code>$ xbcloud get azure://operator-testing/bak22 ...\n</code></pre> <p></p>"},{"location":"xbcloud-azure.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-binary-fifo-datasink.html","title":"FIFO data sink","text":"<p>The feature is in tech preview.</p> <p>Percona XtraBackup 8.0.33-28 implements a new data sink that uses the first in, first out (FIFO) method. With the <code>FIFO</code> data sink feature, users with a streaming capacity of 10Gbps (typically on a Local Area Network (LAN)) can benefit from faster backups by streaming data in parallel to an object storage.</p>"},{"location":"xbcloud-binary-fifo-datasink.html#fifo-data-sink-options","title":"FIFO data sink options","text":"<p>Percona XtraBackup 8.0.33-28 implements the following options:</p> <ul> <li><code>--fifo-streams=#</code> - specifies the number of FIFO files to use for parallel data stream. To disable FIFO data sink and send stream to STDOUT, set <code>--fifo-streams=1</code>. The default value is <code>1</code> (STDOUT) to ensure the backward compatibility. The <code>--fifo-streams</code> value must match on both the XtraBackup and xbcloud sides.</li> <li><code>--fifo-dir=name</code> - specifies a directory to write Named Pipe.</li> <li><code>--fifo-timeout=#</code> - specifies the number of seconds to wait for the other end to open the stream for reading. The default value is <code>60</code> seconds.</li> </ul>"},{"location":"xbcloud-binary-fifo-datasink.html#how-to-enable-fifo-data-sink","title":"How to enable FIFO data sink","text":"<p>To use FIFO data sink, you can either run two commands in separate terminal sessions or run xtrabackup in the background.</p> <p>For example, run the following commands in separate terminal sessions:</p> <pre><code>$ xtrabackup --backup --stream --fifo-streams=2 --fifo-dir=/tmp/fifo\n</code></pre> <pre><code>$ xbcloud put --fifo-streams=2 --fifo-dir=/tmp/fifo full\n</code></pre> <p>Run xtrabackup in the background with the following commands:</p> <pre><code>$ xtrabackup --backup --stream --fifo-streams=2 --fifo-dir=/tmp/fifo &amp;\n$ xbcloud put --fifo-streams=2 --fifo-dir=/tmp/fifo full\n</code></pre>"},{"location":"xbcloud-binary-fifo-datasink.html#stream-to-an-object-storage","title":"Stream to an object storage","text":"<p>When taking a backup, you can save the files locally or stream the files to either a different server or an object storage. </p> <p>Before Percona XtraBackup 8.0.33-28, XtraBackup streams data to an object storage writing to STDOUT (a pipe) and using <code>xbcloud</code> to read from STDIN (standard input device). </p> <p>XtraBackup spawns multiple copy threads and each copy thread reads a data chunk from a specific file. Then each copy thread writes the data chunks to a pipe (STDOUT). An xbcloud read thread reads each chunk of STDIN data. Then xbcloud uploads the chunks to an object storage using an async request, and adds a callback to an event handler list. The xbcloud event handler executes the callback depending on the response from the object storage (success or failure).</p> <p></p> <p>The streaming capacity for XtraBackup using STDOUT is 1.8G. This capacity is sufficient for streaming data using Wide Area Network (WAN) into, for example, Amazon Web Services or Google Cloud Platform. </p> <p>Starting with Percona XtraBackup 8.0.33-28, when you stream backups to Amazon S3 compatible storage using LAN with a streaming capacity of 10Gbps, XtraBackup can use multiple FIFO streams to stream the backups faster. </p> <p>XtraBackup spawns multiple copy threads and each copy thread reads a data chunk from a specific file. Then multiple FIFO files are created to store the data from XtraBackup. Each XtraBackup copy thread writes the data chunks to a specific FIFO file. Xbcloud reads from the FIFO streams and uploads data to an object storage using an async request. The xbcloud event handler executes the callback depending on the response from the object storage (success or failure). </p> <p></p>"},{"location":"xbcloud-binary-fifo-datasink.html#performance-improvement","title":"Performance improvement","text":"<p>Consider an example of using a FIFO data sink compared to the STDOUT method.</p> <p>The database has 1TB of data in multiple tables. The link speed between the source server and destination server using MinIO is ~ 9.2 Gbps.</p> <p>Both STDOUT and FIFO data sink scenarios push 1TB of data from two servers.</p> <p>For the FIFO data sink we configure 8 parallel streams with <code>--fifo-streams=8</code> both for XtraBackup and xbcloud.</p> <p>The results are the following:</p> <ul> <li>The <code>STDOUT</code> method takes 01:25:24 to push 1TB of data using 239 MBps (1.8 Gbps).</li> <li>The <code>FIFO</code> method, using 8 streams, takes 00:16:01 to push 1TB of data using 1.15 GBps (9.2 Gbps).</li> </ul> <p></p>"},{"location":"xbcloud-binary-fifo-datasink.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-binary-overview.html","title":"The xbcloud binary overview","text":"<p>The purpose of xbcloud is to download from the cloud and upload to  the cloud the full or part of an xbstream archive. xbcloud will not  overwrite the backup with the same name. xbcloud accepts input via a pipe from xbstream so that it can be invoked as a pipeline with xtrabackup to stream directly to the cloud without needing a local storage.</p> <p>Note</p> <p>In a Bash shell, the <code>$?</code> parameter returns the exit code from the last binary. If you use pipes, the ${PIPESTATUS[x]} array parameter returns the exit code for each  binary in the pipe string.</p> <pre><code>$ xtrabackup --backup --stream=xbstream --target-dir=/storage/backups/ | xbcloud put [options] full_backup\n...\n$ ${PIPESTATUS[x]}\n0 0\n$ true | false\n$ echo $?\n1\n\n# with PIPESTATUS\n$ true | false\n$ echo ${PIPESTATUS[0]} ${PIPESTATUS[1]}\n0 1\n</code></pre> <p>The xbcloud binary stores each chunk as a separate object with a name <code>backup_name/database/table.ibd.NNN...</code>, where <code>NNN...</code> is a 0-padded serial number of chunk within a file. The size of chunk produced by xtrabackup and xbstream changed to 10M.</p> <p>To adjust the chunk size use <code>--read-buffer-size</code>. To adjust the chunk size for encrypted files, use <code>--read-buffer-size</code> and <code>--encrypt-chunk-size</code>.</p> <p>xbcloud has three essential operations: put, get, and delete. With these operations, backups are created, stored, retrieved, restored, and deleted. xbcloud operations clearly map to similar operations within  the AWS Amazon S3 API.</p> <p>For details on the command-line options, see the xbcloud command line options.</p> <p>The Exponential Backoff feature was implemented in Percona XtraBackup 8.0.26-18. During the backup, a chunk fails to upload or download operation; this feature adds an exponential backoff, a sleep time, and retries the operation. This feature increases the chances of completing a backup or a restore operation.</p> <p>The FIFO datasink feature was implemented in Percona XtraBackup 8.0.33-28. With the <code>FIFO</code> data sink feature, users with a streaming capacity of 10Gbps (typically on a Local Area Network (LAN)) can benefit from faster backups by streaming data in parallel to object storage.</p> <p>Important</p> <p>To prevent intermittent backup failures, update the curl utility in Debian 10.</p>"},{"location":"xbcloud-binary-overview.html#supported-cloud-storage-types","title":"Supported cloud storage types","text":"<p>The following cloud storage types are supported:</p> <ul> <li> <p>OpenStack Object Storage (Swift) - see Using the xbcloud binary with Swift</p> </li> <li> <p>Amazon Simple Storage (S3) - see Using the xbcloud binary with Amazon S3</p> </li> <li> <p>Azure Cloud Storage - see Using the xbcloud binary with Microsoft Azure Cloud Storage</p> </li> <li> <p>Google Cloud Storage (gcs) - see Using the xbcloud binary with Google Cloud Storage</p> </li> <li> <p>MinIO - see Using the xbcloud binary with MinIO</p> </li> </ul> <p>In addition to OpenStack Object Storage (Swift), which has been the only option for storing backups in a cloud storage until Percona XtraBackup 2.4.14, xbcloud supports Amazon S3, MinIO, and Google Cloud Storage. Other Amazon S3-compatible storages, such as Wasabi or Digital Ocean Spaces, are also supported.</p> <p>See also</p> <p>OpenStack Object Storage(\u201cSwift\u201d)</p> <p>Amazon Simple Storage Service</p> <p>MinIO</p> <p>Google Cloud Storage</p> <p>Wasabi</p> <p>Digital Ocean Spaces</p>"},{"location":"xbcloud-binary-overview.html#usage","title":"Usage","text":"<p>The following sample command creates a full backup:</p> <pre><code>$ xtrabackup --backup --stream=xbstream --target-dir=/storage/backups/ --extra-lsndirk=/storage/backups/| xbcloud \\\nput [options] full_backup\n</code></pre> <p>An incremental backup only includes the changes since the last backup. The last backup can be either a full or incremental backup.</p> <p>The following sample command creates an incremental backup:</p> <pre><code>$ xtrabackup --backup --stream=xbstream --incremental-basedir=/storage/backups \\\n--target-dir=/storage/inc-backup | xbcloud  put [options] inc_backup\n</code></pre> <p>To prepare an incremental backup, you must first download the full backup with the following command:</p> <pre><code>$ xbcloud get [options] full_backup | xbstream -xv -C /tmp/full-backup\n</code></pre> <p>You must prepare the full backup:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/tmp/full-backup\n</code></pre> <p>After the full backup has been prepared, download the incremental backup:</p> <pre><code>xbcloud get [options] inc_backup | xbstream -xv -C /tmp/inc-backup\n</code></pre> <p>The downloaded backup is prepared by running the following command:</p> <pre><code>$ xtrabackup --prepare --target-dir=/tmp/full-backup --incremental-dir=/tmp/inc-backup\n</code></pre> <p>You do not need the full backup to restore only a specific database. You can specify only the tables to be restored:</p> <p><pre><code>xbcloud get [options] ibdata1 sakila/payment.ibd /tmp/partial/partial.xbs\n</code></pre> An example of the code: </p> <pre><code>xbstream -xv -C /tmp/partial &lt; /tmp/partial/partial.xbs\n</code></pre>"},{"location":"xbcloud-binary-overview.html#supplying-parameters","title":"Supplying parameters","text":"<p>Each storage type has mandatory parameters that you can supply on the command line, in a configuration file, and via environment variables.</p>"},{"location":"xbcloud-binary-overview.html#configuration-files","title":"Configuration files","text":"<p>The parameters the values of which do not change frequently can be stored in <code>my.cnf</code> or in a custom configuration file. The following example is a template of configuration options under the <code>[xbcloud]</code> group:</p> <pre><code>[xbcloud]\nstorage=s3\ns3-endpoint=http://localhost:9000/\ns3-access-key=minio\ns3-secret-key=minio123\ns3-bucket=backupsx\ns3-bucket-lookup=path\ns3-api-version=4\n</code></pre> <p>Note</p> <p>If you explicitly use a parameter on the command line and in a configuration file, xbcloud uses the value provided on the command line.</p>"},{"location":"xbcloud-binary-overview.html#environment-variables","title":"Environment variables","text":"<p>If you explicitly use a parameter on the command line, in a configuration file, and the corresponding environment variable contains a value, xbcloud uses the value provided on the command line or in the configuration file.</p>"},{"location":"xbcloud-binary-overview.html#shortcuts","title":"Shortcuts","text":"<p>For all operations (put, get, and delete), you can use a shortcut to specify the storage type, bucket name, and backup name as one parameter instead of using three distinct parameters (\u2013storage, \u2013s3-bucket, and backup name per se).</p> <p>Note</p> <p>Use the following format: <code>storage-type://bucket-name/backup-name</code></p> <p>In this example s3 refers to a storage type, operator-testing  is a bucket name, and bak22 is the backup name. </p> <pre><code>$ xbcloud get s3://operator-testing/bak22 ...\n</code></pre> <p>This shortcut expands as follows:</p> <pre><code>$ xbcloud get --storage=s3 --s3-bucket=operator-testing bak22 ...\n</code></pre> <p>You can supply the mandatory parameters on the command line, configuration files, and in environment variables.</p>"},{"location":"xbcloud-binary-overview.html#additional-parameters","title":"Additional parameters","text":"<p>xbcloud accepts additional parameters that you can use with any storage type. The <code>--md5</code> parameter computes the MD5 hash value of the backup chunks. The result is stored in files that following the <code>backup_name.md5</code> pattern.</p> <pre><code>$ xtrabackup --backup --stream=xbstream \\\n--parallel=8 2&gt;backup.log | xbcloud put s3://operator-testing/bak22 \\\n--parallel=8 --md5 2&gt;upload.log\n</code></pre> <p>You may use the <code>--header</code> parameter to pass an additional HTTP header with the server side encryption while specifying a customer key.</p> <p>An example of using the <code>--header</code> for AES256 encryption.</p> <pre><code>$ xtrabackup --backup --stream=xbstream --parallel=4 | \\\nxbcloud put s3://operator-testing/bak-enc/ \\\n--header=\"X-Amz-Server-Side-Encryption-Customer-Algorithm: AES256\" \\\n--header=\"X-Amz-Server-Side-Encryption-Customer-Key: CuStoMerKey=\" \\\n--header=\"X-Amz-Server-Side-Encryption-Customer-Key-MD5: CuStoMerKeyMd5==\" \\\n--parallel=8\n</code></pre> <p>The <code>--header</code> parameter is also useful to set the access control list (ACL) permissions: <code>--header=\"x-amz-acl: bucket-owner-full-control</code></p>"},{"location":"xbcloud-binary-overview.html#incremental-backups","title":"Incremental backups","text":"<p>First, you need to make the full backup on which the incremental one is going to be based:</p> <pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/storage/backups/ \\\n--target-dir=/storage/backups/ | xbcloud put \\\n--storage=swift --swift-container=test_backup \\\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ --parallel=10 \\\nfull_backup\n</code></pre> <p>Then you can make the incremental backup:</p> <pre><code>$ xtrabackup --backup --incremental-basedir=/storage/backups \\\n--stream=xbstream --target-dir=/storage/inc_backup | xbcloud put \\\n--storage=swift --swift-container=test_backup \\\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ --parallel=10 \\\ninc_backup\n</code></pre>"},{"location":"xbcloud-binary-overview.html#preparing-incremental-backups","title":"Preparing incremental backups","text":"<p>To prepare a backup you first need to download the full backup:</p> <pre><code>$ xbcloud get --swift-container=test_backup \\\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ --parallel=10 \\\nfull_backup | xbstream -xv -C /storage/downloaded_full\n</code></pre> <p>Once you download the full backup it should be prepared:</p> <pre><code>$ xtrabackup --prepare --apply-log-only --target-dir=/storage/downloaded_full\n</code></pre> <p>After the full backup has been prepared you can download the incremental backup:</p> <pre><code>$ xbcloud get --swift-container=test_backup \\\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ --parallel=10 \\\ninc_backup | xbstream -xv -C /storage/downloaded_inc\n</code></pre> <p>Once the incremental backup has been downloaded you can prepare it by running:</p> <pre><code>$ xtrabackup --prepare --apply-log-only \\\n--target-dir=/storage/downloaded_full \\\n--incremental-dir=/storage/downloaded_inc\n\n$ xtrabackup --prepare --target-dir=/storage/downloaded_full\n</code></pre>"},{"location":"xbcloud-binary-overview.html#partial-download-of-the-cloud-backup","title":"Partial download of the cloud backup","text":"<p>If you do not want to download the entire backup to restore the specific database you can specify only the tables you want to restore:</p> <pre><code>$ xbcloud get --swift-container=test_backup\n--swift-auth-version=2.0 --swift-user=admin \\\n--swift-tenant=admin --swift-password=xoxoxoxo \\\n--swift-auth-url=http://127.0.0.1:35357/ full_backup \\\nibdata1 sakila/payment.ibd \\\n&gt; /storage/partial/partial.xbs\n\n$ xbstream -xv -C /storage/partial &lt; /storage/partial/partial.xbs\n</code></pre> <p></p>"},{"location":"xbcloud-binary-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-exbackoff.html","title":"Exponential backoff","text":"<p>This feature was implemented in Percona XtraBackup 8.0.26-18.0 in the xbcloud binary.</p> <p>Exponential backoff increases the chances for the completion of a backup or a restore operation. For example, a chunk upload or download may fail if you have an unstable network connection or other network issues. This feature adds an exponential backoff, or sleep, time and then retries the upload or download.</p> <p>When a chunk upload or download operation fails, xbcloud checks the reason for the failure. This failure can be a CURL error or an HTTP error, or a client-specific error. If the error is listed in the Retriable errors list, xbcloud pauses for a calculated time before retrying the operation until that time reaches the <code>--max-backoff</code> value.</p> <p>The operation is retried until the <code>--max-retries</code> value is reached. If the chunk operation fails on the last retry, xbcloud aborts the process.</p> <p>The default values are the following:</p> <ul> <li> <p>\u2013max-backoff = 300000 (5 minutes)</p> </li> <li> <p>\u2013max-retries = 10</p> </li> </ul> <p>You can adjust the number of retries by adding the <code>--max-retries</code> parameter and adjust the maximum length of time between retries by adding the <code>--max-backoff</code> parameter to an xbcloud command.</p> <p>Since xbcloud does multiple asynchronous requests in parallel, a calculated value, measured in milliseconds, is used for <code>max-backoff</code>. This algorithm calculates how many milliseconds to sleep before the next retry. A number generated is based on the combining the power of two (2), the number of retries already attempted and adds a random number between 1 and 1000. This number avoids network congestion if multiple chunks have the same backoff value. If the default values are used, the final retry attempt to be approximately 17 minutes after the first try. The number is no longer calculated when the milliseconds reach the <code>--max-backoff</code> setting. At that point, the retries continue by using the <code>--max-backoff</code> setting until the <code>max-retries</code> parameter is reached.</p>"},{"location":"xbcloud-exbackoff.html#retriable-errors","title":"Retriable errors","text":"<p>We retry for the following CURL operations:</p> <ul> <li> <p>CURLE_GOT_NOTHING</p> </li> <li> <p>CURLE_OPERATION_TIMEOUT</p> </li> <li> <p>CURLE_RECV_ERROR</p> </li> <li> <p>CURLE_SEND_ERROR</p> </li> <li> <p>CURLE_SEND_FAIL_REWIND</p> </li> <li> <p>CURLE_PARTIAL_FILE</p> </li> <li> <p>CURLE_SSL_CONNECT_ERROR</p> </li> </ul> <p>We retry for the following HTTP operation status codes:</p> <ul> <li> <p>503</p> </li> <li> <p>500</p> </li> <li> <p>504</p> </li> <li> <p>408</p> </li> </ul> <p>Each cloud provider may return a different CURL error or an HTTP error, depending on the issue. Add new errors by setting the following variables <code>--curl-retriable-errors</code> or <code>--http-retriable-errors</code> on the command line or in <code>my.cnf</code> or in a custom configuration file under the [xbcloud] section. You can add multiple errors using a comma-separated list of codes.</p> <p>The error handling is enhanced when using the <code>--verbose</code> output. This output specifies which error caused xbcloud to fail and what parameter a user must add to retry on this error.</p> <p>The following is an example of a verbose output:</p> Expected output <pre><code>210701 14:34:23 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Server returned nothing (no headers, no data)\n210701 14:34:23 /work/pxb/ins/8.0/bin/xbcloud: Curl error (52) Server returned nothing (no headers, no data) is not configured as retriable. You can allow it by adding --curl-retriable-errors=52 parameter\n</code></pre>"},{"location":"xbcloud-exbackoff.html#example","title":"Example","text":"<p>The following example adjusts the maximum number of retries and the maximum time between retries.</p> <pre><code>xbcloud [options] --max-retries=5 --max-backoff=10000\n</code></pre> <p>The following list describes the process using <code>--max-backoff=10000</code>:</p> <ul> <li> <p>The chunk <code>xtrabackup_logfile.00000000000000000006</code> fails to upload the first time and sleeps for 2384 milliseconds.</p> </li> <li> <p>The same chunk fails for the second time and the sleep time is increased to 4387 milliseconds.</p> </li> <li> <p>The same chunk fails for the third time and the sleep time is increased to 8691 milliseconds.</p> </li> <li> <p>The same chunk fails for the fourth time. The <code>max-backoff</code> parameter has been reached. All retries sleep the same amount of time after reaching the parameter.</p> </li> <li> <p>The same chunk is successfully uploaded.</p> </li> </ul> An example of the output for this setting <pre><code>210702 10:07:05 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Server returned nothing (no headers, no data)\n210702 10:07:05 /work/pxb/ins/8.0/bin/xbcloud: Sleeping for 2384 ms before retrying backup3/xtrabackup_logfile.00000000000000000006\n. . .\n210702 10:07:23 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Server returned nothing (no headers, no data)\n210702 10:07:23 /work/pxb/ins/8.0/bin/xbcloud: Sleeping for 4387 ms before retrying backup3/xtrabackup_logfile.00000000000000000006\n. . .\n210702 10:07:52 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Failed sending data to the peer\n210702 10:07:52 /work/pxb/ins/8.0/bin/xbcloud: Sleeping for 8691 ms before retrying backup3/xtrabackup_logfile.00000000000000000006\n. . .\n210702 10:08:47 /work/pxb/ins/8.0/bin/xbcloud: Operation failed. Error: Failed sending data to the peer\n210702 10:08:47 /work/pxb/ins/8.0/bin/xbcloud: Sleeping for 10000 ms before retrying backup3/xtrabackup_logfile.00000000000000000006\n. . .\n210702 10:10:12 /work/pxb/ins/8.0/bin/xbcloud: successfully uploaded chunk: backup3/xtrabackup_logfile.00000000000000000006, size: 8388660\n</code></pre> <p></p>"},{"location":"xbcloud-exbackoff.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-gcs.html","title":"Use the xbcloud binary with Google Cloud Storage","text":""},{"location":"xbcloud-gcs.html#create-a-full-backup-with-google-cloud-storage","title":"Create a full backup with Google Cloud Storage","text":"<p>The support for Google Cloud Storage is implemented using the interoperability mode. This mode was especially designed to interact with cloud services compatible with Amazon S3.</p> <p>See also</p> <p>Cloud Storage Interoperability</p> <pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\nxbcloud put --storage=google \\\n--google-endpoint=`storage.googleapis.com` \\\n--google-access-key='YOUR-ACCESSKEYID' \\\n--google-secret-key='YOUR-SECRETACCESSKEY' \\\n--google-bucket='mysql_backups'\n--parallel=10 \\\n$(date -I)-full_backup\n</code></pre> <p>The following options are available when using Google Cloud Storage:</p> <ul> <li> <p>\u2013google-access-key =  <li> <p>\u2013google-secret-key =  <li> <p>\u2013google-bucket =  <li> <p>\u2013google-storage-class=name</p> </li> <p>Note</p> <p>The Google storage class name options are the following:</p> <ul> <li> <p>STANDARD</p> </li> <li> <p>NEARLINE</p> </li> <li> <p>COLDLINE</p> </li> <li> <p>ARCHIVE</p> </li> </ul> <p>See also</p> <p>Google storage classes - the default Google storage class depends on  the storage class of the bucket</p> <p></p>"},{"location":"xbcloud-gcs.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-iam-profile.html","title":"Use the xbcloud binary with an IAM instance profile","text":"<p>This feature is tech preview. Before using this feature in production, we recommend that you test restoring from physical backups in your environment and also use the alternative backup method for redundancy.</p> <p>Percona XtraBackup 8.0.31-24 adds the ability to use the IAM instance profile when running xbcloud from an EC2 instance.</p> <p>An authentication system has two elements:</p> <ul> <li>Who am I?</li> <li>What can I do?</li> </ul> <p>A role defines \u201cwhat can I do.\u201d A role provides a method to define a collection of permissions. Roles are assigned to users, services and EC2 instances, the \u201cwho am I\u201d element.</p> <p>The IAM instance profile is the \u201cwho\u201d for an EC2 instance and assumes the IAM role, which has permissions. The instance profile has the same name as the IAM role.</p> <p>An IAM instance profile does not need the <code>--s3-secret-key</code> nor the <code>--s3-access-key</code> if they are running <code>xbcloud</code> from an Amazon EC2 instance. To configure or attach an instance metadata to an EC2 instance, see How can I grant my Amazon EC2 instance access to an Amazon S3 bucket. </p> <p>An example of the command:</p> <pre><code>$ xtrabackup ... | xbcloud put --storage=s3 --s3-bucket=bucket-name backup-name\n</code></pre> <p>The xbcloud binary outputs a connect message when successful.</p> Expected output <pre><code>221121 13:16:26 Using instance metadata for access and secret key\n221121 13:16:26 xbcloud: Successfully connected.\n</code></pre> <p>An important consideration is that the instance metadata has a time to live (TTL) of 6 hours. A backup that takes more than that time contains Expired token errors. Use Exponential Backoff to retry the upload after fetching new keys from the instance metadata.</p> Output when keys have expired <pre><code>221121 13:04:52 xbcloud: S3 error message: The provided token has expired.\n221121 13:04:52 xbcloud: Sleeping for 2384 ms before retrying test/mysql.ibd.00000000000000000002 [1]\n221121 13:04:55 xbcloud: S3 error message: The provided token has expired.\n221121 13:04:55 xbcloud: Sleeping for 2887 ms before retrying test/mysql.ibd.00000000000000000003 [1]\n221121 13:04:58 xbcloud: S3 error message: The provided token has expired.\n221121 13:04:58 xbcloud: Sleeping for 2778 ms before retrying test/undo_002.00000000000000000000 [1]\n221121 13:05:00 xbcloud: S3 error message: The provided token has expired.\n221121 13:05:00 xbcloud: Sleeping for 2916 ms before retrying test/undo_002.00000000000000000001 [1]\n221121 13:05:03 xbcloud: S3 error message: The provided token has expired.\n221121 13:05:03 xbcloud: Sleeping for 2794 ms before retrying test/undo_002.00000000000000000002 [1]\n221121 13:05:06 xbcloud: S3 error message: The provided token has expired.\n221121 13:05:06 xbcloud: Sleeping for 2336 ms before retrying test/undo_001.00000000000000000000 [1]\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/mysql.ibd.00000000000000000002, size: 5242923\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/mysql.ibd.00000000000000000003, size: 23\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/undo_002.00000000000000000000, size: 10485802\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/undo_002.00000000000000000001, size: 6291498\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/undo_002.00000000000000000002, size: 22\n221121 13:05:09 xbcloud: successfully uploaded chunk: test/undo_001.00000000000000000000, size: 10485802\n221121 13:05:10 xbcloud: successfully uploaded chunk: test/undo_001.00000000000000000001, size: 6291498\n221121 13:05:10 xbcloud: successfully uploaded chunk: test/undo_001.00000000000000000002, size: 22\n. . .\n221121 13:05:18 xbcloud: successfully uploaded chunk: test/xtrabackup_tablespaces.00000000000000000001, size: 36\n221121 13:05:19 xbcloud: Upload completed. \n</code></pre> <p></p>"},{"location":"xbcloud-iam-profile.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-minio.html","title":"Use the xbcloud binary with MinIO","text":""},{"location":"xbcloud-minio.html#create-a-full-backup-with-minio","title":"Create a full backup with MinIO","text":"<pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\nxbcloud put --storage=s3 \\\n--s3-endpoint='play.minio.io:9000' \\\n--s3-access-key='YOUR-ACCESSKEYID' \\\n--s3-secret-key='YOUR-SECRETACCESSKEY' \\\n--s3-bucket='mysql_backups'\n--parallel=10 \\\n$(date -I)-full_backup\n</code></pre>"},{"location":"xbcloud-minio.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-options.html","title":"The xbcloud command-line options","text":"<p>Usage: </p> <pre><code>$ xbcloud put [OPTIONS]\n$ xbcloud get [OPTIONS]\n$ xbcloud delete [OPTIONS]\n</code></pre> <p>This document contains information on general options and the options available when you select the Swift authentication version using <code>swift-auth-version</code>.</p> <p>The xbcloud binary has the following general command line options:</p>"},{"location":"xbcloud-options.html#azure-access-key","title":"azure-access-key","text":"<p>Usage: <code>--azure-access-key=name</code></p> <p>The name of the Azure access-key</p>"},{"location":"xbcloud-options.html#azure-container-name","title":"azure-container-name","text":"<p>Usage: <code>--azure-container-name=name</code></p> <p>The name of the Azure container</p>"},{"location":"xbcloud-options.html#azure-development-storage","title":"azure-development-storage","text":"<p>Usage: <code>--azure-development-storage=name</code></p> <p>If you run the Azurite emulator, use this option, and it works with the default credentials provided by Azurite. You can overwrite these default credentials with other options.</p>"},{"location":"xbcloud-options.html#azure-endpoint","title":"azure-endpoint","text":"<p>Usage: <code>--azure-endpoint=name</code></p> <p>The name of the Azure endpoint</p>"},{"location":"xbcloud-options.html#azure-storage-account","title":"azure-storage-account","text":"<p>Usage: <code>--azure-storage-account=name</code></p> <p>The name of the Azure storage account</p>"},{"location":"xbcloud-options.html#azure-tier-class","title":"azure-tier-class","text":"<p>Usage: <code>--azure-tier-class=name</code></p> <p>The name of the Azure tier-class. The possible values are:</p> <ul> <li> <p>Hot</p> </li> <li> <p>Cool</p> </li> <li> <p>Archive</p> </li> </ul>"},{"location":"xbcloud-options.html#cacert","title":"cacert","text":"<p>Usage: <code>--cacert=name</code></p> <p>The path to the file with Certificate Authority (CA) certificates.</p>"},{"location":"xbcloud-options.html#curl-retriable-errors","title":"curl-retriable-errors","text":"<p>Usage: <code>--curl-retriable-errors=name</code></p> <p>Add a new cURL error code as retriable. For multiple codes, use a comma-separated list.</p>"},{"location":"xbcloud-options.html#fifo-dir","title":"fifo-dir","text":"<p>Usage: <code>--fifo-dir=name</code></p> <p>The directory used to read or write named pipes. In the put mode, xbcloud reads from the named pipes. In the get mode, xbcloud writes to the named pipes.</p>"},{"location":"xbcloud-options.html#fifo-streams","title":"fifo-streams","text":"<p>Usage: <code>--fifo-streams=#</code></p> <p>The number of parallel FIFO stream threads.</p>"},{"location":"xbcloud-options.html#fifo-timeout","title":"fifo-timeout","text":"<p>Usage: <code>--fifo-timeout=#</code></p> <p>The number of seconds to wait for the other end to open the stream. The default value is 60.</p>"},{"location":"xbcloud-options.html#google-access-key","title":"google-access-key","text":"<p>Usage: <code>--google-access-key=name</code></p> <p>The Google Cloud storage access key</p>"},{"location":"xbcloud-options.html#google-bucket-name","title":"google-bucket-name","text":"<p>Usage: <code>--google-bucket-name=name</code></p> <p>The Google Cloud storage bucket name</p>"},{"location":"xbcloud-options.html#google-endpoint","title":"google-endpoint","text":"<p>Usage: <code>--google-endpoint=name</code></p> <p>The Google Cloud storage endpoint</p>"},{"location":"xbcloud-options.html#google-region","title":"google-region","text":"<p>Usage: <code>--google-region=name</code></p> <p>The Google Cloud storage region</p>"},{"location":"xbcloud-options.html#google-secret-key","title":"google-secret-key","text":"<p>Usage: <code>--google-secret-key=name</code></p> <p>The Google Cloud storage secret key</p>"},{"location":"xbcloud-options.html#google-session-token","title":"google-session-token","text":"<p>Usage: <code>--google-session-token=name</code></p> <p>The Google Cloud storage session-token</p>"},{"location":"xbcloud-options.html#google-storage-class","title":"google-storage-class","text":"<p>Usage: <code>--google-storage-class=name</code></p> <p>The Google Cloud storage storage class</p> <p>The possible values are the following:</p> <ul> <li> <p>STANDARD</p> </li> <li> <p>NEARLINE</p> </li> <li> <p>COLDLINE</p> </li> <li> <p>ARCHIVE</p> </li> </ul>"},{"location":"xbcloud-options.html#header","title":"header","text":"<p>Usage: <code>--header=name</code></p> <p>Extra header</p>"},{"location":"xbcloud-options.html#http-retriable-errors","title":"http-retriable-errors","text":"<p>Usage: <code>--http-retriable-errors=name</code></p> <p>Add a new http error code as retriable. For multiple codes, use a comma-separated list.</p>"},{"location":"xbcloud-options.html#insecure","title":"insecure","text":"<p>Usage: <code>--insecure</code></p> <p>Do not verify the certificate of the server.</p>"},{"location":"xbcloud-options.html#max-backoff","title":"max-backoff","text":"<p>Usage: <code>--max-backoff=#</code></p> <p>The maximum backoff delay, in milliseconds, between chunk upload or chunk download retries. The default value is 300000.</p>"},{"location":"xbcloud-options.html#max-retries","title":"max-retries","text":"<p>Usage: <code>--max-retires=#</code></p> <p>The number of retries for chunk uploads or downloads after a failure. The default value is 10.</p>"},{"location":"xbcloud-options.html#md5","title":"md5","text":"<p>Usage: <code>--md5=name</code></p> <p>Uploads an MD5 file into the backup directory.</p>"},{"location":"xbcloud-options.html#parallel","title":"parallel","text":"<p>Usage: <code>--parallel=#</code></p> <p>Defines the maximum number of concurrent upload/download requests. The default value is <code>1</code>.</p>"},{"location":"xbcloud-options.html#s3-access-key","title":"s3-access-key","text":"<p>Usage: <code>--s3-access-key=name</code></p> <p>The name of the s3 access key</p>"},{"location":"xbcloud-options.html#s3-api-version","title":"s3-api-version","text":"<p>Usage: <code>--s3-api-version=name</code></p> <p>The name of the s3 API version</p>"},{"location":"xbcloud-options.html#s3-bucket","title":"s3-bucket","text":"<p>Usage: <code>--s3-bucket=name</code></p> <p>The name of the s3 bucket</p>"},{"location":"xbcloud-options.html#s3-bucket-lookup","title":"s3-bucket-lookup","text":"<p>Usage: <code>--s3-bucket-lookup=name</code></p> <p>The name of the s3 bucket lookup method</p>"},{"location":"xbcloud-options.html#s3-endpoint","title":"s3-endpoint","text":"<p>Usage: <code>--s3-endpoint=name</code></p> <p>The name of the s3 endpoint</p>"},{"location":"xbcloud-options.html#s3-region","title":"s3-region","text":"<p>Usage: <code>--s3-region=name</code></p> <p>The name of the s3 region</p>"},{"location":"xbcloud-options.html#s3-secret-key","title":"s3-secret-key","text":"<p>Usage: <code>--s3-secret-key=name</code></p> <p>The name of the s3 secret key</p>"},{"location":"xbcloud-options.html#s3-session-token","title":"s3-session-token","text":"<p>Usage: <code>--s3-session-token=name</code></p> <p>The name of the s3 session token</p>"},{"location":"xbcloud-options.html#s3-storage-class","title":"s3-storage-class","text":"<p>Usage: <code>--s3-storage-class=name</code></p> <p>The name of the s3 storage class and is used to pass custom storage class names provided by the other s3 implementations, such as MinIO.</p> <p>The possible values are:</p> <ul> <li> <p>STANDARD</p> </li> <li> <p>STANDARD_ID</p> </li> <li> <p>GLACIER</p> </li> </ul>"},{"location":"xbcloud-options.html#storage","title":"storage","text":"<p>Usage: <code>--storage=[S3|SWIFT|GOOGLE|AZURE]</code></p> <p>Defines the Cloud storage option. xbcloud supports Swift, MinIO, Google, Azure, and AWS S3. The default value is <code>swift</code>.</p>"},{"location":"xbcloud-options.html#swift-auth-url","title":"swift-auth-url","text":"<p>Usage: <code>--swift-auth-url=name</code></p> <p>The Base URL of the Swift authentication service.</p>"},{"location":"xbcloud-options.html#swift-container","title":"swift-container","text":"<p>Usage: <code>--swift-container=name</code></p> <p>The Swift container used to store backups.</p>"},{"location":"xbcloud-options.html#swift-key","title":"swift-key","text":"<p>Usage: <code>--swift-key</code></p> <p>The Swift key/password (X-Auth-Key)</p>"},{"location":"xbcloud-options.html#swift-storage-url","title":"swift-storage-url","text":"<p>Usage: <code>--swift-storage-url=name</code></p> <p>If a name is specified, the xbcloud attempts to get the object-store endpoint for a given region from the keystone response. This option overrides that value.</p>"},{"location":"xbcloud-options.html#swift-user","title":"swift-user","text":"<p>Usage: <code>--swift-user=name</code></p> <p>The Swift user name (X-Auth-User).</p>"},{"location":"xbcloud-options.html#timeout","title":"timeout","text":"<p>Usage: <code>--timeout=#</code></p> <p>The number of seconds to wait for activity on the TCP connection. The default value is 120. If the value is 0 (zero), there is no timeout.</p>"},{"location":"xbcloud-options.html#verbose","title":"verbose","text":"<p>Usage: <code>--verbose</code></p> <p>Turns on the cURL tracing.</p>"},{"location":"xbcloud-options.html#swift-authentication-options","title":"Swift authentication options","text":"<p>The Swift specification describes several authentication options. The xbcloud tool can authenticate against keystone with API version 2 and 3.</p>"},{"location":"xbcloud-options.html#swift-auth-version","title":"swift-auth-version","text":"<p>Usage: <code>--swift-auth-version=name</code></p> <p>Defines the swift authentication version used. </p> <p>The possible values are the following: </p> <ul> <li> <p><code>1.0</code> - TempAuth</p> </li> <li> <p><code>2.0</code> - Keystone v2.0</p> </li> <li> <p><code>3</code> - Keystone v3. </p> </li> </ul> <p>The default value is <code>1.0</code>.</p>"},{"location":"xbcloud-options.html#if-swift-auth-version2-the-additional-options-are","title":"If <code>--swift-auth-version=2</code>, the additional options are:","text":""},{"location":"xbcloud-options.html#swift-password","title":"swift-password","text":"<p>Usage: <code>--swift-password=name</code></p> <p>Swift password for the user</p>"},{"location":"xbcloud-options.html#swift-region","title":"swift-region","text":"<p>Usage: <code>--swift-region=name</code></p> <p>Swift region object-store endpoint</p>"},{"location":"xbcloud-options.html#swift-tenant","title":"swift-tenant","text":"<p>Usage: <code>--swift-tenant=name</code></p> <p>The Swift tenant name </p> <p>Either of the <code>--swift-tenant</code> or <code>--swift-tenant-id</code> can be defined, but you should not use both options together. Both of these options are optional.</p>"},{"location":"xbcloud-options.html#swift-tenant-id","title":"swift-tenant-id","text":"<p>Usage: <code>--swift-tenant-id=name</code></p> <p>The Swift tenant ID</p> <p>Either of the <code>--swift-tenant</code> or <code>--swift-tenant-id</code> can be defined, but you should not use both options together. Both of these options are optional.</p>"},{"location":"xbcloud-options.html#if-swift-auth-version3-the-additional-options-are","title":"If <code>--swift-auth-version=3</code>, the  additional options are:","text":""},{"location":"xbcloud-options.html#swift-domain","title":"swift-domain","text":"<p>Usage: <code>--swift-domain=name</code></p> <p>The Swift domain name</p>"},{"location":"xbcloud-options.html#swift-domain-id","title":"swift-domain-id","text":"<p>Usage: <code>--swift-domain-id=name</code></p> <p>The Swift domain ID</p>"},{"location":"xbcloud-options.html#swift-project","title":"swift-project","text":"<p>Usage: <code>--swift-project=name</code></p> <p>The Swift project name</p>"},{"location":"xbcloud-options.html#swift-project-domain","title":"swift-project-domain","text":"<p>Usage: <code>--swift-project-domain=name</code></p> <p>The Swift domain name</p>"},{"location":"xbcloud-options.html#swift-project-domain-id","title":"swift-project-domain-id","text":"<p>Usage: <code>--swift-project-domain-id=name</code></p> <p>The Swift domain ID</p>"},{"location":"xbcloud-options.html#swift-project-id","title":"swift-project-id","text":"<p>Usage: <code>--swift-project-id=name</code></p> <p>The Swift project ID</p>"},{"location":"xbcloud-options.html#swift-user-id","title":"swift-user-id","text":"<p>Usage: <code>--swift-user-id=name</code></p> <p>The Swift user ID</p> <p></p>"},{"location":"xbcloud-options.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-s3.html","title":"Use the xbcloud binary with Amazon S3","text":""},{"location":"xbcloud-s3.html#create-a-full-backup-with-amazon-s3","title":"Create a full backup with Amazon S3","text":"<pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\nxbcloud put --storage=s3 \\\n--s3-endpoint='s3.amazonaws.com' \\\n--s3-access-key='YOUR-ACCESSKEYID' \\\n--s3-secret-key='YOUR-SECRETACCESSKEY' \\\n--s3-bucket='mysql_backups'\n--parallel=10 \\\n$(date -I)-full_backup\n</code></pre> <p>The following options are available when using Amazon S3:</p> Option Details \u2013s3-access-key Use to supply the AWS access key ID \u2013s3-secret-key Use to supply the AWS secret access key \u2013s3-bucket Use supply the AWS bucket name \u2013s3-region Use to specify the AWS region. The default value is us-east-1 \u2013s3-api-version =  Select the signing algorithm. The default value is AUTO. In this case, xbcloud will probe. \u2013s3-bucket-lookup =  Specify whether to use bucket.endpoint.com or endpoint.com/bucket*style requests. The default value is AUTO. In this case, xbcloud will probe. \u2013s3-storage-class= Specify the S3 storage class. The default storage class depends on the provider. The name options are the following:<ul><li>STANDARD</li><li>STANDARD_IA</li><li>GLACIER</li></ul> NOTE If you use the GLACIER storage class, the object must be restored to S3 before restoring the backup. Also supports using custom S3 implementations such as MinIO or CephRadosGW."},{"location":"xbcloud-s3.html#permissions-setup","title":"Permissions setup","text":"<p>Following the principle of \u201cleast-privilege\u201d, these are the minimum bucket permissions needed for xbcloud to write backups to S3: LIST/PUT/GET/DELETE.</p> <p>The following example shows the policy definition for writing to the <code>xbcloud-testing</code> bucket on the AWS S3 storage.</p> <pre><code>{\n    \"Version\": \"2012-10-17\",\n    \"Statement\": [\n        {\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"s3:ListBucket\"\n            ],\n            \"Resource\": \"arn:aws:s3:::xbcloud-testing\"\n        },\n        {\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"s3:PutObject\",\n                \"s3:PutObjectAcl\",\n                \"s3:GetObject\",\n                \"s3:GetObjectAcl\",\n                \"s3:DeleteObject\"\n            ],\n            \"Resource\": \"arn:aws:s3:::xbcloud-testing/*\"\n        }\n    ]\n}\n</code></pre>"},{"location":"xbcloud-s3.html#environment-variables","title":"Environment variables","text":"<p>The following environment variables are recognized. xbcloud maps them automatically to corresponding parameters applicable to the selected storage.</p> <ul> <li> <p>AWS_ACCESS_KEY_ID (or ACCESS_KEY_ID)</p> </li> <li> <p>AWS_SECRET_ACCESS_KEY (or SECRET_ACCESS_KEY)</p> </li> <li> <p>AWS_DEFAULT_REGION (or DEFAULT_REGION)</p> </li> <li> <p>AWS_ENDPOINT (or ENDPOINT)</p> </li> <li> <p>AWS_CA_BUNDLE</p> </li> </ul>"},{"location":"xbcloud-s3.html#restore-with-s3","title":"Restore with S3","text":"<pre><code>$ xbcloud get s3://operator-testing/bak22 \\\n--s3-endpoint=https://storage.googleapis.com/ \\\n--parallel=10 2&gt;download.log | xbstream -x -C restore --parallel=8\n</code></pre>"},{"location":"xbcloud-s3.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcloud-swift.html","title":"Use the xbcloud binary with Swift","text":""},{"location":"xbcloud-swift.html#create-a-full-backup-with-swift","title":"Create a full backup with Swift","text":"<p>For details on the command-line options,  see the xbcloud command-line options</p> <p>The following example shows how to make a full backup and upload it to Swift.</p> <pre><code>$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\nxbcloud put --storage=swift \\\n--swift-container=test \\\n--swift-user=test:tester \\\n--swift-auth-url=http://192.168.8.80:8080/ \\\n--swift-key=testing \\\n--parallel=10 \\\nfull_backup\n</code></pre> <p>The following OpenStack environment variables are also recognized and mapped automatically to the corresponding swift parameters (<code>--storage=swift</code>):</p> <ul> <li> <p>OS_AUTH_URL</p> </li> <li> <p>OS_TENANT_NAME</p> </li> <li> <p>OS_TENANT_ID</p> </li> <li> <p>OS_USERNAME</p> </li> <li> <p>OS_PASSWORD</p> </li> <li> <p>OS_USER_DOMAIN</p> </li> <li> <p>OS_USER_DOMAIN_ID</p> </li> <li> <p>OS_PROJECT_DOMAIN</p> </li> <li> <p>OS_PROJECT_DOMAIN_ID</p> </li> <li> <p>OS_REGION_NAME</p> </li> <li> <p>OS_STORAGE_URL</p> </li> <li> <p>OS_CACERT</p> </li> </ul>"},{"location":"xbcloud-swift.html#restore-with-swift","title":"Restore with Swift","text":"<pre><code>$ xbcloud get [options] &lt;name&gt; [&lt;list-of-files&gt;] | xbstream -x\n</code></pre> <p>The following example shows how to fetch and restore the backup from Swift:</p> <pre><code>$ xbcloud get --storage=swift \\\n--swift-container=test \\\n--swift-user=test:tester \\\n--swift-auth-url=http://192.168.8.80:8080/ \\\n--swift-key=testing \\\nfull_backup | xbstream -xv -C /tmp/downloaded_full\n\n$ xbcloud delete --storage=swift --swift-user=xtrabackup \\\n--swift-password=xtrabackup123! --swift-auth-version=3 \\\n--swift-auth-url=http://openstack.ci.percona.com:5000/ \\\n--swift-container=mybackup1 --swift-domain=Default\n</code></pre> <p></p>"},{"location":"xbcloud-swift.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcrypt-binary-overview.html","title":"The xbcrypt binary overview","text":"<p>To support encryption and decryption of the backups, a new tool <code>xbcrypt</code> was introduced to Percona XtraBackup.</p> <p>Percona XtraBackup 8.0.28-20 implements the <code>XBCRYPT_ENCRYPTION_KEY</code> environment variable. The variable is only used in place of the <code>--encrypt_key=name</code> option. You can use the environment variable or command line option. If you use both, the command line option takes precedence over the value specified in the environment variable.</p> <p>This utility has been modeled after The xbstream binary to perform encryption and decryption outside of Percona XtraBackup. `</p> <p>For more details on the command-line options, see xbcrypt command-line options</p> <p></p>"},{"location":"xbcrypt-binary-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbcrypt-options.html","title":"The xbcrypt command-line options","text":"<p>Usage: </p> <pre><code>$ xbcrypt[OPTIONS]\n</code></pre> <p>The <code>xbcrypt</code> binary has the following command line options:</p>"},{"location":"xbcrypt-options.html#decrypt","title":"decrypt","text":"<p>usage: <code>-d</code> <code>--decrypt</code></p> <p>Decrypt data input to output.</p>"},{"location":"xbcrypt-options.html#encrypt-algo","title":"encrypt-algo","text":"<p>usage: <code>-a=name</code> <code>--encrypt-algo=name</code></p> <p>Defines the name of the encryption algorithm.</p>"},{"location":"xbcrypt-options.html#encrypt-chunk-size","title":"encrypt-chunk-size","text":"<p>usage: <code>-s=#</code> <code>--encrypt-chunk-size=#</code></p> <p>Defines the size of the working buffer for encryption in bytes. The default value is <code>64000</code>.</p>"},{"location":"xbcrypt-options.html#encrypt-key","title":"encrypt-key","text":"<p>usage: <code>-k=name</code> <code>--encrypt-key=name</code></p> <p>The name of the encryption key.</p>"},{"location":"xbcrypt-options.html#encrypt-key-file","title":"encrypt-key-file","text":"<p>usage: <code>-f=name</code> <code>--encrypt-key-file=name</code></p> <p>The name of the file that contains the encryption key.</p>"},{"location":"xbcrypt-options.html#encrypt-threads","title":"encrypt-threads","text":"<p>usage: <code>--encrypt-threads=#</code></p> <p>This option specifies the number of worker threads used for parallel encryption/decryption. The default value is 1.</p>"},{"location":"xbcrypt-options.html#input","title":"input","text":"<p>usage: <code>-i=name</code> <code>--input=name</code></p> <p>Defines the name of the optional input file. If the name is not specified, the input reads from the standard input.</p>"},{"location":"xbcrypt-options.html#output","title":"output","text":"<p>usage: <code>-o=name</code> <code>--output=name</code></p> <p>Defines the name of the optional output file. If this name is not specified, the output is written to the standard output.</p>"},{"location":"xbcrypt-options.html#read-buffer-size","title":"read-buffer-size","text":"<p>usage: <code>--read-buffer-size=#</code></p> <p>Read the buffer size. The default value is 10MB. </p>"},{"location":"xbcrypt-options.html#verbose","title":"verbose","text":"<p>usage: <code>-v</code> <code>--verbose</code></p> <p>Display status in verbose mode.</p> <p></p>"},{"location":"xbcrypt-options.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbstream-binary-overview.html","title":"The xbstream binary overview","text":"<p>To support simultaneous compression and streaming, a new custom streaming format called xbstream was introduced to Percona XtraBackup in addition to the TAR format. That was required to overcome some limitations of traditional archive formats such as tar, cpio and others which did not allow streaming dynamically generated files, for example dynamically compressed files. Other advantages of xbstream over traditional streaming/archive format include ability to stream multiple files concurrently (so it is possible to use streaming in the xbstream format together with the \u2013parallel option) and more compact data storage.</p> <p>For details on the command-line options, see xbcloud command-line options.</p> <p>The utility tries to minimize its impact on the OS page cache by using the appropriate <code>posix_fadvise()</code> calls when available.</p> <p>When compression is enabled with xtrabackup all data is compressed, including the transaction log file and meta data files, using the specified compression algorithm. Read more about supported compression algorithms in the Create a compressed backup document.</p> <p></p>"},{"location":"xbstream-binary-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xbstream-options.html","title":"The xbstream command-line options","text":"<pre><code>$ xbstream -c [OPTIONS]\n$ xbstream -x [OPTIONS]\n</code></pre> <p>This utility has a tar-like interface.</p> <p>The xbstream binary has the following options:</p>"},{"location":"xbstream-options.html#absolute-names","title":"absolute-names","text":"<p>Usage: <code>-absolute-names</code></p> <p>Do not strip the leading // (slashes) from the file names when creating archives.</p>"},{"location":"xbstream-options.html#c","title":"c","text":"<p>Usage: <code>-c</code></p> <p>Streams files specified on the command line to its standard output.</p>"},{"location":"xbstream-options.html#decompress","title":"decompress","text":"<p>Usage: <code>--decompress</code></p> <p>Decompress the individual backup files</p>"},{"location":"xbstream-options.html#decompress-threads","title":"decompress-threads","text":"<p>Usage: <code>--decompress-threads=#</code></p> <p>The number of threads for parallel data decompression. The default value is 1.</p>"},{"location":"xbstream-options.html#decrypt","title":"decrypt","text":"<p>Usage: <code>--decrypt=name</code></p> <p>Specifies that xbstream automatically decrypts encrypted files when extracting input stream. The supported values are: <code>AES128</code>, <code>AES192</code>, and <code>AES256</code>. </p> <p>You can specify either <code>--encrypt-key</code> or <code>--encrypt-key-file</code> to provide the encryption key, but do not use both options. </p>"},{"location":"xbstream-options.html#directory","title":"directory","text":"<p>Usage: <code>--directory=name</code></p> <p>Change the current directory to this named directory before streaming or extracting.</p>"},{"location":"xbstream-options.html#encrypt-key","title":"encrypt-key","text":"<p>Usage: <code>--encrypt-key=name</code></p> <p>Specify the encryption key used. Do not use this option with <code>--encrypt-key-file</code>; these options are mutually exclusive.</p>"},{"location":"xbstream-options.html#encrypt-key-file","title":"encrypt-key-file","text":"<p>Usage: <code>--encrypt-key-file=name</code></p> <p>Specify the file that contains the encryption key. Do not use this option with <code>--encrypt-key</code>; these options are mutually exclusive.</p>"},{"location":"xbstream-options.html#encrypt-threads","title":"encrypt-threads","text":"<p>Usage: <code>--encrypt-threads-=#</code></p> <p>Specify the number of threads for parallel data encryption. The default value is <code>1</code>. </p>"},{"location":"xbstream-options.html#extract","title":"extract","text":"<p>Usage: <code>--extract</code></p> <p>Extract to disk the files from the stream to the standard input.</p>"},{"location":"xbstream-options.html#fifo-dir","title":"fifo-dir","text":"<p>Usage: <code>--fifo-dir=name</code></p> <p>The directory used to read or write named pipes.</p>"},{"location":"xbstream-options.html#fifo-streams","title":"fifo-streams","text":"<p>Usage: <code>--fifo-streams=#</code></p> <p>The number of FIFO files (named pipes) to use for parallel data file streaming. To disable the option and send the stream to STDOUT, set the value to 1. </p>"},{"location":"xbstream-options.html#fifo-timeout","title":"fifo-timeout","text":"<p>Usage: <code>--fifo-timeout=#</code></p> <p>The number of seconds to wait for the other end to open the stream. The default value is 60.</p>"},{"location":"xbstream-options.html#parallel","title":"parallel","text":"<p>Usage: <code>--parallel=#</code></p> <p>Defines the number of worker threads for reading or writing.</p>"},{"location":"xbstream-options.html#x","title":"x","text":"<p>Usage: <code>-x</code></p> <p>Extracts files from the stream read from its standard input to the current directory unless specified otherwise with the <code>-c</code> option. Support for parallel extraction with the <code>--parallel</code> option</p>"},{"location":"xbstream-options.html#verbose","title":"verbose","text":"<p>Usage: <code>--verbose</code></p> <p>Print verbose output</p> <p></p>"},{"location":"xbstream-options.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-binary-overview.html","title":"The xtrabackup binary overview","text":"<p>The xtrabackup binary is a compiled C program that is linked with the InnoDB libraries and the standard MySQL client libraries.</p> <p>For details on the xtrabackup command-line options, see xtrabackup command-line options.</p> <p>xtrabackup enables point-in-time backups of InnoDB / XtraDB tables together with the schema definitions, MyISAM tables, and other portions of the server.</p> <p>The InnoDB libraries provide the functionality to apply a log to data files. The MySQL client libraries are used to parse command-line options and configuration file.</p> <p>The tool runs in either <code>--backup</code> or <code>--prepare</code> mode, corresponding to the two main functions it performs. There are several variations on these functions to accomplish different tasks, and there are two less commonly used modes, <code>--stats</code> and <code>--print-param</code>.</p> <p></p>"},{"location":"xtrabackup-binary-overview.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-exit-codes.html","title":"xtrabackup exit codes","text":"<p>The xtrabackup binary exits with the traditional success value of 0 after a backup when no error occurs. If an error occurs during the backup, the exit value is 1.</p> <p>In certain cases, the exit value can be something other than 0 or 1, due to the command-line option code included from the MySQL libraries. An unknown command-line option, for example, will cause an exit code of 255.</p> <p></p>"},{"location":"xtrabackup-exit-codes.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-files.html","title":"Index of files created by Percona XtraBackup","text":"<ul> <li>Information related to the backup and the server</li> </ul> File Name Description <code>backup-my.cnf</code> This file contains information to start the mini-instance of InnoDB during the <code>--prepare</code>. This not a backup of the original <code>my.cnf</code>. The InnoDB configuration is read from the file <code>backup-my.cnf</code> created by xtrabackup when the backup was made. The <code>--prepare</code> uses InnoDB configuration from <code>backup-my.cnf</code> by default, or from <code>--defaults-file</code>, if specified. The InnoDB\u2019s configuration in this context means server variables that affect dataformat, i.e. <code>innodb_page_size</code> option, <code>innodb_log_block_size</code>, etc. Location-related variables, like <code>innodb_log_group_home_dir</code> or <code>innodb_data_file_path</code> are always ignored by <code>--prepare</code>, so preparing a backup always works with data files from the back directory, rather than any external ones. <code>xtrabackup_checkpoints</code> The type of the backup (for example, full or incremental), its state (for example, prepared) and the LSN range contained in it. This information is used for incremental backups. Example of the <code>xtrabackup_checkpoints</code> after taking a full backup: <code>backup_type = full-backuped from lsn= 0 to_lsn = 15188961605 last_lsn = 15188961605</code> Example of the <code>xtrabackup_checkpoints</code> after taking an incremental backup: <code>backup_type = incremental from_lsn = 15188961605 to_lsn = 15189350111 last_lsn = 15189350111</code> <code>xtrabackup_binlog_info</code> The binary log file used by the server and its position at the moment of the backup. A result of the following query: <code>SELECT server_uuid, local, replication, storage_engines FROM performance_schema.log_status;</code> <code>xtrabackup_binlog</code> The xtrabackup binary used in the process. <code>xtrabackup_logfile</code> Contains data needed for running the: <code>--prepare</code>. The bigger this file is the <code>--prepare</code> process will take longer to finish. <code>&lt;table_name&gt;.delta.meta</code> This file is going to be created when performing the incremental backup. It contains the per-table delta metadata: page size, size of compressed page (if the value is 0 it means the tablespace isn\u2019t compressed) and space id. Example of this file: <code>page_size = 16384 zip_size = 0 space_id = 0</code> <ul> <li> <p>Information related to the replication environment (if using the<code>--slave-info</code> option):</p> <p><code>xtrabackup_slave_info</code></p> <p>The <code>CHANGE MASTER</code> statement needed for setting up a replica.</p> </li> <li> <p>Information related to the Galera and Percona XtraDB Cluster (if using the <code>--galera-info</code> option):</p> <p><code>xtrabackup_galera_info</code></p> <p>Contains the values of <code>wsrep_local_state_uuid</code> and<code>wsrep_last_committed</code> status variables</p> </li> </ul> <p></p>"},{"location":"xtrabackup-files.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-implementation-details.html","title":"xtrabackup implementation details","text":"<p>This page contains notes on various internal aspects of the xtrabackup tool\u2019s operation.</p>"},{"location":"xtrabackup-implementation-details.html#file-permissions","title":"File permissions","text":"<p>xtrabackup opens the source data files in read-write mode, although it does not modify the files. This means that you must run xtrabackup as a user who has permission to write the data files. The reason for opening the files in read-write mode is that xtrabackup uses the embedded InnoDB libraries to open and read the files, and InnoDB opens them in read-write mode because it normally assumes it is going to write to them.</p>"},{"location":"xtrabackup-implementation-details.html#tune-the-os-buffers","title":"Tune the OS buffers","text":"<p>Because xtrabackup reads large amounts of data from the filesystem, it uses <code>posix_fadvise()</code> where possible, to instruct the operating system not to try to cache the blocks it reads from disk. Without this hint, the operating system would prefer to cache the blocks, assuming that <code>xtrabackup</code> is likely to need them again, which is not the case. Caching such large files can place pressure on the operating system\u2019s virtual memory and cause other processes, such as the database server, to be swapped out. The <code>xtrabackup</code> tool avoids this with the following hint on both the source and destination files:</p> <pre><code>posix_fadvise(file, 0, 0, POSIX_FADV_DONTNEED)\n</code></pre> <p>In addition, xtrabackup asks the operating system to perform more aggressive read-ahead optimizations on the source files:</p> <pre><code>posix_fadvise(file, 0, 0, POSIX_FADV_SEQUENTIAL)\n</code></pre>"},{"location":"xtrabackup-implementation-details.html#copy-data-files","title":"Copy data files","text":"<p>When copying the data files to the target directory, xtrabackup reads and writes 1 MB of data at a time. This is not configurable. When copying the log file, xtrabackup reads and writes 512 bytes at a time. This is also not possible to configure, and matches InnoDB\u2019s behavior (workaround exists in Percona Server for MySQL because it has an option to tune <code>innodb_log_block_size</code> for XtraDB, and in that case Percona XtraBackup will match the tuning).</p> <p>After reading from the files, <code>xtrabackup</code> iterates over the 1MB buffer a page at a time, and checks for page corruption on each page with InnoDB\u2019s <code>buf_page_is_corrupted()</code> function. If the page is corrupt, it re-reads and retries up to 10 times for each page. It skips this check on the doublewrite buffer.</p> <p></p>"},{"location":"xtrabackup-implementation-details.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-option-reference.html","title":"The xtrabackup command-line options","text":"<p>Here you can find all of the command-line options for the xtrabackup binary.</p>"},{"location":"xtrabackup-option-reference.html#modes-of-operation","title":"Modes of operation","text":"<p>You invoke xtrabackup in one of the following modes:</p> <ul> <li> <p><code>--backup</code> mode to make a backup in a target directory</p> </li> <li> <p><code>--prepare</code> mode to restore data from a backup (created in <code>--backup</code> mode)</p> </li> <li> <p><code>--copy-back</code> to copy data from a backup to the location   that contained the original data; to move data instead of copying use   the alternate <code>--move-back</code> mode.</p> </li> <li> <p><code>--stats</code> mode to scan the specified data files and print out index statistics.</p> </li> </ul> <p>When you intend to run xtrabackup in any of these modes, use the following syntax:</p> <pre><code>$ xtrabackup [--defaults-file=#] --backup|--prepare|--copy-back|--stats [OPTIONS]\n</code></pre> <p>For example, the <code>--prepare</code> mode is applied as follows:</p> <pre><code>$ xtrabackup --prepare --target-dir=/data/backup/mysql/\n</code></pre> <p>For all modes, the default options are read from the xtrabackup and mysqld configuration groups from the following files in the given order:</p> <ol> <li> <p><code>/etc/my.cnf</code></p> </li> <li> <p><code>/etc/mysql/my.cnf</code></p> </li> <li> <p><code>/usr/etc/my.cnf</code></p> </li> <li> <p><code>~/.my.cnf</code>.</p> </li> </ol> <p>As the first parameter to xtrabackup (in place of the <code>--defaults-file</code>, you may supply one of the following:</p> <ul> <li> <p><code>--print-defaults</code> to have xtrabackup print the argument list and exit.</p> </li> <li> <p><code>--no-defaults</code> to forbid reading options from any file but the login file.</p> </li> <li> <p><code>--defaults-file</code> to read the default options from the given file.</p> </li> <li> <p><code>--defaults-extra-file</code> to read the specified additional file after   the global files have been read.</p> </li> <li> <p><code>--defaults-group-suffix</code> to read the configuration groups with the   given suffix. The effective group name is constructed by concatenating the default   configuration groups (xtrabackup and mysqld) with the given suffix.</p> </li> <li> <p><code>--login-path</code> to read the given path from the login file.</p> </li> </ul>"},{"location":"xtrabackup-option-reference.html#innodb-options","title":"InnoDB options","text":"<p>A large group of InnoDB options are generally read from the <code>my.cnf</code> configuration file, so xtrabackup boots up its embedded InnoDB in the same configuration as your current server. You usually do not need to specify them explicitly. These options have the same behavior in InnoDB and XtraDB. See <code>--innodb-miscellaneous</code> for more information.</p>"},{"location":"xtrabackup-option-reference.html#options","title":"Options","text":""},{"location":"xtrabackup-option-reference.html#apply-log-only","title":"apply-log-only","text":"<p>Usage: <code>--apply-log-only</code></p> <p>This option causes only the redo stage to be performed when preparing a backup. It is very important for incremental backups.</p>"},{"location":"xtrabackup-option-reference.html#backup","title":"backup","text":"<p>Usage: <code>--backup</code></p> <p>Make a backup and place it in <code>--target-dir</code>. See Create a full backup.</p>"},{"location":"xtrabackup-option-reference.html#backup-lock-timeout","title":"backup-lock-timeout","text":"<p>Usage: <code>--backup-lock-timeout</code></p> <p>The timeout in seconds for attempts to acquire metadata locks.</p>"},{"location":"xtrabackup-option-reference.html#backup-lock-retry-count","title":"backup-lock-retry-count","text":"<p>Usage: <code>--backup-lock-retry-count</code></p> <p>The number of attempts to acquire metadata locks.</p>"},{"location":"xtrabackup-option-reference.html#backup-locks","title":"backup-locks","text":"<p>Usage: <code>--backup-locks</code></p> <p>This option controls if backup locks should be used instead of <code>FLUSH TABLES WITH READ LOCK</code> on the backup stage. The option has no effect when the server does not support backup locks. This option is enabled by default, disable with <code>--no-backup-locks</code>.</p>"},{"location":"xtrabackup-option-reference.html#check-privileges","title":"check-privileges","text":"<p>Usage: <code>check-privileges</code></p> <p>This option checks if Percona XtraBackup has all required privileges. If a required privilege is missing for the current operation, the operation terminates and prints an error message. If a privilege is not needed for the current operation, but is missing and may be necessary for another XtraBackup operation, the operation is not aborted, and prints a warning.</p> Example output <pre><code>```{.text .no-copy}\nxtrabackup: Error: missing required privilege LOCK TABLES on *.*\nxtrabackup: Warning: missing required privilege REPLICATION CLIENT on *.*\n```\n</code></pre>"},{"location":"xtrabackup-option-reference.html#close-files","title":"close-files","text":"<p>Usage: <code>--close-files</code></p> <p>Do not keep files opened. When xtrabackup opens a tablespace, xtrabackup normally doesn\u2019t close its file handle. This operation allows xtrabackup to handle the DDL operations correctly. However, if the number of tablespaces is huge and can not fit into any limit, there is an option to close file handles once they are no longer accessed. Percona XtraBackup can produce inconsistent backups with this option enabled. Use at your own risk.</p>"},{"location":"xtrabackup-option-reference.html#compress","title":"compress","text":"<p>Usage: <code>--compress</code></p> <p>xtrabackup compresses all output data, including the transaction log and metadata files. </p> Version updates Option changes Percona XtraBackup 8.0.34-29 * The <code>qpress/QuickLZ</code> compression algorithm is no longer supported for compress operations.  * The <code>ZSTD</code> compression algorithm is moved to  General Availability  . This version makes <code>ZSTD</code> the default compression method for the <code>--compress</code> option.  * <code>--compress</code> produces <code>\\*.zst</code> files. You can specify <code>ZSTD</code> compression level with the <code>--compress-zstd-level=#</code> option.  * <code>--compress=lz4</code> produces <code>\\*.lz4</code> files. You can extract the contents of these files by using <code>lz4</code> program.  You can extract the contents of the files by using the <code>--decompress</code> option. To decompress backups taken by older versions of Percona XtraBackup that used a QuickLZ compression algorithm, the <code>--decompress</code> option still supports <code>qpress</code> for backward compatibility. Percona XtraBackup 8.0.33-28 and lower versions The <code>--compress</code> option uses either the <code>quicklz</code> , <code>lz4</code> , or <code>ZSTD</code> compression algorithm to compress all output data. The <code>quicklz</code> algorithm is chosen by default. When using <code>--compress=quicklz</code> or <code>--compress</code> , the resulting files have the qpress archive format. Every <code>\\*.qp</code> file produced by xtrabackup is essentially a one-file qpress archive and can be extracted and uncompressed by the <code>qpress</code> file archiver.  * <code>--compress=zstd</code> produces <code>\\*.zst</code> files. You can specify <code>ZSTD</code> compression level with the <code>[--compress-zstd-level=#</code>](#compress-zstd-level) option.  * <code>--compress=lz4</code> produces <code>\\*.lz4</code> files. You can extract the contents of these files by using <code>lz4</code> program.  You can extract the contents of the files by using the <code>--decompress</code> option. Percona XtraBackup 8.0.30-23 Adds the Zstandard ( <code>ZSTD</code> ) compression algorithm in  tech preview  . The <code>ZSTD</code> algorithm is a fast lossless compression algorithm that targets real-time compression scenarios and better compression ratios.  To compress files using the ZSTD compression algorithm, set the <code>--compress</code> option to zstd. The <code>--compress=zstd</code> option produces <code>*.zst</code> files. You can extract the contents of these files with the <code>--decompress</code> option. Also, you can specify the ZSTD compression level with the  \u2013compress-zstd-level=#) option."},{"location":"xtrabackup-option-reference.html#compress-chunk-size","title":"compress-chunk-size","text":"<p>Usage: <code>--compress-chunk-size=#</code></p> <p>Size of working buffer(s) for compression threads in bytes. The default value is 64K.</p>"},{"location":"xtrabackup-option-reference.html#compress-threads","title":"compress-threads","text":"<p>Usage: <code>--compress-threads=#</code> This option specifies the number of worker threads xtrabackup uses for parallel data compression. This option defaults to <code>1</code>. Parallel compression (<code>--compress-threads</code>) can be used with <code>--parallel</code>. </p> <p>For example, <code>--parallel=4 --compress --compress-threads=2</code>  creates 4 I/O threads that read and then pipe that data to 2 compression threads.</p>"},{"location":"xtrabackup-option-reference.html#compress-zstd-level","title":"compress-zstd-level","text":"<p>Usage: <code>--compress-zstd-level=#</code></p> <p>This option specifies the <code>ZSTD</code> compression level. Compression levels provide a trade-off between the compression speed and the size of the compressed file. A lower compression level provides faster compression speed but larger file sizes. A higher compression level provides lower compression speed but smaller file sizes. For example, set level 1 if the compression speed is the most important for you. Set level 19 if the size of the compressed files is the most important.</p> <p>The default value is 1. The allowed range is from 1 to 19.</p> <p>Percona XtraBackup 8.0.30-22 implemented this option.</p>"},{"location":"xtrabackup-option-reference.html#copy-back","title":"copy-back","text":"<p>Usage: <code>--copy-back</code></p> <p>Copy all the files in a previously made backup from the backup directory to their original locations. This option will not copy over existing files unless <code>--force-non-empty-directories</code> option is specified.</p>"},{"location":"xtrabackup-option-reference.html#core-file","title":"core-file","text":"<p>Usage: <code>--core-file</code></p> <p>Write core on fatal signals.</p>"},{"location":"xtrabackup-option-reference.html#databases","title":"databases","text":"<p>Usage: <code>--databases=#</code></p> <p>This option specifies a list of databases and tables that should be backed up. The option accepts the list of the form <code>\"databasename1[.table_name1] databasename2[.table_name2] . . .\"</code>.</p>"},{"location":"xtrabackup-option-reference.html#databases-exclude","title":"databases-exclude","text":"<p>Usage: <code>--databases-exclude=name</code></p> <p>Databases are excluded based on name. This option operates the same way as <code>--databases</code>, but excludes the matched names from the backup. </p> <p>This option has a higher priority than <code>--databases</code>.</p>"},{"location":"xtrabackup-option-reference.html#databases-file","title":"databases-file","text":"<p>Usage: <code>--databases-file=#</code></p> <p>This option specifies the path to the file containing the list of databases and tables that should be backed up. The file can contain the list elements of the form <code>databasename1[.table_name1]</code>, one element per line.</p>"},{"location":"xtrabackup-option-reference.html#datadir","title":"datadir","text":"<p>Usage: <code>--datadir=DIRECTORY</code></p> <p>The source directory for the backup. This directory should be the same as the datadir for your MySQL server, so it should be read from <code>my.cnf</code> if that exists; otherwise, you must specify it on the command line.</p> <p>When combined with the <code>--copy-back</code> or <code>--move-back</code> option, <code>--datadir</code> refers to the destination directory.</p> <p>Once connected to the server, to perform a backup, you will need <code>READ</code> and <code>EXECUTE</code> permissions at a filesystem level in the server\u2019s datadir.</p>"},{"location":"xtrabackup-option-reference.html#debug-sleep-before-unlock","title":"debug-sleep-before-unlock","text":"<p>Usage: <code>--debug-sleep-before-unlock=#</code></p> <p>This is a debug-only option used by the xtrabackup test suite.</p>"},{"location":"xtrabackup-option-reference.html#debug-sync","title":"debug-sync","text":"<p>Usage: <code>--debug-sync=name</code></p> <p>The debug sync point. This option is only used by the xtrabackup test suite.</p>"},{"location":"xtrabackup-option-reference.html#decompress","title":"decompress","text":"<p>Usage: <code>--decompress</code></p> <p>Decompresses all files in a backup previously made with the <code>--compress</code> option. The <code>--parallel</code> option will allow multiple files to be decrypted simultaneously. To decompress files compressed with <code>quicklz</code> compression algorithm, install the qpress utility. It must be accessible within the path. Percona XtraBackup does not automatically remove the compressed files. To clean up the backup directory users should use <code>--remove-original</code> option.</p> <p>The <code>--decompress</code> option may be used with xbstream to decompress individual qpress files.</p>"},{"location":"xtrabackup-option-reference.html#decompress-threads","title":"decompress-threads","text":"<p>Usage: <code>--decompress-threads=#</code></p> <p>Force xbstream to use the specified number of threads for decompressing.</p>"},{"location":"xtrabackup-option-reference.html#decrypt","title":"decrypt","text":"<p>Usage: <code>--decrypt=ENCRYPTION-ALGORITHM</code></p> <p>Decrypts all files with the <code>.xbcrypt</code> extension in a backup previously made with <code>--encrypt</code> option. The <code>--parallel</code> option will allow multiple files to be decrypted simultaneously. Percona XtraBackup doesn\u2019t automatically remove the encrypted files. To clean up the backup directory users should use <code>--remove-original</code> option.</p>"},{"location":"xtrabackup-option-reference.html#defaults-extra-file","title":"defaults-extra-file","text":"<p>Usage: <code>--defaults-extra-file=[MY.CNF]</code></p> <p>Read this file after the global files are read. This option must be written as the first option on the command line.</p>"},{"location":"xtrabackup-option-reference.html#defaults-file","title":"defaults-file","text":"<p>Usage: <code>--defaults-file=[MY.CNF]</code></p> <p>Only read default options from the given file. Must be given as the first option on the command-line. Must be a real file; it cannot be a symbolic link.</p>"},{"location":"xtrabackup-option-reference.html#defaults-group","title":"defaults-group","text":"<p>Usage: <code>--defaults-group=GROUP-NAME</code>This option sets the group that should be read from the configuration file. This option is used by xtrabackup if you use the <code>--defaults-group</code> option. It is needed for <code>mysqld_multi</code> deployments.</p>"},{"location":"xtrabackup-option-reference.html#defaults-group-suffix","title":"defaults-group-suffix","text":"<p>Usage: <code>--defaults-group-suffix=#</code></p> <p>Also reads groups with concat(group, suffix).</p>"},{"location":"xtrabackup-option-reference.html#dump-innodb-buffer-pool","title":"dump-innodb-buffer-pool","text":"<p>Usage: <code>--dump-innodb-buffer-pool</code></p> <p>This option controls whether or not a new dump of buffer pool content should be done.</p> <p>With <code>--dump-innodb-buffer-pool</code>, xtrabackup makes a request to the server to start the buffer pool dump (it takes some time to complete and is done in the background) at the beginning of a backup provided the status variable <code>innodb_buffer_pool_dump_status</code> reports that the dump has been completed.</p> <pre><code>$ xtrabackup --backup --dump-innodb-buffer-pool --target-dir=/home/user/backup\n</code></pre> <p>By default, this option is set to OFF.</p> <p>If <code>innodb_buffer_pool_dump_status</code> reports that there is running dump of the buffer pool, xtrabackup waits for the dump to complete using the value of <code>--dump-innodb-buffer-pool-timeout</code></p> <p>The file <code>ib_buffer_pool</code> stores tablespace ID and page ID data to warm up the buffer pool sooner.</p>"},{"location":"xtrabackup-option-reference.html#dump-innodb-buffer-pool-timeout","title":"dump-innodb-buffer-pool-timeout","text":"<p>Usage: <code>--dump-innodb-buffer-pool-timeout</code></p> <p>This option contains the number of seconds that xtrabackup should monitor the value of <code>innodb_buffer_pool_dump_status</code> to determine if buffer pool dump has completed.</p> <p>This option is used in combination with <code>--dump-innodb-buffer-pool</code>. By default, it is set to 10 seconds.</p>"},{"location":"xtrabackup-option-reference.html#dump-innodb-buffer-pool-pct","title":"dump-innodb-buffer-pool-pct","text":"<p>Usage: <code>--dump-innodb-buffer-pool-pct</code></p> <p>This option contains the percentage of the most recently used buffer pool pages to dump.</p> <p>This option is effective if <code>--dump-innodb-buffer-pool</code> option is set to ON. If this option contains a value, xtrabackup sets the MySQL system variable <code>innodb_buffer_pool_dump_pct</code>. As soon as the buffer pool dump completes or it is stopped (see <code>--dump-innodb-buffer-pool-timeout</code>), the value of the MySQL system variable is restored.</p>"},{"location":"xtrabackup-option-reference.html#encrypt","title":"encrypt","text":"<p>Usage: <code>--encrypt=ENCRYPTION_ALGORITHM</code></p> <p>This option instructs xtrabackup to encrypt backup copies of InnoDB data files using the algorithm specified in the ENCRYPTION_ALGORITHM. Currently supported algorithms are: <code>AES128</code>, <code>AES192</code> and <code>AES256</code></p>"},{"location":"xtrabackup-option-reference.html#encrypt-key","title":"encrypt-key","text":"<p>Usage: <code>--encrypt-key=ENCRYPTION_KEY</code></p> <p>A proper length encryption key to use. It is not recommended to use this option where there is uncontrolled access to the machine as the command line and thus the key can be viewed as part of the process info.</p>"},{"location":"xtrabackup-option-reference.html#encrypt-key-file","title":"encrypt-key-file","text":"<p>Usage: <code>--encrypt-key-file=ENCRYPTION_KEY_FILE</code></p> <p>The name of a file where the raw key of the appropriate length can be read from. The file must be a simple binary (or text) file that contains exactly the key to be used.</p> <p>It is passed directly to the xtrabackup child process. See the xtrabackup documentation for more details.</p>"},{"location":"xtrabackup-option-reference.html#encrypt-threads","title":"encrypt-threads","text":"<p>Usage: <code>--encrypt-threads=#</code></p> <p>This option specifies the number of worker threads that will be used for parallel encryption/decryption. See the xtrabackup documentation for more details.</p>"},{"location":"xtrabackup-option-reference.html#encrypt-chunk-size","title":"encrypt-chunk-size","text":"<p>Usage: <code>--encrypt-chunk-size=#</code></p> <p>This option specifies the size of the internal working buffer for each encryption thread, measured in bytes. It is passed directly to the xtrabackup child process.</p> <p>To adjust the chunk size for encrypted files, use <code>--read-buffer-size</code> and <code>--encrypt-chunk-size</code>.</p>"},{"location":"xtrabackup-option-reference.html#estimate-memory","title":"estimate-memory","text":"<p>Usage: <code>--estimate-memory=#</code></p> <p>This option is in tech preview. Before using this option in production, we recommend that you test restoring production from physical backups in your environment, and also use the alternative backup method for redundancy.</p> <p>Implemented in Percona XtraBackup 8.0.32-26, the option lets you enable or disable the Smart memory estimation feature. The default value is OFF. Enable the feature by setting <code>--estimate-memory=ON</code> in the backup phase and setting the <code>--use-free-memory-pct</code> option in the <code>--prepare</code> phase. If the <code>--estimate-memory</code> setting is disabled, the <code>--use-free-memory-pct</code> setting is ignored.</p> <p>An example of how to enable the Smart memory estimation feature:</p> <pre><code>$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/\n</code></pre> <pre><code>$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/\n</code></pre>"},{"location":"xtrabackup-option-reference.html#export","title":"export","text":"<p>Usage: <code>--export</code></p> <p>Create files necessary for exporting tables. See restore individual tables.</p>"},{"location":"xtrabackup-option-reference.html#extra-lsndir","title":"extra-lsndir","text":"<p>Usage: <code>--extra-lsndir=DIRECTORY</code></p> <p>(for \u2013backup): save an extra copy of the <code>xtrabackup_checkpoints</code> and <code>xtrabackup_info</code> files in this directory.</p>"},{"location":"xtrabackup-option-reference.html#force-non-empty-directories","title":"force-non-empty-directories","text":"<p>Usage: <code>--force-non-empty-directories</code></p> <p>When specified, it makes <code>--copy-back</code> and <code>--move-back</code> option transfer files to non-empty directories. No existing files will be overwritten. If files that need to be copied/moved from the backup directory already exist in the destination directory, it will still fail with an error.</p>"},{"location":"xtrabackup-option-reference.html#ftwrl-wait-timeout","title":"ftwrl-wait-timeout","text":"<p>Usage: <code>--ftwrl-wait-timeout=SECONDS</code></p> <p>This option specifies time in seconds that xtrabackup should wait for queries that would block <code>FLUSH TABLES WITH READ LOCK</code> before running it. If there are still such queries when the timeout expires, xtrabackup terminates with an error. Default is <code>0</code>, in which case it does not wait for queries to complete and starts <code>FLUSH TABLES WITH READ LOCK</code> immediately. Where supported xtrabackup will automatically use Backup Locks as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p>"},{"location":"xtrabackup-option-reference.html#ftwrl-wait-threshold","title":"ftwrl-wait-threshold","text":"<p>Usage: <code>--ftwrl-wait-threshold=SECONDS</code></p> <p>This option specifies the query run time threshold which is used by xtrabackup to detect long-running queries with a non-zero value of <code>--ftwrl-wait-timeout</code>. <code>FLUSH TABLES WITH READ LOCK</code> is not started until such long-running queries exist. This option has no effect if <code>--ftwrl-wait-timeout</code> is <code>0</code>. Default value is <code>60</code> seconds. Where supported xtrabackup will automatically use Backup Locks as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p>"},{"location":"xtrabackup-option-reference.html#ftwrl-wait-query-type","title":"ftwrl-wait-query-type","text":"<p>Usage: <code>--ftwrl-wait-query-type=all|update</code></p> <p>This option specifies which types of queries are allowed to complete before xtrabackup will issue the global lock. Default is <code>all</code>.</p>"},{"location":"xtrabackup-option-reference.html#galera-info","title":"galera-info","text":"<p>Usage: <code>--galera-info</code></p> <p>This option creates the <code>xtrabackup_galera_info</code> file which contains the local node state at the time of the backup. Option should be used when performing the backup of Percona XtraDB Cluster. It has no effect when backup locks are used to create the backup.</p>"},{"location":"xtrabackup-option-reference.html#generate-new-master-key","title":"generate-new-master-key","text":"<p>Usage: <code>--generate-new-master-key</code></p> <p>Generate a new master key when doing a copy-back.</p>"},{"location":"xtrabackup-option-reference.html#generate-transition-key","title":"generate-transition-key","text":"<p>Usage: <code>--generate-transition-key</code></p> <p>xtrabackup needs to access the same keyring file or vault server during prepare and copy-back but it should not depend on whether the server keys have been purged.</p> <p><code>--generate-transition-key</code> creates and adds to the keyring a transition key for xtrabackup to use if the master key used for encryption is not found because it has been rotated and purged.</p>"},{"location":"xtrabackup-option-reference.html#get-server-public-key","title":"get-server-public-key","text":"<p>Usage: <code>--get-server-public-key</code></p> <p>Get the server public key</p>"},{"location":"xtrabackup-option-reference.html#help","title":"help","text":"<p>Usage: <code>--help</code></p> <p>When run with this option or without any options xtrabackup displays information about how to run the program on the command line along with all supported options and variables with default values where appropriate.</p>"},{"location":"xtrabackup-option-reference.html#history","title":"history","text":"<p>Usage: <code>--history=NAME</code></p> <p>This option enables the tracking of backup history in the <code>PERCONA_SCHEMA.xtrabackup_history</code> table. An optional history series name may be specified that will be placed with the history record for the current backup being taken.</p>"},{"location":"xtrabackup-option-reference.html#host","title":"host","text":"<p>Usage: <code>--host=HOST</code></p> <p>This option accepts a string argument that specifies the host to use when connecting to the database server with TCP/IP. It is passed to the mysql child process without alteration. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#incremental-basedir","title":"incremental-basedir","text":"<p>Usage: <code>--incremental-basedir=DIRECTORY</code></p> <p>When creating an incremental backup, this is the directory containing the full backup that is the base dataset for the incremental backups.</p>"},{"location":"xtrabackup-option-reference.html#incremental-dir","title":"incremental-dir","text":"<p>Usage: <code>--incremental-dir=DIRECTORY</code></p> <p>When preparing an incremental backup, this is the directory where the incremental backup is combined with the full backup to make a new full backup.</p>"},{"location":"xtrabackup-option-reference.html#incremental-force-scan","title":"incremental-force-scan","text":"<p>Usage: <code>--incremental-force-scan</code></p> <p>When creating an incremental backup, force a full scan of the data pages in that instance.</p>"},{"location":"xtrabackup-option-reference.html#incremental-history-name","title":"incremental-history-name","text":"<p>Usage: <code>--incremental-history-name=name</code></p> <p>This option specifies the name of the backup series stored in the <code>PERCONA_SCHEMA.xtrabackup_history</code> history record to base an incremental backup on. xtrabackup will search the history table looking for the most recent (highest <code>innodb_to_lsn</code>), successful backup in the series and take the to_lsn value to use as the starting <code>lsn</code> for the incremental backup. This will be mutually exclusive with <code>--incremental-history-uuid</code>, <code>--incremental-basedir</code> and <code>--incremental-lsn</code>. If no valid lsn can be found (no series by that name, no successful backups by that name) xtrabackup will return with an error. It is used with the <code>--incremental</code> option.</p>"},{"location":"xtrabackup-option-reference.html#incremental-history-uuid","title":"incremental-history-uuid","text":"<p>Usage: <code>--incremental-history-uuid=name</code></p> <p>This option specifies the UUID of the specific history record stored in the <code>PERCONA_SCHEMA.xtrabackup_history</code> to base an incremental backup on. <code>--incremental-history-name</code>, <code>--incremental-basedir</code> and <code>--incremental-lsn</code>. If no valid lsn can be found (no success record with that UUID) xtrabackup will return with an error. It is used with the \u2013incremental option.</p>"},{"location":"xtrabackup-option-reference.html#incremental-lsn","title":"incremental-lsn","text":"<p>Usage: <code>--incremental-lsn=LSN</code></p> <p>When creating an incremental backup, you can specify the log sequence number (LSN) instead of specifying <code>--incremental-basedir</code>. For databases created in 5.1 and later, specify the LSN as a single 64-bit integer. </p> <p>Important</p> <p>If a wrong LSN value is specified (a user error which Percona XtraBackup does not detect), the backup is unusable. Be careful!</p>"},{"location":"xtrabackup-option-reference.html#innodb","title":"innodb","text":"<p>Usage: <code>--innodb=name</code></p> <p>This option is ignored for MySQL option compatibility.</p>"},{"location":"xtrabackup-option-reference.html#innodb-miscellaneous","title":"innodb-miscellaneous","text":"<p>Usage: <code>--innodb-miscellaneous</code></p> <p>There is a large group of InnoDB options that are normally read from the <code>my.cnf</code> configuration file, so that xtrabackup boots up its embedded InnoDB in the same configuration as your current server. You normally do not need to specify these explicitly. These options have the same behavior in InnoDB and XtraDB:</p>"},{"location":"xtrabackup-option-reference.html#keyring-file-data","title":"keyring-file-data","text":"<p>Usage: <code>--keyring-file-data=FILENAME</code></p> <p>The path to the keyring file. Combine this option with <code>--xtrabackup-plugin-dir</code>.</p>"},{"location":"xtrabackup-option-reference.html#kill-long-queries-timeout","title":"kill-long-queries-timeout","text":"<p>Usage: <code>--kill-long-queries-timeout=SECONDS</code></p> <p>This option specifies the number of seconds xtrabackup waits between starting <code>FLUSH TABLES WITH READ LOCK</code> and killing those queries that block it. Default is 0 seconds, which means xtrabackup will not attempt to kill any queries. In order to use this option xtrabackup user should have the <code>PROCESS</code> and <code>SUPER</code> privileges. Where supported, xtrabackup automatically uses Backup locks as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.</p>"},{"location":"xtrabackup-option-reference.html#kill-long-query-type","title":"kill-long-query-type","text":"<p>Usage: <code>--kill-long-query-type=all|select</code></p> <p>This option specifies which types of queries should be killed to unblock the global lock. Default is \u201cselect\u201d.</p>"},{"location":"xtrabackup-option-reference.html#lock-ddl","title":"lock-ddl","text":"<p>Usage: <code>--lock-ddl</code></p> <p>Issue <code>LOCK TABLES FOR BACKUP</code> if it is supported by server (otherwise use <code>LOCK INSTANCE FOR BACKUP</code>) at the beginning of the backup to block all DDL operations.</p> <p>Note</p> <p>Prior to Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup stops the SQL replica thread after the InnoDB tables and before the non-InnoDB tables are backed up.</p> <p>As of Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup option stops the SQL replica thread before copying the InnoDB files.</p>"},{"location":"xtrabackup-option-reference.html#lock-ddl-per-table","title":"lock-ddl-per-table","text":"<p>Usage: <code>--lock-ddl-per-table</code></p> <p>Lock DDL for each table before xtrabackup starts to copy it and until the backup is completed.</p> <p>Note</p> <p>The [\u2013lock-ddl-per-table] option is deprecated. Use the [\u2013lock-ddl] option instead.</p>"},{"location":"xtrabackup-option-reference.html#lock-ddl-timeout","title":"lock-ddl-timeout","text":"<p>Usage: <code>--lock-ddl-timeout</code></p> <p>If <code>LOCK TABLES FOR BACKUP</code> or <code>LOCK INSTANCE FOR BACKUP</code> does not return within given timeout, abort the backup.</p>"},{"location":"xtrabackup-option-reference.html#log","title":"log","text":"<p>Usage: <code>--log</code></p> <p>This option is ignored for MySQL</p>"},{"location":"xtrabackup-option-reference.html#log-bin","title":"log-bin","text":"<p>Usage: <code>--log-bin</code></p> <p>The base name for the log sequence.</p>"},{"location":"xtrabackup-option-reference.html#log-bin-index","title":"log-bin-index","text":"<p>Usage: <code>--log-bin-index=name</code></p> <p>File that holds the names for binary log files.</p>"},{"location":"xtrabackup-option-reference.html#log-copy-interval","title":"log-copy-interval","text":"<p>Usage: <code>--log-copy-interval=#</code></p> <p>This option specifies the time interval between checks done by the log copying thread in milliseconds (default is 1 second).</p>"},{"location":"xtrabackup-option-reference.html#login-path","title":"login-path","text":"<p>Usage: <code>--login-path</code></p> <p>Read the given path from the login file.</p>"},{"location":"xtrabackup-option-reference.html#move-back","title":"move-back","text":"<p>Usage: <code>--move-back</code></p> <p>Move all the files in a previously made backup from the backup directory to their original locations. As this option removes backup files, it must be used with caution.</p>"},{"location":"xtrabackup-option-reference.html#no-backup-locks","title":"no-backup-locks","text":"<p>Usage: <code>--no-backup-locks</code></p> <p>Explicity disables the <code>--backup-locks</code> option which is enabled by default.</p>"},{"location":"xtrabackup-option-reference.html#no-defaults","title":"no-defaults","text":"<p>Usage: <code>--no-defaults</code></p> <p>The default options are only read from the login file.</p>"},{"location":"xtrabackup-option-reference.html#no-lock","title":"no-lock","text":"<p>Usage: <code>--no-lock</code></p> <p>Disables table lock with <code>FLUSH TABLES WITH READ LOCK</code>. Use it only if all your tables are InnoDB and you do not care about the binary log position of the backup. This option shouldn\u2019t be used if there are any <code>DDL</code> statements being executed or if any updates are happening on non-InnoDB tables (this includes the system MyISAM tables in the mysql database), otherwise it could lead to an inconsistent backup. Where supported xtrabackup will automatically use Backup locks as a lightweight alternative to <code>FLUSH TABLES WITH READ LOCK</code> to copy non-InnoDB data to avoid blocking DML queries that modify InnoDB tables.  If you are considering to use this because your backups are failing to acquire the lock, this could be because of incoming replication events are preventing the lock from succeeding. Please try using <code>--safe-slave-backup</code> to momentarily stop the replication replica thread, this may help the backup to succeed and you do not need to use this option.</p>"},{"location":"xtrabackup-option-reference.html#no-server-version-check","title":"no-server-version-check","text":"<p>Usage: <code>--no-server-version-check</code></p> <p>Implemented in Percona XtraBackup 8.0.21.</p> <p>The <code>--no-server-version-check</code> option disables the server version check.</p> <p>The default behavior runs a check that compares the source system version to the Percona XtraBackup version. If the source system version is higher than the XtraBackup version, the backup is aborted with a message.</p> <p>Adding the option overrides this check, and the backup proceeds, but there may be issues with the backup.</p> <p>See Server Version and Backup Version Comparison for more information.</p>"},{"location":"xtrabackup-option-reference.html#no-version-check","title":"no-version-check","text":"<p>Usage: <code>--no-version-check</code></p> <p>This option disables the version check. If you do not pass this option, the automatic version check is enabled implicitly when xtrabackup runs in the <code>--backup</code> mode. To disable the version check, you should pass explicitly the <code>--no-version-check</code> option when invoking xtrabackup.</p> <p>When the automatic version check is enabled, xtrabackup performs a version check against the server on the backup stage after creating a server connection. xtrabackup sends the following information to the server:</p> <ul> <li> <p>MySQL flavor and version</p> </li> <li> <p>Operating system name</p> </li> <li> <p>Percona Toolkit version</p> </li> <li> <p>Perl version</p> </li> </ul> <p>Each piece of information has a unique identifier. This is a MD5 hash value that Percona Toolkit uses to obtain statistics about how it is used. This is a random UUID; no client information is either collected or stored.</p>"},{"location":"xtrabackup-option-reference.html#open-files-limit","title":"open-files-limit","text":"<p>Usage: <code>--open-files-limit=#</code></p> <p>The maximum number of file descriptors to reserve with setrlimit().</p>"},{"location":"xtrabackup-option-reference.html#parallel","title":"parallel","text":"<p>Usage: <code>--parallel=#</code></p> <p>This option specifies the number of threads to use to copy multiple data files concurrently when creating a backup. The default value is 1 (i.e., no concurrent transfer). In Percona XtraBackup 2.3.10 and newer, this option can be used with the <code>--copy-back</code> option to copy the user data files in parallel (redo logs and system tablespaces are copied in the main thread).</p>"},{"location":"xtrabackup-option-reference.html#password","title":"password","text":"<p>Usage: <code>--password=PASSWORD</code></p> <p>This option specifies the password to use when connecting to the database. It accepts a string argument. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#plugin-load","title":"plugin-load","text":"<p>Usage: <code>--plugin-load</code></p> <p>List of plugins to load.</p>"},{"location":"xtrabackup-option-reference.html#port","title":"port","text":"<p>Usage: <code>--port=PORT</code></p> <p>This option accepts a string argument that specifies the port to use when connecting to the database server with TCP/IP. It is passed to the mysql child process without alteration. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#prepare","title":"prepare","text":"<p>Usage: <code>--prepare</code></p> <p>Makes xtrabackup perform a recovery on a backup created with <code>--backup</code>, so that it is ready to use. See preparing a backup.</p>"},{"location":"xtrabackup-option-reference.html#print-defaults","title":"print-defaults","text":"<p>Usage: <code>--print-defaults</code></p> <p>Print the program argument list and exit. Must be given as the first option on the command-line.</p>"},{"location":"xtrabackup-option-reference.html#print-param","title":"print-param","text":"<p>Usage: <code>--print-param</code></p> <p>Makes xtrabackup print out parameters that can be used for copying the data files back to their original locations to restore them.</p>"},{"location":"xtrabackup-option-reference.html#read-buffer-size","title":"read-buffer-size","text":"<p>Usage: <code>--read-buffer-size</code></p> <p>Sets the read buffer size. The given value is scaled up to page size. The default size is 10MB. Use this option to increase the xbcloud/xbstream chunk size from the default size. To adjust the chunk size for encrypted files, use <code>--read-buffer-size</code> and <code>--encrypt-chunk-size</code>.</p>"},{"location":"xtrabackup-option-reference.html#redo-log-arch-dir","title":"redo-log-arch-dir","text":"<p>Usage: <code>--redo-log-arch-dir=name</code></p> <p>This option sets the redo log archive directory if this directory is not already set on the server. To use this option, you must run Percona XtraBackup as the owner of <code>mysqld</code>. Additionally, the user must have at least one of the following privileges: <code>SUPER</code> or <code>SYSTEM_VARIABLES_ADMIN</code>.</p> <p>Implemented in Percona XtraBackup 8.0.34-29.</p>"},{"location":"xtrabackup-option-reference.html#register-redo-log-consumer","title":"register-redo-log-consumer","text":"<p>Usage: <code>--register-redo-log-consumer</code></p> <p>The <code>--register-redo-log-consumer</code> parameter is disabled by default. When enabled, this parameter lets Percona XtraBackup register as a redo log consumer at the start of the backup. The server does not remove a redo log that Percona XtraBackup (the consumer) has not yet copied. The consumer reads the redo log and manually advances the log sequence number (LSN). The server blocks the writes during the process. Based on the redo log consumption, the server determines when it can purge the log.</p> <p>Implemented in Percona XtraBackup 8.0.30-23.</p>"},{"location":"xtrabackup-option-reference.html#remove-original","title":"remove-original","text":"<p>Usage: <code>--remove-original</code></p> <p>Implemented in Percona XtraBackup 2.4.6, this option when specified will remove <code>.qp</code>, <code>.xbcrypt</code> and <code>.qp.xbcrypt</code> files after decryption and decompression.</p>"},{"location":"xtrabackup-option-reference.html#rocksdb-datadir","title":"rocksdb-datadir","text":"<p>Usage: <code>--rocksdb-datadir</code></p> <p>RocksDB data directory</p>"},{"location":"xtrabackup-option-reference.html#rocksdb-wal-dir","title":"rocksdb-wal-dir","text":"<p>Usage: <code>--rocksdb-wal-dir</code></p> <p>RocksDB WAL directory.</p>"},{"location":"xtrabackup-option-reference.html#rocksdb-checkpoint-max-age","title":"rocksdb-checkpoint-max-age","text":"<p>Usage: <code>--rocksdb-checkpoint-max-age</code></p> <p>The checkpoint cannot be older than this number of seconds when the backup completes.</p>"},{"location":"xtrabackup-option-reference.html#rocksdb-checkpoint-max-count","title":"rocksdb-checkpoint-max-count","text":"<p>Usage: <code>--rocksdb-checkpoint-max-count</code></p> <p>Complete the backup even if the checkpoint age requirement has not been met after this number of checkpoints.</p>"},{"location":"xtrabackup-option-reference.html#rollback-prepared-trx","title":"rollback-prepared-trx","text":"<p>Usage: <code>--rollback-prepared-trx</code></p> <p>Force rollback prepared InnoDB transactions.</p>"},{"location":"xtrabackup-option-reference.html#rsync","title":"rsync","text":"<p>Usage: <code>--rsync</code></p> <p>Uses the rsync utility to optimize local file transfers. When this option is specified, xtrabackup uses rsync to copy all non-InnoDB files instead of spawning a separate cp for each file, which can be much faster for servers with a large number of databases or tables.  This option cannot be used together with <code>--stream</code>.</p>"},{"location":"xtrabackup-option-reference.html#safe-slave-backup","title":"safe-slave-backup","text":"<p>Usage: <code>--safe-slave-backup</code></p> <p>When specified, xtrabackup will stop the replica SQL thread just before running <code>FLUSH TABLES WITH READ LOCK</code> and wait to start backup until <code>Slave_open_temp_tables</code> in <code>SHOW STATUS</code> is zero. If there are no open temporary tables, the backup will take place, otherwise the SQL thread will be started and stopped until there are no open temporary tables. The backup will fail if <code>Slave_open_temp_tables</code> does not become zero after <code>--safe-slave-backup-timeout</code> seconds. The replication SQL thread will be restarted when the backup finishes. This option is implemented in order to deal with replicating temporary tables and isn\u2019t necessary with Row-Based-Replication.</p> <p>Note</p> <p>Prior to Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup stops the SQL replica thread after the InnoDB tables and before the non-InnoDB tables are backed up.</p> <p>As of Percona XtraBackup 8.0.22-15.0, using a safe-slave-backup option stops the SQL replica thread before copying the InnoDB files.</p>"},{"location":"xtrabackup-option-reference.html#safe-slave-backup-timeout","title":"safe-slave-backup-timeout","text":"<p>Usage: <code>--safe-slave-backup-timeout=SECONDS</code></p> <p>How many seconds <code>--safe-slave-backup</code> should wait for <code>Slave_open_temp_tables</code> to become zero. Defaults to 300 seconds.</p>"},{"location":"xtrabackup-option-reference.html#secure-auth","title":"secure-auth","text":"<p>Usage: <code>--secure-auth</code></p> <p>Refuse client connecting to server if it uses old (pre-4.1.1) protocol. (Enabled by default; use \u2013skip-secure-auth to disable.)</p>"},{"location":"xtrabackup-option-reference.html#server-id","title":"server-id","text":"<p>Usage: <code>--server-id=#</code></p> <p>The server instance being backed up.</p>"},{"location":"xtrabackup-option-reference.html#server-public-key-path","title":"server-public-key-path","text":"<p>Usage: <code>--server-public-key-path</code></p> <p>The file path to the server public RSA key in the PEM format.</p>"},{"location":"xtrabackup-option-reference.html#skip-tables-compatibility-check","title":"skip-tables-compatibility-check","text":"<p>Usage: <code>--skip-tables-compatibility-check</code></p> <p>See <code>--tables-compatibility-check</code>.</p>"},{"location":"xtrabackup-option-reference.html#slave-info","title":"slave-info","text":"<p>Usage: <code>--slave-info</code></p> <p>This option is useful when backing up a replication replica server. It prints the binary log position of the source server. It also writes the binary log coordinates to the <code>xtrabackup_slave_info</code> file as a <code>CHANGE MASTER</code> command. A new replica for this source can be set up by starting a replica server on this backup and issuing a <code>CHANGE MASTER</code> command with the binary log position saved in the <code>xtrabackup_slave_info</code> file.</p>"},{"location":"xtrabackup-option-reference.html#socket","title":"socket","text":"<p>Usage: <code>--socket</code></p> <p>This option accepts a string argument that specifies the socket to use when connecting to the local database server with a UNIX domain socket. It is passed to the mysql child process without alteration. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#ssl","title":"ssl","text":"<p>Usage: <code>--ssl</code></p> <p>Enable secure connection.</p>"},{"location":"xtrabackup-option-reference.html#ssl-ca","title":"ssl-ca","text":"<p>Usage: <code>--ssl-ca</code></p> <p>Path of the file which contains list of trusted SSL CAs.</p>"},{"location":"xtrabackup-option-reference.html#ssl-capath","title":"ssl-capath","text":"<p>Usage: <code>--ssl-capath</code></p> <p>Directory path that contains trusted SSL CA certificates in PEM format.</p>"},{"location":"xtrabackup-option-reference.html#ssl-cert","title":"ssl-cert","text":"<p>Usage: <code>--ssl-cert</code></p> <p>Path of the file which contains X509 certificate in PEM format.</p>"},{"location":"xtrabackup-option-reference.html#ssl-cipher","title":"ssl-cipher","text":"<p>Usage: <code>--ssl-cipher</code></p> <p>List of permitted ciphers to use for connection encryption.</p>"},{"location":"xtrabackup-option-reference.html#ssl-crl","title":"ssl-crl","text":"<p>Usage: <code>--ssl-crl</code></p> <p>Path of the file that contains certificate revocation lists. MySQL server documentation.</p>"},{"location":"xtrabackup-option-reference.html#ssl-crlpath","title":"ssl-crlpath","text":"<p>Usage: <code>--ssl-crlpath</code></p> <p>Path of directory that contains certificate revocation list files. </p>"},{"location":"xtrabackup-option-reference.html#ssl-fips-mode","title":"ssl-fips-mode","text":"<p>Usage: <code>--ssl-fips-mode</code></p> <p>SSL FIPS mode (applies only for OpenSSL); permitted values are: OFF, ON, STRICT.</p>"},{"location":"xtrabackup-option-reference.html#ssl-key","title":"ssl-key","text":"<p>Usage: <code>--ssl-key</code></p> <p>Path of file that contains X509 key in PEM format.</p>"},{"location":"xtrabackup-option-reference.html#ssl-mode","title":"ssl-mode","text":"<p>Usage: <code>--ssl-mode</code></p> <p>Security state of connection to server.</p>"},{"location":"xtrabackup-option-reference.html#ssl-verify-server-cert","title":"ssl-verify-server-cert","text":"<p>Usage: <code>--ssl-verify-server-cert</code></p> <p>Verify server certificate Common Name value against host name used when connecting to server.</p>"},{"location":"xtrabackup-option-reference.html#stats","title":"stats","text":"<p>Usage: <code>--stats</code></p> <p>Causes xtrabackup to scan the specified data files and print out index statistics.</p>"},{"location":"xtrabackup-option-reference.html#stream","title":"stream","text":"<p>Usage: <code>--stream=FORMAT</code></p> <p>Stream all backup files to the standard output in the specified format. Currently, this option only supports the xbstream format.</p>"},{"location":"xtrabackup-option-reference.html#strict","title":"strict","text":"<p>Usage: <code>--strict</code></p> <p>If this option is specified, xtrabackup fails with an error when invalid parameters are passed.</p>"},{"location":"xtrabackup-option-reference.html#tables","title":"tables","text":"<p>Usage: <code>--tables=name</code></p> <p>A regular expression against which the full tablename, in <code>databasename.tablename</code> format, is matched. If the name matches, the table is backed up. See partial backups.</p>"},{"location":"xtrabackup-option-reference.html#tables-compatibility-check","title":"tables-compatibility-check","text":"<p>Usage: <code>--tables-compatibility-check</code></p> <p>Enables the engine compatibility warning. The default value is ON. To disable the engine compatibility warning use <code>--skip-tables-compatibility-check</code>.</p>"},{"location":"xtrabackup-option-reference.html#tables-exclude","title":"tables-exclude","text":"<p>Usage: <code>--tables-exclude=name</code></p> <p>Filtering by regexp for table names. Operates the same way as <code>--tables</code>, but matched names are excluded from backup. Note that this option has a higher priority than <code>--tables</code>.</p>"},{"location":"xtrabackup-option-reference.html#tables-file","title":"tables-file","text":"<p>Usage: <code>--tables-file=name</code></p> <p>A file containing one table name per line, in databasename.tablename format. The backup will be limited to the specified tables.</p>"},{"location":"xtrabackup-option-reference.html#target-dir","title":"target-dir","text":"<p>Usage: <code>--target-dir=DIRECTORY</code></p> <p>This option specifies the destination directory for the backup. If the directory does not exist, xtrabackup creates it. If the directory does exist and is empty, xtrabackup will succeed. xtrabackup will not overwrite existing files, however; it will fail with operating system error 17, <code>file exists</code>.</p> <p>If this option is a relative path, it is interpreted as being relative to the current working directory from which xtrabackup is executed.</p> <p>In order to perform a backup, you need <code>READ</code>, <code>WRITE</code>, and <code>EXECUTE</code> permissions at a filesystem level for the directory that you supply as the value of <code>--target-dir</code>.</p>"},{"location":"xtrabackup-option-reference.html#innodb-temp-tablespaces-dir","title":"innodb-temp-tablespaces-dir","text":"<p>Usage: <code>--innodb-temp-tablespaces-dir=DIRECTORY</code></p> <p>Directory where temp tablespace files live, this path can be absolute.</p>"},{"location":"xtrabackup-option-reference.html#throttle","title":"throttle","text":"<p>Usage: <code>--throttle=#</code></p> <p>This option limits the number of chunks copied per second. The chunk size is 10 MB. </p> <p>To limit the bandwidth to 10 MB/s, set the option to 1.</p>"},{"location":"xtrabackup-option-reference.html#tls-ciphersuites","title":"tls-ciphersuites","text":"<p>Usage: <code>--tls-ciphersuites</code></p> <p>TLS v1.3 cipher to use.</p>"},{"location":"xtrabackup-option-reference.html#tls-version","title":"tls-version","text":"<p>Usage: <code>--tls-version</code></p> <p>TLS version to use, permitted values are: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3.</p>"},{"location":"xtrabackup-option-reference.html#tmpdir","title":"tmpdir","text":"<p>Usage: <code>--tmpdir=name</code></p> <p>Specify the directory that will be used to store temporary files during the backup</p>"},{"location":"xtrabackup-option-reference.html#transition-key","title":"transition-key","text":"<p>Usage: <code>--transition-key=name</code></p> <p>This option is used to enable processing the backup without accessing the keyring vault server. In this case, xtrabackup derives the AES encryption key from the specified passphrase and uses it to encrypt tablespace keys of tablespaces being backed up.</p> <p>If <code>--transition-key</code> does not have any value, xtrabackup will ask for it. The same passphrase should be specified for the <code>--prepare</code> command.</p>"},{"location":"xtrabackup-option-reference.html#use-free-memory-pct","title":"use-free-memory-pct","text":"<p>Usage: <code>--use-free-memory-pct</code></p> <p>The <code>--use-free-memory-pct</code> is a tech preview option. Before using this option in production, we recommend that you test restoring production from physical backups in your environment, and also use the alternative backup method for redundancy.</p> <p>Implemented in Percona XtraBackup 8.0.30-23, this option lets you configure the Smart memory estimation feature. The option controls the amount of free memory that can be used to <code>--prepare</code> a backup. The default value is 0 (zero) which defines the option as disabled. For example, if you set <code>--use-free-memory-pct=50</code>, then 50% of the free memory is used to <code>prepare</code> a backup. The maximum allowed value is 100. </p> <p>This option works, only if <code>--estimate-memory</code> option is enabled. If the <code>--estimate-memory</code> option is disabled, the <code>--use-free-memory-pct</code> setting is ignored.</p> <p>An example of how to enable the Smart memory estimation feature:</p> <pre><code>$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/\n</code></pre> <pre><code>$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/\n</code></pre>"},{"location":"xtrabackup-option-reference.html#use-memory","title":"use-memory","text":"<p>Usage: <code>--use-memory</code></p> <p>This option affects how much memory is allocated and is similar to <code>innodb_buffer_pool_size</code>. This option is only relevant in the <code>--prepare</code> phase or when analyzing statistics with <code>--stats</code>. The default value is 100MB. The recommended value is between 1GB to 2GB. Multiple values are supported if you provide the unit (for example, 1MB, 1M, 1GB, 1G).</p>"},{"location":"xtrabackup-option-reference.html#user","title":"user","text":"<p>Usage: <code>--user=USERNAME</code></p> <p>This option specifies the MySQL username used when connecting to the server, if that\u2019s not the current user. The option accepts a string argument. See mysql \u2013help for details.</p>"},{"location":"xtrabackup-option-reference.html#version","title":"version","text":"<p>Usage: <code>--version</code></p> <p>This option prints xtrabackup version and exits.</p>"},{"location":"xtrabackup-option-reference.html#xtrabackup-plugin-dir","title":"xtrabackup-plugin-dir","text":"<p>Usage: <code>--xtrabackup-plugin-dir=DIRNAME</code></p> <p>The absolute path to the directory that contains the <code>keyring</code> plugin.</p> <p></p>"},{"location":"xtrabackup-option-reference.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"xtrabackup-version-numbers.html","title":"Understand version numbers","text":"<p>A version number identifies the product release. The product contains the latest Generally Available (GA) features at the time of that release.</p> 8.0.30 -23 Base version Minor build version <p>Percona uses semantic version numbering, which follows the pattern of base version and build version. Percona assigns unique, non-negative integers in increasing order for each version release. The version number combines the base MySQL 8.0 version number and the minor build version.</p> <p>Note that Percona XtraBackup numbering changed after the 8.0.14 version to align Percona XtraBackup versions with Percona Server and MySQL. Find more information in Aligning Percona XtraBackup Versions with Percona Server for MySQL blog post.</p> <p>The version numbers for Percona XtraBackup 8.0.30-23 define the following information:</p> <ul> <li> <p>Base version - the leftmost numbers indicate the MySQL 8.0 version used as a base. An increase in base version resets the minor build version to 0.  </p> </li> <li> <p>Minor build version - an internal number that denotes the version of the software. A build version increases by one each time the Percona XtraBackup is released.</p> </li> </ul> <p>Percona XtraBackup 8.0.28-20 and 8.0.28-21 are multiple releases based on MySQL 8.0.28.</p> <p></p>"},{"location":"xtrabackup-version-numbers.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"yum-download-rpm.html","title":"Install with RPM packages","text":"<p>This guide walks you through installing Percona XtraBackup 8.0 using DEB packages on Ubuntu-based systems.</p> <ol> <li> <p>Download the appropriate packages for your architecure from Percona Software Downloads. This example downloads the Percona XtraBackup 8.0 package for Red Hat Enterprise Linux 9.</p> <pre><code>$ wget https://downloads.percona.com/downloads/Percona-XtraBackup-LATEST/Percona-XtraBackup-8.0.32-26/binary/redhat/9/x86_64/percona-xtrabackup-80-8.0.32-26.1.el9.x86_64.rpm\n</code></pre> </li> <li> <p>Install the package</p> <pre><code>$ sudo yum localinstall percona-xtrabackup-80-8.0.32-26.1.el9.x86_64.rpm\n</code></pre> </li> </ol>"},{"location":"yum-download-rpm.html#common-dependencies","title":"Common dependencies","text":"Library name Description libev A high-performance event-loop library used in asynchronous network applications. libgcrypt A general-purpose cryptographic library providing encryption, decryption, and hashing algorithms. openssl A robust library for implementing SSL/TLS encryption and cryptographic functions. zlib A compression library that supports data compression and decompression using the DEFLATE algorithm. libaio A library for asynchronous I/O operations, providing non-blocking I/O functionality. <p>If yum reports missing dependencies, it may offer to install them automatically. If not, you can install these dependencies manually using the following example.</p> <pre><code>$ sudo yum install libev libgcrypt openssl zlib libaio\n</code></pre>"},{"location":"yum-download-rpm.html#verify-the-installation","title":"Verify the installation","text":"<p>After installation, verify it by checking the version:</p> <pre><code>$ xtrabackup --version\n</code></pre>"},{"location":"yum-download-rpm.html#troubleshoot-the-installation","title":"Troubleshoot the installation","text":"Issue Description Permission denied Ensure you\u2019re using sudo or have root access for installation commands. Repository issues If packages are not found, check your yum repository configuration. Incompatible OS version Double-check your OS version matches the package requirements. Conflicts with existing packages Consider removing conflicting packages or use a separate environment. <p>If you encounter persistent issues, consult the Percona XtraBackup documentation or reach out to their support forums for assistance.</p> <p>Remember, when installing packages manually, you\u2019re responsible for managing dependencies and potential conflicts. Always back up your data before making significant system changes.</p> <p></p>"},{"location":"yum-download-rpm.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"yum-files.html","title":"Files in the RPM package built for Percona XtraBackup 8.0","text":"<p>The following tables show what data each <code>RPM</code> package contains:</p> Package Contains percona-xtrabackup-80 The latest Percona XtraBackup GA binaries and associated files percona-xtrabackup-80-debuginfo The debug symbols for binaries in percona-xtrabackup-80 percona-xtrabackup-test-80 The test suite for Percona XtraBackup percona-xtrabackup The older version of the Percona XtraBackup <p></p>"},{"location":"yum-files.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"yum-repo.html","title":"Install Percona XtraBackup on Red Hat-based systems","text":"<p>Ready-to-use packages are available from the Percona XtraBackup software repositories and the download page. The Percona yum repository supports popular <code>RPM</code>-based operating systems, including the <code>Amazon Linux AMI</code>, which has reached its end of life. <code>Amazon Linux 2</code> is not supported at this time. </p> <p>The easiest way to install the Percona Yum repository is to install an <code>RPM</code> that configures yum and installs the Percona GPG key.</p> <p>Specific information on the supported platforms, products, and versions is described in Percona Software and Platform Lifecycle.</p>"},{"location":"yum-repo.html#version-changes","title":"Version changes","text":"<p>Starting with Percona XtraBackup 8.0.35-31, the RPM builds for RHEL 8 and RHEL 9 include ARM packages with the <code>aarch64.rpm</code> extension. This extension means Percona XtraBackup is now available for users on ARM-based systems.</p> <p>We recommend downloading Percona XtraBackup for the same platform as your MySQL-compatible server. For instance, if your server runs on an ARM64 platform, you should download and use the Percona XtraBackup with the <code>aarch64.rpm</code> extension for that operating system.</p> <p>Make sure that you have the <code>libev</code> package installed before installing Percona XtraBackup on CentOS 6. For this operating system, the <code>libev</code> package is available from EPEL.</p>"},{"location":"yum-repo.html#prerequisites","title":"Prerequisites","text":"<ul> <li> <p>Sudo or root access</p> </li> <li> <p>Internet connection</p> </li> </ul>"},{"location":"yum-repo.html#install-from-percona-yum-repository","title":"Install from Percona <code>YUM</code> repository","text":"<p>The following procedure installs Percona XtraBackup 8.0.</p> <ol> <li> <p>Install the Percona yum repository by running the following command as the <code>root</code> user or with sudo: </p> <pre><code>$ sudo yum install \\\nhttps://repo.percona.com/yum/percona-release-latest.\\\nnoarch.rpm\n</code></pre> Example output <pre><code>Oracle Linux 9 BaseOS Latest (x86_64)                                 6.6 MB/s |  35 MB     00:05\nOracle Linux 9 Application Stream Packages (x86_64)                   8.5 MB/s |  41 MB     00:04\nLast metadata expiration check: 0:00:06 ago on Mon Sep 23 09:43:33 2024.\npercona-release-latest.noarch.rpm                                      49 kB/s |  27 kB     00:00\nDependencies resolved.\n...\nFor more information, please visit:\nhttps://docs.percona.com/percona-software-repositories/percona-release.html\n\n\nVerifying        : percona-release-1.0-29.noarch    \n                                            1/1\n\nInstalled:\npercona-release-1.0-29.noarch\n\nComplete!\n</code></pre> </li> <li> <p>Enable the repository: </p> <pre><code>$ sudo percona-release enable pxb-80\n</code></pre> Example output <pre><code>```{.text .no-copy}\n* Enabling the Percona XtraBackup 8.0 repository\n&lt;*&gt; All done!\n```\n</code></pre> </li> <li> <p>Install Percona XtraBackup by running:</p> <pre><code>$ sudo yum install percona-xtrabackup-80\n</code></pre> Example output <pre><code>* Enabling the Percona XtraBackup 8.0 repository\n&lt;*&gt; All done!\n[root@e1dc549c0c65 /]# yum install percona-xtrabackup-80\nPMM2 Client release/x86_64 YUM repository                              13 kB/s | 6.4 kB     00:00\nPercona Release release/noarch YUM repository                         4.3 kB/s | 2.0 kB     00:00\nPercona XtraBackup 8.0 release/x86_64 YUM repository                  363 kB/s | 416 kB     00:01\nPercona Telemetry release/x86_64 YUM repository                       3.1 kB/s | 1.5 kB     00:00\nDependencies resolved.\n...\n\nComplete!\n</code></pre> </li> <li> <p>To decompress backups made using <code>LZ4</code> or <code>ZSTD</code> compression algorithm, install the corresponding package:</p> Install the <code>lz4</code> packageInstall the <code>zstd</code> package <pre><code>$ sudo yum install lz4\n</code></pre> <pre><code>$ sudo yum install zstd\n</code></pre> </li> </ol>"},{"location":"yum-repo.html#verify-the-installation","title":"Verify the installation","text":"<p>Run Percona XtraBackup:</p> <pre><code>$ xtrabackup --version\n</code></pre> <p>If this command fails, the installation is incomplete or incorrect.</p>"},{"location":"yum-repo.html#troubleshoot","title":"Troubleshoot","text":"<p>To troubleshoot a Percona XtraBackup 8.0.x installation on a Red Hat-based system, follow these steps:</p> <ol> <li> <p>This command checks for missing libraries.</p> <pre><code>$ ldd $(which xtrabackup) | grep \"not found\"\n</code></pre> </li> <li> <p>Install missing dependencies:</p> <pre><code>$ sudo yum install &lt;missing-library-name&gt;\n</code></pre> </li> <li> <p>Examine log files:</p> <pre><code>$ sudo journalctl -xe | grep xtrabackup\n</code></pre> </li> <li> <p>Ensure the Percona repository is correctly set up:</p> <pre><code>$ cat /etc/yum.repos.d/percona-release.repo\n</code></pre> </li> <li> <p>Update the system to ensure all packages are current:</p> <pre><code>$ sudo yum update\n</code></pre> </li> <li> <p>If issues persist, try a clean reinstall:</p> <pre><code>$ sudo yum remove percona-xtrabackup-80 \n$ sudo yum clean all \n$ sudo yum install percona-xtrabackup-80\n</code></pre> </li> <li> <p>SELinux might block XtraBackup. Check its status:</p> <pre><code>$ getenforce\n</code></pre> </li> <li> <p>Set SELinux to permissive temporarily:</p> <pre><code>$ sudo setenforce 0\n</code></pre> </li> <li> <p>Create a backup to verify functionality:</p> <pre><code>$ xtrabackup --backup --target-dir=/tmp/test_backup\n</code></pre> </li> </ol> <p>If problems continue, gather all error messages and logs, then consult Percona\u2019s documentation or support forums for further assistance.</p> <p>See also</p> <p>To install Percona XtraBackup using downloaded rpm packages, see Install with package manager.</p> <p>To uninstall Percona XtraBackup, see Uninstall Percona XtraBackup </p> <p></p>"},{"location":"yum-repo.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"yum-uninstall-xtrabackup.html","title":"Uninstall Percona XtraBackup 8.0 on Red Hat-based systems","text":"<p>Remember to back up any important data before uninstalling software.</p> <p>Remove the XtraBackup packages:</p> <pre><code>$ sudo yum remove percona-xtrabackup-80\n</code></pre> <p>To remove all configuration files and packages, run the following command:</p> <pre><code>$ sudo yum remove percona-xtrabackup-80 --remove-leaves\n</code></pre> <p>Remove any unused dependencies:</p> <pre><code>$ sudo yum autoremove\n</code></pre> <p>To verify the removal, check the version:</p> <pre><code>$ xtrabackup --version\n</code></pre> <p>This should return a <code>command not found</code>.</p> <p>You must remove any remaining directories manually:</p> <pre><code>$ sudo rm -rf /var/lib/xtrabackup\n</code></pre> <p>You can also remove any added Percona repositories from your system manager\u2019s configuration.</p> <p></p>"},{"location":"yum-uninstall-xtrabackup.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0-3-rc1.html","title":"Percona XtraBackup 8.0-3-rc1","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0-3-rc1 on October 31 2018. Downloads are available from our download site and from apt and yum repositories.</p> <p>This is a Release Candidate quality release and it is not intended for production. If you want a high quality, Generally Available release, use the current Stable version (the most recent stable version at the time of writing is 2.4.12 in the 2.4 series).</p>"},{"location":"release-notes/8.0/8.0-3-rc1.html#things-to-note","title":"Things to Note","text":"<ul> <li> <p><code>innobackupex</code> was previously deprecated and has been removed</p> </li> <li> <p>Due to the new MySQL redo log and data dictionary formats the Percona XtraBackup 8.0.x versions will only be compatible with MySQL 8.0.x and the upcoming Percona Server for MySQL 8.0.x</p> </li> <li> <p>For experimental migrations from earlier database server versions, you will need to backup and restore and using XtraBackup 2.4 and then use <code>mysql_upgrade</code> from MySQL 8.0.x</p> </li> </ul>"},{"location":"release-notes/8.0/8.0-3-rc1.html#improvements","title":"Improvements","text":"<ul> <li>PXB-1655: The <code>--lock-ddl</code> option is supported when backing up MySQL 8</li> </ul>"},{"location":"release-notes/8.0/8.0-3-rc1.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1678: Incremental backup prepare with the <code>--apply-log-only</code> option could roll back uncommitted transactions</p> </li> <li> <p>PXB-1672: The MTS slave without GTID could be backed up when the <code>--safe-slave-backup</code> option was applied.</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0-3-rc1.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.10.html","title":"Percona XtraBackup 8.0.10","text":"<ul> <li> <p>Date</p> <p>March 16, 2020</p> </li> </ul> <p>Installing Percona XtraBackup 8.0</p> <p>Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.10.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1982: The history table showed a wrong value for <code>lock_time</code>.</p> </li> <li> <p>PXB-2099: <code>copy-back</code> did not move undo files to the data directory.</p> </li> <li> <p>PXB-2107: If the undo tablespace was created in a directory which is a symbolic link to another directory then the backup failed at backup stage.</p> </li> <li> <p>PXB-2118: Undo log file was renamed incorrectly to undo tablespace name after restore</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.10.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.11.html","title":"Percona XtraBackup 8.0.11","text":"<ul> <li> <p>Date</p> <p>April 13, 2020</p> </li> </ul> <p>Installing Percona XtraBackup 8.0</p> <p>Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>All Percona software is open-source and free.</p> <p>This release fixes security vulnerability CVE-2020-10997.</p> <p></p>"},{"location":"release-notes/8.0/8.0.11.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.12.html","title":"Percona XtraBackup 8.0.12","text":"<ul> <li> <p>Date</p> <p>May 27, 2020</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>Percona XtraBackup 8.0.12 now supports backup and restore processing for all versions of MySQL; previous versions of Percona XtraBackup will not work with MySQL 8.0.20 and higher.</p>"},{"location":"release-notes/8.0/8.0.12.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2133: Correct prtype stored for DECIMAL columns in .cfg file by \u2013export</p> </li> <li> <p>PXB-2146: Amazon S3 session token support added to xbcloud</p> </li> <li> <p>PXB-2179: Modify <code>xtrabackup prepare</code> to shut down keyring plugin when run with \u2013generate-transition-key</p> </li> <li> <p>PXB-2157: Modify <code>xtrabackup \u2013prepare</code> to generate cfg files for partition tables when \u2013export is used</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.12.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.13.html","title":"Percona XtraBackup 8.0.13","text":"<ul> <li> <p>Date</p> <p>June 17, 2020</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>Percona XtraBackup 8.0.13 supports backup and restore processing for all versions of MySQL and has been tested with the latest MySQL 8.0.20.</p>"},{"location":"release-notes/8.0/8.0.13.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2165: Modify xbcloud to store backups using s3 access key parameters if AWS access key env variables are set</p> </li> <li> <p>PXB-2164: Modify xbcloud to return the error when the backup doesn\u2019t exist in s3 bucket</p> </li> <li> <p>PXB-2127: Modify xbcloud to upload backups with empty database to min.io storage</p> </li> <li> <p>PXB-2198: Modify xbcloud delete to return the error when the backup doesn\u2019t exist in s3 bucket</p> </li> <li> <p>PXB-2155: Correct corruption when redo logs are encrypted using xtrabackup \u2013backup \u2013compress=lz4</p> </li> <li> <p>PXB-2166: Modify xbcloud to check for bucket existence and return <code>ok</code> status when domain name can be resolved</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.13.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.14.html","title":"Percona XtraBackup 8.0.14","text":"<ul> <li> <p>Date</p> <p>August 31, 2020</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>Percona XtraBackup 8.0.14 supports backup and restore processing for all versions of MySQL and has been tested with the latest MySQL 8.0.21.</p>"},{"location":"release-notes/8.0/8.0.14.html#improvements","title":"Improvements","text":"<ul> <li> <p>PXB-1605: Document how to use Percona Xtrabackup with Docker</p> </li> <li> <p>PXB-2252: Introduce debug option to print redo log records scanned and applied</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.14.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2215: Modify Import tablespace process to correctly calculate pack_length</p> </li> <li> <p>PXB-2114: Document when table is ignored by full backup it is not automatically ignored for incremental backup</p> </li> <li> <p>PXB-2255: Modify processing to Error out if undo truncation during backup</p> </li> <li> <p>PXB-2249: Verify perl binary exists before completing version check</p> </li> <li> <p>PXB-2243: Correct processing when undo truncation happens between full backup and incremental</p> </li> <li> <p>PXB-2238: Provide binary tarball with shared libs and glibc suffix &amp; minimal tarballs</p> </li> <li> <p>PXB-2202: Modify Xbcloud to display an error when xtrabackup fails to create a backup</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.14.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.22-15.0.html","title":"Percona XtraBackup 8.0.22-15.0","text":"<ul> <li> <p>Date</p> <p>December 14, 2020</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>NOTE: The naming structure for the releases has changed. See the aligning Percona XtraBackup versions with Percona Server for MySQL blog post for more information.</p>"},{"location":"release-notes/8.0/8.0.22-15.0.html#new-features","title":"New Features","text":"<ul> <li> <p>PXB-2112: xbcloud: support storage_class option with \u2013storage=s3 (Thanks to user rluisr for reporting this issue)</p> </li> <li> <p>PXB-2242: Prevent back up if Source system (DB) version is higher then current PXB version</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.22-15.0.html#improvements","title":"Improvements","text":"<ul> <li>PXB-2254: Redesign \u2013lock-ddl-per-table</li> </ul>"},{"location":"release-notes/8.0/8.0.22-15.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-793: Fix syntax error when executing \u2013lock-ddl-per-table queries</p> </li> <li> <p>PXB-953: Improve stdout for the end of usage of \u2013lock-ddl-per-table</p> </li> <li> <p>PXB-787: Modify scan to provide correct status when finding corrupted tablespace</p> </li> <li> <p>PXB-2314: Handle Disk format changes introduced in MySQL 8.0.22 release</p> </li> <li> <p>PXB-2279: Modify to look for prefixes in xtrabackup_tablespaces* without extensions (Thanks to user mrmainnet for reporting this issue)</p> </li> <li> <p>PXB-2336: Modify to check to see if first block is an all-zero block and process accordingly</p> </li> <li> <p>PXB-2275: Modify backup processing to add validations if an encrypted table is created</p> </li> <li> <p>PXB-2272: Modify regexp to consider all #sql as temporary tables</p> </li> <li> <p>PXB-2257: Modify \u2013lock-ddl-per-table to properly close database connection</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.22-15.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.23-16.0.html","title":"Percona XtraBackup 8.0.23-16.0","text":"<ul> <li> <p>Date</p> <p>March 22, 2021</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>This release fixes the security vulnerability CVE-2020-29488</p>"},{"location":"release-notes/8.0/8.0.23-16.0.html#improvements","title":"Improvements","text":"<ul> <li> <p>PXB-2280: Provide SELinux and AppArmor default policies</p> </li> <li> <p>PXB-1979: Enable \u2013lock-ddl by default to prevent corruption of the backup</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.23-16.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2274: Correct restore processing when there are DML statements running during backup stage by writing the last_checkpoint and LSN from ps.log_status instead of the redo log (Thanks to user Li Biao for reporting this issue)</p> </li> <li> <p>PXB-2430: Correct build failure by removing the dependency of no-server-version-check with version-check (Thanks to user agarner for reporting this issue)</p> </li> <li> <p>PXB-2415: Add build dependencies to correct Debian/Ubuntu packages in docker (Thanks to user Matt Cole for reporting this issue)</p> </li> <li> <p>PXB-2429: Correct Backup failure for encrypted tablespace by skipping the encryption reset operation during the redo scan phase</p> </li> <li> <p>PXB-2418: Remove PROTOBUF_LITE_LIBRARY - it is not used and is not needed</p> </li> <li> <p>PXB-2395: Update versions for xbstream and xbcrypt</p> </li> <li> <p>PXB-2394: Correct spellings in xbcloud help</p> </li> <li> <p>PXB-2357: Correct hang in backup with redo log archive by using block number instead of checksum (checksum of redo file and archive file can be different)</p> </li> <li> <p>PXB-2180: Correct incremental prepare failure with logical redo by skipping the apply of logical redos (MLOG_TABLE_DYNAMIC_META) during the incremental prepare (except the last prepare).</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.23-16.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.25-17.0.html","title":"Percona XtraBackup 8.0.25-17.0","text":"<ul> <li> <p>Date</p> <p>June 3, 2021</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.25-17.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2442 : Backup cannot be decompressed using the AppArmor profile</p> </li> <li> <p>PXB-2444 : The xbcloud binary fails to upload backup with enforcing SELinux mode</p> </li> <li> <p>PXB-2443 : Version check fails with AppArmor profile</p> </li> <li> <p>PXB-2445 : Initializing the libgcrypt in xbcloud</p> </li> <li> <p>PXB-2455 : XtraBackup prepare fails if the checkpoint LSN is greater than the last LSN</p> </li> <li> <p>PXB-2473 : SELinux errors in audit logs</p> </li> <li> <p>PXB-1462 : Long gtid_executed breaks \u2014history functionality</p> </li> <li> <p>PXB-2369 : Issues with \u201cInstalling\u201d page in XtraBackup documentation</p> </li> <li> <p>PXB-2457 : Incorrect binlog names if binlog name contains periods</p> </li> <li> <p>PXB-2106 : Copy-back creates wrong binlog.index</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.25-17.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.26-18.0.html","title":"Percona XtraBackup 8.0.26-18.0","text":"<ul> <li> <p>Date</p> <p>September 2, 2021</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.26-18.0.html#improvements","title":"Improvements","text":"<ul> <li> <p>PXB-2477: The xbcloud should retry on error and utilize incremental backoff (Thanks to Baptiste Mille-Mathias for reporting this issue)</p> </li> <li> <p>PXB-2580: With the xbcloud binary, a chunk-upload on an SSL connect error to S3 was not retried (Thanks to Tim Vaillancourt for providing the patch)</p> </li> <li> <p>PXB-2317: Remove the obsolete LOCKLESS binary log functionality since the <code>performance_schema.log_status</code> table is now used to get the log information on all the storages without locking them</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.26-18.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2101: The Prepare step fails due to duplicate Serialized Dictionary Information (SDI) (Thanks to Fungo Wang for reporting this issue)</p> </li> <li> <p>PXB-1504: The FIND_GCRYPT macro is broken (Thanks to Maxim Bublis for reporting this issue)</p> </li> <li> <p>PXB-1961: The Prepare step of a full backup fails for encrypted tables with a generic error</p> </li> <li> <p>PXB-2585: XtraBackup fails to backup archive RocksDB Write-Ahead Log (WAL) files</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.26-18.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.27-19.0.html","title":"Percona XtraBackup 8.0.27-19","text":"<ul> <li> <p>Date</p> <p>February 2, 2022</p> </li> <li> <p>Installation</p> <p>Installing Percona XtraBackup</p> </li> </ul> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.27-19.0.html#release-highlights","title":"Release Highlights","text":"<p>The following list contains a number of the bug fixes for MySQL 8.0.27, provided by Oracle, and included in Percona Server for MySQL:</p> <ul> <li> <p>The <code>default_authentication_plugin</code> is deprecated. Support for this plugin may be removed in future versions. Use the <code>authentication_policy</code> variable.</p> </li> <li> <p>The <code>binary</code> operator is deprecated. Support for this operator may be removed in future versions. Use <code>CAST(... AS BINARY)</code>.</p> </li> <li> <p>When a parent table updated or deleted a row, this operation initiated a cascading <code>SET NULL</code> operation on the child table. On the child table, a virtual column value could be set to NULL instead of the value derived from the base column value.</p> </li> </ul> <p>Find the full list of bug fixes and changes in the MySQL 8.0.27 Release Notes.</p>"},{"location":"release-notes/8.0/8.0.27-19.0.html#new-features","title":"New Features","text":"<ul> <li>PXB-1883: Added support for Microsoft Azure Cloud Storage in the xbcloud binary. (Thanks to Ivan for reporting this issue)</li> </ul>"},{"location":"release-notes/8.0/8.0.27-19.0.html#improvements","title":"Improvements","text":"<ul> <li>PXB-2434: Use MySQL page tracking for incremental backup</li> </ul>"},{"location":"release-notes/8.0/8.0.27-19.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1741: PS startup displays errors for databases excluded during partial backup</p> </li> <li> <p>PXB-2614: The <code>xbstream</code> binary was enhanced to support sparse files  on the XFS file system.</p> </li> <li> <p>PXB-2608: Upgrade the Vault API to V2 (Thanks to Benedito Marques Magalhaes for reporting this issue)</p> </li> <li> <p>PXB-2543: Fix that adds <code>IB_EXPORT_CFG_VERSION_V6</code> when exporting a <code>.cfg</code> file for a table (Thanks to Peng Gao for reporting this issue)</p> </li> <li> <p>PXB-2465: Fix for querying the <code>ps.log_status</code> when group replication channels are items on that list. XtraBackup skips the name if it matches either <code>group_replication_applier</code>or <code>group_replication_recovery</code>.(Thanks to Galamb Gerg\u0151 for reporting this issue)</p> </li> <li> <p>PXB-2625: The default version of CURL in Debian Buster failed to identify a TLS HTTP2 connection as closed and attempted to reuse the connection. (Thanks to Johan Andersson for reporting this issue)</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.27-19.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.28-20.0.html","title":"Percona XtraBackup 8.0.28-20","text":"<ul> <li> <p>Date</p> <p>April 26, 2022</p> </li> </ul> <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.28-20.0.html#release-highlights","title":"Release Highlights","text":"<p>The log statements structure in Percona XtraBackup has been improved. Now, the error logs have a standard structure. The uniformity of the headers makes it easier to follow an operation\u2019s progress or review the log to diagnose issues. The improved log structure is displayed in the backup, prepare, move-back/copy-back error logs.</p> <p>Each log statement has the following attributes:</p> <ul> <li> <p>Timestamp - a timestamp for when the event occurred in a UTC format.</p> </li> <li> <p>Severity - the severity level of a statement indicates the importance of an event.</p> </li> <li> <p>ID - this identifier is currently not used but may be used in future versions.</p> </li> <li> <p>Context - the name of the module that issued the log statement, such as XtraBackup, InnoDB, or Server.</p> </li> <li> <p>Message - a description of the event generated by the module.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.28-20.0.html#new-features","title":"New Features","text":"<ul> <li>PXB-2670: Improves the error logging framework in Percona XtraBackup.</li> </ul>"},{"location":"release-notes/8.0/8.0.28-20.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1676: The error message after creating a backup was incorrect.</p> </li> <li> <p>PXB-2716: Fix for a compilation error on systems without fallocate. (Thanks to user Bo98 for providing the patch to fix this issue.)</p> </li> <li> <p>PXB-2506: During copy back and move back operations, added a check if the backup is fully prepared. Percona XtraBackup throws an error if the backup is not prepared or was prepared with \u2013apply-log-only.</p> </li> <li> <p>PXB-2662: Percona XtraBackup exited during prepare when creating an incremental backup using page tracking.</p> </li> <li> <p>PXB-2714: Fix for a memory leak on the keyring component.</p> </li> <li> <p>PXB-2697: Undefined symbols in macOS resulted in an error when linked with Percona XtraBackup 8.0.27.</p> </li> <li> <p>PXB-2722: Fix for when via command line, a password, passed using the -p option, was written into the backup tool_command in xtrabackup_info.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.28-20.0.html#useful-links","title":"Useful Links","text":"<ul> <li> <p>The Percona XtraBackup installation instructions</p> </li> <li> <p>The Percona XtraBackup downloads</p> </li> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>To contribute to the documentation, review the Documentation Contribution Guide</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.28-20.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.28-21.0.html","title":"Percona XtraBackup 8.0.28-21 (2022-05-25)","text":"<p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.28-21.0.html#release-highlights","title":"Release Highlights","text":"<p>Percona XtraBackup adds support for the Amazon Key Management Service (KMS) component.</p>"},{"location":"release-notes/8.0/8.0.28-21.0.html#new-features","title":"New Features","text":"<ul> <li>PXB-2721: Implements support for the Amazon Key Management Service component in Percona XtraBackup.</li> </ul>"},{"location":"release-notes/8.0/8.0.28-21.0.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-2761: Fix for a compilation error in GCC 11. (Thanks to user tcoyvwac for providing the patch to fix this issue.)</p> </li> <li> <p>PXB-2422: The extraction of files failed when a file was located in another directory.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.28-21.0.html#useful-links","title":"Useful Links","text":"<ul> <li> <p>The Percona XtraBackup installation instructions</p> </li> <li> <p>The Percona XtraBackup downloads</p> </li> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>To contribute to the documentation, review the Documentation Contribution Guide</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.28-21.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.29-22.0.html","title":"Percona XtraBackup 8.0.29-22 (2022-07-19)","text":"<p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.29-22.0.html#release-highlights","title":"Release Highlights","text":"<p>Percona XtraBackup 8.0.29-22 adds new redo log types to support the changes in the <code>INSTANT</code> algorithm behavior. MySQL 8.0.29 extended the support for <code>ALGORITHM=INSTANT</code> to allow columns to be added to any position in a table and column drops. Older versions of Percona XtraBackup are incompatible with MySQL 8.0.29 because of this new functionality.</p> <p>Note</p> <p>MySQL 8.0.29 extended the support of the <code>ALTER TABLE \u2026 DROP COLUMNS</code> statement to use <code>ALGORITHM=INSTANT</code>. These operations only modify the metadata in the data directory and do not affect the physical structure. The <code>ALGORITHM=INSTANT</code> is the default setting for supported <code>DDL</code> operations. Prior to MySQL 8.0.29, an <code>ALGORITHM=INSTANT</code> column could only be added as the last table column. As of MySQL 8.0.29, the column can be added to any table position. The ability to add or drop a column in any position increases the complexity of crash recovery since the redo log does not have the logical positions from the data dictionary. The redo log contains the physical order for the table.</p> <p>Percona Server for MySQL 8.0.29-21 contains fixes for these issues. Percona XtraBackup 8.0.29 can backup and restore tables that used the <code>INSTANT</code> algorithm in ADD/DROP in Percona Server for MySQL. However, MySQL 8.0.29, if the server contains tables modified by INSTANT ADD/DROP, is unsafe for backups at this time. Percona XtraBackup detects the tables modified by <code>INSTANT</code> ADD/DROP and generates an error. This error lists the affected tables and provides instructions to convert the modified tables to regular tables.</p>"},{"location":"release-notes/8.0/8.0.29-22.0.html#useful-links","title":"Useful Links","text":"<ul> <li> <p>The Percona XtraBackup installation instructions</p> </li> <li> <p>The Percona XtraBackup downloads</p> </li> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>To contribute to the documentation, review the Documentation Contribution Guide</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.29-22.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html","title":"Percona XtraBackup 8.0.30-23 (2022-11-14)","text":"Release date November 14, 2022 Install instructions Install Percona XtraBackup Download this version Percona XtraBackup 8.0 <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p> <p>For paid support, managed services or consulting services, contact Percona Sales.</p> <p>For training, contact Percona Training - Start learning now.</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#release-highlights","title":"Release highlights","text":"<p>The Take an incremental backup using page tracking feature is Generally Available (GA).</p> <p>The following features and improvements introduced in Percona XtraBackup 8.0.30-23 are available only in tech preview:</p> <ul> <li> <p>Percona XtraBackup adds support for <code>Zstandard (ZSTD)</code> compression algorithm. <code>ZSTD</code> is a fast lossless compression algorithm, targeting real-time compression scenarios at zlib-level and better compression ratios. </p> </li> <li> <p>Percona XtraBackup implements the <code>Smart memory estimation</code> feature to compute the memory required to <code>--prepare</code> a backup. Percona XtraBackup has extended the crash recovery logic to extract the formula used to allocate memory. Now, in the backup phase, while copying redo log entries, Percona XtraBackup computes the required memory for <code>--prepare</code>. Percona XtraBackup also takes into consideration the number of InnoDB pages to be fetched from the disk. Percona XtraBackup checks the server\u2019s available free memory and uses that memory up to the limit specified in the <code>--use-free-memory-pct</code> option to run <code>--prepare</code>.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.30-23.0.html#new-features","title":"New features","text":"<p>PXB-2669: Implements support for <code>Zstandard (ZSTD)</code> compression algorithm.</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#improvements","title":"Improvements","text":"<p>PXB-2710: Implements support for <code>Smart Memory Estimation</code>.</p> <p>PXB-2844: Adjusts the logic to detect multi-threaded slave.</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#bug-fixes","title":"Bug fixes","text":"<p>PXB-2681: Percona XtraBackup got stuck during incremental backup prepare of encrypted tables.</p> <p>PXB-2517: Check if files-from is successfully closed before rsync (Thanks to Garen Chan for the patch.)</p> <p>PXB-2702: Backup failed when undo truncation log is present (Thanks to Dmitry Smal for his contribution to the initial patch.)</p> <p>PXB-2729: Percona XtraBackup compilation failed if GTest packages are installed.</p> <p>PXB-2810: Percona XtraBackup crashed when AIO initialization failed (Thanks to Yan Huang for the patch.) </p> <p>PXB-2840: Xbcloud attempted to create a non-existing bucket. </p> <p>PXB-2874: When Percona XtraBackup generated a new master key on \u2013copy-back or \u2013move-back, the master key id was reset back to 1.</p> <p>PXB-2809: <code>wsrep_sync_wait&lt;&gt;0</code> caused <code>Lock wait timeout exceeded; try restarting transaction</code> error (Thanks to Frank Well for providing the initial patch.)</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#platform-support","title":"Platform support","text":"<p>Percona XtraBackup 8.0.30 supports Oracle Linux/Red Hat Enterprise Linux 9.</p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#useful-links","title":"Useful links","text":"<ul> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>Contribute to the documentation</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.30-23.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html","title":"Percona XtraBackup 8.0.31-24 (2023-02-07)","text":"Release date February 7, 2023 Install instructions Install Percona XtraBackup Download this version Percona XtraBackup 8.0 <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p> <p>For training, contact Percona Training - Start learning now.</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#release-highlights","title":"Release highlights","text":"<p>This release adds the ability to use an IAM instance profile when running xbcloud from an EC2 instance. An IAM instance profile does not need the <code>--s3-secret-key</code> nor the <code>--s3-access-key</code> but the profile has a six-hour lifespan.</p> <p>With this version, <code>qpress</code>/<code>QuickLZ</code> are deprecated. </p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#new-features","title":"New features","text":"<p>PXB-2856: Use IAM instance profile when running xbcloud from an EC2 instance.</p> <p>PXB-2869: A warning is printed on backup that qpress/QuickLZ is deprecated.</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#bug-fixes","title":"Bug fixes","text":"<p>PXB-2890: XtraBackup did not compress already compressed tables.</p> <p>PXB-2928: XtraBackup exits with signal 11 when taking a backup using page tracking.</p> <p>PXB-2854: Fixed a memory corruption issue in QuickLZ.</p> <p>PXB-2925: The PXB start_lsn, during the prepare phase, did not match the redo file start LSN when a wait was added in the backup phase after calling <code>recv_find_max_checkpoint</code> and before copying the checkpoint header.</p> <p>PXB-2964: XtraBackup required a very high open files limit.</p> <p>PXB-2959: XtraBackup now compiles on platforms with OpenSSL 3.0.</p> <p>PXB-2971: XtraBackup copied local manifest files which caused node failures when the files overrode settings on another node.</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#deprecation-and-removal","title":"Deprecation and removal","text":"<p>Starting with Percona XtraBackup 8.0.31-24, using qpress/QuickLZ to compress backups is deprecated and may be removed in future versions. We recommend using either the <code>LZ4</code> or the Zstandard (<code>ZSTD</code>) compression algorithms.</p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#useful-links","title":"Useful links","text":"<ul> <li> <p>The Percona XtraBackup GitHub location</p> </li> <li> <p>Contribute to the documentation</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.31-24.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.32-25.0.html","title":"Percona XtraBackup 8.0.32-25 (2023-02-27)","text":"Release date February 27, 2023 Install instructions Install Percona XtraBackup <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.32-25.0.html#release-highlights","title":"Release highlights","text":"<p>This release merges the MySQL 8.0.32 code base. Percona has implemented a two-stage release process for each version. The first release primarily ensures compatibility with the latest MySQL version, to help those customers who need an updated version of Percona XtraBackup as soon as possible. The second release contains additional bug fixes and any improvements or new features.</p> <p>Starting with version 8.0.32-25, Percona XtraBackup allows instant columns in the backup for MySQL 8.0.32. This limitation still exists for backing up MySQL 8.0.31 and lower versions.</p> <p>This limitation does not exist for backing up any version of Percona Server for MySQL.</p>"},{"location":"release-notes/8.0/8.0.32-25.0.html#useful-links","title":"Useful links","text":"<p>The Percona XtraBackup GitHub location</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.32-25.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html","title":"Percona XtraBackup 8.0.32-26 (2023-04-04)","text":"Release date April 4, 2023 Install instructions Install Percona XtraBackup <p>Percona XtraBackup for MySQL Databases enables MySQL backups without blocking user queries. Percona XtraBackup is ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, Percona XtraBackup drives down backup costs while providing unique features for MySQL backups.</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#release-highlights","title":"Release highlights","text":"<p>This release includes improvements and bug fixes. Percona has implemented a two-stage release process for each version. The first release primarily ensures compatibility with the latest MySQL version, to help those customers who need an updated version of Percona XtraBackup as soon as possible. The second release contains additional bug fixes and any improvements or new features. </p> <p>This release fixes the security vulnerability CVE-2022-25834 with PXB-2977.</p> <p>This version adds the \u2013estimate-memory parameter to enable/disable the Smart memory estimation feature during the backup phase.</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#improvements","title":"Improvements","text":"<p>PXB-2882: Removes bitmap code and variables.</p> <p>PXB-2979: The Smart memory estimation feature parses metadata from the redo log to estimate the required memory to prepare a backup. On write-intensive workloads, this behavior caused the delay of the redo follow thread.</p> <p>PXB-2980: Adds the \u2013estimate-memory parameter to enable/disable the Smart memory estimation feature during the backup phase.</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#bug-fixes","title":"Bug fixes","text":"<p>PXB-2264: When a table with the next auto incremental value <code>2</code> was exported using Percona XtraBackup, the table got the next auto incremental value <code>1</code> instead of <code>2</code>.</p> <p>PXB-2954: During prepare phase Percona XtraBackup uses Serialized Dictionary information (SDI) to create the table metadata. If there was an orphan table, leftover from a upgrade, without SDI information, Percona XtraBackup failed to prepare a backup.</p> <p>PXB-2970: Removed unnecessary check for redo log files at the end of backup in case the redo archive was enabled.</p> <p>PXB-2972: An error after the redo apply phase caused an assertion failure instead of a graceful exit.</p> <p>PXB-2977: Fixed the security vulnerability CVE-2022-25834.</p> <p>PXB-2998: Due to a server bug in the upgrade, the server leaves the dictionary tables in a temporary schema instead of the <code>mysql</code> schema. Percona Xtrabackup can now successfully prepare these backup directories.</p> <p>PXB-2999: Removed the warning message that MLOG_INDEX_LOAD redo log record was found.</p> <p>PXB-3022: Reduced the memory required for <code>--prepare</code> phase.</p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#useful-links","title":"Useful links","text":"<p>The Percona XtraBackup GitHub location</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.32-26.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.33-27.0.html","title":"Percona XtraBackup 8.0.33-27 (2023-05-25)","text":"Release date May 25, 2023 Install instructions Install Percona XtraBackup <p>Percona XtraBackup (PXB) is a 100% open source backup solution for all versions of Percona Server for MySQL and MySQL\u00ae that performs online non-blocking, tightly compressed, highly secure full backups on transactional systems. Maintain fully available applications during planned maintenance windows with Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.33-27.0.html#release-highlights","title":"Release highlights","text":"<p>This release merges the MySQL 8.0.33 code base. Percona has implemented a two-stage release process for each version. The first release primarily ensures compatibility with the latest MySQL version, to help those customers who need an updated version of Percona XtraBackup as soon as possible. The second release contains additional bug fixes and any improvements or new features.</p>"},{"location":"release-notes/8.0/8.0.33-27.0.html#bug-fix","title":"Bug fix","text":"<p>PXB-3026: <code>DWITH_NDB=OFF</code> option did not turn off the <code>DWITH_NDB_CLUSTER_STORAGE_ENGINE</code> and compiled <code>NDB</code> files.</p>"},{"location":"release-notes/8.0/8.0.33-27.0.html#useful-links","title":"Useful links","text":"<p>The Percona XtraBackup GitHub location</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.33-27.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html","title":"Percona XtraBackup 8.0.33-28 (2023-07-19)","text":"<p>Percona XtraBackup (PXB) is a 100% open source backup solution for all versions of Percona Server for MySQL and MySQL\u00ae that performs online non-blocking, tightly compressed, highly secure full backups on transactional systems. Maintain fully available applications during planned maintenance windows with Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#release-highlights","title":"Release highlights","text":"<p>This release includes improvements, features, and bug fixes. Percona has implemented a two-stage release process for each version. The first release primarily ensures compatibility with the latest MySQL version, to help those customers who need an updated version of Percona XtraBackup as soon as possible. The second release contains additional bug fixes and any improvements or new features.</p> <p>Percona XtraBackup 8.0.33-28 implements a new data sink that uses the first in, first out (FIF0) method. With the FIFO data sink feature, users with a streaming capacity of 10Gbps (typically on a Local Area Network (LAN)) can benefit from faster backups by streaming data in parallel to object storage. This feature is in tech preview.</p> <p>Percona XtraBackup 8.0.33-28 implements the Dictionary cache feature. Dictionary cache improves the performance of xtrabackup <code>--prepare</code> operation.</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#new-feature","title":"New feature","text":"<p>PXB-2514: Implements a new data sink that uses <code>FIFO</code> (named pipes).</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#improvements","title":"Improvements","text":"<ul> <li> <p>PXB-2955: Implements dictionary cache.</p> </li> <li> <p>PXB-3033: Executes <code>STOP SLAVE</code> conditionally depending on <code>--[lock-ddl]</code>.</p> </li> <li> <p>PXB-3066: Fixes compilation issues on Debian 12.</p> </li> <li> <p>PXB-2993: Makes Percona XtraBackup compatible with procps-4.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.33-28.0.html#bug-fix","title":"Bug fix","text":"<ul> <li> <p>PXB-2811: Fix for several Percona XtraBackup compilation warnings.</p> </li> <li> <p>PXB-3075: Percona XtraBackup 8.0.33 could not prepare backups from 8.0.29 and previous versions.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.33-28.0.html#packaging-notes","title":"Packaging notes","text":"<p>Percona XtraBackup 8.0.33-28 supports Debian 12.</p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#useful-links","title":"Useful links","text":"<p>Install Percona XtraBackup 8.0</p> <p>The Percona XtraBackup GitHub location</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.33-28.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.34-29.0.html","title":"Percona XtraBackup 8.0.34-29 (2023-08-21)","text":"<p>Get started with Quickstart Guide for Percona XtraBackup.</p> <p>Percona XtraBackup (PXB) is a 100% open source backup solution for all versions of Percona Server for MySQL and MySQL\u00ae that performs online non-blocking, tightly compressed, highly secure full backups on transactional systems. Maintain fully available applications during planned maintenance windows with Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.34-29.0.html#release-highlights","title":"Release highlights","text":"<p>Starting with Percona XtraBackup 8.0.34 you can take backups of Percona Server for MySQL 8.0.34, MySQL 8.0.34, and higher versions within the 8.0 series.</p> <p>Check the latest list of all Supported versions.</p>"},{"location":"release-notes/8.0/8.0.34-29.0.html#compression","title":"Compression","text":"<p>The ZSTD compression algorithm is moved to General Availability and becomes the default compression algorithm for the <code>--compress</code> option.</p> <p>The <code>QuickLZ</code> compression algorithm is removed and is not used for <code>--backup</code>. The <code>--decompress</code> option still uses <code>qpress</code> for backward compatibility to decompress backups taken by older versions of Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.34-29.0.html#new-features","title":"New features","text":"<ul> <li>PXB-3059: Adds the <code>--redo-log-arch-dir=name</code> option to set the redo log archive destination directory. (Thanks to wangbincmss for providing the patch)</li> </ul>"},{"location":"release-notes/8.0/8.0.34-29.0.html#improvements","title":"Improvements","text":"<ul> <li>PXB-3007: The ZSTD compression algorithm is moved to General Availability and becomes the default compression algorithm for the <code>--compress</code> option.</li> </ul>"},{"location":"release-notes/8.0/8.0.34-29.0.html#bug-fix","title":"Bug fix","text":"<ul> <li> <p>PXB-3073: An unresponsive host may cause <code>xbcloud</code> to become stuck. Added a <code>--timeout</code> option to <code>xbcloud</code>.</p> </li> <li> <p>PXB-3088: Percona XtraBackup could not prepare the backup if the redo log size was more than 128G. (Thanks to Ahmed Et-tanany for providing the fix for this issue)</p> </li> <li> <p>PXB-3079: The prepare phase skipped rollback on encrypted tables and was completed successfully if the keyring plugin was not loaded.</p> </li> <li> <p>PXB-2860: Percona XtraBackup locked table even when the  <code>--tables-exclude</code> and <code>--lock-ddl-per-table</code> options were used.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.34-29.0.html#useful-links","title":"Useful links","text":"<p>Install Percona XtraBackup 8.0</p> <p>The Percona XtraBackup GitHub location</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p>Contribute to the documentation</p> <p>For training, contact Percona Training - Start learning now.</p> <p></p>"},{"location":"release-notes/8.0/8.0.34-29.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.35-30.0.html","title":"Percona XtraBackup 8.0.35-30 (2023-12-04)","text":"<p>Get started with Quickstart Guide for Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.35-30.0.html#supported-versions","title":"Supported versions","text":"<p>Check the latest list of all Supported versions.</p>"},{"location":"release-notes/8.0/8.0.35-30.0.html#release-highlights","title":"Release highlights","text":"<p>This release merges the MySQL 8.0.35 code base.</p>"},{"location":"release-notes/8.0/8.0.35-30.0.html#bug-fix","title":"Bug fix","text":"<ul> <li> <p>PXB-3003: Percona XtraBackup discovering redo logs to parse and the server purging redo logs simultaneously could cause a race condition.</p> </li> <li> <p>PXB-3139: Fix for gcc-13 and clang-16 compilation issues.</p> </li> <li> <p>PXB-3147: Percona XtraBackup failed to execute the <code>DO innodb_redo_log_consumer_register(\"PXB\");</code> query.</p> </li> <li> <p>PXB-3181: The use of the <code>innodb-use-native-aio=true</code> option resulted in printing duplicate timestamps.</p> </li> <li> <p>PXB-3173: The xbcloud was refactored to use multiple threads with a global list of files. This list did not allow users to download a subset of files.</p> </li> <li> <p>PXB-3141: Adjusted folder creation on <code>ds_fifo.cc</code> and xbcloud to use proper permission.</p> </li> <li> <p>PXB-3168: Under high write load, a backup could fail with a <code>log block numbers mismatch</code> error.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.35-30.0.html#useful-links","title":"Useful links","text":"<p>Install Percona XtraBackup 8.0</p> <p>The Percona XtraBackup GitHub repository</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p></p>"},{"location":"release-notes/8.0/8.0.35-30.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.35-31.0.html","title":"Percona XtraBackup 8.0.35-31 (2024-06-20)","text":"<p>Get started with Quickstart Guide for Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.35-31.0.html#supported-versions","title":"Supported versions","text":"<p>Starting with Percona XtraBackup 8.0.34, you can take backups of Percona Server for MySQL 8.0.34, MySQL 8.0.34, and higher versions within the 8.0 series.</p> <p>Check the latest list of all Supported versions.</p>"},{"location":"release-notes/8.0/8.0.35-31.0.html#release-highlights","title":"Release highlights","text":"<p>This release adds Percona XtraBackup ARM64 packages and provides bug fixes.</p> <p>We recommend that you download the Percona XtraBackup for the same platform as the MySQL-compatible server. For example, if your server is on an ARM64 platform, you should download and use the Percona XtraBackup for ARM64 for that operating system.</p>"},{"location":"release-notes/8.0/8.0.35-31.0.html#bug-fix","title":"Bug fix","text":"<ul> <li> <p>PXB-3283: If backup contains tables with temporal datatypes and their charset/collation changed (ALTER TABLE CONVERT CHARACTER SET) before the backup is taken, xtrabackup export couldn\u2019t generate the correct configuration (.cfg) files required by the import.</p> </li> <li> <p>PXB-2797: When you import a table with a full-text index from an XtraBackup backup, you might encounter a schema mismatch. This happens when the table\u2019s structure in the backup does not match the structure expected by the database.</p> </li> <li> <p>PXB-3210: Percona XtraBackup version 8.0.33-28 and later fail to build on MacOS because of the FIND_PROCPS() function. This function causes issues during the build process, preventing the software from compiling successfully.</p> </li> <li> <p>PXB-3130: When preparing 8.0.30 backups with newer xtrabackup versions, the prepare step failed. (Thank you to LiNing for the contribution!)</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.35-31.0.html#useful-links","title":"Useful links","text":"<p>Install Percona XtraBackup 8.0</p> <p>The Percona XtraBackup GitHub repository</p> <p>Download product binaries, packages, and tarballs at Percona Product Downloads</p> <p></p>"},{"location":"release-notes/8.0/8.0.35-31.0.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.35-31.0.upd.html","title":"Percona XtraBackup 8.0.35-31-Update (2024-09-20)","text":""},{"location":"release-notes/8.0/8.0.35-31.0.upd.html#packaging-notes","title":"Packaging notes","text":"<p>This update to the release of Percona XtraBackup includes the addition of <code>arm64.deb</code> packages in Percona Software Downloads for the following platforms:</p> <ul> <li> <p>Debian 12</p> </li> <li> <p>Debian 11</p> </li> <li> <p>Ubuntu 24.04</p> </li> <li> <p>Ubuntu 22.04</p> </li> <li> <p>Ubuntu 20.04</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.35-31.0.upd.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.4.html","title":"Percona XtraBackup 8.0.4","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.4 on December 10, 2018. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>This release of Percona Xtrabackup is a General Availability release ready for use in a production environment.</p>"},{"location":"release-notes/8.0/8.0.4.html#please-note-the-following-about-this-release","title":"Please note the following about this release:","text":"<ul> <li> <p>The deprecated innobackupex has been removed. Use the xtrabackup command to back up your instances: <code>$ xtrabackup --backup --target-dir=/data/backup</code></p> </li> <li> <p>When migrating from earlier database server versions, backup and restore and using Percona XtraBackup 2.4 and then use <code>mysql_upgrade</code> from MySQL 8.0.x</p> </li> <li> <p>If using <code>yum</code> or <code>apt</code> repositories to install Percona XtraBackup 8.0.4, ensure that you have enabled the new tools repository. You can do this with the percona-release enable tools release command and then install the percona-xtrabackup-80 package.</p> </li> </ul> <p>All Percona software is open-source and free. We are grateful to the community for the invaluable contributions to Percona XtraBackup. We would especially like to highlight the input of Alexey Kopytov who has been actively offering improvements and submitting bug reports for Percona XtraBackup.</p>"},{"location":"release-notes/8.0/8.0.4.html#new-features","title":"New Features","text":"<ul> <li>Percona XtraBackup 8.0.4 is based on MySQL 8.0.13 and fully supports Percona Server for MySQL 8.0 series and MySQL 8.0 series.</li> </ul>"},{"location":"release-notes/8.0/8.0.4.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>PXB-1699: xtrabackup \u2013prepare could fail on backups of MySQL\u00a08.0.13 databases</p> </li> <li> <p>PXB-1704: xtrabackup \u2013prepare could hang while performing insert buffer merge</p> </li> <li> <p>PXB-1668: When the \u2013throttle option was used, the applied value was different from the one specified by the user (off by one error)</p> </li> <li> <p>PXB-1679: PXB could crash when <code>ALTER TABLE ... TRUNCATE PARTITION</code> command was run during a backup without locking DDL</p> </li> </ul> <p></p>"},{"location":"release-notes/8.0/8.0.4.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.5.html","title":"Percona XtraBackup 8.0.5","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.5 on March 4, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>Percona XtraBackup 8.0.5 introduces the support of undo tablespaces created using the new syntax (<code>CREATE UNDO TABLESPACE</code>) available since MySQL 8.0.14. Percona XtraBackup also supports the binary log encryption introduced in MySQL 8.0.14.</p> <p>Two new options were added to xbstream. Use the <code>--decompress</code> option with xbstream to decompress individual qpress files. With the <code>--decompress-threads</code> option, specify the number of threads to apply when decompressing. Thanks to Rauli Ikonen for this contribution.</p> <p>This release of Percona XtraBackup is a General Availability release ready for use in a production environment.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.5.html#please-note-the-following-about-this-release","title":"Please note the following about this release:","text":"<ul> <li> <p>The deprecated innobackupex has been removed. Use the xtrabackup command to back up your instances: <code>$ xtrabackup --backup --target-dir=/data/backup</code></p> </li> <li> <p>When migrating from earlier database server versions, backup and restore and using Percona XtraBackup 2.4 and then use <code>mysql_upgrade</code> from MySQL 8.0.x</p> </li> <li> <p>If using <code>yum</code> or <code>apt</code> repositories to install Percona Xtrabackup 8.0.5, ensure that you have enabled the new tools repository. You can do this with the percona-release enable tools release command and then install the percona-xtrabackup-80 package.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.5.html#new-features","title":"New Features","text":"<ul> <li> <p>PXB-1548: Percona XtraBackup enables updating the <code>ib_buffer_pool</code> file with the latest pages present in the buffer pool using the <code>--dump-innodb-buffer-pool</code> option. Thanks to Marcelo Altmann for contribution.</p> </li> <li> <p>PXB-1768: Added support for undo tablespaces created with the new MySQL 8.0.14 syntax.</p> </li> <li> <p>PXB-1781: Added support for binary log encryption introduced in MySQL 8.0.14.</p> </li> <li> <p>PXB-1797: For xbstream, two new options were added. The <code>--decompress</code> option enables xbstream to decompress individual qpress files. The <code>--decompress-threads</code> option controls the number of threads to apply when decompressing. Thanks to Rauli Ikonen for this contribution.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.5.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>Using <code>--lock-ddl-per-table</code> caused the server to scan all records of partitioned tables which could lead to the \u201cout of memory\u201d error. Bugs fixed PXB-1691 and PXB-1698.</p> </li> <li> <p>When Percona XtraBackup was started run with the <code>--slave-info</code>, incorrect coordinates were written to the xtrabackup_slave_info file.. Bug fixed PXB-1737</p> </li> <li> <p>Percona XtraBackup could crash at the prepare stage when making an incremental backup if the variable <code>innodb-rollback-segments</code> was changed after starting the MySQL Server. Bug fixed PXB-1785.</p> </li> <li> <p>The full backup could fail when Percona Server for MySQL was started with the <code>--innodb-encrypt-tables</code> parameter. Bug fixed PXB-1793.</p> </li> </ul> <p>Other bugs fixed: PXB-1632, PXB-1715, PXB-1770, PXB-1771, PXB-1773.</p> <p></p>"},{"location":"release-notes/8.0/8.0.5.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.6.html","title":"Percona XtraBackup 8.0.6","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.6 on May 9, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>In version 8.0.6, Percona XtraBackup introduces the support of the MyRocks storage engine with Percona Server for MySQL version 8.0.15-6 or higher.</p> <p>Percona XtraBackup 8.0.6 enables saving backups to an Amazon S3, MinIO, and Google Cloud Storage (using interoperability mode) when using xbcloud. The following example demonstrates how to use an Amazon S3 storage to make a full backup:</p> <pre><code>  $ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \\\n  xbcloud put --storage=s3 \\\n  --s3-endpoint='s3.amazonaws.com' \\\n  --s3-access-key='YOUR-ACCESSKEYID' \\\n  --s3-secret-key='YOUR-SECRETACCESSKEY' \\\n  --s3-bucket='mysql_backups'\n  --parallel=10 \\\n  ${date -I}-full_backup\n\nAll *Percona* software is open-source and free\n</code></pre>"},{"location":"release-notes/8.0/8.0.6.html#new-features","title":"New Features","text":"<ul> <li> <p>The MyRocks storage engine is now supported with Percona XtraBackup. More information in PXB-1754.</p> </li> <li> <p>Amazon S3 is now supported in xbcloud. More information in PXB-1813.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.6.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>Percona XtraBackup could fail to restore the undo tablespace created during or before incremental backup. Bug fixed PXB-1780.</p> </li> <li> <p>A backup could fail if <code>log_bin_index</code> was defined in <code>my.cnf</code>. Bug fixed PXB-1801.</p> </li> <li> <p>When the row format was changed during the backup, xtrabackup could crash during the incremental prepare stage. Bug fixed PXB-1824.</p> </li> <li> <p>During the <code>prepare</code> phase, Percona XtraBackup could freeze and never finish execution. Bug fixed PXB-1819.</p> </li> <li> <p>Percona XtraBackup could crash during the <code>prepare</code> stage when making a backup of a host running MySQL Server v8.0.16. Bug fixed PXB-1839.</p> </li> </ul> <p>Other bugs fixed: PXB-1809, PXB-1810, PXB-1832, PXB-1837.</p> <p></p>"},{"location":"release-notes/8.0/8.0.6.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.7.html","title":"Percona XtraBackup 8.0.7","text":"<p>Percona is glad to announce the release of Percona XtraBackup  8.0.7 on August 7, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>In release 8.0.7, Percona XtraBackup enables making backups of databases that contain the encrypted system tablespace. Encrypted mysql tablespace is now also supported.</p> <p>Percona XtraBackup 8.0.7 implements the support of the <code>lz4</code> compression algorithm so that you could make compressed backups using lz4 (\u2013compress=lz4) in addition to the default quicklz method.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.7.html#new-features-and-improvements","title":"New Features and Improvements","text":"<ul> <li> <p>Add support of the system tablespace encryption. More information in PXB-1649.</p> </li> <li> <p>Implemented the support of the lz4 compression algorithm. More information in PXB-1857.</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.7.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>When the encrypted tablespaces feature was enabled, encrypted and compressed tables were not usable on the joiner node (Percona XtraDB Cluster) via SST (State Snapshot Transfer) with the xtrabackup-v2 method. Bug fixed PXB-1867.</p> </li> <li> <p><code>xbcloud</code> did not update date related fields of the HTTP header when retrying a request. Bug fixed PXB-1874.</p> </li> <li> <p><code>xbcloud</code> did not retry to send the request after receiving the HTTP 408 error (request timeout). Bug fixed PXB-1875.</p> </li> <li> <p><code>xtrabackup</code> did not accept decimal fractions as values of the <code>innodb_max_dirty_pages_pct</code> option. Bug fixed PXB-1807.</p> </li> <li> <p>If the user tried to merge an already prepared incremental backup, a misleading error was produced without informing that incremental backups may not be used twice. Bug fixed PXB-1862.</p> </li> </ul> <p>Other bugs fixed: PXB-1493, PXB-1557, PXB-1887, PXB-1870, PXB-1879, PXB-1901.</p> <p></p>"},{"location":"release-notes/8.0/8.0.7.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.8.html","title":"Percona XtraBackup 8.0.8","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.8 on November 21, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.8.html#new-features-and-improvements","title":"New Features and Improvements","text":"<ul> <li> <p>Support log archiving feature in PXB 8.0. More information in PXB-1912 and in the Redo Log section of MySQL documentation</p> </li> <li> <p>For the MyRocks storage engine, support the creation of renewable checkpoints (controlled via <code>--rocksdb-checkpoint-max-age</code> and <code>--rocksdb-checkpoint-max-count</code>) to minimize the amount of binary logs to apply after the backup was completed. Using renewable checkpoints, Percona XtraBackup only copies the SST files that were created after the previous checkpoint. More information in PXB-1915.</p> </li> <li> <p>Two options (\u2013-backup-lock-timeout and -\u2013backup-lock-retry-count) were added to enable the configuring of the timeout for acquiring metadata locks in <code>FLUSH TABLES WITH READ LOCK</code>, <code>LOCK TABLE FOR BACKUP</code>, and <code>LOCK BINLOG FOR BACKUP</code> statements. More information in PXB-1914</p> </li> </ul>"},{"location":"release-notes/8.0/8.0.8.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li> <p>An encrypted table could not be restored when <code>ADD INDEX</code> or <code>DROP INDEX</code> commands had been run on the table. Bug fixed PXB-1905</p> </li> <li> <p>In some cases <code>xtrabackup --prepare</code> could fail to decrypt a table but reported that the operation completed ok. Bug fixed PXB-1936</p> </li> <li> <p><code>xtrabackup --move-back</code> did not complete successfully when the encrypted binlog file. Bug fixed PXB-1937.</p> </li> <li> <p>Percona XtraBackup could crash during the prepare stage when making an incremental</p> </li> </ul> <p>backup when a multi valued index was being added or dropped for JSON data. Bug fixed PXB-1913.</p> <p>Other bugs fixed: PXB-1928, PXB-1938, PXB-1951, PXB-1953, PXB-1954.</p> <p></p>"},{"location":"release-notes/8.0/8.0.8.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"},{"location":"release-notes/8.0/8.0.9.html","title":"Percona XtraBackup 8.0.9","text":"<p>Percona is glad to announce the release of Percona XtraBackup 8.0.9 on December 16, 2019. Downloads are available from our download site and from apt and yum repositories.</p> <p>Percona XtraBackup enables MySQL backups without blocking user queries, making it ideal for companies with large data sets and mission-critical applications that cannot tolerate long periods of downtime. Offered free as an open source solution, it drives down backup costs while providing unique features for MySQL backups.</p> <p>All Percona software is open-source and free.</p>"},{"location":"release-notes/8.0/8.0.9.html#bugs-fixed","title":"Bugs Fixed","text":"<ul> <li>Sometime between December 3<sup>rd</sup> and December 10<sup>th</sup>, a change was introduced in  that caused an incompatibility with our Percona XtraBackup <code>xbcloud</code> utility. Bug fixed PXB-1978.</li> </ul>"},{"location":"release-notes/8.0/8.0.9.html#get-expert-help","title":"Get expert help","text":"<p>If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.</p> <p> Community Forum  Get a Percona Expert</p>"}]}
\ No newline at end of file
diff --git a/8.0/server-backup-version-comparison.html b/8.0/server-backup-version-comparison.html
index 73f8dcac..dfc59bbf 100644
--- a/8.0/server-backup-version-comparison.html
+++ b/8.0/server-backup-version-comparison.html
@@ -3111,7 +3111,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3153,7 +3153,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3174,7 +3174,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3280,7 +3280,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3322,7 +3322,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/set-up-replication.html b/8.0/set-up-replication.html
index d6df9158..17bdcd49 100644
--- a/8.0/set-up-replication.html
+++ b/8.0/set-up-replication.html
@@ -3030,7 +3030,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3072,7 +3072,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3093,7 +3093,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3199,7 +3199,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3241,7 +3241,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/smart-memory-estimation.html b/8.0/smart-memory-estimation.html
index ab8c5a1b..4c07b086 100644
--- a/8.0/smart-memory-estimation.html
+++ b/8.0/smart-memory-estimation.html
@@ -3096,7 +3096,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3138,7 +3138,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3159,7 +3159,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3265,7 +3265,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3307,7 +3307,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/store-backup-history.html b/8.0/store-backup-history.html
index 6a21740b..825da556 100644
--- a/8.0/store-backup-history.html
+++ b/8.0/store-backup-history.html
@@ -3100,7 +3100,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3142,7 +3142,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3163,7 +3163,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3269,7 +3269,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3311,7 +3311,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/supported-versions.html b/8.0/supported-versions.html
index 918bd5a6..c92f3afb 100644
--- a/8.0/supported-versions.html
+++ b/8.0/supported-versions.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/take-streaming-backup.html b/8.0/take-streaming-backup.html
index 49181ff5..1d0a0beb 100644
--- a/8.0/take-streaming-backup.html
+++ b/8.0/take-streaming-backup.html
@@ -3098,7 +3098,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3140,7 +3140,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3161,7 +3161,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3267,7 +3267,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3309,7 +3309,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/throttling-backups.html b/8.0/throttling-backups.html
index 65cf8bdc..a51e43f4 100644
--- a/8.0/throttling-backups.html
+++ b/8.0/throttling-backups.html
@@ -3083,7 +3083,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3125,7 +3125,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3146,7 +3146,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3252,7 +3252,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3294,7 +3294,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/toolkit-version-check.html b/8.0/toolkit-version-check.html
index 3b427762..7d40758e 100644
--- a/8.0/toolkit-version-check.html
+++ b/8.0/toolkit-version-check.html
@@ -3032,7 +3032,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3074,7 +3074,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3095,7 +3095,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3201,7 +3201,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3243,7 +3243,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/topic-index.html b/8.0/topic-index.html
index 9dc897a8..8f183621 100644
--- a/8.0/topic-index.html
+++ b/8.0/topic-index.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/trademark-policy.html b/8.0/trademark-policy.html
index b9b63c04..24835732 100644
--- a/8.0/trademark-policy.html
+++ b/8.0/trademark-policy.html
@@ -3029,7 +3029,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3071,7 +3071,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3092,7 +3092,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3198,7 +3198,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3240,7 +3240,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/update-curl-utility.html b/8.0/update-curl-utility.html
index 89685b85..0c4decfc 100644
--- a/8.0/update-curl-utility.html
+++ b/8.0/update-curl-utility.html
@@ -3085,7 +3085,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3127,7 +3127,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3148,7 +3148,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3254,7 +3254,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3296,7 +3296,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/verify-backup.html b/8.0/verify-backup.html
index ffcb4edd..2c86a3cc 100644
--- a/8.0/verify-backup.html
+++ b/8.0/verify-backup.html
@@ -3029,7 +3029,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3071,7 +3071,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3092,7 +3092,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3198,7 +3198,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3240,7 +3240,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/work-with-apparmor.html b/8.0/work-with-apparmor.html
index 5e21fc43..7a6055f4 100644
--- a/8.0/work-with-apparmor.html
+++ b/8.0/work-with-apparmor.html
@@ -3029,7 +3029,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3071,7 +3071,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3092,7 +3092,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3258,7 +3258,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3300,7 +3300,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/work-with-selinux.html b/8.0/work-with-selinux.html
index a7b15397..0f9873af 100644
--- a/8.0/work-with-selinux.html
+++ b/8.0/work-with-selinux.html
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3198,7 +3198,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3240,7 +3240,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/working-with-binary-logs.html b/8.0/working-with-binary-logs.html
index bb7b6cb3..7ffc12d2 100644
--- a/8.0/working-with-binary-logs.html
+++ b/8.0/working-with-binary-logs.html
@@ -3105,7 +3105,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3147,7 +3147,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3168,7 +3168,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3274,7 +3274,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3316,7 +3316,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-azure.html b/8.0/xbcloud-azure.html
index d6598017..fc5902a7 100644
--- a/8.0/xbcloud-azure.html
+++ b/8.0/xbcloud-azure.html
@@ -3109,7 +3109,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3151,7 +3151,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3172,7 +3172,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3278,7 +3278,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3320,7 +3320,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-binary-fifo-datasink.html b/8.0/xbcloud-binary-fifo-datasink.html
index 44adb121..c93804a4 100644
--- a/8.0/xbcloud-binary-fifo-datasink.html
+++ b/8.0/xbcloud-binary-fifo-datasink.html
@@ -3116,7 +3116,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3158,7 +3158,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3179,7 +3179,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3285,7 +3285,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3327,7 +3327,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-binary-overview.html b/8.0/xbcloud-binary-overview.html
index be6d42cd..8bf3be7c 100644
--- a/8.0/xbcloud-binary-overview.html
+++ b/8.0/xbcloud-binary-overview.html
@@ -3186,7 +3186,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3228,7 +3228,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3249,7 +3249,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3355,7 +3355,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3397,7 +3397,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-exbackoff.html b/8.0/xbcloud-exbackoff.html
index 8c461784..49d9fcd9 100644
--- a/8.0/xbcloud-exbackoff.html
+++ b/8.0/xbcloud-exbackoff.html
@@ -3099,7 +3099,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3141,7 +3141,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3162,7 +3162,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3268,7 +3268,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3310,7 +3310,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-gcs.html b/8.0/xbcloud-gcs.html
index 29fd6e09..536bdb13 100644
--- a/8.0/xbcloud-gcs.html
+++ b/8.0/xbcloud-gcs.html
@@ -3091,7 +3091,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3133,7 +3133,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3154,7 +3154,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3260,7 +3260,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3302,7 +3302,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-iam-profile.html b/8.0/xbcloud-iam-profile.html
index 7809f9bd..b5cde2d3 100644
--- a/8.0/xbcloud-iam-profile.html
+++ b/8.0/xbcloud-iam-profile.html
@@ -3082,7 +3082,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3124,7 +3124,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3145,7 +3145,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3251,7 +3251,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3293,7 +3293,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-minio.html b/8.0/xbcloud-minio.html
index c0f84d3c..4e5a7db2 100644
--- a/8.0/xbcloud-minio.html
+++ b/8.0/xbcloud-minio.html
@@ -3091,7 +3091,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3133,7 +3133,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3154,7 +3154,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3260,7 +3260,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3302,7 +3302,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-options.html b/8.0/xbcloud-options.html
index 75673b8c..84ade8e3 100644
--- a/8.0/xbcloud-options.html
+++ b/8.0/xbcloud-options.html
@@ -3605,7 +3605,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3647,7 +3647,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3668,7 +3668,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3774,7 +3774,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3816,7 +3816,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-s3.html b/8.0/xbcloud-s3.html
index 1c7f495f..4a71c239 100644
--- a/8.0/xbcloud-s3.html
+++ b/8.0/xbcloud-s3.html
@@ -3118,7 +3118,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3160,7 +3160,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3181,7 +3181,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3287,7 +3287,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3329,7 +3329,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcloud-swift.html b/8.0/xbcloud-swift.html
index eefd1a8b..51a49d24 100644
--- a/8.0/xbcloud-swift.html
+++ b/8.0/xbcloud-swift.html
@@ -3100,7 +3100,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3142,7 +3142,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3163,7 +3163,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3269,7 +3269,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3311,7 +3311,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcrypt-binary-overview.html b/8.0/xbcrypt-binary-overview.html
index 8c63c5e1..b39ebecf 100644
--- a/8.0/xbcrypt-binary-overview.html
+++ b/8.0/xbcrypt-binary-overview.html
@@ -3081,7 +3081,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3123,7 +3123,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3144,7 +3144,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3250,7 +3250,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3292,7 +3292,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbcrypt-options.html b/8.0/xbcrypt-options.html
index 97d8b1cb..a7585949 100644
--- a/8.0/xbcrypt-options.html
+++ b/8.0/xbcrypt-options.html
@@ -3170,7 +3170,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3212,7 +3212,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3233,7 +3233,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3339,7 +3339,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3381,7 +3381,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbstream-binary-overview.html b/8.0/xbstream-binary-overview.html
index 29b58036..fee836a3 100644
--- a/8.0/xbstream-binary-overview.html
+++ b/8.0/xbstream-binary-overview.html
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3130,7 +3130,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3151,7 +3151,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3257,7 +3257,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3299,7 +3299,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xbstream-options.html b/8.0/xbstream-options.html
index 56cce5b4..7cb4826c 100644
--- a/8.0/xbstream-options.html
+++ b/8.0/xbstream-options.html
@@ -3224,7 +3224,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3266,7 +3266,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3287,7 +3287,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3393,7 +3393,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3435,7 +3435,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xtrabackup-binary-overview.html b/8.0/xtrabackup-binary-overview.html
index 05cd2191..4d2fcc2b 100644
--- a/8.0/xtrabackup-binary-overview.html
+++ b/8.0/xtrabackup-binary-overview.html
@@ -3081,7 +3081,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3123,7 +3123,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3144,7 +3144,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3250,7 +3250,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3292,7 +3292,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xtrabackup-exit-codes.html b/8.0/xtrabackup-exit-codes.html
index ef6908f3..1cf6a0c3 100644
--- a/8.0/xtrabackup-exit-codes.html
+++ b/8.0/xtrabackup-exit-codes.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xtrabackup-files.html b/8.0/xtrabackup-files.html
index aae838df..453197f4 100644
--- a/8.0/xtrabackup-files.html
+++ b/8.0/xtrabackup-files.html
@@ -3025,7 +3025,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3067,7 +3067,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3088,7 +3088,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3194,7 +3194,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3236,7 +3236,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xtrabackup-implementation-details.html b/8.0/xtrabackup-implementation-details.html
index de66df0f..0f36659c 100644
--- a/8.0/xtrabackup-implementation-details.html
+++ b/8.0/xtrabackup-implementation-details.html
@@ -3108,7 +3108,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3150,7 +3150,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3171,7 +3171,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3277,7 +3277,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3319,7 +3319,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xtrabackup-option-reference.html b/8.0/xtrabackup-option-reference.html
index d48fbb57..44035a63 100644
--- a/8.0/xtrabackup-option-reference.html
+++ b/8.0/xtrabackup-option-reference.html
@@ -4280,7 +4280,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -4322,7 +4322,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -4343,7 +4343,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -4449,7 +4449,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -4491,7 +4491,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/xtrabackup-version-numbers.html b/8.0/xtrabackup-version-numbers.html
index ad38d278..708a108c 100644
--- a/8.0/xtrabackup-version-numbers.html
+++ b/8.0/xtrabackup-version-numbers.html
@@ -3078,7 +3078,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3120,7 +3120,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3141,7 +3141,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3247,7 +3247,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3289,7 +3289,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/yum-download-rpm.html b/8.0/yum-download-rpm.html
index 805423d2..93101dc0 100644
--- a/8.0/yum-download-rpm.html
+++ b/8.0/yum-download-rpm.html
@@ -8,7 +8,7 @@
       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
       
-        <meta name="description" content="Download RPM packages of the desired series for your architecture from the download page.">
+        <meta name="description" content="This guide walks you through installing Percona XtraBackup 8.0 using DEB packages on Ubuntu-based systems.">
       
       
         <meta name="author" content="Percona LLC">
@@ -28,7 +28,7 @@
     
     
       
-        <title>Downloaded RPM packages - Percona XtraBackup</title>
+        <title>Download RPM packages - Percona XtraBackup</title>
       
     
     
@@ -91,7 +91,7 @@
                  
                  
                  <meta property="og:type" content="website" />
-                 <meta property="og:title" content="Percona XtraBackup - Downloaded RPM packages" />
+                 <meta property="og:title" content="Percona XtraBackup - Download RPM packages" />
                  <meta property="og:image" content="https://docs.percona.com/percona-xtrabackup/8.0/_static/percona-mysql-logo.png">
                  <meta property="og:url" content="https://docs.percona.com/percona-xtrabackup/">
 
@@ -114,7 +114,7 @@
     <div data-md-component="skip">
       
         
-        <a href="#install-percona-xtrabackup-80-using-downloaded-rpm-packages" class="md-skip">
+        <a href="#install-with-rpm-packages" class="md-skip">
           Skip to content
         </a>
       
@@ -189,7 +189,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
             
-              Downloaded RPM packages
+              Download RPM packages
             
           </span>
         </div>
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3198,7 +3198,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3249,7 +3249,7 @@
           
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
@@ -3260,7 +3260,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
@@ -3283,6 +3283,33 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#common-dependencies" class="md-nav__link">
+    <span class="md-ellipsis">
+      Common dependencies
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#verify-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Verify the installation
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#troubleshoot-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Troubleshoot the installation
+    </span>
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#get-expert-help" class="md-nav__link">
     <span class="md-ellipsis">
@@ -4620,6 +4647,33 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#common-dependencies" class="md-nav__link">
+    <span class="md-ellipsis">
+      Common dependencies
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#verify-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Verify the installation
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#troubleshoot-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Troubleshoot the installation
+    </span>
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#get-expert-help" class="md-nav__link">
     <span class="md-ellipsis">
@@ -4666,15 +4720,87 @@
   
 
 
-<h1 id="install-percona-xtrabackup-80-using-downloaded-rpm-packages">Install Percona XtraBackup 8.0 using downloaded RPM packages<a class="headerlink" href="#install-percona-xtrabackup-80-using-downloaded-rpm-packages" title="Permanent link">&para;</a></h1>
-<p>Download <code>RPM</code> packages of the desired series for your architecture from the <a href="https://www.percona.com/downloads/">download page</a>. </p>
-<p>The following example downloads <em>Percona XtraBackup</em> 8.0.4 release package for <em>CentOS</em> 7:</p>
-<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>wget<span class="w"> </span>https://www.percona.com/downloads/XtraBackup/Percona-XtraBackup-8.0.4/binary/redhat/7/x86_64/percona-xtrabackup-80-8.0.4-1.el7.x86_64.rpm
+<h1 id="install-with-rpm-packages">Install with RPM packages<a class="headerlink" href="#install-with-rpm-packages" title="Permanent link">&para;</a></h1>
+<p class="power-number">This guide walks you through installing Percona XtraBackup 8.0 using DEB packages on Ubuntu-based systems.</p>
+<ol>
+<li>
+<p>Download the appropriate packages for your architecure from <a href="https://www.percona.com/downloads">Percona Software Downloads</a>. This example downloads the Percona XtraBackup 8.0 package for Red Hat Enterprise Linux 9.</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>wget<span class="w"> </span>https://downloads.percona.com/downloads/Percona-XtraBackup-LATEST/Percona-XtraBackup-8.0.32-26/binary/redhat/9/x86_64/percona-xtrabackup-80-8.0.32-26.1.el9.x86_64.rpm
+</code></pre></div>
+</li>
+<li>
+<p>Install the package</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>localinstall<span class="w"> </span>percona-xtrabackup-80-8.0.32-26.1.el9.x86_64.rpm
+</code></pre></div>
+</li>
+</ol>
+<h2 id="common-dependencies">Common dependencies<a class="headerlink" href="#common-dependencies" title="Permanent link">&para;</a></h2>
+<table>
+<thead>
+<tr>
+<th>Library name</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>libev</td>
+<td>A high-performance event-loop library used in asynchronous network applications.</td>
+</tr>
+<tr>
+<td>libgcrypt</td>
+<td>A general-purpose cryptographic library providing encryption, decryption, and hashing algorithms.</td>
+</tr>
+<tr>
+<td>openssl</td>
+<td>A robust library for implementing SSL/TLS encryption and cryptographic functions.</td>
+</tr>
+<tr>
+<td>zlib</td>
+<td>A compression library that supports data compression and decompression using the DEFLATE algorithm.</td>
+</tr>
+<tr>
+<td>libaio</td>
+<td>A library for asynchronous I/O operations, providing non-blocking I/O functionality.</td>
+</tr>
+</tbody>
+</table>
+<p>If yum reports missing dependencies, it may offer to install them automatically. If not, you can install these dependencies manually using the following example.</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>libev<span class="w"> </span>libgcrypt<span class="w"> </span>openssl<span class="w"> </span>zlib<span class="w"> </span>libaio
 </code></pre></div>
-<p>Install Percona XtraBackup by running:</p>
-<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>yum<span class="w"> </span>localinstall<span class="w"> </span>percona-xtrabackup-80-8.0.4-1.el7.x86_64.rpm
+<h2 id="verify-the-installation">Verify the installation<a class="headerlink" href="#verify-the-installation" title="Permanent link">&para;</a></h2>
+<p>After installation, verify it by checking the version:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>xtrabackup<span class="w"> </span>--version
 </code></pre></div>
-<p>When installing packages manually like this, you’ll need to make sure to resolve all the dependencies and install missing packages yourself.</p>
+<h2 id="troubleshoot-the-installation">Troubleshoot the installation<a class="headerlink" href="#troubleshoot-the-installation" title="Permanent link">&para;</a></h2>
+<table>
+<thead>
+<tr>
+<th>Issue</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Permission denied</td>
+<td>Ensure you&rsquo;re using sudo or have root access for installation commands.</td>
+</tr>
+<tr>
+<td>Repository issues</td>
+<td>If packages are not found, check your yum repository configuration.</td>
+</tr>
+<tr>
+<td>Incompatible OS version</td>
+<td>Double-check your OS version matches the package requirements.</td>
+</tr>
+<tr>
+<td>Conflicts with existing packages</td>
+<td>Consider removing conflicting packages or use a separate environment.</td>
+</tr>
+</tbody>
+</table>
+<p>If you encounter persistent issues, consult the Percona XtraBackup documentation or reach out to their support forums for assistance.</p>
+<p>Remember, when installing packages manually, you&rsquo;re responsible for managing dependencies and potential conflicts. Always back up your data before making significant system changes.</p>
 <div data-banner="data-banner">
 <p><svg style="display:block;margin:-1em 0 0.75em" width="78" height="69" viewBox="0 0 78 69" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M56.7281 30.7666C62.6528 26.8938 64.5914 18.9942 61.0059 12.7854C59.2094 9.67113 56.3053 7.44082 52.8311 6.50951C49.6122 5.64535 46.2502 5.99872 43.2912 7.49366L39.251 0.5L30.8648 15.0245L11.4811 48.5937H67.021L56.7281 30.7666ZM51.881 10.0674C54.4064 10.7401 56.5079 12.3616 57.8168 14.6194C60.3895 19.0701 59.053 24.7153 54.8808 27.5665L45.1362 10.6905C47.2355 9.68104 49.6034 9.46087 51.881 10.0674ZM39.251 7.87125L60.6339 44.907H48.1228L32.9927 18.7102L39.2499 7.87235L39.251 7.87125ZM17.8682 44.907L30.8637 22.4035L43.8592 44.907H17.8682Z" fill="url(#paint0_linear_2899_1968)"/><path style="fill:var(--md-typeset-color)" d="M4.981 64.943H3.157V68.207H.756V57.323H5.217C7.822 57.323 9.397 58.861 9.397 61.086V61.116C9.397 63.635 7.433 64.94 4.984 64.94L4.981 64.943V64.943ZM6.961 61.134C6.961 60.061 6.213 59.485 5.011 59.485H3.154V62.812H5.056C6.258 62.812 6.958 62.096 6.958 61.163V61.134H6.961ZM10.738 68.208V57.323H18.973V59.455H13.124V61.664H18.27V63.796H13.124V66.082H19.051V68.214H10.738V68.208 68.208ZM27.557 68.208 25.218 64.726H23.332V68.208H20.931V57.323H25.921C28.496 57.323 30.039 58.677 30.039 60.915V60.945C30.039 62.702 29.088 63.807 27.7 64.32L30.367 68.207H27.556L27.557 68.208ZM27.605 61.041C27.605 60.016 26.887 59.485 25.719 59.485H23.333V62.61H25.767C26.936 62.61 27.605 61.987 27.605 61.071V61.042 61.041ZM36.922 68.499C33.668 68.499 31.249 65.994 31.249 62.825V62.795C31.249 59.659 33.619 57.091 37.019 57.091 39.105 57.091 40.356 57.783 41.383 58.792L39.834 60.571C38.98 59.798 38.113 59.327 37.004 59.327 35.141 59.327 33.795 60.871 33.795 62.762V62.793C33.795 64.684 35.107 66.257 37.004 66.257 38.268 66.257 39.043 65.753 39.913 64.964L41.462 66.524C40.322 67.738 39.059 68.493 36.925 68.493L36.922 68.499ZM47.885 68.499C44.47 68.499 42.021 65.962 42.021 62.825V62.795C42.021 59.659 44.503 57.091 47.915 57.091 51.327 57.091 53.779 59.628 53.779 62.765V62.795C53.779 65.931 51.297 68.499 47.885 68.499ZM51.237 62.795C51.237 60.904 49.846 59.331 47.885 59.331 45.925 59.331 44.567 60.874 44.567 62.766V62.796C44.567 64.688 45.959 66.261 47.919 66.261 49.879 66.261 51.237 64.717 51.237 62.826V62.795 62.795ZM67.001 68.217 72.374 57.091 77.746 68.218H75.052L72.374 62.681 69.705 68.218H67.001V68.217ZM66.007 57.327V68.5L57.813 61.884V68.199H55.264V57.091L63.458 63.681V57.327H66.007Z"/><defs><linearGradient id="paint0_linear_2899_1968" x1="18.1513" y1="44.7152" x2="61.4356" y2="20.9786" gradientUnits="userSpaceOnUse"><stop stop-color="#FC3519"/><stop offset="1" stop-color="#F0D136"/></linearGradient></defs></svg></p>
 <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href="#get-expert-help" title="Permanent link">&para;</a></h2>
@@ -4690,7 +4816,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
   <small>
     
       Last update:
-      2023-06-12
+      2024-09-13
     
   </small>
 </div>
diff --git a/8.0/yum-files.html b/8.0/yum-files.html
index 2bc36725..5bfb6995 100644
--- a/8.0/yum-files.html
+++ b/8.0/yum-files.html
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3198,7 +3198,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3291,7 +3291,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
diff --git a/8.0/yum-repo.html b/8.0/yum-repo.html
index b93851a1..37a87ea1 100644
--- a/8.0/yum-repo.html
+++ b/8.0/yum-repo.html
@@ -9,7 +9,7 @@
       <meta name="viewport" content="width=device-width,initial-scale=1">
       
         <meta name="description" content="Ready-to-use packages are available from the Percona XtraBackup software
-repositories and the download page. The Percona yum repository supports popular RPM-based operating systems, including the Amazon Linux AMI.">
+repositories and the download page. The Percona yum repository supports popular RPM-based operating systems, including the Amazon Linux AMI, which has reached its end of life. Amazon Linux 2 is not supported at this time.">
       
       
         <meta name="author" content="Percona LLC">
@@ -29,7 +29,7 @@
     
     
       
-        <title>Use RPM repositories - Percona XtraBackup</title>
+        <title>Percona release and YUM - Percona XtraBackup</title>
       
     
     
@@ -92,7 +92,7 @@
                  
                  
                  <meta property="og:type" content="website" />
-                 <meta property="og:title" content="Percona XtraBackup - Use RPM repositories" />
+                 <meta property="og:title" content="Percona XtraBackup - Percona release and YUM" />
                  <meta property="og:image" content="https://docs.percona.com/percona-xtrabackup/8.0/_static/percona-mysql-logo.png">
                  <meta property="og:url" content="https://docs.percona.com/percona-xtrabackup/">
 
@@ -115,7 +115,7 @@
     <div data-md-component="skip">
       
         
-        <a href="#use-a-yum-repository-to-install-percona-xtrabackup" class="md-skip">
+        <a href="#install-percona-xtrabackup-on-red-hat-based-systems" class="md-skip">
           Skip to content
         </a>
       
@@ -190,7 +190,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
             
-              Use RPM repositories
+              Percona release and YUM
             
           </span>
         </div>
@@ -3028,7 +3028,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3070,7 +3070,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3091,7 +3091,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3208,7 +3208,7 @@
           
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3219,7 +3219,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3252,9 +3252,36 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#install-percona-xtrabackup-from-percona-yum-repository" class="md-nav__link">
+  <a href="#prerequisites" class="md-nav__link">
     <span class="md-ellipsis">
-      Install Percona XtraBackup from Percona yum repository
+      Prerequisites
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#install-from-percona-yum-repository" class="md-nav__link">
+    <span class="md-ellipsis">
+      Install from Percona YUM repository
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#verify-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Verify the installation
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#troubleshoot" class="md-nav__link">
+    <span class="md-ellipsis">
+      Troubleshoot
     </span>
   </a>
   
@@ -3310,7 +3337,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
@@ -4649,9 +4676,36 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#install-percona-xtrabackup-from-percona-yum-repository" class="md-nav__link">
+  <a href="#prerequisites" class="md-nav__link">
+    <span class="md-ellipsis">
+      Prerequisites
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#install-from-percona-yum-repository" class="md-nav__link">
+    <span class="md-ellipsis">
+      Install from Percona YUM repository
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#verify-the-installation" class="md-nav__link">
+    <span class="md-ellipsis">
+      Verify the installation
+    </span>
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#troubleshoot" class="md-nav__link">
     <span class="md-ellipsis">
-      Install Percona XtraBackup from Percona yum repository
+      Troubleshoot
     </span>
   </a>
   
@@ -4703,40 +4757,87 @@
   
 
 
-<h1 id="use-a-yum-repository-to-install-percona-xtrabackup">Use a YUM repository to install Percona XtraBackup<a class="headerlink" href="#use-a-yum-repository-to-install-percona-xtrabackup" title="Permanent link">&para;</a></h1>
+<h1 id="install-percona-xtrabackup-on-red-hat-based-systems">Install Percona XtraBackup on Red Hat-based systems<a class="headerlink" href="#install-percona-xtrabackup-on-red-hat-based-systems" title="Permanent link">&para;</a></h1>
 <p>Ready-to-use packages are available from the Percona XtraBackup software
-repositories and the <a href="https://www.percona.com/downloads/">download page</a>. The Percona yum repository supports popular <code>RPM</code>-based operating systems, including the <code>Amazon Linux AMI</code>.</p>
+repositories and the <a href="https://www.percona.com/downloads/">download page</a>. The Percona yum repository supports popular <code>RPM</code>-based operating systems, including the <code>Amazon Linux AMI</code>, which has reached its end of life. <code>Amazon Linux 2</code> is not supported at this time. </p>
 <p>The easiest way to install the Percona Yum repository is to install an <code>RPM</code> that configures yum and installs the <a href="https://www.percona.com/downloads/RPM-GPG-KEY-percona">Percona GPG key</a>.</p>
 <p>Specific information on the supported platforms, products, and versions is described in <a href="https://www.percona.com/services/policies/percona-software-platform-lifecycle#mysql">Percona Software and Platform Lifecycle</a>.</p>
 <h2 id="version-changes">Version changes<a class="headerlink" href="#version-changes" title="Permanent link">&para;</a></h2>
 <p>Starting with <a href="release-notes/8.0/8.0.35-31.0.html">Percona XtraBackup 8.0.35-31</a>, the RPM builds for RHEL 8 and RHEL 9 include ARM packages with the <code>aarch64.rpm</code> extension. This extension means Percona XtraBackup is now available for users on ARM-based systems.</p>
 <p>We recommend downloading Percona XtraBackup for the same platform as your MySQL-compatible server. For instance, if your server runs on an ARM64 platform, you should download and use the Percona XtraBackup with the <code>aarch64.rpm</code> extension for that operating system.</p>
-<h2 id="install-percona-xtrabackup-from-percona-yum-repository">Install Percona XtraBackup from Percona <code>yum</code> repository<a class="headerlink" href="#install-percona-xtrabackup-from-percona-yum-repository" title="Permanent link">&para;</a></h2>
+<p>Make sure that you have the <code>libev</code> package installed before installing Percona XtraBackup on CentOS 6. For this operating system, the <code>libev</code> package is available from <a href="https://fedoraproject.org/wiki/EPEL">EPEL</a>.</p>
+<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h2>
+<ul>
+<li>
+<p>Sudo or root access</p>
+</li>
+<li>
+<p>Internet connection</p>
+</li>
+</ul>
+<h2 id="install-from-percona-yum-repository">Install from Percona <code>YUM</code> repository<a class="headerlink" href="#install-from-percona-yum-repository" title="Permanent link">&para;</a></h2>
+<p class="power-number">The following procedure installs Percona XtraBackup 8.0.</p>
 <ol>
 <li>
-<p>Install the Percona yum repository by running the following command as the <code>root</code> user or with <strong>sudo</strong>: </p>
+<p>Install the Percona yum repository by running the following command as the <code>root</code> user or with sudo: </p>
 <div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span><span class="se">\</span>
 https://repo.percona.com/yum/percona-release-latest.<span class="se">\</span>
 noarch.rpm
 </code></pre></div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>Oracle Linux 9 BaseOS Latest (x86_64)                                 6.6 MB/s |  35 MB     00:05
+Oracle Linux 9 Application Stream Packages (x86_64)                   8.5 MB/s |  41 MB     00:04
+Last metadata expiration check: 0:00:06 ago on Mon Sep 23 09:43:33 2024.
+percona-release-latest.noarch.rpm                                      49 kB/s |  27 kB     00:00
+Dependencies resolved.
+...
+For more information, please visit:
+https://docs.percona.com/percona-software-repositories/percona-release.html
+
+
+Verifying        : percona-release-1.0-29.noarch    
+                                            1/1
+
+Installed:
+percona-release-1.0-29.noarch
+
+Complete!
+</code></pre></div>
+</details>
 </li>
 <li>
 <p>Enable the repository: </p>
-<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>percona-release<span class="w"> </span>enable-only<span class="w"> </span>tools<span class="w"> </span>release
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>percona-release<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>pxb-80
 </code></pre></div>
-<p>If <em>Percona XtraBackup</em> is intended to be used in combination with
-the upstream MySQL Server, you only need to enable the `tools repository: </p>
-<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>percona-release<span class="w"> </span>enable-only<span class="w"> </span>tools
+<details class="example">
+<summary>Example output</summary>
+<div class="highlight"><pre><span></span><code>```{.text .no-copy}
+* Enabling the Percona XtraBackup 8.0 repository
+&lt;*&gt; All done!
+```
 </code></pre></div>
+</details>
 </li>
 <li>
 <p>Install <em>Percona XtraBackup</em> by running:</p>
 <div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>percona-xtrabackup-80
 </code></pre></div>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>Make sure that you have the <code>libev</code> package installed before installing <em>Percona XtraBackup</em> on CentOS 6. For this operating system, the <code>libev</code> package is available from the <a href="https://fedoraproject.org/wiki/EPEL">EPEL</a> repositories.</p>
-</div>
+<details class="example">
+<summary>Example output</summary>
+<div class="no-copy highlight"><pre><span></span><code>* Enabling the Percona XtraBackup 8.0 repository
+&lt;*&gt; All done!
+[root@e1dc549c0c65 /]# yum install percona-xtrabackup-80
+PMM2 Client release/x86_64 YUM repository                              13 kB/s | 6.4 kB     00:00
+Percona Release release/noarch YUM repository                         4.3 kB/s | 2.0 kB     00:00
+Percona XtraBackup 8.0 release/x86_64 YUM repository                  363 kB/s | 416 kB     00:01
+Percona Telemetry release/x86_64 YUM repository                       3.1 kB/s | 1.5 kB     00:00
+Dependencies resolved.
+...
+
+Complete!
+</code></pre></div>
+</details>
 </li>
 <li>
 <p>To decompress backups made using <code>LZ4</code> or <code>ZSTD</code> compression algorithm, install the corresponding package:</p>
@@ -4754,6 +4855,63 @@ <h2 id="install-percona-xtrabackup-from-percona-yum-repository">Install Percona
 </div>
 </li>
 </ol>
+<h2 id="verify-the-installation">Verify the installation<a class="headerlink" href="#verify-the-installation" title="Permanent link">&para;</a></h2>
+<p>Run Percona XtraBackup:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>xtrabackup<span class="w"> </span>--version
+</code></pre></div>
+<p>If this command fails, the installation is incomplete or incorrect.</p>
+<h2 id="troubleshoot">Troubleshoot<a class="headerlink" href="#troubleshoot" title="Permanent link">&para;</a></h2>
+<p class="power-number">To troubleshoot a Percona XtraBackup 8.0.x installation on a Red Hat-based system, follow these steps:</p>
+<ol>
+<li>
+<p>This command checks for missing libraries.</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>ldd<span class="w"> </span><span class="k">$(</span>which<span class="w"> </span>xtrabackup<span class="k">)</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>grep<span class="w"> </span><span class="s2">&quot;not found&quot;</span>
+</code></pre></div>
+</li>
+<li>
+<p>Install missing dependencies:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>&lt;missing-library-name&gt;
+</code></pre></div>
+</li>
+<li>
+<p>Examine log files:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>journalctl<span class="w"> </span>-xe<span class="w"> </span><span class="p">|</span><span class="w"> </span>grep<span class="w"> </span>xtrabackup
+</code></pre></div>
+</li>
+<li>
+<p>Ensure the Percona repository is correctly set up:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>cat<span class="w"> </span>/etc/yum.repos.d/percona-release.repo
+</code></pre></div>
+</li>
+<li>
+<p>Update the system to ensure all packages are current:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>update
+</code></pre></div>
+</li>
+<li>
+<p>If issues persist, try a clean reinstall:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>remove<span class="w"> </span>percona-xtrabackup-80<span class="w"> </span>
+$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>clean<span class="w"> </span>all<span class="w"> </span>
+$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>install<span class="w"> </span>percona-xtrabackup-80
+</code></pre></div>
+</li>
+<li>
+<p>SELinux might block XtraBackup. Check its status:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>getenforce
+</code></pre></div>
+</li>
+<li>
+<p>Set SELinux to permissive temporarily:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>setenforce<span class="w"> </span><span class="m">0</span>
+</code></pre></div>
+</li>
+<li>
+<p>Create a backup to verify functionality:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>xtrabackup<span class="w"> </span>--backup<span class="w"> </span>--target-dir<span class="o">=</span>/tmp/test_backup
+</code></pre></div>
+</li>
+</ol>
+<p>If problems continue, gather all error messages and logs, then consult Percona&rsquo;s documentation or support forums for further assistance.</p>
 <div class="admonition admonition">
 <p class="admonition-title">See also</p>
 <p>To install Percona XtraBackup using downloaded rpm packages, see <a href="yum-download-rpm.html">Install with package manager</a>.</p>
@@ -4774,7 +4932,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
   <small>
     
       Last update:
-      2024-06-26
+      2024-09-13
     
   </small>
 </div>
diff --git a/8.0/yum-uninstall-xtrabackup.html b/8.0/yum-uninstall-xtrabackup.html
index 63d5e540..35f8ff3e 100644
--- a/8.0/yum-uninstall-xtrabackup.html
+++ b/8.0/yum-uninstall-xtrabackup.html
@@ -8,7 +8,7 @@
       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
       
-        <meta name="description" content="To completely uninstall Percona XtraBackup, remove all the installed packages:">
+        <meta name="description" content="Remember to back up any important data before uninstalling software.">
       
       
         <meta name="author" content="Percona LLC">
@@ -114,7 +114,7 @@
     <div data-md-component="skip">
       
         
-        <a href="#uninstall-percona-xtrabackup-80-on-red-hat-enterprise-linux-and-centos" class="md-skip">
+        <a href="#uninstall-percona-xtrabackup-80-on-red-hat-based-systems" class="md-skip">
           Skip to content
         </a>
       
@@ -3027,7 +3027,7 @@
         
   
   <span class="md-ellipsis">
-    Use APT repositories
+    Percona release and APT
   </span>
   
 
@@ -3069,7 +3069,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded DEB packages
+    Download DEB packages
   </span>
   
 
@@ -3090,7 +3090,7 @@
         
   
   <span class="md-ellipsis">
-    Apt pinning
+    Pin packages
   </span>
   
 
@@ -3198,7 +3198,7 @@
         
   
   <span class="md-ellipsis">
-    Use RPM repositories
+    Percona release and YUM
   </span>
   
 
@@ -3240,7 +3240,7 @@
         
   
   <span class="md-ellipsis">
-    Downloaded RPM packages
+    Download RPM packages
   </span>
   
 
@@ -4666,10 +4666,25 @@
   
 
 
-<h1 id="uninstall-percona-xtrabackup-80-on-red-hat-enterprise-linux-and-centos">Uninstall Percona XtraBackup 8.0 on Red Hat Enterprise Linux and CentOS<a class="headerlink" href="#uninstall-percona-xtrabackup-80-on-red-hat-enterprise-linux-and-centos" title="Permanent link">&para;</a></h1>
-<p>To completely uninstall Percona XtraBackup, remove all the installed packages:</p>
-<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>yum<span class="w"> </span>remove<span class="w"> </span>percona-xtrabackup
+<h1 id="uninstall-percona-xtrabackup-80-on-red-hat-based-systems">Uninstall Percona XtraBackup 8.0 on Red Hat-based systems<a class="headerlink" href="#uninstall-percona-xtrabackup-80-on-red-hat-based-systems" title="Permanent link">&para;</a></h1>
+<p>Remember to back up any important data before uninstalling software.</p>
+<p>Remove the XtraBackup packages:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>remove<span class="w"> </span>percona-xtrabackup-80
 </code></pre></div>
+<p>To remove all configuration files and packages, run the following command:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>remove<span class="w"> </span>percona-xtrabackup-80<span class="w"> </span>--remove-leaves
+</code></pre></div>
+<p>Remove any unused dependencies:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>yum<span class="w"> </span>autoremove
+</code></pre></div>
+<p>To verify the removal, check the version:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>xtrabackup<span class="w"> </span>--version
+</code></pre></div>
+<p>This should return a <code>command not found</code>.</p>
+<p>You must remove any remaining directories manually:</p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>rm<span class="w"> </span>-rf<span class="w"> </span>/var/lib/xtrabackup
+</code></pre></div>
+<p>You can also remove any added Percona repositories from your system manager&rsquo;s configuration.</p>
 <div data-banner="data-banner">
 <p><svg style="display:block;margin:-1em 0 0.75em" width="78" height="69" viewBox="0 0 78 69" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M56.7281 30.7666C62.6528 26.8938 64.5914 18.9942 61.0059 12.7854C59.2094 9.67113 56.3053 7.44082 52.8311 6.50951C49.6122 5.64535 46.2502 5.99872 43.2912 7.49366L39.251 0.5L30.8648 15.0245L11.4811 48.5937H67.021L56.7281 30.7666ZM51.881 10.0674C54.4064 10.7401 56.5079 12.3616 57.8168 14.6194C60.3895 19.0701 59.053 24.7153 54.8808 27.5665L45.1362 10.6905C47.2355 9.68104 49.6034 9.46087 51.881 10.0674ZM39.251 7.87125L60.6339 44.907H48.1228L32.9927 18.7102L39.2499 7.87235L39.251 7.87125ZM17.8682 44.907L30.8637 22.4035L43.8592 44.907H17.8682Z" fill="url(#paint0_linear_2899_1968)"/><path style="fill:var(--md-typeset-color)" d="M4.981 64.943H3.157V68.207H.756V57.323H5.217C7.822 57.323 9.397 58.861 9.397 61.086V61.116C9.397 63.635 7.433 64.94 4.984 64.94L4.981 64.943V64.943ZM6.961 61.134C6.961 60.061 6.213 59.485 5.011 59.485H3.154V62.812H5.056C6.258 62.812 6.958 62.096 6.958 61.163V61.134H6.961ZM10.738 68.208V57.323H18.973V59.455H13.124V61.664H18.27V63.796H13.124V66.082H19.051V68.214H10.738V68.208 68.208ZM27.557 68.208 25.218 64.726H23.332V68.208H20.931V57.323H25.921C28.496 57.323 30.039 58.677 30.039 60.915V60.945C30.039 62.702 29.088 63.807 27.7 64.32L30.367 68.207H27.556L27.557 68.208ZM27.605 61.041C27.605 60.016 26.887 59.485 25.719 59.485H23.333V62.61H25.767C26.936 62.61 27.605 61.987 27.605 61.071V61.042 61.041ZM36.922 68.499C33.668 68.499 31.249 65.994 31.249 62.825V62.795C31.249 59.659 33.619 57.091 37.019 57.091 39.105 57.091 40.356 57.783 41.383 58.792L39.834 60.571C38.98 59.798 38.113 59.327 37.004 59.327 35.141 59.327 33.795 60.871 33.795 62.762V62.793C33.795 64.684 35.107 66.257 37.004 66.257 38.268 66.257 39.043 65.753 39.913 64.964L41.462 66.524C40.322 67.738 39.059 68.493 36.925 68.493L36.922 68.499ZM47.885 68.499C44.47 68.499 42.021 65.962 42.021 62.825V62.795C42.021 59.659 44.503 57.091 47.915 57.091 51.327 57.091 53.779 59.628 53.779 62.765V62.795C53.779 65.931 51.297 68.499 47.885 68.499ZM51.237 62.795C51.237 60.904 49.846 59.331 47.885 59.331 45.925 59.331 44.567 60.874 44.567 62.766V62.796C44.567 64.688 45.959 66.261 47.919 66.261 49.879 66.261 51.237 64.717 51.237 62.826V62.795 62.795ZM67.001 68.217 72.374 57.091 77.746 68.218H75.052L72.374 62.681 69.705 68.218H67.001V68.217ZM66.007 57.327V68.5L57.813 61.884V68.199H55.264V57.091L63.458 63.681V57.327H66.007Z"/><defs><linearGradient id="paint0_linear_2899_1968" x1="18.1513" y1="44.7152" x2="61.4356" y2="20.9786" gradientUnits="userSpaceOnUse"><stop stop-color="#FC3519"/><stop offset="1" stop-color="#F0D136"/></linearGradient></defs></svg></p>
 <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href="#get-expert-help" title="Permanent link">&para;</a></h2>
@@ -4685,7 +4700,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
   <small>
     
       Last update:
-      2023-06-12
+      2024-09-13
     
   </small>
 </div>