Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

MiningStructure Class

 

Applies To: SQL Server 2016 Preview

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)


[DesignerAttribute("Microsoft.AnalysisServices.Design.MiningModelDesigner, Microsoft.AnalysisServices.Design", 
	typeof(IRootDesigner))]
[XmlRootAttribute(ElementName = "MiningStructure", Namespace = "http://schemas.microsoft.com/analysisservices/2003/engine")]
[DesignerSerializerAttribute("Microsoft.DataWarehouse.Serialization.DesignXmlSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91", 
	"Microsoft.DataWarehouse.Serialization.DesignerComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91")]
[GuidAttribute("EEF145A8-5946-492d-9422-032C1178B04F")]
[DesignerCategoryAttribute("Designer")]
[DesignerSerializerAttribute("Microsoft.DataWarehouse.Serialization.OnlineComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91", 
	"Microsoft.DataWarehouse.Serialization.OnlineComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91")]
public sealed class MiningStructure : ProcessableMajorObject, 
	IMajorObject, INamedComponent, IModelComponent, IComponent, 
	IDisposable, ICloneable

NameDescription
System_CAPS_pubmethodMiningStructure()

Initializes a new instance of MiningStructure using the default values.

System_CAPS_pubmethodMiningStructure(String)

Initializes a new instance of MiningStructure using a name.

System_CAPS_pubmethodMiningStructure(String, String)

Initializes a new instance of MiningStructure using a name and an identifier.

NameDescription
System_CAPS_pubpropertyAnnotations

Gets the collection object of all annotations to current object.(Inherited from MajorObject.)

System_CAPS_pubpropertyCacheMode

Gets or sets the caching mechanism used for training data retrieved while processing a mining structure.

System_CAPS_pubpropertyCaseTableName

Gets or sets the name of the case table that is associated with the MiningStructure object.

System_CAPS_pubpropertyCollation

Gets or sets the collation used by MiningStructure.

System_CAPS_pubpropertyColumns

Gets the collection of columns associated with a MiningStructure.

System_CAPS_pubpropertyContainer

(Inherited from Component.)

System_CAPS_pubpropertyCreatedTimestamp

Gets or sets the date and time of the creation of the object.(Inherited from MajorObject.)

System_CAPS_pubpropertyDataSource

Gets the DataSource object that is associated with a MiningStructure.

System_CAPS_pubpropertyDataSourceView

Gets the DataSourceView object that is associated with a MiningStructure.

System_CAPS_pubpropertyDescription

Gets or sets a description string of current object.(Inherited from MajorObject.)

System_CAPS_pubpropertyErrorConfiguration

Gets or sets the settings for handling errors that can occur when the MiningStructure is processed.

System_CAPS_pubpropertyFilterComponent

Gets or sets an MDX expression that defines the slice of the source cube that is used for the mining structure.

System_CAPS_protpropertyFriendlyName

Returns a user-friendly name.(Inherited from NamedComponent.)

System_CAPS_pubpropertyHoldoutActualSize

Gets or sets 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.

System_CAPS_pubpropertyHoldoutMaxCases

Gets or sets the maximum number of cases in the partition of the MiningStructure that contains testing data.

System_CAPS_pubpropertyHoldoutMaxPercent

Gets or sets the percentage of cases in the source data of the MiningStructure that are used for testing.

System_CAPS_pubpropertyHoldoutSeed

Gets or sets the seed used to initialize partitioning of the MiningStructure into training and testing data sets.

System_CAPS_pubpropertyID

Gets or sets the identifier of the component.(Inherited from NamedComponent.)

System_CAPS_pubpropertyIsLoaded

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates whether MajorObject have been loaded.(Inherited from MajorObject.)

System_CAPS_protpropertyKeyForCollection

Returns the key used in collections.(Inherited from NamedComponent.)

System_CAPS_pubpropertyLanguage

Gets or sets the language identifier of MiningStructure.

System_CAPS_pubpropertyLastProcessed

Gets or sets the DateTime on which the object was last processed.(Inherited from ProcessableMajorObject.)

System_CAPS_pubpropertyLastSchemaUpdate

Gets or sets the date and time when current object schema was last updated.(Inherited from MajorObject.)

System_CAPS_pubpropertyMiningModels

Gets the collection of MiningModel objects associated with a MiningStructure.

