ASExecuteDDLTask Class
Executes Data Definition Language (DDL) commands against an instance of Microsoft SQL Server Analysis Services.
Assembly: Microsoft.SqlServer.ASTasks (in Microsoft.SqlServer.ASTasks.dll)
Microsoft.SqlServer.Dts.Runtime::DtsObject
Microsoft.SqlServer.Dts.Runtime::Task
Microsoft.DataTransformationServices.Tasks.DTSProcessingTask::ASTaskBase
Microsoft.DataTransformationServices.Tasks.DTSProcessingTask::ASExecuteDDLTask
[GuidAttribute("B8A6644B-E7A4-4409-8B78-59572781BD15")] [DtsTaskAttribute(LocalizationType = (ASExecuteDDLTask^::typeid), UITypeName = "Microsoft.DataTransformationServices.Tasks.DTSProcessingTaskUI.ASExecuteDDLTaskUI, Microsoft.SqlServer.ASTasksUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91", IconResource = "ExecuteTaskIcon")] public ref class ASExecuteDDLTask : ASTaskBase, IDTSComponentPersist
| Name | Description | |
|---|---|---|
![]() | ASExecuteDDLTask() | Creates a new instance of the ASExecuteDDLTask class. |
| Name | Description | |
|---|---|---|
![]() | ConnectionName | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the connection for the analysis services task.(Inherited from ASTaskBase.) |
![]() | ExecutionValue | Gets the result of the Analysis Services Execute DDL task.(Overrides Task::ExecutionValue.) |
![]() | ProgressEventName | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the name of the progress event for the analysis services task.(Inherited from ASTaskBase.) |
![]() | Source | Gets or sets the name of the source that contains the DDL statement to be sent to the Analysis Services server. |
![]() | SourceType | Gets or sets a value from the DDLSourceType enumeration indicating the source type that contains the DDL statements. |
![]() | StatusEventName | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the status event name for the Analysis Services Execute DDL task.(Overrides ASTaskBase::StatusEventName.) |
![]() | SubComponentName | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the sub component name for the Analysis Services Execute DDL task.(Overrides ASTaskBase::SubComponentName.) |
![]() | TargetServerVersion | (Inherited from Task.) |
![]() ![]() | TaskDescription | Gets a description of the Analysis Services Execute DDL task. |
![]() ![]() | TaskDisplayName | Gets the unique name for the Analysis Services Execute DDL task. |
![]() | Version | *** Member deprecated; see Remarks. *** Returns the version of the task. This property is read-only.(Inherited from Task.) |
| Name | Description | |
|---|---|---|
![]() | CanUpdate(String^) | *** Member deprecated; see Remarks. *** A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.) |
![]() | Equals(Object^) | Determines whether two object instances are equal.(Inherited from DtsObject.) |
![]() | Execute(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^, Object^) | This API supports the product infrastructure and is not intended to be used directly from your code. Executes the analysis services task.(Inherited from ASTaskBase.) |
![]() | Finalize() | (Inherited from Object.) |
![]() | FireError(Int32, String^, String^, String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Raises an event when an error occurs.(Inherited from ASTaskBase.) |
![]() | FireError(String^, String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Raises an event when an error occurs.(Inherited from ASTaskBase.) |
![]() | GetConnectionID(Connections^, String^) | Gets a String containing the ID of the connection.(Inherited from Task.) |
![]() | GetConnectionName(Connections^, String^) | Gets a String containing the name of the connection.(Inherited from Task.) |
![]() | GetHashCode() | Returns the hash code for this instance.(Inherited from DtsObject.) |
![]() | GetType() | (Inherited from Object.) |
![]() | InitializeTask(Connections^, VariableDispenser^, IDTSInfoEvents^, IDTSLogging^, EventInfos^, LogEntryInfos^, ObjectReferenceTracker^) | Initializes the properties associated with the task. This method is called by the runtime and is not used in code.(Inherited from Task.) |
![]() | InternalExecute(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^, Object^) | This API supports the product infrastructure and is not intended to be used directly from your code. Executes the DDL task internally.(Overrides ASTaskBase::InternalExecute(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^, Object^).) |
![]() | InternalValidate(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^) | This API supports the product infrastructure and is not intended to be used directly from your code. Validates the DDL task internally.(Overrides ASTaskBase::InternalValidate(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^).) |
![]() | LoadFromXML(XmlElement^, IDTSInfoEvents^) | This method is not callable by your application code. To load a package saved as .xml, use the Application::LoadPackage method. |
![]() | MemberwiseClone() | (Inherited from Object.) |
![]() | SaveToXML(XmlDocument^, IDTSInfoEvents^) | This method is not callable by your application code. To save a package as .xml, use the Application::SaveToXml method. |
![]() | StopExecution() | This API supports the product infrastructure and is not intended to be used directly from your code. Stops the execution of the analysis service task.(Inherited from ASTaskBase.) |
![]() | SubscribeToProgressEvent(SessionTrace^) | This API supports the product infrastructure and is not intended to be used directly from your code. Subscribes the task to progress event.(Inherited from ASTaskBase.) |
![]() | ToString() | (Inherited from Object.) |
![]() | UnsubscribeToProgressEvent(SessionTrace^) | This API supports the product infrastructure and is not intended to be used directly from your code. Unsubscribes the task from the progress event.(Inherited from ASTaskBase.) |
![]() | Update(String^%) | |
![]() | Validate(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^) | This API supports the product infrastructure and is not intended to be used directly from your code. Validates the analysis service task.(Inherited from ASTaskBase.) |
![]() | ValidateConnection(Connections^) | This API supports the product infrastructure and is not intended to be used directly from your code. Validates the task connection.(Inherited from ASTaskBase.) |
![]() | ValidateDDL(VariableDispenser^, Connections^, Exception^%) | This API supports the product infrastructure and is not intended to be used directly from your code. Verifies that the DDL task is properly configured.(Overrides ASTaskBase::ValidateDDL(VariableDispenser^, Connections^, Exception^%).) |
![]() | WriteLog(IDTSLogging^, String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Writes a log for the task.(Inherited from ASTaskBase.) |
| Name | Description | |
|---|---|---|
![]() | bExecutionCanceled | This API supports the product infrastructure and is not intended to be used directly from your code. The execution is cancelled.(Inherited from ASTaskBase.) |
![]() | bTraceError | This API supports the product infrastructure and is not intended to be used directly from your code. The trace error.(Inherited from ASTaskBase.) |
![]() | ddl | This API supports the product infrastructure and is not intended to be used directly from your code. The data definition language.(Inherited from ASTaskBase.) |
![]() | m_events | This API supports the product infrastructure and is not intended to be used directly from your code. The events.(Inherited from ASTaskBase.) |
![]() | server | This API supports the product infrastructure and is not intended to be used directly from your code. The server.(Inherited from ASTaskBase.) |
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.





