• Article

Server Class

Represents an instance of Microsoft SQL Server 2005 Analysis Services (SSAS) and provides methods and members that enable to you to control that instance. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.AnalysisServices.ModelComponent
        Microsoft.AnalysisServices.NamedComponent
          Microsoft.AnalysisServices.MajorObject
            Microsoft.AnalysisServices.Server

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

Syntax

'Declaration
<GuidAttribute("554BBCA3-925F-4797-9460-2421A8CD7030")> _
Public NotInheritable Class Server _
    Inherits MajorObject _
    Implements IMajorObject, INamedComponent, IModelComponent, IComponent,  _
    IDisposable, ICloneable
'Usage
Dim instance As Server

[GuidAttribute("554BBCA3-925F-4797-9460-2421A8CD7030")]
public sealed class Server : MajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable

[GuidAttribute(L"554BBCA3-925F-4797-9460-2421A8CD7030")]
public ref class Server sealed : public MajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable

[<SealedAttribute>]
[<GuidAttribute("554BBCA3-925F-4797-9460-2421A8CD7030")>]
type Server =  
    class
        inherit MajorObject
        interface IMajorObject
        interface INamedComponent
        interface IModelComponent
        interface IComponent
        interface IDisposable
        interface ICloneable
    end

public final class Server extends MajorObject implements IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable

The Server type exposes the following members.

Constructors

  Name Description
Public method Server Initializes a new instance of Server using the default values.

Top

Properties

  Name Description
Public property Annotations Gets the collection object of all annotations to current object. (Inherited from MajorObject.)
Public property Assemblies Gets a collection of assemblies from the Server object.
Protected property CanRaiseEvents (Inherited from Component.)
Public property CaptureLog Gets a collection containing XML/A commands generated if CaptureXml property was set to true.
Public property CaptureXml Gets or sets the CaptureLog property of the Server object, which indicates whether XML messages sent to an instance of Analysis Services should be logged.
Public property Connected Gets a value indicating whether there is a connection to an instance of Analysis Services.
Public property ConnectionInfo Gets the ConnectionInfo object from the Server object. This field is read-only.
Public property ConnectionString Gets the string of characters used to connect to an instance Analysis Services. This field is read-only.
Public property Container (Inherited from Component.)
Public property CreatedTimestamp Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public property Databases The collection of databases resident on a Server.
Public property Description Gets or sets a description string of current object. (Inherited from MajorObject.)
Protected property DesignMode (Inherited from Component.)
Public property Edition Gets the currently installed version of Analysis Services. This is read-only.
Public property EditionID Gets the EditionID for the currently installed version of Analysis Services. This is read-only.
Protected property Events (Inherited from Component.)
Protected property FriendlyName (Inherited from NamedComponent.)
Public property ID (Inherited from NamedComponent.)
Public property IsLoaded Infrastructure. (Inherited from MajorObject.)
Protected property KeyForCollection (Inherited from NamedComponent.)
Public property LastSchemaUpdate Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public property Name (Inherited from NamedComponent.)
Public property OwningCollection Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public property Parent Infrastructure. (Inherited from ModelComponent.)
Public property ProductLevel Gets or sets read-only access to the product level element. The product level itself is obtained from the stored install-specific string.
Public property ProductName Gets or sets read-only access to the name of the product from which an instance of Analysis Services was installed.
Public property Roles Represents the collection of Roles for a database, cube, or mining model.
Public property ServerProperties Gets a collection of server properties associated with a specific Server object.
Public property SessionID Gets the session ID for the server.
Public property SessionTrace Gets the SessionTrace object that is used to start and stop traces on the server.
Public property Site (Inherited from NamedComponent.)
Public property SiteID (Inherited from NamedComponent.)
Public property Traces Gets the traces available on the server.
Public property Version Gets or sets the server version.

Top

Methods

  Name Description
