Parameters

typescript
Copied
1
// my_task.airplane.ts
2
export default airplane.task(
3
  {
4
    slug: "my_task"
5
    parameters: {
6
      user_email: {
7
        type: "shorttext",
8
        name: "User email",
9
        description: "The email address of the user",
10
      },
11
    },
12
  },
13
  async (params) => {
14
    console.log(`Email ${params.user_email}`);
15
  }
16
);

javascript
Copied
1
// my_task.airplane.js
2
export default airplane.task(
3
  {
4
    slug: "my_task"
5
    parameters: {
6
      user_email: {
7
        type: "shorttext",
8
        name: "User email",
9
        description: "The email address of the user",
10
      },
11
    },
12
  },
13
  async (params) => {
14
    console.log(`Email ${params.user_email}`);
15
  }
16
);

python
Copied
1
# my_task_airplane.py
2
import airplane
3

4
@airplane.task()
5
def my_task(user_email: str):
6
    """Deletes a user by email.
7

8
    Args:
9
      user_email: The email address of the user
10
    """
11
    print(f"Email {user_email}")

yaml
Copied
1
# my_task.task.yaml
2
parameters:
3
  - name: User email
4
    slug: user_email
5
    type: shorttext
6
    description: The email address of the user

• SQL tasks can pass in parameters using query args, e.g. SELECT name FROM users WHERE id = :id where id is a query arg tied to a parameter.
• Docker Image tasks can interpolate parameters into the Docker command, e.g. echo {{params.name}}.
• REST tasks can interpolate parameters into the URL, query parameters, headers, and more.
• Custom code tasks like JavaScript receive the parameters as a JSON object keyed by task slug, e.g. {"name": "some name"}.

• Be fewer than 50 characters long
• Use only lowercase letters, numbers, and underscores
• Start with a lowercase letter

json
Copied
1
{
2
  "__airplaneType": "upload",
3
  "id": "upl20220609zlqsu3b4a1g",
4
  "url": "https://storage.googleapis.com/airplane-external-f4aeab0/file-params/upl20220609zlqsu3b4a1g/atc.jpeg?<...credentials...>"
5
}

typescript
Copied
1
import { AirplaneFile } from "airplane";
2

3
export default async function (params) {
4
  const file = new AirplaneFile(params.example_file);
5

6
  // Download the file and print to stdout:
7
  const body = await file.text();
8
  console.log(body);
9
}

javascript
Copied
1
import { AirplaneFile } from "airplane";
2

3
export default async function (params) {
4
  const file = new AirplaneFile(params.example_file);
5

6
  // Download the file and print to stdout:
7
  const body = await file.text();
8
  console.log(body);
9
}

python
Copied
1
import requests
2

3
import airplane
4

5
@airplane.task()
6
def my_task(example_file: airplane.File):
7
    # Extract the "url" field from the file parameter:
8
    file_url = example_file.url
9
    print(f"File URL: {file_url}")
10

11
    # Download the file and print to stdout:
12
    response = requests.get(file_url)
13
    print(response.text)

bash
Copied
1
# Given a file parameter with slug "example_file", you can extract the
2
# signed URL from a Shell task like so:
3
FILE_URL=$(echo $PARAM_EXAMPLE_FILE | jq -r .url)
4
echo "File URL: ${FILE_URL}"
5

6
# Use curl to download the file and print to stdout:
7
FILE=$(curl -s ${FILE_URL})
8
echo ${FILE}

json
Copied
1
{
2
  "name": "my_config_var",
3
  "value": "config_var_value"
4
}

javascript
Copied
1
export default async function (params) {
2
  console.log("config var name:", params.my_config_var.name);
3
  console.log("config var value:", params.my_config_var.value);
4
}

Example constraint settings for a parameter.