Article
05/23/2011

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
	Server	Initializes a new instance of Server using the default values.

Top

Properties

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

Top

Methods

	Name	Description
	AddToContainer	Infrastructure. (Inherited from ModelComponent.)
	AfterInsert	Infrastructure. (Inherited from ModelComponent.)
	AfterMove	Infrastructure. (Inherited from ModelComponent.)
	AfterRemove	Infrastructure. (Inherited from ModelComponent.)
	Attach(String)
	Attach(String, ReadWriteMode)
	Attach(String, ReadWriteMode, String)
	BeforeRemove	Infrastructure. (Inherited from ModelComponent.)
	BeginTransaction	Starts a transaction on the server.
	CancelCommand()	Cancels the last command sent to the server.
	CancelCommand(String)	Cancels the last command sent to the server on the specified session.
	CancelConnection(Int32)	Cancels the server connection specified by the connection ID.
	CancelConnection(Int32, Boolean)	Cancels the server connection specified by the connection ID, and indicates whether all other associated connections will be canceled.
	CancelSession()	Cancels the session on the server.
	CancelSession(Int32)	Cancels the specified session on the server.
	CancelSession(String)	Cancels the specified session on the server.
	CancelSession(Int32, Boolean)	Cancels the specified session on the server.
	CancelSession(String, Boolean)	Cancels the specified session on the server.
	Clone()	Creates a new, full copy of a Server object.
	Clone(Boolean)	Infrastructure. (Inherited from MajorObject.)
	CommitTransaction	Commits the changes made in the current transaction.
	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.
	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.
	Connect(String)	Connects the current instance of Server to the Analysis Services server, using the specified connection string.
	Connect(String, String)	Connects the current instance of Server to the Analysis Services server, using the specified connection string.
	CopyTo(ModelComponent)	Infrastructure. (Inherited from ModelComponent.)
	CopyTo(NamedComponent)	(Inherited from NamedComponent.)
	CopyTo(Server)	Copies an Server object to the specified object.
	CopyTo(MajorObject, Boolean)	Infrastructure. (Inherited from MajorObject.)
	CreateObjRef	(Inherited from MarshalByRefObject.)
	Disconnect()	Disconnects the Server object from the Analysis Services server.
	Disconnect(Boolean)	Disconnects the specified session Server object from the Analysis Services server.
	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.)
	EndXmlaRequest	Ends the last XML for Analysis (XMLA) request.
	Equals	(Inherited from Object.)
	Execute(String)	Executes the specified command on the Analysis Services server.
	Execute(String, ImpactDetailCollection, Boolean)	Executes the specified command on the Analysis Services server, and provides support for impact analysis.
	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.
	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.
	Finalize	(Inherited from Component.)
	GetConnectionState	Gets the current state of the connection to the Analysis Services server.
	GetCreateReferences	Infrastructure. (Inherited from MajorObject.)
	GetDependents	Infrastructure. (Inherited from MajorObject.)
	GetDropDependents	Infrastructure. (Inherited from MajorObject.)
	GetHashCode	(Inherited from Object.)
	GetLastSchemaUpdate	Infrastructure.
	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.)
	NotifyTableChange	Notifies an instance of Analysis Services that a change has occurred to tables in a specified data source.
	Reconnect	Re-establishes the connection to the Analysis Services database.
	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	(Inherited from NamedComponent.)
	Restore(String)	Restores an Analysis Services database from a backup file.
	Restore(RestoreInfo)	Restores an Analysis Services database from a backup file, using the options set on a RestoreInfo object.
	Restore(String, String)	Restores an Analysis Services database from a backup file to the specified database.
	Restore(String, String, Boolean)	Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag.
	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.
	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.
	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.
	Restore(String, String, Boolean, array<RestoreLocation[], RestoreSecurity, String, String)
	RollbackTransaction	Rolls back the current transaction on the connection to the server.
	SendXmlaRequest(XmlaRequestType, Stream)	Sends an XML for Analysis (XMLA) request of the specified type using the specified stream.
	SendXmlaRequest(XmlaRequestType, TextReader)	Sends an XML for Analysis (XMLA) request of the specified type using the specified stream.
	StartXmlaRequest	Starts an XML for Analysis (XMLA) request to the server.
	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.)
	UpdateObjects(array<IMajorObject[])	Infrastructure.
	UpdateObjects(array<IMajorObject[], ImpactDetailCollection)	Infrastructure.
	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)	Indicates whether the Server object is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
	Validate(ValidationResultCollection, ValidationOptions, ServerEdition)	(Inherited from MajorObject.)

Top

Events

	Name	Description
	Disposed	(Inherited from Component.)

Top

Explicit Interface Implementations

	Name	Description
	ICloneable.Clone
	IDeserializationCallback.OnDeserialization	(Inherited from MajorObject.)
	IFormattable.ToString	(Inherited from NamedComponent.)
	IDeserializationStartCallback.OnDeserializationBegin	(Inherited from MajorObject.)
	IHostableComponent.Host	(Inherited from ModelComponent.)
	IMajorObject.BaseType
	IMajorObject.CreateBody	Infrastructure.
	IMajorObject.DependsOn	Infrastructure.
	IMajorObject.ObjectReference
	IMajorObject.ParentDatabase
	IMajorObject.ParentServer
	IMajorObject.Path
	IMajorObject.WriteRef	Infrastructure.
	IModelComponent.FriendlyPath	(Inherited from ModelComponent.)
	IModelComponent.OwningCollection	(Inherited from ModelComponent.)

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.

Share via