---
parser: v2
author_name: Dan van Leeuwen
author_profile: https://github.com/danielva
auto_validation: true
time: 15
tags: [ tutorial>beginner, software-product>sap-hana-cloud, software-product-function>sap-hana-cloud--sap-hana-database, software-product>sap-hana, programming-tool>python]
primary_tag: software-product>sap-hana-cloud
slug: hana-clients-python
canonical_url: https://developers.sap.com/tutorials/hana-clients-python
---

# Connect Using the SAP HANA Python Interface

<!-- description --> Create and debug a Python application that connects to SAP HANA using the SAP HANA client.

## Prerequisites

- You have completed the first 3 tutorials in this mission.

## You will learn

- How to install Python and the SAP HANA client Python driver
- How to create and debug a Python application that queries a SAP HANA database

## Intro

In the 2023 Stack Overflow's annual developer survey, Python ranked 3rd in the [Most popular technologies](https://survey.stackoverflow.co/2023/#most-popular-technologies-language) section.  For further information on Python, see [Introduction to Python 3](https://realpython.com/python-introduction/) or [The Python Tutorial](https://docs.python.org/3/tutorial/).

The following steps create a simple Python app that can connect to and query an SAP HANA database.  

---

### Install Python

The first step is to check if Python is installed.

Enter the commands below.

```Shell
python --version
python3 --version
```

If Python is installed, the command will return a value such as Python 3.13.3. If you are using Python 3, replace pip with pip3 in all commands throughout this tutorial to ensure packages are installed for the correct Python version.

