MiningStructure Class

Defines the structure for one or more mining models. A structure includes columns, bindings, and optional holdout partition. This class cannot be inherited.

Namespace:  Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)

[GuidAttribute("EEF145A8-5946-492d-9422-032C1178B04F")]
public sealed class MiningStructure : ProcessableMajorObject, 
	IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
	ICloneable

The MiningStructure type exposes the following members.

  NameDescription
Public methodMiningStructure()Initializes a new instance of MiningStructure using the default values.
Public methodMiningStructure(String)Initializes a new instance of MiningStructure using a name.
Public methodMiningStructure(String, String)Initializes a new instance of MiningStructure using a name and an identifier.
Top

  NameDescription
Public propertyAnnotationsGets the collection object of all annotations to current object. (Inherited from MajorObject.)
Public propertyCacheModeGets or sets the caching mechanism used for training data retrieved while processing a mining structure.
Protected propertyCanRaiseEvents (Inherited from Component.)
Public propertyCaseTableNameGets or sets the name of the case table that is associated with the MiningStructure object.
Public propertyCollationGets or sets the collation used by MiningStructure.
Public propertyColumnsGets the collection of columns associated with a MiningStructure.
Public propertyContainer (Inherited from Component.)
Public propertyCreatedTimestampGets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public propertyDataSourceGets the DataSource object that is associated with a MiningStructure.
Public propertyDataSourceViewGets the DataSourceView object that is associated with a MiningStructure.
Public propertyDescriptionGets or sets a description string of current object. (Inherited from MajorObject.)
Protected propertyDesignMode (Inherited from Component.)
Public propertyErrorConfigurationGets or sets the settings for handling errors that can occur when the MiningStructure is processed.
Protected propertyEvents (Inherited from Component.)
Public propertyFilterComponentGets or sets an MDX expression that defines the slice of the source cube that is used for the mining structure.
Protected propertyFriendlyName (Inherited from NamedComponent.)
Public propertyHoldoutActualSizeReturns the size of the holdout partition that is associated with a MiningStructure. This value is read-only and is not available until the MiningStructure has been processed.
Public propertyHoldoutMaxCasesGets or sets the maximum number of cases in the partition of the MiningStructure that contains testing data.
Public propertyHoldoutMaxPercentGets or sets the percentage of cases in the source data of the MiningStructure that are used for testing.
Public propertyHoldoutSeedGets or sets the seed used to initialize partitioning of the MiningStructure into training and testing data sets[.]
Public propertyID (Inherited from NamedComponent.)
Public propertyIsLoadedInfrastructure. (Inherited from MajorObject.)
Protected propertyKeyForCollection (Inherited from NamedComponent.)
Public propertyLanguageGets or sets the language identifier of MiningStructure.
Public propertyLastProcessed (Inherited from ProcessableMajorObject.)
Public propertyLastSchemaUpdateGets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public propertyMiningModelsGets the collection of MiningModel objects associated with a MiningStructure.
Public propertyMiningStructurePermissionsGets or sets the collection of permissions on a MiningStructure object.
Public propertyName (Inherited from NamedComponent.)
Public propertyOwningCollectionGets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public propertyParentGets the Database object that is the parent of the MiningStructure.
Public propertyParentServerGets the Server object that is the parent of the MiningStructure.
Public propertySite (Inherited from NamedComponent.)
Public propertySiteID (Inherited from NamedComponent.)
Public propertySourceGets or sets the source of data to which MiningStructure is bound.
Public propertyState (Inherited from ProcessableMajorObject.)
Public propertyTranslationsGets the collection of Translation objects associated with a MiningStructure.
Top

  NameDescription
Protected methodAddToContainerInfrastructure. (Inherited from ModelComponent.)
Protected methodAfterInsertInfrastructure. (Inherited from ModelComponent.)
Protected methodAfterMoveInfrastructure. (Inherited from ModelComponent.)
Protected methodAfterRemoveInfrastructure. (Inherited from ModelComponent.)
Protected methodBeforeRemoveInfrastructure. (Inherited from ModelComponent.)
Public methodCanProcessReturns a Boolean value indicating whether the mining structure can be processed with the specified ProcessType parameter. (Overrides ProcessableMajorObject.CanProcess(ProcessType).)
Public methodClone()Creates a new full copy of the MiningStructure object.
Protected methodClone(Boolean)Infrastructure. (Inherited from MajorObject.)
Public methodCopyTo(MiningStructure)Copies a MiningStructure to the specified object.
Protected methodCopyTo(ModelComponent)Infrastructure. (Inherited from ModelComponent.)
Protected methodCopyTo(NamedComponent) (Inherited from NamedComponent.)
Protected methodCopyTo(MajorObject, Boolean) (Inherited from ProcessableMajorObject.)
Public methodCreateMiningModel()
Public methodCreateMiningModel(Boolean)Create a mining model with a default name and optionally adds the model to the collection of models for the current structure.
Public methodCreateMiningModel(Boolean, String)Creates a mining model with the specified name and optionally adds the model to the collection of models for the structure.
Public methodCreateObjRef (Inherited from MarshalByRefObject.)
Public methodDispose() (Inherited from Component.)
Protected methodDispose(Boolean) (Inherited from Component.)
Public methodDrop()Removes current object and updates server. (Inherited from MajorObject.)
Public methodDrop(DropOptions)Removes current object and updates server using specified options. (Inherited from MajorObject.)
Public methodDrop(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.)
Public methodDrop(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.)
Public methodDrop(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.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Component.)
Protected methodGetCreateReferencesInfrastructure. (Inherited from MajorObject.)
Public methodGetDependentsInfrastructure. (Inherited from MajorObject.)
Protected methodGetDropDependentsInfrastructure. (Inherited from MajorObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLifetimeService (Inherited from MarshalByRefObject.)
Public methodGetReferencesInfrastructure. (Inherited from MajorObject.)
Protected methodGetService (Inherited from Component.)
Public methodGetType (Inherited from Object.)
Public methodGetUpdateOverwritesInfrastructure. (Inherited from MajorObject.)
Public methodInitializeLifetimeService (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone() (Inherited from Object.)
Protected methodMemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public methodProcess() (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType) (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, Binding) (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration) (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, WriteBackTableCreation) (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection) (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) (Inherited from ProcessableMajorObject.)
Public methodRefresh()Updates current object from server definitions. (Inherited from MajorObject.)
Public methodRefresh(Boolean)Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Public methodRefresh(Boolean, RefreshType)Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Protected methodRemoveFromContainerInfrastructure. (Inherited from ModelComponent.)
Protected methodReset (Inherited from NamedComponent.)
Public methodSubmit()Infrastructure. (Inherited from ModelComponent.)
Public methodSubmit(Boolean)Infrastructure. (Inherited from ModelComponent.)
Public methodToString (Inherited from NamedComponent.)
Public methodUpdate()Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(UpdateOptions)Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(UpdateOptions, UpdateMode)Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(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.)
Public methodUpdate(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.)
Public methodUpdate(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.)
Public methodValidate(ValidationErrorCollection)Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public methodValidate(ValidationResultCollection) (Inherited from MajorObject.)
Public methodValidate(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.)
Public methodValidate(ValidationResultCollection, ValidationOptions) (Inherited from MajorObject.)
Public methodValidate(ValidationErrorCollection, Boolean, ServerEdition)Validates the current mining structure and returns a collection of validation errors. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public methodValidate(ValidationResultCollection, ValidationOptions, ServerEdition) (Inherited from MajorObject.)
Top

  NameDescription
Public eventDisposed (Inherited from Component.)
Top

Many mining models can be defined that use the same structure.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show: