Running a basic Python script in SQL Server big data cluster

About this sample
Before you begin
Run this sample
Sample details
Related links

About this sample

This is a sample Python app, which shows how to run a Python script in SQL Server big data cluster. This sample creates an app that adds two whole numbers and returns the result. The code for this sample is in add.py. The inputs and outputs are shown below.

Inputs

Parameter	Description
`x`	The first whole number to add
`y`	The second whole number to add

Outputs

Parameter	Description
`result`	The result of adding `x` and `y`

Before you begin

To run this sample, you need the following prerequisites.

Software prerequisites:

SQL Server big data cluster CTP 2.3 or later.
mssqlctl. Refer to installing mssqlctl document on setting up the mssqlctl and connecting to a SQL Server 2019 big data cluster.

Run this sample

Clone or download this sample on your computer.
Log in to the SQL Server big data cluster using the command below using the IP address of the endpoint-service-proxy in your cluster. If you are not familiar with mssqltctl you can refer to the documentation and then return to this sample.
```
mssqlctl login -e https://<ip-address-of-endpoint-service-proxy>:30777 -u <user-name> -p <password>
```
Deploy the application by running the following command, specifying the folder where your spec.yaml and add.py files are located:
```
mssqlctl app create --spec ./addpy
```
Check the deployment by running the following command:
```
mssqlctl app list -n addpy -v [version]
```
Once the app is listed as Ready you can continue to the next step.

Test the app by running the following command:

mssqlctl app run -n addpy -v [version] --input x=3,y=5

You should get output like the example below. The result of adding 3+5 are returned as result.

{
  "changedFiles": [],
  "consoleOutput": "",
  "errorMessage": "",
  "outputFiles": {},
  "outputParameters": {
    "result": 8
  },
  "success": true
}

You can clean up the sample by running the following commands:

# delete app
mssqlctl app delete --name addpy --version [version]

Sample details

Please refer to add.py for the code for this sample.

Spec file

Here is the spec file for this application. As you can see the sample uses the Python runtime and calls the add method in the add.py file, accepting two integer inputs named x and y and returning an integer output named result.

name: addpy
version: v1
runtime: Python
src: ./add.py
entrypoint: add
replicas: 1
poolsize: 1
inputs:
  x: int
  y: int
output:
  result: int

For more information, see these articles:

How to deploy and app on SQL Server 2019 big data cluster (preview)

3.6 KiB Raw Blame History