System_CAPS_pubpropertyMiningStructurePermissions

Gets or sets the collection of permissions on a MiningStructure object.

System_CAPS_pubpropertyName

Gets or sets the name of the component.(Inherited from NamedComponent.)

System_CAPS_pubpropertyOwningCollection

Gets or sets the collection that contains the ModelComponent.(Inherited from ModelComponent.)

System_CAPS_pubpropertyParent

Gets the Database object that is the parent of the MiningStructure.

System_CAPS_pubpropertyParentServer

Gets the Server object that is the parent of the MiningStructure.

System_CAPS_pubpropertySite

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the site of the component.(Inherited from NamedComponent.)

System_CAPS_pubpropertySiteID

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the identifier for the site associated with the component.(Inherited from NamedComponent.)

System_CAPS_pubpropertySource

Gets or sets the source of data to which MiningStructure is bound.

System_CAPS_pubpropertyState

Gets or sets the AnalysisState of this current instance.(Inherited from ProcessableMajorObject.)

System_CAPS_pubpropertyTranslations

Gets the collection of Translation objects associated with a MiningStructure.

NameDescription
System_CAPS_protmethodAddToContainer(IContainer)

This API supports the product infrastructure and is not intended to be used directly from your code. Adds a ModelComponent object to the specified container.(Inherited from ModelComponent.)

