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
3 changes: 3 additions & 0 deletions _resource/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,10 @@

{% block content %}

{# Stop Cloudflare Email Obfuscation from rewriting addresses in code samples #}
<!--email_off-->
{{ super() }}
<!--email_on-->

<script>
window.addEventListener('beforeprint', (event) => {
Expand Down
3 changes: 3 additions & 0 deletions _resourcepdf/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,10 @@

{% block content %}

{# Stop Cloudflare Email Obfuscation from rewriting addresses in code samples #}
<!--email_off-->
{{ super() }}
<!--email_on-->

<script>
window.addEventListener('beforeprint', (event) => {
Expand Down
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/{{ps}}/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/{{ps}}/backup-locks.html)
Expand Down
2 changes: 1 addition & 1 deletion docs/apt-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ described in [Percona Release Lifecycle Overview :octicons-link-external-16:](ht
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
2 changes: 1 addition & 1 deletion docs/backup-size-reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Compressed backups additionally report:
Percona XtraBackup calculates `uncompressed_backup_size` separately from the final compressed backup size so that the reported value reflects the logical backup size before compression.

Percona XtraBackup stores the reported values in:
Expand commentComment on line R60Resolved

* `xtrabackup_info`

* XtraBackup error log
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 @@ -7,13 +7,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 @@ -73,7 +73,7 @@ Enable page tracking before creating the first backup to avoid this delay. This
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 @@ -82,15 +82,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 @@ -105,7 +105,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 @@ -118,12 +118,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"
```
2 changes: 1 addition & 1 deletion docs/quickstart-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This guide will help you get started quickly, but there's a lot more to learn ab
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.

* [Start Percona Server in a Docker container :octicons-link-external-16:](https://docs.percona.com/percona-server/{{ps}}/quickstart-docker.html)
* [Create a database and table in Percona Server :octicons-link-external-16:](https://docs.percona.com/percona-server/{{ps}}/quickstart-docker.html#create-a-database)
* [Create a database and table in Percona Server :octicons-link-external-16:](https://docs.percona.com/percona-server/{{ps}}/quickstart-database-script.html)

### Limitations

Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart-restore-back.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following steps describe how to restore your backup to another Percona Serve

You must provide at least one environment variable to access the database, such as `MYSQL_ROOT_PASSWORD`, `MYSQL_DATABASE`, `MYSQL_USER`, and `MYSQL_PASSWORD` or the instance refuses to initialize.

For this document, we are using the `9.7` 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 `latest` as the default tag and downloads the latest image from [percona/percona-server on the Docker Hub].
For this document, we are using the `9.7` 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 `latest` as the default tag and downloads the latest image from [percona/percona-server on Docker Hub :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-server).

To use a Docker volume for persistent storage with a database, specify the path where the database stores its data inside the container, usually `/var/lib/mysql`.

Expand Down Expand Up @@ -203,7 +203,7 @@ This section describes the backup validation steps assuming that you backed up `

6. Check that your table contains data

```sql
```sql
SELECT * FROM employees;
```

Expand Down
2 changes: 0 additions & 2 deletions docs/redo-log-archiving.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# InnoDB Redo Log Archiving

<!-- Varify the instruction for 9.7 version-->

A physical backup includes raw copies of database contents and related files, such as configuration files and logs. During crash recovery, InnoDB uses the redo log to correct data from incomplete transactions. The redo log contains entries that restore the database to a consistent state. An LSN value identifies the position of data in the redo log.

InnoDB continuously appends data to the redo log. When a file fills, InnoDB creates a new file. The checkpoint process truncates old data and removes obsolete files.
Expand Down
4 changes: 2 additions & 2 deletions docs/release-notes/9.7.1-rc1.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ Percona XtraBackup 9.7 adds support for Ubuntu 26.04.

## Additional resources

Install [Percona XtraBackup 9.7.1-rc1](..//installation.md)
Install [Percona XtraBackup 9.7.1-rc1](../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
8 changes: 4 additions & 4 deletions docs/set-up-replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,8 +293,8 @@ rsync -avprP -e ssh /path/to/backupdir NewReplica:/path/to/mysql/datadir
For example, to set up a new user, `user2`, you add another grant on
the Source:

```{.bash data-prompt=">"}
> GRANT REPLICATION REPLICA ON *.* TO 'user2'@'$newreplicaip'
```sql
GRANT REPLICATION REPLICA ON *.* TO 'user2'@'$newreplicaip'
IDENTIFIED BY '$replicapass';
```

Expand Down Expand Up @@ -329,8 +329,8 @@ CHANGE REPLICATION SOURCE TO

Start the replica:

```{.bash data-prompt=">"}
> START REPLICA;
```sql
START REPLICA;
```

If both IO and SQL threads are running when you check the `NewReplica`,
Expand Down
8 changes: 4 additions & 4 deletions docs/smart-memory-estimation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ To run `prepare`, Percona XtraBackup checks the server's available free memory a

You can enable or disable the memory estimation during the `backup` phase with the [`--estimate-memory`](xtrabackup-option-reference.md#estimate-memory) option. The default value is `OFF`. Enable the memory estimation with `--estimate-memory=ON`:

```{.bash data-prompt="$"}
$ xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/
```shell
xtrabackup --backup --estimate-memory=ON --target-dir=/data/backups/
```

In the `prepare` phase, enable the [`--use-free-memory-pct`](xtrabackup-option-reference.md#use-free-memory-pct) option by specifying the percentage of free memory to be used to `prepare` a backup. The `--use-free-memory-pct` value must be larger than 0.

For example:

```{.bash data-prompt="$"}
$ xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/
```shell
xtrabackup --prepare --use-free-memory-pct=50 --target-dir=/data/backups/
```

## Example of Smart memory estimation usage
Expand Down
4 changes: 2 additions & 2 deletions docs/toolkit-version-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Although the *version checking* feature does not collect any personal informatio
you might prefer to disable this feature, either one time or permanently. To
disable it one time, use `--no-version-check` option when invoking the tool
from a Percona product which supports it. Here is a simple example which shows
running [pt-diskstats :octicons-link-external-16:](https://www.percona.com/doc/percona-toolkit/LATEST/pt-diskstats.html) tool
running [pt-diskstats :octicons-link-external-16:](https://docs.percona.com/percona-toolkit/pt-diskstats.html) tool
from the *Percona Toolkit* with *version checking* turned off:

```text
Expand All @@ -83,7 +83,7 @@ pt-diskstats --no-version-check
Disabling *version checking* permanently can be done by placing
`no-version-check` 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 :octicons-link-external-16:](https://www.percona.com/doc/percona-toolkit/LATEST/configuration_files.html)
in case of *Percona Toolkit* [this can be done :octicons-link-external-16:](https://docs.percona.com/percona-toolkit/configuration_files.html)
in a global configuration file `/etc/percona-toolkit/percona-toolkit.conf`:

```shell
Expand Down
Loading
Loading