Details on supported versions of Python for the [SAP HANA client for Python](https://help.sap.com/docs/SAP_HANA_CLIENT/f1b440ded6144a54ada97ff95dac7adf/f3b8fabf34324302b123297cdbe710f0.html) can be found at SAP Note [3165810 - SAP HANA Client Supported Platforms](https://launchpad.support.sap.com/#/notes/3165810).

If Python is not installed, it can be downloaded from [Python downloads](https://www.python.org/downloads/).

On Microsoft Windows, check the box that says **Add Python 3.x to PATH** as shown below to ensure that the interpreter will be placed in your path.

![python-install](https://raw.githubusercontent.com/sap-tutorials/Tutorials/master/tutorials/hana-clients-python/install-python.png)

You should now be able to open a new shell and verify that Python is installed.

### Install SAP HANA client for Python using pip and PyPI

The standard package installer for Python is [pip](https://pypi.org/project/pip/).  The following commands will check the version of pip and attempt to upgrade it to the latest available version.

```Shell
pip --version
pip install --upgrade pip
or
pip3 --version
pip3 install --upgrade pip
```

>On Linux or Mac, if you encounter permission issues, one way to solve the issue is to use `sudo` before the command.
>
>On Linux, if Python is installed but pip is not, it can be installed on openSUSE using Zypper as shown below.

>```Shell (Linux)
>zypper install python3-pip
>```

The repository that contains Python packages is [PyPI](https://pypi.org/project/hdbcli/) and includes a package for the SAP HANA client for Python.

![hdbcli on PyPI](https://raw.githubusercontent.com/sap-tutorials/Tutorials/master/tutorials/hana-clients-python/PyPI.png)  

Run the following command to download and install the SAP HANA client for Python from `PyPI`:

```Shell
pip install hdbcli
```

>If an error is displayed that mentions "No matching distribution found for `hdbcli`, an alternate method is to install it from the SAP HANA client install folder as shown below. 
>
>Ensure that the filename is correct in the install command below because it might change depending on the version of `hdbcli` that you have.
>
> ```Shell
> cd C:\SAP\hdbclient
> pip install hdbcli-2.20.15.zip
> ```

> If the install still fails, check [3165810 - SAP HANA Client Supported Platforms](https://launchpad.support.sap.com/#/notes/3165810) to ensure that a supported version of Python installed.
>
> To upgrade to the latest available version, enter the following command:
> ```Shell
> pip install --no-cache-dir --upgrade hdbcli
> ```
>
> To uninstall `hdbcli`, run the following command:
> ```Shell
> pip uninstall hdbcli
> ```
>
> A specific version can be installed using the following command.
>
> ```Shell
> pip install hdbcli==2.18.22
> ```
>
> The list of installed packages can be shown with the following command.
>
> ```Shell
> pip list
> ```
>
> Details of an installed package such as `hdbcli` can be shown with the following command.
>
> ```Shell
> pip show hdbcli
> ```

### Create Python application that queries SAP HANA

1. In a shell, create a folder named `python`, enter the newly created directory, and open a file name `pythonQuery.py` in an editor.

   ```Shell (Microsoft Windows)
   mkdir %HOMEPATH%\HANAClientsTutorial\python
   cd %HOMEPATH%\HANAClientsTutorial\python
   notepad pythonQuery.py
   ```

    Substitute `pico` below for your preferred text editor.  

   ```Shell (Linux or Mac)
   mkdir -p $HOME/HANAClientsTutorial/python
   cd $HOME/HANAClientsTutorial/python
   pico pythonQuery.py
   ```

2. Add the code below to `pythonQuery.py`.

   ```Python
   #Import your dependencies
   import platform
   from hdbcli import dbapi

   #verify the architecture of Python
   print ("Platform architecture: " + platform.architecture()[0])

   try :
       #Initialize your connection
       conn = dbapi.connect(
           #Option 1, retrieve the connection parameters from the hdbuserstore
           key='USER1UserKey', # address, port, user and password are retrieved from the hdbuserstore

           #Option2, specify the connection parameters
           #address='6b7ae0da-ee5a-4782-bc7e-297099099b59.hana.prod-ca10.hanacloud.ondemand.com',
           #port='443',
           #user='User1',
           #password='Password1',

           #Additional parameters
           #encrypt=True, # must be set to True when connecting to HANA as a Service
           #As of SAP HANA Client 2.6, connections on port 443 enable encryption by default (HANA Cloud)
           #sslValidateCertificate=False #Must be set to false when connecting
           #to an SAP HANA on-premise instance that uses a self-signed certificate.
       )
   except dbapi.Error as er:
       print('Connect failed, exiting')
       print(er)
       exit()

   #If no errors, print connected
   print('connected')

   cursor = conn.cursor()
   sql_command = "SELECT TITLE, FIRSTNAME, NAME FROM HOTELS.CUSTOMER;"
   cursor.execute(sql_command)

   rows = cursor.fetchall()
   for row in rows:
       for col in row:
           print ("%s" % col, end=" ")
       print ("  ")
   cursor.close()
   print("\n")

   #Prepared statement example
   sql_command2 = "CALL HOTELS.SHOW_RESERVATIONS(?,?);"
   parameters = [11, "2020-12-24"]
   cursor.execute(sql_command2, parameters)
   rows = cursor.fetchall()
   for row in rows:
       for col in row:
           print ("%s" % col, end=" ")
       print (" ")
   cursor.close()
   conn.close()
   ```

    Note that the address, port, UID and PWD will be retrieved from the `hdbuserstore`.   

3. Run the app.

   ```Shell
   python pythonQuery.py
   ```

    >On some Linux distributions, python refers to a 2.x version of Python.  If so, replace `python` with `python3`.

    ![python Query](https://raw.githubusercontent.com/sap-tutorials/Tutorials/master/tutorials/hana-clients-python/python-app.png)

The code in `pythonQuery.py` uses [PEP 249 -- Python Database API Specification](https://www.python.org/dev/peps/pep-0249/), which defines a set of methods that provide a consistent database interface, independent of the actual database being used.   

- For further examples of accessing a database from Python, see [Python and SQL](https://www.python-course.eu/sql_python.php) and [Python MySQL](https://www.w3schools.com/python/python_mysql_insert.asp).  

- For information on the SAP HANA Python client, see [Python Application Programming](https://help.sap.com/docs/SAP_HANA_CLIENT/f1b440ded6144a54ada97ff95dac7adf/f3b8fabf34324302b123297cdbe710f0.html).

- For further details on secure connections from Python to SAP HANA see [Secure connection from Python to SAP HANA](https://blogs.sap.com/2020/05/07/secure-connection-from-python-to-sap-hana/).

### Debug the application

Visual Studio Code provides plugins for Python and can be used to debug an application.  

1. If you have not already done so, download [Visual Studio Code](https://code.visualstudio.com/Download).

2. If you have not already done so, add the tutorial folder to the workspace by choosing **File | Add Folder to Workspace**, and then add the `HANAClientsTutorial` folder.

    ![Workspace](https://raw.githubusercontent.com/sap-tutorials/Tutorials/master/tutorials/hana-clients-python/workspace.png)

3. Open the file `pythonQuery.py`.

    ![Python Extension](https://raw.githubusercontent.com/sap-tutorials/Tutorials/master/tutorials/hana-clients-python/extension.png)

    If necessary, Visual Studio Code will recognize the `py` file extension and will suggest installing the Python extension.  Click **Install**.

4. Place a breakpoint on line the line `for row in rows:`.

5. Select **Run | Start Debugging | Python File Debug the currently active Python file**.

    Notice that the program stops running at the breakpoint that was set.

    Observe the variable values in the leftmost pane.  Step through code.

    ![VS Code Debugging](https://raw.githubusercontent.com/sap-tutorials/Tutorials/master/tutorials/hana-clients-python/debugging.png)  

### Knowledge check

Congratulations! You have now created and debugged a Python application that connects to and queries an SAP HANA database.  


---