Protected method AddToContainer Infrastructure. (Inherited from ModelComponent.)
Protected method AfterInsert Infrastructure. (Inherited from ModelComponent.)
Protected method AfterMove Infrastructure. (Inherited from ModelComponent.)
Protected method AfterRemove Infrastructure. (Inherited from ModelComponent.)
Public method Attach(String)
Public method Attach(String, ReadWriteMode)
Public method Attach(String, ReadWriteMode, String)
Protected method BeforeRemove Infrastructure. (Inherited from ModelComponent.)
Public method BeginTransaction Starts a transaction on the server.
Public method CancelCommand() Cancels the last command sent to the server.
Public method CancelCommand(String) Cancels the last command sent to the server on the specified session.
Public method CancelConnection(Int32) Cancels the server connection specified by the connection ID.
Public method CancelConnection(Int32, Boolean) Cancels the server connection specified by the connection ID, and indicates whether all other associated connections will be canceled.
Public method CancelSession() Cancels the session on the server.
Public method CancelSession(Int32) Cancels the specified session on the server.
Public method CancelSession(String) Cancels the specified session on the server.
Public method CancelSession(Int32, Boolean) Cancels the specified session on the server.
Public method CancelSession(String, Boolean) Cancels the specified session on the server.
Public method Clone() Creates a new, full copy of a Server object.
Protected method Clone(Boolean) Infrastructure. (Inherited from MajorObject.)
Public method CommitTransaction Commits the changes made in the current transaction.
Public method ConcatenateCaptureLog(Boolean, Boolean) Gets the capture log in a concatenated XML format, wrapped in an XMLA Batch element, and indicates whether to include the transaction attribute and XMLA Parallel element.
Public method ConcatenateCaptureLog(Boolean, Boolean, Boolean) Gets the capture log in a concatenated XML format, wrapped in an XMLA Batch element, and indicates whether to include the transaction attribute and XMLA Parallel element.
Public method Connect(String) Connects the current instance of Server to the Analysis Services server, using the specified connection string.
Public method Connect(String, String) Connects the current instance of Server to the Analysis Services server, using the specified connection string.
Protected method CopyTo(ModelComponent) Infrastructure. (Inherited from ModelComponent.)
Protected method CopyTo(NamedComponent) (Inherited from NamedComponent.)
Public method CopyTo(Server) Copies an Server object to the specified object.
Protected method CopyTo(MajorObject, Boolean) Infrastructure. (Inherited from MajorObject.)
Public method CreateObjRef (Inherited from MarshalByRefObject.)
Public method Disconnect() Disconnects the Server object from the Analysis Services server.
Public method Disconnect(Boolean) Disconnects the specified session Server object from the Analysis Services server.
Public method Dispose() (Inherited from Component.)
Protected method Dispose(Boolean) (Inherited from Component.)
Public method Drop() Removes current object and updates server. (Inherited from MajorObject.)
Public method Drop(DropOptions) Removes current object and updates server using specified options. (Inherited from MajorObject.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method EndXmlaRequest Ends the last XML for Analysis (XMLA) request.
Public method Equals (Inherited from Object.)
Public method Execute(String) Executes the specified command on the Analysis Services server.
Public method Execute(String, ImpactDetailCollection, Boolean) Executes the specified command on the Analysis Services server, and provides support for impact analysis.
Public method ExecuteCaptureLog(Boolean, Boolean) Executes the contents of the capture log on the server, and indicates whether execution will be in a transactional and/or parallel mode. Affected objects will not be processed.
Public method ExecuteCaptureLog(Boolean, Boolean, Boolean) Executes the contents of the capture log on the server, indicates whether execution will be in a transactional and/or parallel mode, and indicates whether affected objects will be processed.
Protected method Finalize (Inherited from Component.)
Public method GetConnectionState Gets the current state of the connection to the Analysis Services server.
Protected method GetCreateReferences Infrastructure. (Inherited from MajorObject.)
Public method GetDependents Infrastructure. (Inherited from MajorObject.)
Protected method GetDropDependents Infrastructure. (Inherited from MajorObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetLastSchemaUpdate Infrastructure.
Public method GetLifetimeService (Inherited from MarshalByRefObject.)
Public method GetReferences Infrastructure. (Inherited from MajorObject.)
Protected method GetService (Inherited from Component.)
Public method GetType (Inherited from Object.)
Public method GetUpdateOverwrites Infrastructure. (Inherited from MajorObject.)
Public method InitializeLifetimeService (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public method NotifyTableChange Notifies an instance of Analysis Services that a change has occurred to tables in a specified data source.
Public method Reconnect Re-establishes the connection to the Analysis Services database.
Public method Refresh() Updates current object from server definitions. (Inherited from MajorObject.)
Public method Refresh(Boolean) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Public method Refresh(Boolean, RefreshType) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Protected method RemoveFromContainer Infrastructure. (Inherited from ModelComponent.)
Protected method Reset (Inherited from NamedComponent.)
Public method Restore(String) Restores an Analysis Services database from a backup file.
Public method Restore(RestoreInfo) Restores an Analysis Services database from a backup file, using the options set on a RestoreInfo object.
Public method Restore(String, String) Restores an Analysis Services database from a backup file to the specified database.
Public method Restore(String, String, Boolean) Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag.
Public method Restore(String, String, Boolean, array<RestoreLocation[]) Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag and multiple remote servers.
Public method Restore(String, String, Boolean, array<RestoreLocation[], RestoreSecurity) Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag, multiple remote servers, and specifying security settings.
Public method Restore(String, String, Boolean, array<RestoreLocation[], RestoreSecurity, String) Restores an Analysis Services database from a backup file to the specified database, given a password, an overwrite flag, multiple remote servers, and specifying security settings.
Public method Restore(String, String, Boolean, array<RestoreLocation[], RestoreSecurity, String, String)
Public method RollbackTransaction Rolls back the current transaction on the connection to the server.
Public method SendXmlaRequest(XmlaRequestType, Stream) Sends an XML for Analysis (XMLA) request of the specified type using the specified stream.
Public method SendXmlaRequest(XmlaRequestType, TextReader) Sends an XML for Analysis (XMLA) request of the specified type using the specified stream.
Public method StartXmlaRequest Starts an XML for Analysis (XMLA) request to the server.
Public method Submit() Infrastructure. (Inherited from ModelComponent.)
Public method Submit(Boolean) Infrastructure. (Inherited from ModelComponent.)
Public method ToString (Inherited from NamedComponent.)
Public method Update() Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method UpdateObjects(array<IMajorObject[]) Infrastructure.
Public method UpdateObjects(array<IMajorObject[], ImpactDetailCollection) Infrastructure.
Public method Validate(ValidationErrorCollection) Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public method Validate(ValidationResultCollection) (Inherited from MajorObject.)
Public method 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.)
Public method Validate(ValidationResultCollection, ValidationOptions) (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean, ServerEdition) Indicates whether the Server object is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public method Validate(ValidationResultCollection, ValidationOptions, ServerEdition) (Inherited from MajorObject.)

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

Top

Remarks

This object is the root object for the entire Analysis Management Objects (AMO) object model tree. With an object of ClassType Server you can:

  • Connect to a computer on which an instance of Analysis Services is running.

  • Connect (create a session) and disconnect (end session context) to an instance of Analysis Services.

  • Capture XML message logs of command traffic to Analysis Services.

  • Identify the product edition and product level.

  • Execute requests to create other Analysis Services objects, such as databases, data sources, commands, dimensions, cubes, data mining models, and roles.

  • See ConnectionString for a detailed description of connection string parameters.

Examples

The following code creates and initializes an instance of Analysis Services. "LocalHost" specifies the instance running on the same computer as your AMO application.

// Create instance of Analysis Services object
Server myServer = new Server();
// Connect to local instance of Analysis Services
myServer.Connect("LocalHost");
// An error will be raised if the connection attempt fails
// Your code goes here
// DisConnect to the local instance of Analysis Services
myServer.DisConnect();

Thread Safety

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