Documentation Home
A Quick Guide to Using the MySQL APT Repository
Related Documentation
Yum Guide
SLES Guide
Download this Manual
PDF (US Ltr) - 58.9Kb
PDF (A4) - 59.9Kb

A Quick Guide to Using the MySQL APT Repository

Abstract

This is a quick guide to using the MySQL APT repository, which provides deb packages for installing and managing the MySQL server, client, and other components on the current Debian and Ubuntu releases.

For legal information, see the Legal Notices.

For help with using MySQL, please visit the MySQL Forums, where you can discuss your issues with other MySQL users.

Document generated on: 2024-12-19 (revision: 80567)

Table of Contents

Steps for a Fresh Installation of MySQL

Note

The following instructions assume that no versions of MySQL (whether distributed by Oracle or other parties) have already been installed on your system; if that is not the case, follow the instructions given in Replacing a Native Distribution of MySQL Using the MySQL APT Repository or Replacing a MySQL Server Installed by a Direct deb Package Download instead.

  1. Adding the MySQL APT Repository

    First, add the MySQL APT repository to your system's software repository list. Follow these steps:

    1. Go to the download page for the MySQL APT repository at https://dev.mysql.com/downloads/repo/apt/.

    2. Select and download the release package for your Linux distribution.

      Although this is not required for each update, it does update MySQL repository information to include the current information. For example, mysql-apt-config_0.8.26-1_all.deb is the first APT repository configuration file that adds the innovation release track that begins with MySQL 8.1.

    3. Install the downloaded release package with the following command, replacing version-specific-package-name with the name of the downloaded package (preceded by its path, if you are not running the command inside the folder where the package is): 

      $> sudo dpkg -i /PATH/version-specific-package-name.deb

      For example, for version w.x.y-z of the package, the command is: 

      $> sudo dpkg -i mysql-apt-config_w.x.y-z_all.deb

      Note that the same package works on all supported Debian and Ubuntu platforms.

    4. During the installation of the package, you will be asked to choose the versions of the MySQL server and other components (for example, the MySQL Workbench) that you want to install. If you are not sure which version to choose, do not change the default options selected for you. You can also choose none if you do not want a particular component to be installed. After making the choices for all components, choose Ok to finish the configuration and installation of the release package.

      Note

      The innovation track, which begins with MySQL 8.1, includes "-innovation-" in the component name.

      You can always change your choices for the versions later; see Selecting a Major Release Version for instructions.

    5. Update package information from the MySQL APT repository with the following command (this step is mandatory): 

      $> sudo apt-get update

    Instead of using the release package, you can also add and configure the MySQL APT repository manually; see Appendix A: Adding and Configuring the MySQL APT Repository Manually for details.

    Note

    Once the MySQL APT repository is enabled on your system, you will no longer be able to install any MySQL packages from your platform's native software repositories until the MySQL APT repository is disabled.

  2. Installing MySQL with APT

    Install MySQL by the following command: 

    $> sudo apt-get install mysql-server

    This installs the package for the MySQL server, as well as the packages for the client and for the database common files.

    During the installation, you are asked to supply a password for the root user for your MySQL installation.

    Important

    Make sure you remember the root password you set. Users who want to set a password later can leave the password field blank in the dialogue box and just press Ok; in that case, root access to the server will be authenticated by Socket Peer-Credential Pluggable Authentication for connections using a Unix socket file. You can set the root password later using the program mysql_secure_installation.

  3. Starting and Stopping the MySQL Server

    The MySQL server is started automatically after installation. You can check the status of the MySQL server with the following command: 

    $> systemctl status mysql

    If the operating system is systemd enabled, standard systemctl (or alternatively, service with the arguments reversed) commands such as stop, start, status, and restart should be used to manage the MySQL server service. The mysql service is enabled by default, and it starts at system reboot. See Managing MySQL Server with systemd for additional information.

Note

A few third-party native repository packages that have dependencies on the native MySQL packages may not work with the MySQL APT repository packages and should not be used together with them; these include akonadi-backend-mysql, handlersocket-mysql-5.5, and zoneminder.

