MicrosoftSqlDescribe

Execute a Microsoft SQL SP_HELP Statement.

Added in version 1.0.0.

• Friendly name: MS-SQL Describe

• Step class: base_steps_syncpack.steps.MicrosoftSqlDescribe.MicrosoftSqlDescribe

• Step version: 1.1.0

• Required parameters: table, database, host, username, password, port

Parameters

Name	Type	Required	Default	Description
table	string	yes	–	The database Table Example: Users
database	string	yes	–	The database Example: database1
host	string	yes	–	The host of the database Example: host1
username	string	yes	–	The db username Example: ${db_user_name}
password	string	yes	–	The db password Example: ${db_password}
port	number	yes	1433	The port number to use when establishing a connection to the remote sql server.

Every step also accepts the platform parameters common to all steps – see Platform parameters.

Dependencies

• Inherits from: MicrosoftSqlDescribe -> BaseStep -> Serializable

• External packages: ipaascommon, ipaascore

Behaviour

Connects through the inherited BaseStep.connect_sql_server and runs sp_help {table}.

Outputs

A list of tuples from sp_help, or []. Not dicts — unlike MySqlDescribe, which returns dicts keyed by Field, Type and so on. The two describe steps are not interchangeable downstream.

Notes

• sp_help returns several result sets (columns, indexes, constraints), so the output is broader than a plain column list and its layout depends on the SQL Server version.

• port defaults to 1433, matching MicrosoftSqlSelect but not MicrosoftSqlInsert.