Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Server Class

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

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

The Server type exposes the following members.

  NameDescription
Public methodServerInitializes a new instance of the Server using the default values.
Top
  NameDescription
Public propertyAnnotationsGets the collection object of all annotations to current object. (Inherited from MajorObject.)
Public propertyAssembliesGets a collection of assemblies from the Server object.
Public propertyCaptureLogGets a collection containing XMLA commands generated if CaptureXml property was set to true.
Public propertyCaptureXmlGets 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 propertyConnectedGets a value indicating whether there is a connection to an instance of Analysis Services.
Public propertyConnectionInfoGets the ConnectionInfo object from the Server object. This field is read-only.
Public propertyConnectionStringGets the string of characters used to connect to an instance Analysis Services. This field is read-only.
Public propertyContainer (Inherited from Component.)
Public propertyCreatedTimestampGets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public propertyDatabasesGets the collection of databases resident on a Server.
Public propertyDefaultCompatibilityLevel
Public propertyDescriptionGets or sets a description string of current object. (Inherited from MajorObject.)
Public propertyEditionGets or sets the currently installed version of Analysis Services. This is read-only.
Public propertyEditionIDGets or sets the EditionID for the currently installed version of Analysis Services. This is read-only.
Protected propertyFriendlyNameReturns a user-friendly name. (Inherited from NamedComponent.)
Public propertyIDGets or sets the identifier of the component. (Inherited from NamedComponent.)
Public propertyIsLoadedInfrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.)
Protected propertyKeyForCollectionReturns the key used in collections. (Inherited from NamedComponent.)
Public propertyLastSchemaUpdateGets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public propertyNameGets or sets the name of the component. (Inherited from NamedComponent.)
Public propertyOwningCollectionGets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public propertyParentInfrastructure. Gets the IModelComponent object that is the parent of the ModelComponent object. (Inherited from ModelComponent.)
Public propertyProductLevelGets or sets read-only access to the product level element. The product level itself is obtained from the stored install-specific string.
Public propertyProductNameGets or sets read-only access to the name of the product from which an instance of Analysis Services was installed.
Public propertyRolesGets the collection of Roles for a database, cube, or mining model.
Public propertyServerLocation
Public propertyServerModeGets or sets the server mode the server is operating in.Server mode is an enumeration of ServerMode
Public propertyServerPropertiesGets a collection of server properties associated with a specific Server object.
Public propertySessionIDGets the session ID for the server.
Public propertySessionTraceGets the SessionTrace object that is used to start and stop traces on the server.
Public propertySiteInfrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
Public propertySiteIDInfrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)
Public propertyTracesGets the traces available on the server.
Public propertyVersionGets or sets the server version.
Top
  NameDescription
