Install azdata for SQL Server Big Data Clusters using pip

THIS TOPIC APPLIES TO:yesSQL Server noAzure SQL DatabasenoAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

This article describes how to install the azdata tool Windows or Linux using pip.

For Windows and Linux (Ubuntu distribution), you can install with a package manager for a simpler experience.

Prerequisites

azdata 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. pip is required to download and install azdata tool. The instructions below provide examples for Windows and Ubuntu. For installing Python on other platforms, see the Python documentation. In addition, install and update the latest version of requests Python package:

pip3 install -U requests

Important

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

Windows azdata 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 azdata installed, it is important to uninstall it first before installing the latest version.

    For CTP 3.2 or RC1, run the following command.

    pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-ctp3.2/requirements.txt
    

    or

    pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-rc1/requirements.txt
    
  4. Install azdata with the following command:

    pip3 install -r https://aka.ms/azdata
    

Linux azdata 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 && \
    sudo apt-get install -y libkrb5-dev && \
    sudo apt-get install -y libsqlite3-dev && \
    sudo apt-get install -y unixodbc-dev
    
  2. Upgrade pip3:

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

    For CTP 3.2 or RC1, run the following command.

    pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-ctp3.2/requirements.txt
    

    or

    pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-rc1/requirements.txt
    
  4. Install azdata with the following command:

    pip3 install -r https://aka.ms/azdata --user
    

    Note

    The --user switch installs azdata 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 ./azdata from there.

Install azdata on macOS or OS X

To install azdata on macOS or OS X complete these steps. For each step, run the example in Terminal.

  1. On a macOS client, install Homebrew if you don't have it already:

    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    
  2. Install Python and pip, minimum version 3.0:

    brew install python3
    
  3. Install dependencies:

    pip3 install -U requests
    brew install freetds
    
  4. If you have any previous releases of the tool installed, it is important to uninstall it first before installing the latest version of azdata. The following command removes the version of azdata.

    pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-rc1/requirements.txt
    
  5. Install azdata with the following command:

    pip3 install -r https://aka.ms/azdata
    

Next steps

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