System_CAPS_protmethodAfterInsert(Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Displays a ModelComponent object after added to the specified index.(Inherited from ModelComponent.)

System_CAPS_protmethodAfterMove(Int32, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. Displays a ModelComponent object after moving to the specified index.(Inherited from ModelComponent.)

System_CAPS_protmethodAfterRemove(ModelComponentCollection)

This API supports the product infrastructure and is not intended to be used directly from your code. Displays a ModelComponentCollection after a ModelComponent object is removed.(Inherited from ModelComponent.)

System_CAPS_protmethodBeforeRemove(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Removes the ModelComponent object before the cleanup.(Inherited from ModelComponent.)

System_CAPS_pubmethodCanProcess(ProcessType)

Indicates whether the mining structure can be processed with the specified ProcessType parameter.(Overrides ProcessableMajorObject.CanProcess(ProcessType).)

System_CAPS_pubmethodClone()

Creates a new full copy of the MiningStructure object.

System_CAPS_protmethodClone(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Creates a new copy of the MajorObject object.(Inherited from MajorObject.)

System_CAPS_protmethodCopyTo(MajorObject, Boolean)

Copies the object to the specified destination.(Inherited from ProcessableMajorObject.)

System_CAPS_pubmethodCopyTo(MiningStructure)

Copies the content of the object to another object (the destination).

System_CAPS_pubmethodCreateMiningModel()

Creates a child mining model object within the mining structure.

System_CAPS_pubmethodCreateMiningModel(Boolean)

Create a mining model with a default name and optionally adds the model to the collection of models for the current structure.

System_CAPS_pubmethodCreateMiningModel(Boolean, String)

Creates a mining model with the specified name and optionally adds the model to the collection of models for the structure.

System_CAPS_pubmethodCreateObjRef(Type)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

(Inherited from Component.)

System_CAPS_pubmethodDrop()

Removes current object and updates server.(Inherited from MajorObject.)

System_CAPS_pubmethodDrop(DropOptions)

Removes current object and updates server using specified options.(Inherited from MajorObject.)

System_CAPS_pubmethodDrop(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.)

System_CAPS_pubmethodDrop(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.)

System_CAPS_pubmethodDrop(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.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodGetCreateReferences(Hashtable, Boolean, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a Hashtable to create references.(Inherited from MajorObject.)

System_CAPS_pubmethodGetDependents(Hashtable)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the dependents to the specified Hashtable.(Inherited from MajorObject.)

System_CAPS_protmethodGetDropDependents(Hashtable, Hashtable)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the drop dependents.(Inherited from MajorObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetReferences(Hashtable, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the objects that the MajorObject references.(Inherited from MajorObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGetUpdateOverwrites(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the Hashtable object that overwrites the updated MajorObject.(Inherited from MajorObject.)

System_CAPS_pubmethodInitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodProcess()

Processes the ProcessableMajorObject.(Inherited from ProcessableMajorObject.)

System_CAPS_pubmethodProcess(ProcessType)

Processes the ProcessableMajorObject with the specified process type.(Inherited from ProcessableMajorObject.)

System_CAPS_pubmethodProcess(ProcessType, Binding)

Processes the ProcessableMajorObject with the specified process type.(Inherited from ProcessableMajorObject.)

System_CAPS_pubmethodProcess(ProcessType, ErrorConfiguration)

Processes the ProcessableMajorObject with the specified process type.(Inherited from ProcessableMajorObject.)

System_CAPS_pubmethodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection)

Processes the ProcessableMajorObject with the specified process type.(Inherited from ProcessableMajorObject.)

System_CAPS_pubmethodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection)

Processes the ProcessableMajorObject with the specified process type.(Inherited from ProcessableMajorObject.)

System_CAPS_pubmethodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean)

Processes the ProcessableMajorObject with the specified process type.(Inherited from ProcessableMajorObject.)

System_CAPS_pubmethodProcess(ProcessType, WriteBackTableCreation)

Processes the ProcessableMajorObject with the specified process type and writeback option.(Inherited from ProcessableMajorObject.)

System_CAPS_pubmethodRefresh()

Updates current object from server definitions.(Inherited from MajorObject.)

System_CAPS_pubmethodRefresh(Boolean)

Updates current object from server definitions and loaded dependent objects if specified.(Inherited from MajorObject.)

System_CAPS_pubmethodRefresh(Boolean, RefreshType)

Updates current object from server definitions and loaded dependent objects if specified.(Inherited from MajorObject.)

System_CAPS_protmethodRemoveFromContainer(IContainer)

This API supports the product infrastructure and is not intended to be used directly from your code. Removes a ModelComponent object from the specified container.(Inherited from ModelComponent.)

System_CAPS_pubmethodSubmit()

This API supports the product infrastructure and is not intended to be used directly from your code. Submits a ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubmethodSubmit(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Submits a ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubmethodToString()

Returns a string containing the name of the component.(Inherited from NamedComponent.)

System_CAPS_pubmethodUpdate()

Updates server definition of current object to actual values using the default values to update dependent objects.(Inherited from MajorObject.)

System_CAPS_pubmethodUpdate(UpdateOptions)

Updates server definition of current object to actual values using the specified options to update dependent objects.(Inherited from MajorObject.)

System_CAPS_pubmethodUpdate(UpdateOptions, UpdateMode)

Updates server definition of current object to actual values using the specified options to update dependent objects.(Inherited from MajorObject.)

System_CAPS_pubmethodUpdate(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.)

System_CAPS_pubmethodUpdate(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.)

System_CAPS_pubmethodUpdate(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.)

System_CAPS_pubmethodValidate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.(Inherited from ModelComponent.)

System_CAPS_pubmethodValidate(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.)

System_CAPS_pubmethodValidate(ValidationErrorCollection, Boolean, ServerEdition)

Validates the current mining structure and returns a collection of validation errors.(Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)

System_CAPS_pubmethodValidate(ValidationResultCollection)

Indicates whether the MajorObject is valid.(Inherited from MajorObject.)

System_CAPS_pubmethodValidate(ValidationResultCollection, ValidationOptions)

Indicates whether the MajorObject is valid.(Inherited from MajorObject.)

System_CAPS_pubmethodValidate(ValidationResultCollection, ValidationOptions, ServerEdition)

Indicates whether the MajorObject is valid.(Inherited from MajorObject.)

NameDescription
System_CAPS_pubeventDisposed

(Inherited from Component.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDeserializationStartCallback.OnDeserializationBegin(Object)

Runs when the entire object graph starts to deserialized.(Inherited from MajorObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIMajorObject.CreateBody()

Returns the CreateBody implementation of the mining structure.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIMajorObject.DependsOn(IMajorObject)

Returns the DependsOn implementation of the mining structure.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIMajorObject.WriteRef(XmlWriter)

Returns the WriteRef implementation of the mining structure.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICloneable.Clone()

Returns the Clone implementation of the mining structure.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIFormattable.ToString(String, IFormatProvider)

Formats the value of the current instance using the specified format.(Inherited from NamedComponent.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDeserializationCallback.OnDeserialization(Object)

Runs when the entire object graph has been deserialized.(Inherited from MajorObject.)

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.

Return to top

Community Additions

Show:
© 2015 Microsoft