Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/.linkspector.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ ignorePatterns:
- pattern: "#mysql_alerts$"
- pattern: "#postgresql_alerts$"
- pattern: "#proxysql_alerts$"
- pattern: "^https://www\\.zmanda\\.com/zrm-community/?$"

replacementPatterns:
- pattern: "\\{\\{vers\\}\\}"
Expand Down
4 changes: 2 additions & 2 deletions docs/accelerate-backup-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ xtrabackup --backup --parallel=4 --target-dir=/path/to/backup

By using the xbstream in streaming backups, you can additionally speed up the
compression process with the `--compress-threads` option. This option
specifies the number of threads created by xtrabackup for for parallel data
specifies the number of threads created by xtrabackup for parallel data
compression. The default value for this option is 1.

To use this feature, simply add the option to a local backup, for example:
Expand All @@ -57,7 +57,7 @@ TABLES WITH READ LOCK` and once during to minimize the time the read lock is
being held. During the second `rsync` call, it will only synchronize the
changes to non-transactional data (if any) since the first call performed before
the `FLUSH TABLES WITH READ LOCK`. Note that Percona XtraBackup will use
[Backup locks] where available as a lightweight alternative to `FLUSH TABLES WITH READ
[backup locks :octicons-link-external-16:](https://docs.percona.com/percona-server/8.4/backup-locks.html) where available as a lightweight alternative to `FLUSH TABLES WITH READ
LOCK`.

Percona XtraBackup uses these locks automatically to copy non-InnoDB data to avoid blocking Data manipulation language (DML) queries that modify InnoDB tables. Find more information in [Backup locks :octicons-link-external-16:](https://docs.percona.com/percona-server/8.4/backup-locks.html)
Expand Down
4 changes: 2 additions & 2 deletions docs/apt-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Ready-to-use packages are available from the Percona XtraBackup software
repositories and the [Percona Software Downloads :octicons-link-external-16:](https://www.percona.com/downloads).

Specific information on the supported platforms, products, and versions is
described in [Percona Release Lifecycle Overview].
described in [Percona Release Lifecycle Overview :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-support-lifecycle).

## Install Percona XtraBackup through percona-release

Install Percona XtraBackup, like many other Percona products, with the `percona-release` package configuration tool. Run the following commands as root or use the sudo command.
{.power-number}

1. Use the apt package manager to dowload `percona-release`:
1. Use the apt package manager to download `percona-release`:

```shell
sudo apt update
Expand Down
6 changes: 3 additions & 3 deletions docs/compile-xtrabackup.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ in your distribution as a separate package `cmake3`. For more information, see [

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
install and enable [the Developer Toolset :octicons-link-external-16:](https://developers.redhat.com/products/developertoolset/overview) on
`RPM`-based distributions to make sure that you use the latest GCC
compiler and development tools. Then, install `cmake` and other
dependencies:
Expand Down Expand Up @@ -193,10 +193,10 @@ Update your PATH environment variable if you would like to use the command on
the command line directly.

```shell
$# Setting $PATH on the command line
# Setting $PATH on the command line
PATH=$PATH:/usr/local/xtrabackup/bin/xtrabackup

$# Run xtrabackup directly
# Run xtrabackup directly
xtrabackup
```

Expand Down
2 changes: 1 addition & 1 deletion docs/create-incremental-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ xtrabackup --backup --target-dir=/data/backups/base
```

If you look at the `xtrabackup_checkpoints` file, you should see similar
content depending on your LSN nuber:
content depending on your LSN number:

??? example "Expected output"

Expand Down
2 changes: 1 addition & 1 deletion docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To set up a database server on a host machine or in Docker
container, follow the documentation of the supported product that you
intend to use with Percona XtraBackup.

!!! admontion "See also"
!!! admonition "See also"

[Docker volumes as container persistent data storage :octicons-link-external-16:](https://docs.docker.com/storage/volumes/)

Expand Down
2 changes: 1 addition & 1 deletion docs/encrypt-backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ xtrabackup --backup --encrypt=AES256 --encrypt-key="{randomly-generated-alphanum
### encrypt-key-file option

The recommended method uses the command line: `echo -n “{randomly-generated-alphanumeric-string}” > /data/backups/keyfile` to create the file.
Remember that using the-- encrypt-key-file option, your text editor can automatically insert a CRLF (end of line) character in the `KEYFILE`. This inserted character invalidates the key because the size is wrong.
Remember that when you use the `--encrypt-key-file` option, your text editor can automatically insert a CRLF (end of line) character in the `KEYFILE`. This inserted character invalidates the key because the size is wrong.

An example of using the `--encrypt-key-file` option:

Expand Down
8 changes: 3 additions & 5 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,11 @@ created in versions prior to {{vers}} of MySQL, Percona Server for MySQL or
Percona XtraDB Cluster.


## Are you aware of any web-based backup management tools (commercial or not) built around Percona XtraBackup*?
## Are you aware of any web-based backup management tools (commercial or not) built around Percona XtraBackup?

[ZRM Community :octicons-link-external-16:](https://www.zmanda.com/zrm-community/) is a community tool that uses Percona XtraBackup for Non-Blocking Backups:
[Percona Monitoring and Management (PMM) :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/3/backup/index.html) includes backup management for MySQL. PMM uses Percona XtraBackup to create on-demand and scheduled physical backups and to restore them from the PMM web interface.

“ZRM 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).”\*
For the required XtraBackup version and setup, see [MySQL backup prerequisites :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/3/backup/mysql-backup/mysql_prerequisites.html).

## xtrabackup binary fails with a floating point exception

Expand Down
36 changes: 23 additions & 13 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A finalized version of the product which is made available to the general public

## .ibd

On a multiple tablespace setup ([innodb\_file\_per\_table] enabled), MySQL will store each newly created table on a file with a `.ibd` extension.
On a multiple tablespace setup ([`innodb_file_per_table`](#innodb_file_per_table) enabled), MySQL will store each newly created table on a file with a `.ibd` extension.

## .MRG

Expand Down Expand Up @@ -104,39 +104,49 @@ engine for MySQL {{vers}}.

The size in bytes of the memory buffer to cache data and indexes of InnoDB’s tables. This aims to reduce disk access to provide better performance.

> \[mysqld\]<br/>
> innodb\_buffer\_pool\_size=8MB
```ini
[mysqld]
innodb_buffer_pool_size=8MB
```

## innodb\_data\_home\_dir

The directory (relative to `datadir`) where the database server stores
the files in a shared tablespace setup. This option does not affect the location of `innodb\_file\_per\_table`. For example:

> \[mysqld\]<br/>
> innodb\_data\_home\_dir = ./
```ini
[mysqld]
innodb_data_home_dir = ./
```

## innodb\_data\_file\_path

Specifies the names, sizes and location of shared tablespace files:

> \[mysqld\]<br/>
> innodb\_data\_file\_path=ibdata1:50M;ibdata2:50M:autoextend
```ini
[mysqld]
innodb_data_file_path=ibdata1:50M;ibdata2:50M:autoextend
```

## innodb\_file\_per\_table

By default, InnoDB creates tables and indexes in a [file-per-tablespace :octicons-link-external-16:](https://dev.mysql.com/doc/refman/{{vers}}/en/innodb-file-per-table-tablespaces.html). If the `innodb_file_per_table` variable is disabled, you can enable the variable in your configuration file:

> \[mysqld\]<br/>
> innodb\_file\_per\_table <br/>
> or <br/>
> start the server with `--innodb_file_per_table`.
```ini
[mysqld]
innodb_file_per_table
```

Alternatively, start the server with `--innodb_file_per_table`.

## innodb\_log\_group\_home\_dir

Specifies the location of the InnoDB log files:

> \[mysqld\]<br/>
> innodb\_log\_group\_home=/var/lib/mysql
```ini
[mysqld]
innodb_log_group_home=/var/lib/mysql
```

## logical backup

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Percona XtraBackup is designed to make backups seamless without disrupting the p

## Percona XtraBackup features

Taking your backup with Percona XtraBackup is easy. Follow our documentation guides, and you’ll be set up in quickly.
Taking your backup with Percona XtraBackup is easy. Follow our documentation guides, and you’ll be set up quickly.

<div data-grid markdown><div data-banner markdown>

Expand Down
2 changes: 1 addition & 1 deletion docs/lru-dump-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ reducing the warm up time. It restores the buffer pool state from
`ib_buffer_pool` and backs it up automatically.


![image](_static/lru_dump.png)
![Diagram: page IDs from the InnoDB buffer pool LRU list, ordered from most to least recently used, are written to the ib_lru_dump file](_static/lru_dump.png)

If the buffer restore option is enabled in `my.cnf`, buffer pool will be in
the warm state after backup is restored.
Expand Down
16 changes: 8 additions & 8 deletions docs/page-tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ To start using the page tracking functionality, do the following:

1. Install the `mysqlbackup` component and enable it on the server:

```shell
```sql
INSTALL COMPONENT "file://component_mysqlbackup";
```

2. Check whether the `mysqlbackup` component is installed successfully:

```shell
```sql
SELECT COUNT(1) FROM mysql.component WHERE component_urn='file://component_mysqlbackup';
```

Expand Down Expand Up @@ -75,7 +75,7 @@ See also [`--page-tracking-merge-gap`](xtrabackup-option-reference.md#page-track
After the mysqlbackup component is loaded and active on the server, you can
start page tracking manually with the following option:

```shell
```sql
SELECT mysqlbackup_page_track_set(true);
```

Expand All @@ -84,15 +84,15 @@ SELECT mysqlbackup_page_track_set(true);
Check the LSN value starting from which changed pages are tracked with the
following option:

```shell
```sql
SELECT mysqlbackup_page_track_get_start_lsn();
```

## Stop page tracking

To stop page tracking, use the following command:

```shell
```sql
SELECT mysqlbackup_page_track_set(false);
```

Expand All @@ -107,7 +107,7 @@ grow until you stop the page tracking explicitly.
If you purge the page tracking data, you should create a full backup
afterward. To purge the page tracking data, do the following steps:

```shell
```sql
SELECT mysqlbackup_page_track_set(false);
SELECT mysqlbackup_page_track_purge_up_to(9223372036854775807);
/* Specify the LSN up to which you want to purge page tracking data. /
Expand All @@ -120,12 +120,12 @@ SELECT mysqlbackup_page_track_set(true);
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 :octicons-link-external-16:](https://jira.percona.com/browse/PS-8032).
see [PS-8032 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PS-8032).

## Uninstall the mysqlbackup component

To uninstall the mysqlbackup component, use the following statement:

```shell
```sql
UNINSTALL COMPONENT "file://component_mysqlbackup"
```
3 changes: 1 addition & 2 deletions docs/quickstart-exit.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,12 +109,11 @@ Remove the Docker images to free disk space. Skip this step to retain images for

## Step 4: Remove Docker volumes

Remove the volumes that stored database and backup data.

!!! warning "Permanent data loss"

Removing volumes permanently deletes all stored data. Verify the data is no longer needed before proceeding.

Remove the volumes that stored database and backup data.
{.power-number}

1. Remove the backup volume:
Expand Down
9 changes: 4 additions & 5 deletions docs/release-notes/8.4.0-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,20 @@ Use the Percona XtraBackup Innovation series, the latest version is 8.3.0-1, to

* The terms MASTER and SLAVE have been replaced with SOURCE and REPLICA to align with MySQL 8.4.0. Find the full list of removed (MASTER/SLAVE) terminology in the [MySQL Deprecation and Removal Notes](https://dev.mysql.com/doc/relnotes/mysql/8.4/en/news-8-4-0.html).

* Percona XtraBackup 8.4.0-1 removes support for the [Keyring file plugin]. Use the [Keyring file component] instead.
* Percona XtraBackup 8.4.0-1 removes support for the keyring file plugin. Use the [Keyring file component] instead.

* The `--stats` mode of operation for the xtrabackup binary has been removed.

## Additional resources

Install [Percona XtraBackup 8.4.0-1](..//installation.md)
Install [Percona XtraBackup 8.4.0-1](../installation.md)

The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup)

Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads)

[Percona XtraBackup 8.0 series]: https://docs.percona.com/percona-xtrabackup/8.0/
[Percona Server for MySQL 8.0.x]: https://docs.percona.com/percona-server/8.0/
[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md
[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md
[keyring_vault]: https://docs.percona.com/percona-server/8.4/use-keyring-vault-component.html
[Keyring file component]: https://docs.percona.com/percona-server/8.4/use-keyring-file.html?h=#use-the-keyring-file-component
[Keyring file plugin]: https://docs.percona.com/percona-server/8.4/use-keyring-file.html?h=#use-the-keyring-file-plugin
[Keyring file component]: https://docs.percona.com/percona-server/8.4/use-keyring-file.html
6 changes: 3 additions & 3 deletions docs/release-notes/8.4.0-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The `--lock-ddl=REDUCED` option features are as follows:

* The number of open file handles in your operating system should be configured to match the number of files in the server data directory.

* Taking a backup using [page tracking](..//page-tracking.md) is not supported with `--lock-ddl=REDUCED` option.
* Taking a backup using [page tracking](../page-tracking.md) is not supported with `--lock-ddl=REDUCED` option.

## Pro features

Expand All @@ -83,10 +83,10 @@ for reporting this issue.)

## Additional resources

Install [Percona XtraBackup 8.4.0-2](..//installation.md)
Install [Percona XtraBackup 8.4.0-2](../installation.md)

The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup)

Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads)

[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md
[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md
4 changes: 2 additions & 2 deletions docs/release-notes/8.4.0-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t

## Additional resources

Install [Percona XtraBackup 8.4.0-3](..//installation.md)
Install [Percona XtraBackup 8.4.0-3](../installation.md)

The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup)

Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads)

[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md
[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md
4 changes: 2 additions & 2 deletions docs/release-notes/8.4.0-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t

## Additional resources

Install [Percona XtraBackup 8.4.0-4](..//installation.md)
Install [Percona XtraBackup 8.4.0-4](../installation.md)

The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup)

Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads)

[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md
[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md
4 changes: 2 additions & 2 deletions docs/release-notes/8.4.0-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t

## Additional resources

Install [Percona XtraBackup 8.4.0-5](..//installation.md)
Install [Percona XtraBackup 8.4.0-5](../installation.md)

The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup)

Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads)

[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md
[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md
4 changes: 2 additions & 2 deletions docs/release-notes/8.4.0-6.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t

## Additional resources

Install [Percona XtraBackup 8.4.0-6](..//installation.md)
Install [Percona XtraBackup 8.4.0-6](../installation.md)

The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup)

Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads/)

[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md
[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md
4 changes: 2 additions & 2 deletions docs/release-notes/8.4.0-7.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ We recommend that you download the Percona XtraBackup for the same platform as t

## Additional resources

Install [Percona XtraBackup 8.4.0-7](..//installation.md)
Install [Percona XtraBackup 8.4.0-7](../installation.md)

The [Percona XtraBackup GitHub repository](https://github.com/percona/percona-xtrabackup)

Download product binaries, packages, and tarballs at [Percona Product Downloads](https://www.percona.com/downloads/)

[Quickstart Guide for Percona XtraBackup]: ..//quickstart-overview.md
[Quickstart Guide for Percona XtraBackup]: ../quickstart-overview.md
Loading
Loading