Airplane built-ins

To help customers get started, Airplane offers a set of common operations as built-in functionality that can be accessed from tasks via an Airplane SDK, from runbooks via blocks, and even wrapped as top-level tasks (e.g. SQL or REST). You can run a SQL query, send a REST request, send a Slack message, and more with a few lines of code!

Built-ins can be executed from tasks, using SDKs. For example, you can perform an SQL query from a task with the following code:

typescript
Copied
1
const run = await airplane.sql.query<{ id: string; name: string; email: string }>(
2
  // SQL resource slug
3
  "my_sql_db",
4
  // SQL query to execute
5
  "select * from users where name ilike :name",
6
  // Query arguments
7
  { args: { name: `%${name}%` } },
8
);

python
Copied
1
run = airplane.sql.query(
2
  # SQL resource slug
3
  sql_resource="my_sql_db",
4
  query="select * from users where name ilike :name",
5
  query_args={"name": f"%{params['name']}%"}
6
)

Most built-ins execute against a Resource. See Using resources in tasks for how to attach resources to tasks. for how to do so. For resources that operate against a team-level resource, e.g. Slack, you do not need to attach anything to your task.

When a built-in is executed, it will create a run (similar to tasks!) that appears in the run timeline.

To get started, check out our supported built-ins:

We are constantly expanding the catalog of built-ins. If the built-in catalog doesn't support an operation you need, you can always build it with a task!