Microsoft SQL Server

Frends.MicrosoftSQL.ExecuteQuery / 2.3.0

Summary

Runs SQL against SQL Server, returning rows or an affected count depending on the statement, with parameters passed separately from the text.

Typical use — the general-purpose SQL Server Task; parameterising rather than concatenating is also what keeps injection out of the query

Details

Frends version
5.5 and newer
Agent
Crossplatform
Target framework
net6.0

Input parameters.

Name Type Default Example Description
ConnectionStringSecret String Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword; Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;

Connection string.

Query String "SELECT * FROM MyTable", "INSERT INTO MyTable (id, first_name, last_name) VALUES (:id, :first_name, :last_name)",

Query to be executed in string format. Supports SELECT, INSERT, UPDATE and DELETE statements.

Parameters QueryParameter[] [ { Name = "id", Value = 1, DataType = SqlDataTypes.Auto }, { Name = "first_name", Value = "John", DataType = SqlDataTypes.NVarChar }, { Name = "last_name", Value = "Doe", DataType = SqlDataTypes.NVarChar } ]

Parameters for the database query.

ExecuteType ExecuteTypes ExecuteReader ExecuteType.ExecuteReader

Specifies how a command string is interpreted. Auto: ExecuteReader for SELECT-query and NonQuery for UPDATE, INSERT, or DELETE statements. ExecuteReader: Use this operation to execute any arbitrary SQL statements in SQL Server if you want the result set to be returned. NonQuery: Use this operation to execute any arbitrary SQL statements in SQL Server if you do not want any result set to be returned. You can use this operation to create database objects or change data in a database by executing UPDATE, INSERT, or DELETE statements. The return value of this operation is of Int32 data type, and For the UPDATE, INSERT, and DELETE statements, the return value is the number of rows affected by the SQL statement. For all other types of statements, the return value is -1. Scalar: Use this operation to execute any arbitrary SQL statements in SQL Server to return a single value. This operation returns the value only in the first column of the first row in the result set returned by the SQL statement.

Possible values:

  • Auto: ExecuteReader for SELECT-query and NonQuery for UPDATE, INSERT, or DELETE statements.

  • NonQuery: Executes a Transact-SQL statement against the connection and returns the number of rows affected.

  • Scalar: Executes the query, and returns the first column of the first row in the result set returned by the query. Additional columns or rows are ignored.

  • ExecuteReader: Executes the query, and returns an object that can iterate over the entire result set.

An unhandled error has occurred. Reload 🗙