Microsoft SQL Server
Connect to SQL Server from Airplane tasks and runbooks.
The Microsoft SQL Server resource allows tasks and runbooks to connect to a Microsoft SQL Server
database. For a high-level introduction to resources, see the resources page
To create a new Microsoft SQL Server resource, visit
for your team, click the "New" button,
and select the Microsoft SQL Server resource type. Enter your connection details in the form:
Name should be a human-readable name for your resource.
Host should be the IP address or DNS name of your database. Unless you're connecting to this
database behind a self-hosted agent (see Private Networking below), this should be the public IP
address and/or the public DNS name of the database.
If your database has restrictions on incoming network connections, you'll need to ensure the
Airplane IP addresses are whitelisted:
To connect to a database inside a private VPC, you can self-host the agent
and run the agent within your own VPC. Since tasks and SQL queries run on agents, these tasks will
run from within your network and be able to connect.
When this resource is attached to a task
, its fields
are available in the JSON environment variable
under the alias it was attached
with. The available fields are documented below.
The slug of the resource as defined in the resource settings page.
The name of the resource.
The kind of the resource.
The name of the database.
The encryption mode setting (
Optional SSH host for tunneling.
Optional SSH port for tunneling.
Optional SSH username for tunneling.
Optional SSH private key for tunneling.