Selecting a Major Release Version

By default, all installations and upgrades for your MySQL server and the other required components come from the release series of the major version you have selected during the installation of the configuration package (see Adding the MySQL APT Repository). However, you can switch to another supported major release series at any time by reconfiguring the configuration package you have installed. Use the following command: 

$> sudo dpkg-reconfigure mysql-apt-config

A dialogue box then asks you to choose the major release version you want. Make your selection and choose Ok. After returning to the command prompt, update package information from the MySQL APT repository with this command: 

$> sudo apt-get update

The latest version in the selected series will then be installed when you use the apt-get install command next time.

You can use the same method to change the version for any other MySQL component you want to install with the MySQL APT repository.

Installing Additional MySQL Products and Components

You can use APT to install individual components of MySQL from the MySQL APT repository. Assuming you already have the MySQL APT repository on your system's repository list (see Adding the MySQL APT Repository for instructions), first, use the following command to get the latest package information from the MySQL APT repository: 

$> sudo apt-get update

Install any packages of your choice with the following command, replacing package-name with name of the package: 

$> sudo apt-get install package-name

For example, to install the MySQL Workbench: 

$> sudo apt-get install mysql-workbench-community

To install the shared client libraries: 

$> sudo apt-get install libmysqlclient21

Installing MySQL from Source with the MySQL APT Repository

Note

This feature is only supported on 64-bit systems.

You can download the source code for MySQL and build it using the MySQL APT Repository:

  1. Add the MySQL APT repository to your system's repository list and choose the major release series you want (see Adding the MySQL APT Repository for instructions).

  2. Update package information from the MySQL APT repository with the following command (this step is mandatory): 

    $> sudo apt-get update

  3. Install packages that the build process depends on: 

    $> sudo apt-get build-dep mysql-server

  4. Download the source code for the major components of MySQL and then build them (run this command in the folder in which you want the downloaded files and the builds to be located): 

    $> apt-get source -b mysql-server

    deb packages for installing the various MySQL components are created.

  5. Pick the deb packages for the MySQL components you need and install them with the command: 

    $> sudo dpkg -i package-name.deb

    Notice that dependency relationships exist among the MySQL packages. For a basic installation of the MySQL server, install the database common files package, the client package, the client metapackage, the server package, and the server metapackage (in that order) with the following steps:

    • Preconfigure the MySQL server package with the following command: 

      $> sudo dpkg-preconfigure mysql-community-server_version-and-platform-specific-part.deb

      You will be asked to provide a password for the root user for your MySQL installation; see important information on root password given in Installing MySQL with APT above. You might also be asked other questions regarding the installation.

    • Install the required packages with a single command: 

      $> sudo dpkg -i mysql-{common,community-client,client,community-server,server}_*.deb

    • If you are being warned of unmet dependencies by dpkg, you can fix them using apt-get: 

      sudo apt-get -f install

    Here are where the files are installed on the system:

    • All configuration files (like my.cnf) are under /etc/mysql

    • All binaries, libraries, headers, etc., are under /usr/bin and /usr/sbin

    • The data directory is under /var/lib/mysql

See also information given in Starting and Stopping the MySQL Server.

Upgrading MySQL with the MySQL APT Repository

Notes

