Install mssqlctl to manage SQL Server 2019 big data clusters

This article describes how to install the mssqlctl tool on Windows or Linux.

mssqlctl is a command-line utility written in Python that enables cluster administrators to bootstrap and manage the big data cluster via REST APIs. The minimum Python version required is v3.5. You must also have pip that is used to download and install mssqlctl tool. The instructions below provide examples for Windows and Ubuntu. For installing Python on other platforms, see the Python documentation.

Important

If you are installing a newer version of big data clusters, you must backup your data and delete the old cluster before upgrading mssqlctl and installing the new release. For more information, see Upgrading to a new release.

Windows mssqlctl installation

  1. On a Windows client, download the necessary Python package from https://www.python.org/downloads/. For python3.5.3 and later, pip3 is also installed when you install Python.

    Tip

    When installing Python3, select to add Python to your PATH. If you do not, you can later find where pip3 is located and manually add it to your PATH.

  2. Open a new Windows PowerShell session so that it gets the latest path with Python in it.

  3. If you have any previous releases of mssqlctl installed, it is important to uninstall mssqlctl first before installing the latest version.

    If you are unisntalling mssqlctl corresponding to CTP version 2.2 or lower run:

    pip3 uninstall mssqlctl
    

    For CTP2.3 or higher run:

    pip3 uninstall -r  https://private-repo.microsoft.com/python/ctp-2.3/mssqlctl/requirements.txt
    
  4. Install mssqlctl with the following command:

    pip3 install -r  https://private-repo.microsoft.com/python/ctp-2.3/mssqlctl/requirements.txt
    

Linux mssqlctl installation

On Linux, you must install Python 3.5 and then upgrade pip. The following example shows the commands that would work for Ubuntu. For other Linux platforms, see the Python documentation.

  1. Install the necessary Python packages:

    sudo apt-get update && /
    sudo apt-get install -y python3 && /
    sudo apt-get install -y python3-pip
    
  2. Upgrade pip3:

    sudo -H pip3 install --upgrade pip
    
  3. If you have any previous releases of mssqlctl installed, it is important to uninstall mssqlctl first before installing the latest version.

    If you are unisntalling mssqlctl corresponding to CTP version 2.2 or lower run:

    pip3 uninstall mssqlctl
    

    For CTP2.3 or higher run:

    pip3 uninstall -r  https://private-repo.microsoft.com/python/ctp-2.3/mssqlctl/requirements.txt
    
  4. Install mssqlctl with the following command:

    pip3 install -r  https://private-repo.microsoft.com/python/ctp-2.3/mssqlctl/requirements.txt --user
    

    Note

    The --user switch installs mssqlctl to the Python user install directory. This is typically ~/.local/bin on Linux. Either add this directory to your path or navigate to the user install directory and run ./mssqlctl from there.

Next steps

For more information about big data clusters, see What are SQL Server 2019 big data clusters?.