MiningModel Class
Defines the details of an individual mining model. This class cannot be inherited.
Namespace: Microsoft.AnalysisServices
Assembly: Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)
The MiningModel type exposes the following members.
| Name | Description | |
|---|---|---|
|
MiningModel() | Initializes a new instance of the MiningModel class using the default values. |
|
MiningModel(String) | Initializes a new instance of the MiningModel class using a name. |
|
MiningModel(String, String) | Initializes a new instance of the MiningModel class using a name and an identifier. |
| Name | Description | |
|---|---|---|
|
Algorithm | Gets or sets the algorithm associated with the MiningModel, which can be supplied by Microsoft or can be your own custom algorithm. |
|
AlgorithmParameters | Gets the applicable set of algorithm parameters, independent of assigned algorithm. |
|
AllowDrillThrough | Gets or sets a value that indicates whether drillthrough is permitted on the mining model. |
|
Annotations | Gets the collection object of all annotations to current object. (Inherited from MajorObject.) |
|
CanRaiseEvents | (Inherited from Component.) |
|
Collation | Gets or sets the collation used by the MiningModel object. |
|
Columns | Gets the collection of columns associated with the MiningModel object. |
|
Container | (Inherited from Component.) |
|
CreatedTimestamp | Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.) |
|
Description | Gets or sets a description string of current object. (Inherited from MajorObject.) |
|
DesignMode | (Inherited from Component.) |
|
Events | (Inherited from Component.) |
|
Filter | Gets or sets the filter expression associated with the mining model. |
|
FoldingParameters | Gets or sets the folding parameters associated with the mining model. |
|
FriendlyName | Returns a user-friendly name. (Inherited from NamedComponent.) |
|
ID | (Inherited from NamedComponent.) |
|
IsLoaded | Infrastructure. (Inherited from MajorObject.) |
|
KeyForCollection | Returns the key used in collections. (Inherited from NamedComponent.) |
|
Language | Gets or sets the language to use by default. |
|
LastProcessed | (Inherited from ProcessableMajorObject.) |
|
LastSchemaUpdate | Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.) |
|
MiningModelPermissions | Gets the collection of permissions for a MiningModel object. |
|
Name | (Inherited from NamedComponent.) |
|
OwningCollection | Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.) |
|
Parent | Gets the MiningStructure to which this mining model belongs. |
|
ParentDatabase | Gets the Database object that is the parent of the MiningModel object. |
|
ParentServer | Gets the Server object that is the parent of the MiningModel object. |
|
Site | Infrastructure. (Inherited from NamedComponent.) |
|
SiteID | Infrastructure. (Inherited from NamedComponent.) |
|
State | (Inherited from ProcessableMajorObject.) |
|
Translations | Gets the collection of Translation objects associated with the MiningModel object. |
| Name | Description | |
|---|---|---|
|
AddToContainer | Infrastructure. (Inherited from ModelComponent.) |
|
AfterInsert | Infrastructure. (Inherited from ModelComponent.) |
|
AfterMove | Infrastructure. (Inherited from ModelComponent.) |
|
AfterRemove | Infrastructure. (Inherited from ModelComponent.) |
|
BeforeRemove | Infrastructure. (Inherited from ModelComponent.) |
|
CanProcess | Indicates whether the mining model can be processed with the specified process type. (Overrides ProcessableMajorObject.CanProcess(ProcessType).) |
|
Clone() | Returns a clone of the object. |
|
Clone(Boolean) | Infrastructure. (Inherited from MajorObject.) |
|
CopyTo(MiningModel) | Copies the content of the object to another object (the destination). |
|
CopyTo(ModelComponent) | Infrastructure. (Inherited from ModelComponent.) |
|
CopyTo(NamedComponent) | Infrastructure. (Inherited from NamedComponent.) |
|
CopyTo(MajorObject, Boolean) | (Inherited from ProcessableMajorObject.) |
|
CreateObjRef | (Inherited from MarshalByRefObject.) |
|
Dispose() | (Inherited from Component.) |
|
Dispose(Boolean) | (Inherited from Component.) |
|
Drop() | Removes current object and updates server. (Inherited from MajorObject.) |
|
Drop(DropOptions) | Removes current object and updates server using specified options. (Inherited from MajorObject.) |
|
Drop(DropOptions, XmlaWarningCollection) | Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings object. (Inherited from MajorObject.) |
|
Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection) | Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.) |
|
Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean) | Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.) |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Component.) |
|
FindRelatedColumn | Finds the specified column from the mining structure that is associated with the model. |
|
GetCreateReferences | Infrastructure. (Inherited from MajorObject.) |
|
GetDependents | Infrastructure. (Inherited from MajorObject.) |
|
GetDropDependents | Infrastructure. (Inherited from MajorObject.) |
|
GetHashCode | (Inherited from Object.) |
|
GetLifetimeService | (Inherited from MarshalByRefObject.) |
|
GetReferences | Infrastructure. (Inherited from MajorObject.) |
|
GetService | (Inherited from Component.) |
|
GetType | (Inherited from Object.) |
|
GetUpdateOverwrites | Infrastructure. (Inherited from MajorObject.) |
|
InitializeLifetimeService | (Inherited from MarshalByRefObject.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) |
|
Process() | (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType) | (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, Binding) | (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration) | (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, WriteBackTableCreation) | (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) | (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) | (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) | (Inherited from ProcessableMajorObject.) |
|
Refresh() | Updates current object from server definitions. (Inherited from MajorObject.) |
|
Refresh(Boolean) | Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.) |
|
Refresh(Boolean, RefreshType) | Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.) |
|
RemoveFromContainer | Infrastructure. (Inherited from ModelComponent.) |
|
Reset | Infrastructure. (Inherited from NamedComponent.) |
|
Submit() | Infrastructure. (Inherited from ModelComponent.) |
|
Submit(Boolean) | Infrastructure. (Inherited from ModelComponent.) |
|
ToString | (Inherited from NamedComponent.) |
|
Update() | Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.) |
|
Update(UpdateOptions) | Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.) |
|
Update(UpdateOptions, UpdateMode) | Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.) |
|
Update(UpdateOptions, UpdateMode, XmlaWarningCollection) | Updates server definition of current object to actual values using the specified options to update dependent objects and reports any warnings from operation. (Inherited from MajorObject.) |
|
Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection) | Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. (Inherited from MajorObject.) |
|
Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean) | Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. If analyzeImpactOnly is true, an impact analysis operation is performed with no update operation. (Inherited from MajorObject.) |
|
Validate(ValidationErrorCollection) | Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.) |
|
Validate(ValidationResultCollection) | (Inherited from MajorObject.) |
|
Validate(ValidationErrorCollection, Boolean) | Validates the element to which it is appended; returns any errors encountered in a collection. Also contains a parameter to enable return of detailed errors. (Inherited from ModelComponent.) |
|
Validate(ValidationResultCollection, ValidationOptions) | (Inherited from MajorObject.) |
|
Validate(ValidationErrorCollection, Boolean, ServerEdition) | Determines whether the mining model is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).) |
|
Validate(ValidationResultCollection, ValidationOptions, ServerEdition) | (Inherited from MajorObject.) |
| Name | Description | |
|---|---|---|
|
ICloneable.Clone | Returns a clone of the object. |
|
IDeserializationCallback.OnDeserialization | (Inherited from MajorObject.) |
|
IFormattable.ToString | (Inherited from NamedComponent.) |
|
IDeserializationStartCallback.OnDeserializationBegin | (Inherited from MajorObject.) |
|
IHostableComponent.Host | (Inherited from ModelComponent.) |
|
IMajorObject.BaseType | Gets the base type implementation of the mining model. |
|
IMajorObject.CreateBody | Creates a new body for the mining model. |
|
IMajorObject.DependsOn | Determines whether the mining model depends on an object. |
|
IMajorObject.ObjectReference | Gets the object reference implementation of the mining model. |
|
IMajorObject.ParentDatabase | Gets the parent database implementation of the mining model. |
|
IMajorObject.ParentServer | Gets the parent server implementation of the mining model. |
|
IMajorObject.Path | Gets the path implementation of the mining model. |
|
IMajorObject.WriteRef | Writes a reference for the mining model. |
|
IModelComponent.FriendlyPath | (Inherited from ModelComponent.) |
|
IModelComponent.OwningCollection | (Inherited from ModelComponent.) |
|
IProcessable.LastProcessed | (Inherited from ProcessableMajorObject.) |
|
IProcessable.State | (Inherited from ProcessableMajorObject.) |
Many mining models can share the same structure, but changing the algorithm, or changing the columns whose values are to be predicted, does change the structure. The set of columns in the MiningModel must be a subset of the columns of the owning structure and share the same nested table structure. You can exclude columns either by omitting them or by setting the usage value to none.