Description

With the sqlcmd utility, you can enter Transact-SQL statements, system procedures, and script files at the command prompt. You can enter these statements in Query Editor in SQLCMD mode, in a Windows script file, or in an operating system (Cmd.exe) job step of an SQL Server Agent job. This utility uses OLE DB to execute Transact-SQL batches.

SQLCMD is a command-line application that comes with Microsoft SQL Server and exposes the management features of SQL Server.

The Microsoft SQL Server SQLCmd plug-in automates the execution of the Microsoft utility as a process step. The utility is included with the Microsoft SQL Server. It is a command-line application that provides access to the management features of the Microsoft SQL Server.

This plugin currently supports up to MSSQL 2012.

Quick Info

Product
HCL Launch
Type
plugin
Compatibility
HCL Launch version 7.0 or later
Created by
HCL Software
Version Name Action

9.1100934

launch-sqlcmd-9.1100934.zip

launch-sqlcmd-9.1100934.zip

9.1100934


Summary

The Microsoft SQL Server SQLCmd plugin automates the execution of the Microsoft utility as a process step.

The sqlcmd utility is included with the Microsoft SQL Server. It is a command-line application that provides access to the management features of the Microsoft SQL Server.

This plugin includes one or more steps, click Steps for step details and properties.

Compatibility

This plugin requires HCL Launch version 7.0 or later.

This plugin supports Microsoft SQL Server 2012, 2014, and 2016+.

This plugin runs on the Windows operating systems that HCL Launch supports.

Installation

See Installing plugins in HCL Launch for installing and removing plugins.

History

The following table describes the changes made in each plugin version.

Plugin history details
Version Description
9 Minor enhancements

Usage

With the Run SQLCmd scripts step, you can run a set of SQL statements as a script. Scripts are stored as an SQL file and are used to manage databases or to create the database schema during database deployment.

Note: The SQL-JDBC plugin can be used to deploy to Microsoft SQL from a Linux agent.

Step palette

To access this plugin in the palette, click Database > SQLCmd.

Steps

The following process steps are available in the Microsoft SQL Server SQLCmd plugin.

Run SQLCmd scripts

Run SQLCmd scripts in sorted order

Input properties for the Run SQLCmd scripts step
Name Type Description Required
Additonal Arguments String Specify additional command line arguments in the format: FLAG [VALUE]. Each Flag, and poential Value, should be separated with a space. Example: -v MyVar1=something or -N. Separate each argument pair with a new line or semicolon. No
DB Name String The name of the DB to use. No
Directory Offset String The directory offset relative to the current working directory where the step should run. No
Exclude Files String A new line separated list of file filters to determine the files to be excluded from the above selection. Use in conjunction with includes. If using list it is ignored. No
Login Timeout String Specifies the number of seconds before a sqlcmd login to the OLE DB provider times out when you try to connect to a server.Defaults to 8 sec if not specified. No
Password Password The password of the user for the scripts to be run as. No
Password Script String Use this instead of the Password field if the password is stored in a property. No
SQL File Includes String A new line separated list of file filters to determine the sql scripts to be executed. Use this when order between files is unimportant. No
SQL Files String A new line separated list of files to be executed. Use this when order between files is important. No
SQLCmd Executable Path String The full path to the sqlcmd executable if it is not in the current working directory, and if it is not specified in the PATH environment variable. No
Server\Instance String The server\instance to connect to. No
Use Dedicated Admin Connection Boolean Select here to use a dedicated admin connection. No
Use Trusted Connection Boolean Select here to use a trusted connection instead of user/password. No
User name String The user name for the scripts to be run as. No