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.

Microsoft SQL Server Connections#

MS SQL Server Connection#

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

InputDefaultNotesExample
Input
Database
string
/ Required
Default
 
Notes
Provide a string value for the name of the database.
Example
msdb
Input
Host
string
/ Required
Default
 
Notes
Provide a string value for the address that your database server is hosted on.
Example
192.168.0.1
Input
Password
string
Default
 
Notes
 
Example
 
Input
Port
string
/ Required
Default
1433
Notes
Provide a string value of the port your database server is exposing.
Example
 
Input
Username
string
Default
 
Notes
 
Example
 

Actions#

Query#

Interact with a Microsoft SQL Server Database | key: query

InputDefaultNotesExample
Input
Parameters
data
Key Value List
Default
 
Notes
Optional parameters to insert into a query.
Example
["Example item to be used in query"]
Input
Query
string
/ Required
Default
SELECT * FROM Customers WHERE customerId = @id
Notes
Provide a string containing a query that will be executed by the Microsoft SQL-Server database. You can pass in optional named parameters using the '@variable' operator.
Example
 
Input
Connection
connection
/ Required
Default
 
Notes
 
Example