# Install mariadb-dump

MariaDB Cloud customers can manually create a backup of a MariaDB Cloud service using the `mariadb-dump` utility:

* The `mariadb-dump` utility provides a command-line interface (CLI)
* The `mariadb-dump` utility is available for Linux and Windows
* The `mariadb-dump` utility supports [many command-line options](https://app.gitbook.com/s/SsmexDFPv2xG2OTyO5yV/clients-and-utilities/backup-restore-and-import-clients/mariadb-dump)
* Egress charges may apply for customer-initiated backups

For details about restoring a backup created with the `mariadb-dump` utility, see "[Restore a Manual Backup](https://app.gitbook.com/s/SsmexDFPv2xG2OTyO5yV/clients-and-utilities/backup-restore-and-import-clients/mariadb-dump#restoring-dumps)".

## Installation

Installation of MariaDB Dump varies by operating system.

#### **CentOS / RHEL**

1. Configure YUM package repositories:

   ```bash
   sudo yum install wget
   wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
   echo "935944a2ab2b2a48a47f68711b43ad2d698c97f1c3a7d074b34058060c2ad21b mariadb_repo_setup" \
       | sha256sum -c -
   chmod +x mariadb_repo_setup
   sudo ./mariadb_repo_setup --mariadb-server-version="mariadb-10.6"
   ```
2. Install MariaDB Dump and package dependencies:

   ```bash
   sudo yum install MariaDB-client
   ```

#### **Debian / Ubuntu**

1. Configure APT package repositories:

   ```bash
   sudo apt install wget
   wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
   $ echo "935944a2ab2b2a48a47f68711b43ad2d698c97f1c3a7d074b34058060c2ad21b mariadb_repo_setup" 
       | sha256sum -c -
   chmod +x mariadb_repo_setup
   sudo ./mariadb_repo_setup --mariadb-server-version="mariadb-10.6"$ sudo apt update
   ```
2. Install MariaDB Dump and package dependencies:

   ```bash
   sudo apt install mariadb-client
   ```

#### **SLES**

1. Configure ZYpp package repositories:

   ```bash
   sudo zypper install wget
   wget https://downloads.mariadb.com/MariaDB/mariadb_repo_setup
   echo "935944a2ab2b2a48a47f68711b43ad2d698c97f1c3a7d074b34058060c2ad21b mariadb_repo_setup" \
       | sha256sum -c -
   chmod +x mariadb_repo_setup
   sudo ./mariadb_repo_setup --mariadb-server-version="mariadb-10.6"
   ```
2. Install MariaDB Dump and package dependencies:

   ```bash
   sudo zypper install MariaDB-client
   ```

#### **Windows**

1. Access [MariaDB Downloads](https://mariadb.com/downloads/community/community-server/) for MariaDB Community Server.
2. In the "Version" dropdown, select the version you want to download.
3. In the "OS" dropdown, select "MS Windows (64-bit)".
4. Click the "Download" button to download the MSI package.
5. When the MSI package finishes downloading, run it.
6. On the first screen, click "Next" to start the Setup Wizard.
7. On the second screen, click the license agreement checkbox, and then click "Next".
8. On the third screen, select the components you want to install. If you only want the standard MariaDB Client tools:
   * Deselect "Database instance".
   * Deselect "Backup utilities".
   * Deselect "Development Components".
   * Deselect "Third party tools".
   * When only "Client programs" is selected, click "Next".
9. On the next screen, click "Install".
10. When the installation process completes, click "Finish".

## Create a Logical “Dump” SQL File

The procedure to create a backup depends on the operating system.

If you plan to restore the backup to a MariaDB Cloud service, the `mysql` database should be excluded from the backup by specifying [`--ignore-database=mysql`](https://app.gitbook.com/s/SsmexDFPv2xG2OTyO5yV/clients-and-utilities/backup-restore-and-import-clients/mariadb-dump#ignore-database-database), because MariaDB Cloud user accounts do not have sufficient privileges to restore that database.

#### **Linux**

1. Determine the [connection parameters](https://github.com/mariadb-corporation/mariadb-docs/blob/main/Connecting%20to%20Sky%20DBs/README.md) for your MariaDB Cloud service.
2. Use your connection parameters in the following command line:

```bash
mariadb-dump --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \
      --user DATABASE_USER --password \
      --ssl-verify-server-cert \
      --all-databases \
      --ignore-database=mysql \
      --single-transaction \
      --events \
      --routines \
      --default-character-set=utf8mb4 \
      > skysql_dump.sql
```

* Replace `FULLY_QUALIFIED_DOMAIN_NAME` with the Fully Qualified Domain Name of your service.
* Replace `TCP_PORT` with the read-write or read-only port of your service.
* Replace `DATABASE_USER` with the default username for your service, or the username you created.

After the command is executed, you will be prompted for a password. Enter the default password for your default user, the password you set for the default user, or the password for the database user you created.

#### **Windows**

1. Fix your executable search path.

   On Windows, MariaDB Dump is not typically found in the executable search path by default. You must find its installation path, and add that path to the executable search path:

   ```bash
   SET "PATH=C:\Program Files\MariaDB 10.6\bin;%PATH%"
   ```
2. Determine the [connection parameters](https://github.com/mariadb-corporation/mariadb-docs/blob/main/Connecting%20to%20Sky%20DBs/README.md) for your MariaDB Cloud service.
3. Use your connection parameters in the following command line:

```bash
mariadb-dump --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \
      --user DATABASE_USER --password \
      --ssl-verify-server-cert \
      --all-databases \
      --ignore-database=mysql \
      --single-transaction \
      --events \
      --routines \
      --default-character-set=utf8mb4 \
      > skysql_dump.sql
```

* Replace `FULLY_QUALIFIED_DOMAIN_NAME` with the Fully Qualified Domain Name of your service.
* Replace `TCP_PORT` with the read-write or read-only port of your service.
* Replace `DATABASE_USER` with the default username for your service, or the username you created.

After the command is executed, you will be prompted for a password. Enter the default password for your default user, the password you set for the default user, or the password for the database user you created.

#### **MariaDB Dump 10.3 and Older**

The instructions provided above are written for MariaDB Dump 10.4 and later, which uses the binary filename of `mariadb-dump`.

For MariaDB Dump 10.3 and older, the binary filename was `mysqldump`. The instructions can be adapted for MariaDB Dump 10.3 and older by executing `mysqldump` rather than `mariadb-dump`.

## Temporal Tables

For system-versioned tables and transaction-precise tables, MariaDB Dump only backs up current row versions. It does not back up historical row versions.