Skip to main content

Microsoft SQL Server Component

Query and manage data in a Microsoft SQL Server (MSSQL) Database

Component key: ms-sql-server

Description#

Microsoft SQL Server (MSSQL) is a popular relational database system. This component allows you to query an MSSQL database.

This component returns data as an object that can be used in subsequent steps. Instead of generating dynamic queries and sanitizing SQL yourself, you can use generic queries with named parameter placeholders like @variableKey. For example, you can enter a query that reads INSERT INTO users (name, email) VALUES (@name, @email). Then, you can enter values with keys of name and email, and whatever values you like. Values provided for name and email are sanitized automatically.

Authorization Methods#

Microsoft SQL Server requires one of the following authorization methods:

Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

The MS SQL Server username and password can be put directly into a basic auth credential, alongside the database host, port, and database name.

Actions#

Query#

Interact with a Microsoft SQL Server Database | key: query

InputKeyDefaultNotesExample

Database

string
/ Required
databasemsdb

Host

string
/ Required
host192.168.0.1

Parameters

data
paramsOptional parameters to insert into a query.

Port

string
/ Required
port14331433

Query

string
/ Required
queryFieldSELECT * FROM Customers WHERE customerId = @id