Manual SkySQL Backups using MariaDB Dump
This page is part of MariaDB's Documentation.
The parent of this page is: Backup/Restore
Topics on this page:
Overview
MariaDB SkySQL customers can manually create a backup of a SkySQL 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 WindowsThe
mariadb-dump
utility supports many command-line optionsEgress charges may apply for customer-initiated backups
For details about restoring a backup created with the mariadb-dump
utility, see "Restore a Manual Backup".
Compatibility
Enterprise Server Single Node
Enterprise Server With Replica(s)
Xpand Distributed SQL
Installation
Installation of MariaDB Dump varies by operating system.
CentOS / RHEL
Configure YUM package repositories:
$ sudo yum install curl $ curl -LsSO https://downloads.mariadb.com/MariaDB/mariadb_repo_setup $ echo "6083ef1974d11f49d42ae668fb9d513f7dc2c6276ffa47caed488c4b47268593 mariadb_repo_setup" \ | sha256sum -c - $ chmod +x mariadb_repo_setup $ sudo ./mariadb_repo_setup \ --mariadb-server-version="mariadb-10.6"
Install MariaDB Dump and package dependencies:
$ sudo yum install MariaDB-client
Debian / Ubuntu
Configure APT package repositories:
$ sudo apt install curl $ curl -LsSO https://downloads.mariadb.com/MariaDB/mariadb_repo_setup $ echo "6083ef1974d11f49d42ae668fb9d513f7dc2c6276ffa47caed488c4b47268593 mariadb_repo_setup" \ | sha256sum -c - $ chmod +x mariadb_repo_setup $ sudo ./mariadb_repo_setup \ --mariadb-server-version="mariadb-10.6" $ sudo apt update
Install MariaDB Dump and package dependencies:
$ sudo apt install mariadb-client
SLES
Configure ZYpp package repositories:
$ sudo zypper install curl $ curl -LsSO https://downloads.mariadb.com/MariaDB/mariadb_repo_setup $ echo "6083ef1974d11f49d42ae668fb9d513f7dc2c6276ffa47caed488c4b47268593 mariadb_repo_setup" \ | sha256sum -c - $ chmod +x mariadb_repo_setup $ sudo ./mariadb_repo_setup \ --mariadb-server-version="mariadb-10.6"
Install MariaDB Dump and package dependencies:
$ sudo zypper install MariaDB-client
Windows
Access MariaDB Downloads for MariaDB Community Server.
In the "Version" dropdown, select the version you want to download.
In the "OS" dropdown, select "MS Windows (64-bit)".
Click the "Download" button to download the MSI package.
When the MSI package finishes downloading, run it.
On the first screen, click "Next" to start the Setup Wizard.
On the second screen, click the license agreement checkbox, and then click "Next".
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".
On the next screen, click "Install".
When the installation process completes, click "Finish".
Create a Backup
The procedure to create a backup depends on the operating system.
If you plan to restore the backup to a SkySQL service, the mysql
database should be excluded from the backup by specifying --ignore-database=mysql
, because SkySQL user accounts do not have sufficient privileges to restore that database.
Linux
Determine the connection parameters for your MariaDB SkySQL service.
Use your connection parameters in the following command line:
$ mariadb-dump --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \ --user DATABASE_USER --password \ --ssl-verify-server-cert \ --ssl-ca ~/PATH_TO_PEM_FILE \ --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.Replace
~/PATH_TO_PEM_FILE
with the path to the certificate authority chain (.pem) file.
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
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:
$ SET "PATH=C:\Program Files\MariaDB 10.6\bin;%PATH%"
Determine the connection parameters for your MariaDB SkySQL service.
Use your connection parameters in the following command line:
$ mariadb-dump --host FULLY_QUALIFIED_DOMAIN_NAME --port TCP_PORT \ --user DATABASE_USER --password \ --ssl-verify-server-cert \ --ssl-ca ~/PATH_TO_PEM_FILE \ --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.Replace
PATH_TO_PEM_FILE
with the path to the certificate authority chain (.pem) file.
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.