Use the MySQL APT repository to perform an in-place upgrade for your MySQL installation (that is, replacing the old version and then running the new version using the old data files) by following these steps:

  1. Make sure you already have the MySQL APT repository on your system's repository list (see Adding the MySQL APT Repository for instructions).

  2. Make sure you have the most up-to-date package information on the MySQL APT repository by running: 

    $> sudo apt-get update

  3. Note that, by default, the MySQL APT repository will update MySQL to the release series you have selected when you were adding the MySQL APT repository to your system. If you want to upgrade to another release series, select it by following the steps given in Selecting a Major Release Version.

    As a general rule, to upgrade from one release series to another, go to the next series rather than skipping a series. For example, if you are currently running MySQL 5.6 and wish to upgrade to a newer series, upgrade to MySQL 5.7 first before upgrading to 8.0.

    Important

  4. Upgrade MySQL by the following command: 

    $> sudo apt-get install mysql-server

    The MySQL server, client, and the database common files are upgraded if newer versions are available. To upgrade any other MySQL package, use the same apt-get install command and supply the name for the package you want to upgrade: 

    $> sudo apt-get install package-name

    To see the names of the packages you have installed from the MySQL APT repository, use the following command: 

    $> dpkg -l | grep mysql | grep ii

    Note

    If you perform a system-wide upgrade using apt-get upgrade, only the MySQL library and development packages are upgraded with newer versions (if available). To upgrade other components including the server, client, test suite, etc., use the apt-get install command.

  5. The MySQL server always restarts after an update by APT. Prior to MySQL 8.0.16, run mysql_upgrade after the server restarts to check and possibly resolve any incompatibilities between the old data and the upgraded software. mysql_upgrade also performs other functions; see mysql_upgrade — Check and Upgrade MySQL Tables for details. As of MySQL 8.0.16, this step is not required, as the server performs all tasks previously handled by mysql_upgrade.

Replacing a Native Distribution of MySQL Using the MySQL APT Repository

Variants and forks of MySQL are distributed by different parties through their own software repositories or download sites. You can replace a native distribution of MySQL installed from your Linux platform's software repository with a distribution from the MySQL APT repository in a few steps.

Note

The MySQL APT repository can only replace distributions of MySQL maintained and distributed by Debian or Ubuntu. It cannot replace any MySQL forks found either inside or outside of the distributions' native repositories. To replace such MySQL forks, you have to uninstall them first before you install MySQL using the MySQL APT repository. Follow the instructions for uninstallation from the forks' distributors and, before you proceed, make sure you back up your data and you know how to restore them to a new server.

Warning

A few third-party native repository packages that have dependencies on the native MySQL packages may not work with the MySQL APT repository packages and should not be used together with them; these include akonadi-backend-mysql, handlersocket-mysql-5.5, and zoneminder.

  1. Backing Up Your Database

    To avoid loss of data, always back up your database before trying to replace your MySQL installation using the MySQL APT repository. See Backup and Recovery for instructions.

  2. Adding the MySQL APT Repository and Selecting a Release Series

    Add the MySQL APT repository to your system's repository list and select the release series you want by following the instructions given in Adding the MySQL APT Repository.

  3. Replacing the Native Distribution by an APT Update

    By design, the MySQL APT repository replaces your native distribution of MySQL when you perform upgrades on the MySQL packages. To perform the upgrades, follow the same instructions given in Step 4 in Upgrading MySQL with the MySQL APT Repository.

Warning

Once the native distribution of MySQL has been replaced using the MySQL APT repository, purging the old MySQL packages from the native repository using the apt-get purge, apt-get remove --purge, or dpkg -P command might impact the newly installed MySQL server in various ways. Therefore, do not purge the old MySQL packages from the native repository packages.

Replacing a MySQL Server Installed by a Direct deb Package Download

deb packages from MySQL for installing the MySQL server and its components can either be downloaded from the MySQL Developer Zone's MySQL Download page or from the MySQL APT repository. The deb packages from the two sources are different, and they install and configure MySQL in different ways.

If you have installed MySQL with the MySQL Developer Zone's deb packages and now want to replace the installation using the ones from the MySQL APT repository, follow these steps:

  1. Back up your database. See Backup and Recovery for instructions.

  2. Follow the steps given previously for adding the MySQL APT repository.

  3. Remove the old installation of MySQL by running: 

    $> sudo dpkg -P mysql

  4. Install MySQL from the MySQL APT repository: 

    $> sudo apt-get install mysql-server

  5. If needed, restore the data on the new MySQL installation. See Backup and Recovery for instructions.

Removing MySQL with APT

To uninstall the MySQL server and the related components that have been installed using the MySQL APT repository, first, remove the MySQL server using the following command: 

$> sudo apt-get remove mysql-server

Then, remove any other software that was installed automatically with the MySQL server: 

