IDacCompatibilityService.RunAction Method
Runs the specified Action.
Namespace: Microsoft.SqlServer.Dac.Compatibility
Assembly: Microsoft.SqlServer.Dac.Compatibility (in Microsoft.SqlServer.Dac.Compatibility.dll)
Syntax
'Declaration
Function RunAction ( _
actionName As String, _
parameters As IDictionary, _
properties As IDictionary, _
sqlCmdVariables As IDictionary _
) As Boolean
'Usage
Dim instance As IDacCompatibilityService
Dim actionName As String
Dim parameters As IDictionary
Dim properties As IDictionary
Dim sqlCmdVariables As IDictionary
Dim returnValue As Boolean
returnValue = instance.RunAction(actionName, _
parameters, properties, sqlCmdVariables)
bool RunAction(
string actionName,
IDictionary parameters,
IDictionary properties,
IDictionary sqlCmdVariables
)
bool RunAction(
String^ actionName,
IDictionary^ parameters,
IDictionary^ properties,
IDictionary^ sqlCmdVariables
)
abstract RunAction :
actionName:string *
parameters:IDictionary *
properties:IDictionary *
sqlCmdVariables:IDictionary -> bool
function RunAction(
actionName : String,
parameters : IDictionary,
properties : IDictionary,
sqlCmdVariables : IDictionary
) : boolean
Parameters
- actionName
Type: String
The name of the action to perform. Known actions at the time this API is created are Extract, Publish, Export, Import, Script, DeployReport, DriftReport.
- parameters
Type: IDictionary
The parameters defining core inputs required for the action to run. These are defined as a Dictionary of key-value pairs, each expected to be string keys and string values. Some parameters will be required for the action to succeed, while others are optional. Each parameter can have only one value assigned to it.
- properties
Type: IDictionary
The properties passed to the action. Properties are generally optional and can be used to override default properties and behaviors. These are defined as a Dictionary of key-value pairs. All keys must be strings. All values must be either strings or a string array - some properties can have multiple values.
- sqlCmdVariables
Type: IDictionary
The set of SQLCMD variables to pass to the method. This is an optional input as some operations do not support these variables, and for others they will only be required if the variables are included in the model. These are defined as a Dictionary of key-value pairs. All keys must be strings. All values must be strings - each variable can have only one value assigned to it.
Return Value
Type: Boolean
True if the action succeeded, false otherwise
Exceptions
| Exception | Condition |
|---|---|
| FileNotFoundException | If no valid SqlPackage.exe executable could be found installed on disk this exception is thrown. The service will only find SqlPackage.exe files that have been registered via MSI installer, with a registry key added in a known location that indicates where to look. |
| ArgumentException | If actionName is null or whitespace, or invalid values are specified for the contents of the IDictionary parameters |