Protected methodAddToContainerInfrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
Protected methodAfterInsertInfrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
Protected methodAfterMoveInfrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
Protected methodAfterRemoveInfrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
Public methodAttach(String)Attaches a folder to the server.
Public methodAttach(String, ReadWriteMode)Attaches a folder to the server with specified mode.
Public methodAttach(String, ReadWriteMode, String)Attaches a folder to the server with specified mode and password.
Protected methodBeforeRemoveInfrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
Public methodBeginTransactionStarts a transaction on the server.
Public methodCancelCommand()Cancels the last command sent to the server.
Public methodCancelCommand(String)Cancels the last command sent to the server on the specified session.
Public methodCancelConnection(Int32)Cancels the server connection specified by the connection ID.
Public methodCancelConnection(Int32, Boolean)Cancels the server connection specified by the connection ID, and indicates whether all other associated connections will be canceled.
Public methodCancelSession()Cancels the session on the server.
Public methodCancelSession(Int32)Cancels the specified session on the server.
Public methodCancelSession(String)Cancels the specified session on the server.
Public methodCancelSession(Int32, Boolean)Cancels the specified session on the server.
Public methodCancelSession(String, Boolean)Cancels the specified session on the server.
Public methodClone()Creates a new, full copy of a Server object.
Protected methodClone(Boolean)Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.)
Public methodCommitTransactionCommits the changes made in the current transaction.
Public methodConcatenateCaptureLog(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 methodConcatenateCaptureLog(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 methodConnect(String)Connects the current instance of Server to the Analysis Services server, using the specified connection string.
Public methodConnect(String, Boolean)Connects the current instance of Server to the Analysis Services server using the specified connection string and properties.
Public methodConnect(String, String)Connects the current instance of Server to the Analysis Services server, using the specified connection string.
Public methodCopyTo(Server)Copies a Server object to the specified object.
Protected methodCopyTo(MajorObject, Boolean)Infrastructure. Copies a MajorObject object to the specified destination. (Inherited from MajorObject.)
Public methodCreateObjRefSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodDisconnect()Disconnects the Server object from the Analysis Services server.
Public methodDisconnect(Boolean)Disconnects the specified session Server object from the Analysis Services server.
Public methodDispose (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 methodEndXmlaRequestEnds the last XML for Analysis (XMLA) request.
Public methodEquals (Inherited from Object.)
Public methodExecute(String)Executes the specified command on the Analysis Services server.
Public methodExecute(String, ImpactDetailCollection, Boolean)Executes the specified command on the Analysis Services server, and provides support for impact analysis.
Public methodExecuteCaptureLog(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 methodExecuteCaptureLog(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.
Public methodExecuteCaptureLog(Boolean, 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, indicates whether affected objects will be processed, and indicates whether to skip volatile objects.
Public methodGetConnectionStateGets the current state of the connection to the Analysis Services server.
Protected methodGetCreateReferencesInfrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.)
Public methodGetDependentsInfrastructure. Gets the dependents to the specified Hashtable. (Inherited from MajorObject.)
Protected methodGetDropDependentsInfrastructure. Gets the drop dependents. (Inherited from MajorObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLastSchemaUpdateInfrastructure. Retrieves the date and time when the specified object schema was last updated.
Public methodGetLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodGetReferencesInfrastructure. Gets the objects that the MajorObject references. (Inherited from MajorObject.)
Public methodGetType (Inherited from Object.)
Public methodGetUpdateOverwritesInfrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.)
Public methodInitializeLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodNotifyTableChangeNotifies an instance of Analysis Services that a change has occurred to tables in a specified data source.
Public methodReconnectRe-establishes the connection to the Analysis Services database.
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. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
Public methodRestore(String)Restores an Analysis Services database from a backup file.
Public methodRestore(RestoreInfo)Restores an Analysis Services database from a backup file, using the options set on a RestoreInfo object.
Public methodRestore(String, String)Restores an Analysis Services database from a backup file to the specified database.
Public methodRestore(String, String, Boolean)Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag.
Public methodRestore(String, String, Boolean, RestoreLocation[])Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag and multiple remote servers.
Public methodRestore(String, String, Boolean, 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 methodRestore(String, String, Boolean, 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 methodRestore(String, String, Boolean, RestoreLocation[], RestoreSecurity, String, String)Restores an Analysis Services database from a backup file to the specified database, given a password, an overwrite flag, multiple remote servers, specifying security settings and storage location.
Public methodRollbackTransactionRolls back the current transaction on the connection to the server.
Public methodSendXmlaRequest(XmlaRequestType, Stream)Sends an XML for Analysis (XMLA) request of the specified type using the specified stream.
Public methodSendXmlaRequest(XmlaRequestType, TextReader)Sends an XML for Analysis (XMLA) request of the specified type using the specified stream.
Public methodStartXmlaRequestStarts an XML for Analysis (XMLA) request to the server.
Public methodSubmit()Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodSubmit(Boolean)Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodToStringReturns a string containing the name of the component. (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 methodUpdateObjects(IMajorObject[])Infrastructure. Sends the updates made on the Server object to the Analysis Services server.
Public methodUpdateObjects(IMajorObject[], ImpactDetailCollection)Infrastructure. Sends the updates made on the Server object to the Analysis Services server.
Public methodValidate(ValidationErrorCollection)Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public methodValidate(ValidationResultCollection)Indicates whether the MajorObject is valid. (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)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public methodValidate(ValidationErrorCollection, Boolean, ServerEdition)Indicates whether the Server object is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public methodValidate(ValidationResultCollection, ValidationOptions, ServerEdition)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Top
  NameDescription
Public eventDisposed (Inherited from Component.)
Top
  NameDescription
Explicit interface implemetationPrivate methodICloneable.CloneCreates a copy of the server.
Explicit interface implemetationPrivate methodIDeserializationCallback.OnDeserializationRuns when the entire object graph has been deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate methodIFormattable.ToStringFormats the value of the current instance using the specified format. (Inherited from NamedComponent.)
Explicit interface implemetationPrivate methodIDeserializationStartCallback.OnDeserializationBeginRuns when the entire object graph starts to deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate propertyIHostableComponent.HostGets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIMajorObject.BaseTypeGets the base type implementation of the server.
Explicit interface implemetationPrivate methodIMajorObject.CreateBodyInfrastructure. Creates a new body for the server.
Explicit interface implemetationPrivate methodIMajorObject.DependsOnInfrastructure. Determines whether the server depends on an object.
Explicit interface implemetationPrivate propertyIMajorObject.ObjectReferenceGets the object reference implementation of the server.
Explicit interface implemetationPrivate propertyIMajorObject.ParentDatabaseGets the parent database implementation of the server.
Explicit interface implemetationPrivate propertyIMajorObject.ParentServerGets the parent server implementation of the server.
Explicit interface implemetationPrivate propertyIMajorObject.PathGets the path implementation of the server.
Explicit interface implemetationPrivate methodIMajorObject.WriteRefInfrastructure. Writes a reference for the server.
Explicit interface implemetationPrivate propertyIModelComponent.FriendlyPathGets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIModelComponent.OwningCollectionGets or sets the collection that owns the current object. (Inherited from ModelComponent.)
Top

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.

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

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.AnalysisServices;

namespace AMO_Server_object_snippet
{
    class Program
    {
        static void Main(string[] args)
        {
            // Create instance of Analysis Services object
            using (Server myServer = new Server())
            {
                // Connect to local instance of Analysis Services
                myServer.Connect("LocalHost");

                //use the server object here
                //....

                //Disconnect from the server
                myServer.Disconnect();
            }//Remember: this closing curly brace is 
             //          where the Dispose method, of the server object,
             //          is invoked (when you use the 'using' statement).
        }
    }
}
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.