$> sudo apt-get autoremove

To uninstall other components, use the following command, replacing package-name with the name of the package of the component you want to remove: 

$> sudo apt-get remove package-name

To see a list of packages you have installed from the MySQL APT repository, use the following command: 

$> dpkg -l | grep mysql | grep ii

Special Notes on Upgrading the Shared Client Libraries

You can install the shared client libraries from MySQL APT repository by the following command (see Installing Additional MySQL Products and Components with APT for more details): 

$> sudo apt-get install libmysqlclient21

If you already have the shared client libraries installed from you Linux platform's software repository, it can be updated by the MySQL APT repository with its own package by using the same command (see Replacing the Native Distribution by an APT Update for more details).

After updating MySQL using the APT repository, applications compiled with older versions of the shared client libraries should continue to work.

If you recompile applications and dynamically link them with the updated libraries: as typical with new versions of shared libraries, any applications compiled using the updated, newer shared libraries might require those updated libraries on systems where the applications are deployed. If those libraries are not in place, the applications requiring the shared libraries might fail. Therefore, it is recommended that the packages for the shared libraries from MySQL be deployed on those systems. You can do this by adding the MySQL APT repository to the systems (see Adding the MySQL APT Repository) and installing the latest shared client libraries using the command given at the beginning of this section.

Installing MySQL NDB Cluster Using the APT Repository

Notes

  • The MySQL APT repository supports installation of MySQL NDB Cluster on Debian and Ubuntu systems. For methods to install NDB Cluster on other Debian-based systems, see Installing NDB Cluster Using .deb Files.

  • If you already have the MySQL server or MySQL NDB Cluster installed on your system, make sure it is stopped and you have your data and configuration files backed up before proceeding.

  1. Adding the MySQL APT Repository for MySQL NDB Cluster

    Follow the steps in Adding the MySQL APT Repository to add the MySQL APT repository to your system's repository list. During the installation process of the configuration package, when you are asked which MySQL product you want to configure, choose “MySQL Server & Cluster”; when asked which version you wish to receive, choose “mysql-cluster-x.y.” After returning to the command prompt, go to Step 2 below.

    If you already have the configuration package installed on your system, make sure it is up-to-date by running the following command: 

    $> sudo apt-get install mysql-apt-config

    Then, use the same method described in Selecting a Major Release Version to select MySQL NDB Cluster for installation. When you are asked which MySQL product you want to configure, choose “MySQL Server & Cluster”; when asked which version you wish to receive, choose “mysql-cluster-x.y.” After returning to the command prompt, update package information from the MySQL APT repository with this command: 

    $> sudo apt-get update

  2. Installing MySQL NDB Cluster

    For a minimal installation of MySQL NDB Cluster, follow these steps:

    • Install the components for SQL nodes: 

      $> sudo apt-get install mysql-cluster-community-server

      You will be asked to provide a password for the root user for your SQL node; see important information on the root password given in Installing MySQL with APT above. You might also be asked other questions regarding the installation.

    • Install the executables for management nodes: 

      $> sudo apt-get install mysql-cluster-community-management-server

    • Install the executables for data nodes: 

      $> sudo apt-get install mysql-cluster-community-data-node

  3. Configuring and Starting MySQL NDB Cluster

    See Initial Configuration of NDB Cluster on how to configure MySQL NDB Cluster and Initial Startup of NDB Cluster on how to start it for the first time. When following those instructions, adjust them according to the following details regarding the SQL nodes of your NDB Cluster installation:

    • All configuration files (like my.cnf) are under /etc/mysql

    • All binaries, libraries, headers, etc., are under /usr/bin and /usr/sbin

    • The data directory is /var/lib/mysql

Installing Additional MySQL NDB Cluster Products and Components

You can use APT to install individual components and additional products of MySQL NDB Cluster from the MySQL APT repository. To do that, assuming you already have the MySQL APT repository on your system's repository list (see Adding the MySQL Yum Repository for MySQL NDB Cluster), follow the same steps given in Installing Additional MySQL Products and Components with APT.

Note

