2.11.3 Installing MySQL Using a Development Source Tree

This section discusses how to install MySQL from the latest development source code.

To obtain the source tree, you must have Bazaar installed. The Bazaar VCS Web site has instructions for downloading and installing Bazaar on different platforms. Bazaar is supported on any platform that supports Python, and is therefore compatible with any Linux, Unix, Windows, or OS X host.

MySQL development projects are hosted on Launchpad. MySQL projects, including MySQL Server, MySQL Workbench, and others are available from the Oracle/MySQL Engineering page. For the repositories related only to MySQL Server, see the MySQL Server page.

To build under Unix/Linux, you must have the following tools installed:

To build under Windows you must have Microsoft Visual C++ 2005 Express Edition, Visual Studio .Net 2003 (7.1), or Visual Studio 2005 (8.0) compiler system.

Once the necessary tools are installed, create a local branch of the MySQL development tree on your machine using this procedure:

  1. To obtain a copy of the MySQL source code, you must create a new Bazaar branch. If you do not already have a Bazaar repository directory set up, you must initialize a new directory:

    shell> mkdir mysql-server
    shell> bzr init-repo --trees mysql-server

    This is a one-time operation.

  2. Assuming that you have an initialized repository directory, you can branch from the public MySQL server repositories to create a local source tree. To create a branch of a specific version:

    shell> cd mysql-server
    shell> bzr branch lp:mysql-server/5.1 mysql-5.1

    This is a one-time operation per source tree. You can branch the source trees for several versions of MySQL under the mysql-server directory.

  3. The initial download will take some time to complete, depending on the speed of your connection. Please be patient. Once you have downloaded the first tree, additional trees should take significantly less time to download.

  4. When building from the Bazaar branch, you may want to create a copy of your active branch so that you can make configuration and other changes without affecting the original branch contents. You can achieve this by branching from the original branch:

    shell> bzr branch mysql-5.1 mysql-5.1-build
  5. To obtain changes made after you have set up the branch initially, update it using the pull option periodically. Use this command in the top-level directory of the local copy:

    shell> bzr pull

    To examine the changeset comments for the tree, use the log option to bzr:

    shell> bzr log

    You can also browse changesets, comments, and source code online at the Launchpad MySQL Server page.

    If you see diffs (changes) or code that you have a question about, do not hesitate to send email to the MySQL internals mailing list. See Section 1.6.1, “MySQL Mailing Lists”. If you think you have a better idea on how to do something, send an email message to the list with a patch.

After you have the local branch, you can build MySQL server from the source code. On Windows, the build process is different from Unix/Linux: see Section 2.11.7, “Installing MySQL from Source on Windows”.

On Unix/Linux, use the autoconf system to create the configure script so that you can configure the build environment before building. The following example shows the typical commands required to build MySQL from a source tree.

  1. Change location to the top-level directory of the source tree; replace mysql-5.1 with the appropriate directory name.

    shell> cd mysql-5.1
  2. Prepare the source tree for configuration.

    Prior to MySQL 5.1.12, you must separately configure the InnoDB storage engine. Run the following command from the main source directory:

    shell> (cd storage/innobase; autoreconf --force --install)

    You can omit the previous command for MySQL 5.1.12 and later, or if you do not require InnoDB support.

    Prepare the remainder of the source tree:

    shell> autoreconf --force --install

    As an alternative to the preceding autoreconf command, you can use BUILD/autorun.sh, which acts as a shortcut for the following sequence of commands:

    shell> aclocal; autoheader
    shell> libtoolize --automake --force
    shell> automake --force --add-missing; autoconf

    If you get some strange errors during this stage, verify that you have the correct version of libtool installed.

  3. Configure the source tree and compile MySQL:

    shell> ./configure  # Add your favorite options here
    shell> make

    For a description of some configure options, see Section 2.11.4, “MySQL Source-Configuration Options”.

    A collection of configuration scripts is located in the BUILD/ subdirectory. For example, you may find it more convenient to use the BUILD/compile-pentium-debug script than the preceding set of shell commands. To compile on a different architecture, modify the script by removing flags that are Pentium-specific, or use another script that may be more appropriate. These scripts are provided on an as-is basis. They are not supported and their contents may change from release to release.

  4. When the build is done, run make install. Be careful with this on a production machine; the installation command may overwrite your live release installation. If you already have MySQL installed and do not want to overwrite it, run ./configure with values for the --prefix, --with-tcp-port, and --with-unix-socket-path options different from those used by your production server. For additional information about preventing multiple servers from interfering with each other, see Section 5.5, “Running Multiple MySQL Instances on One Machine”.

  5. Play hard with your new installation. For example, try to make new features crash. Start by running make test. See Section 22.1.2, “The MySQL Test Suite”.

  6. If you have gotten to the make stage, but the distribution does not compile, please enter the problem into our bugs database using the instructions given in Section 1.7, “How to Report Bugs or Problems”. If you have installed the latest versions of the required tools, and they crash trying to process our configuration files, please report that also. However, if you get a command not found error or a similar problem for required tools, do not report it. Instead, make sure that all the required tools are installed and that your PATH variable is set correctly so that your shell can find them.