Known issue: Currently, not all components required for running the MySQL NDB Cluster test suite are installed automatically when you install the test suite package (mysql-cluster-community-test). Install the following packages with apt-get install before you run the test suite:

  • mysql-cluster-community-auto-installer

  • mysql-cluster-community-management-server

  • mysql-cluster-community-data-node

  • mysql-cluster-community-memcached

  • mysql-cluster-community-java

  • ndbclient-dev

Appendix A: Adding and Configuring the MySQL APT Repository Manually

Here are the steps for adding manually the MySQL APT repository to your system's software repository list and configuring it, without using the release packages provided by MySQL:

  • Download the MySQL GPG Public key (see Signature Checking Using GnuPG on how to do that) and save it to a file, without adding any spaces or special characters. Then, add the key to your system's GPG keyring with the following command: 

    $> sudo apt-key add path/to/signature-file

  • Alternatively, you can download the GPG key to your APT keyring directly using the apt-key utility: 

    $> sudo apt-key adv --keyserver pgp.mit.edu --recv-keys A8D3785C
    Note

    The KeyID for MySQL 8.0.36 and later release packages is A8D3785C, as shown above. For earlier MySQL releases, the keyID is 3A79BD29. Using an incorrect key can cause a key verification error.

  • Create a file named /etc/apt/sources.list.d/mysql.list, and put into it repository entries in the following format (this is not a command to execute): 

    deb http://repo.mysql.com/apt/{debian|ubuntu}/ {jammy} {mysql-8.0|mysql-tools|mysql-8.4-lts}

    Pick the relevant options for your repository set up:

    • Choose “debian” or “ubuntu” according to your platform.

    • Choose the appropriate version name for the version of your system; examples include “bullseye” (for Debian 11) and “jammy” (for Ubuntu 22.04).

    • For installing the MySQL server, client, and database common files, choose “mysql-8.0”, “mysql-8.4”, or “mysql-innovation” according to the desired MySQL series. To switch to another release series later, come back and adjust the entry with your new choice. This also includes access to tools such as MySQL Router and MySQL Shell.

      Note

      If you already have a version of MySQL installed on your system, do not choose a lower version at this step, or it might result in an unsupported downgrade operation.

    • Include “mysql-tools” to install a connector.

    For example, on the Ubuntu 22.04 platform use these lines in your mysql.list files to install MySQL 8.0 and the latest MySQL Connectors from the MySQL APT repository: 

    deb http://repo.mysql.com/apt/ubuntu/ jammy mysql-8.0 mysql-tools

  • Use the following command to get the most up-to-date package information from the MySQL APT repository: 

    $> sudo apt-get update

You have configured your system to use the MySQL APT repository and are now ready to continue with Installing MySQL with APT or Installing Additional MySQL Products and Components with APT.

Legal Notices

Copyright © 1997, 2024, Oracle and/or its affiliates.

License Restrictions

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software, software documentation, data (as defined in the Federal Acquisition Regulation), or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed, or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software," "commercial computer software documentation," or "limited rights data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed, or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government's use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Trademark Notice

Oracle, Java, MySQL, and NetSuite are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Use of This Documentation

This documentation is NOT distributed under a GPL license. Use of this documentation is subject to the following terms:

You may create a printed copy of this documentation solely for your own personal use. Conversion to other formats is allowed as long as the actual content is not altered or edited in any way. You shall not publish or distribute this documentation in any form or on any media, except if you distribute the documentation in a manner similar to how Oracle disseminates it (that is, electronically for download on a Web site with the software) or on a CD-ROM or similar medium, provided however that the documentation is disseminated together with the software on the same medium. Any other use, such as any dissemination of printed copies or use of this documentation, in whole or in part, in another publication, requires the prior written consent from an authorized representative of Oracle. Oracle and/or its affiliates reserve any and all rights to this documentation not expressly granted above.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support for Accessibility

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.


Related Documentation
Yum Guide
SLES Guide
Download this Manual
PDF (US Ltr) - 58.9Kb
PDF (A4) - 59.9Kb