Server Class

 

Updated: May 24, 2016

Represents an instance of Analysis Services and provides methods and members that enable you to control that instance. This class cannot be inherited.

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

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

public ref class Server : Server, ICloneable, IMajorObject

NameDescription
System_CAPS_pubmethodServer()

Initializes a new instance of the Server using the default values.

NameDescription
System_CAPS_pubpropertyAnnotations

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

System_CAPS_protpropertyCanRaiseEvents

(Inherited from Component.)

System_CAPS_pubpropertyCaptureLog

Gets a collection containing XMLA commands generated if CaptureXml property was set to true.(Inherited from Server.)

System_CAPS_pubpropertyCaptureXml

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.(Inherited from Server.)

System_CAPS_pubpropertyConnected

Gets a value indicating whether there is a connection to an instance of Analysis Services.(Inherited from Server.)

System_CAPS_pubpropertyConnectionInfo

Gets the ConnectionInfo object from the Server object. This field is read-only.(Inherited from Server.)

System_CAPS_pubpropertyConnectionString

Gets the string of characters used to connect to an instance Analysis Services. This field is read-only.(Inherited from Server.)

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_pubpropertyDatabases

Gets the collection of databases resident on a Server.

System_CAPS_pubpropertyDefaultCompatibilityLevel

Gets or sets a default compatiblity level to use whenever this value is unspecified. (Inherited from Server.)

System_CAPS_pubpropertyDescription

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

System_CAPS_protpropertyDesignMode

(Inherited from Component.)

System_CAPS_pubpropertyEdition

Gets the currently installed version of Analysis Services. This is read-only.(Inherited from Server.)

System_CAPS_pubpropertyEditionID

Gets the EditionID for the currently installed version of Analysis Services. This is read-only.(Inherited from Server.)

System_CAPS_protpropertyEvents

(Inherited from Component.)

System_CAPS_protpropertyFriendlyName

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

System_CAPS_pubpropertyID

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

System_CAPS_pubpropertyIsInTransaction

Gets the value indicating whether there is an active transaction started on Server.

System_CAPS_pubpropertyIsLoaded

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_pubpropertyLastSchemaUpdate

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

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 IModelComponent object that is the parent of the ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubpropertyProductLevel

>Gets or sets read-only access to the product level element. The product level itself is obtained from the stored install-specific string.(Inherited from Server.)

System_CAPS_pubpropertyProductName

Gets or sets read-only access to the name of the SQL Server product from which an instance of Analysis Services was installed.(Inherited from Server.)

System_CAPS_pubpropertyRoles

Gets the collection of Roles.

System_CAPS_pubpropertyServerLocation

Gets the location of the server, which is either on-premises or in a Microsoft data center that provides internal hosting of tabular models for Microsoft's online services, (for example, Excel data models viewed in Office 365).(Inherited from Server.)

System_CAPS_pubpropertyServerMode

Gets or sets the server mode the server is operating in.Server mode is an enumeration of ServerMode(Inherited from Server.)

System_CAPS_pubpropertyServerProperties

Gets a collection of server properties associated with a specific Server object.(Inherited from Server.)

System_CAPS_pubpropertySessionID

Gets the session ID for the server.(Inherited from Server.)

System_CAPS_pubpropertySessionTrace

Gets the SessionTrace object that is used to start and stop traces on the server.

System_CAPS_pubpropertySite

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

System_CAPS_pubpropertySiteID

Gets or sets the identifier for the site associated with the component.(Inherited from NamedComponent.)

System_CAPS_pubpropertyTraces

Gets the traces available on the server.

System_CAPS_pubpropertyVersion

Gets or sets the server version. (Inherited from Server.)

NameDescription
System_CAPS_protmethodAddToContainer(IContainer^)

Adds a ModelComponent object to the specified container.(Inherited from ModelComponent.)

System_CAPS_protmethodAfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.(Inherited from ModelComponent.)

System_CAPS_protmethodAfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.(Inherited from ModelComponent.)

System_CAPS_protmethodAfterRemove(ModelComponentCollection^)

Displays a ModelComponentCollection after a ModelComponent object is removed.(Inherited from ModelComponent.)

System_CAPS_pubmethodAttach(String^)

Attaches a folder to the server.(Inherited from Server.)

System_CAPS_pubmethodAttach(String^, ReadWriteMode)

Attaches a folder to the server with specified mode.(Inherited from Server.)

System_CAPS_pubmethodAttach(String^, ReadWriteMode, String^)

Attaches a folder to the server with specified mode and password.(Inherited from Server.)

System_CAPS_protmethodBeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.(Inherited from ModelComponent.)

System_CAPS_pubmethodBeginTransaction()

Starts a transaction on the server.

System_CAPS_pubmethodCancelCommand()

Cancels the last command sent to the server.(Inherited from Server.)

System_CAPS_pubmethodCancelCommand(String^)

Cancels the last command sent to the server on the specified session.(Inherited from Server.)

System_CAPS_pubmethodCancelConnection(Int32)

Cancels the server connection specified by the connection ID.(Inherited from Server.)

System_CAPS_pubmethodCancelConnection(Int32, Boolean)

Cancels the server connection specified by the connection ID, and indicates whether all other associated connections will be canceled.(Inherited from Server.)

System_CAPS_pubmethodCancelSession()

Cancels the session on the server.(Inherited from Server.)

System_CAPS_pubmethodCancelSession(Int32)

Cancels the specified session on the server.(Inherited from Server.)

System_CAPS_pubmethodCancelSession(Int32, Boolean)

Cancels the specified session on the server.(Inherited from Server.)

System_CAPS_pubmethodCancelSession(String^)

Cancels the specified session on the server.(Inherited from Server.)

System_CAPS_pubmethodCancelSession(String^, Boolean)

Cancels the specified session on the server.(Inherited from Server.)

System_CAPS_pubmethodClone()

Returns a clone of the object.

System_CAPS_protmethodClone(Boolean)

Infrastructure. Creates a new copy of the MajorObject object. (Overrides MajorObject::Clone(Boolean).)

System_CAPS_pubmethodCommitTransaction()

Commits the changes made in the current transaction.

System_CAPS_pubmethodCommitTransaction(ModelOperationResult^%)

Commits the changes made in the current transaction and returns ModelOperationResult.

System_CAPS_pubmethodConcatenateCaptureLog(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.(Inherited from Server.)

System_CAPS_pubmethodConcatenateCaptureLog(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.(Inherited from Server.)

System_CAPS_pubmethodConnect(String^)

Connects the current instance of Server to the Analysis Services server, using the specified connection string.(Inherited from Server.)

System_CAPS_pubmethodConnect(String^, Boolean)

Connects the current instance of Server to the Analysis Services server using the specified connection string and properties.(Inherited from Server.)

System_CAPS_pubmethodConnect(String^, String^)

Connects the current instance of Server to the Analysis Services server, using the specified connection string.(Inherited from Server.)

System_CAPS_protmethodCopyTo(MajorObject^, Boolean)

Infrastructure. Copies a MajorObject object to the specified destination. (Overrides Server::CopyTo(MajorObject^, Boolean).)

System_CAPS_protmethodCopyTo(ModelComponent^)

Copies a ModelComponent object to the specified object.(Inherited from ModelComponent.)

System_CAPS_protmethodCopyTo(NamedComponent^)

Copies a NamedComponent object to the specified object.(Inherited from NamedComponent.)

System_CAPS_pubmethodCopyTo(Server^)

Copies a Server object to the specified object.(Inherited from Server.)

System_CAPS_pubmethodCopyTo(Server^)

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

System_CAPS_pubmethodCreateObjRef(Type^)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDisconnect()

Disconnects the Server object from the Analysis Services server.(Inherited from Server.)

System_CAPS_pubmethodDisconnect(Boolean)

Disconnects the Server object from the Analysis Services server. (Overrides Server::Disconnect(Boolean).)

System_CAPS_pubmethodDispose()

(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the Server and optionally releases the managed resources.(Inherited from Server.)

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_pubmethodEndXmlaRequest()

Ends the last XML for Analysis (XMLA) request.(Inherited from Server.)

System_CAPS_pubmethodEndXmlaRequestAndGetResults()

Ends the Xmla request and get the results from the Server.(Inherited from Server.)

System_CAPS_pubmethodEndXmlaRequestWithReader(XmlaResultCollection^%)

Reads the server object to end the XML for Analysis (XMLA) request.(Inherited from Server.)

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_pubmethodExecute(String^)

Executes the specified command on the Analysis Services server.(Inherited from Server.)

System_CAPS_pubmethodExecute(String^, ImpactDetailCollection^, Boolean)

Executes the specified command on the Analysis Services server, and provides support for impact analysis.(Inherited from Server.)

System_CAPS_pubmethodExecuteCaptureLog(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.(Inherited from Server.)

System_CAPS_pubmethodExecuteCaptureLog(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.(Inherited from Server.)

System_CAPS_pubmethodExecuteCaptureLog(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.(Inherited from Server.)

System_CAPS_pubmethodExecuteReader(String^, XmlaResultCollection^%, IDictionary^, Boolean)

Sends the CommandText to the Connection and builds an AmoDataReader.(Inherited from Server.)

System_CAPS_protmethodFinalize()

(Inherited from Component.)

System_CAPS_pubmethodGetConnectionState(Boolean)

Gets the current state of the connection to the Analysis Services server.(Inherited from Server.)

System_CAPS_protmethodGetCreateReferences(Hashtable^, Boolean, Boolean)

Gets a Hashtable to create references.(Inherited from MajorObject.)

System_CAPS_pubmethodGetDependents(Hashtable^)

Gets the dependents to the specified Hashtable.(Inherited from MajorObject.)

System_CAPS_protmethodGetDropDependents(Hashtable^, Hashtable^)

Gets the drop dependents.(Inherited from MajorObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetLastSchemaUpdate(IMajorObject^)

Retrieves the date and time when the specified object schema was last updated.

System_CAPS_pubmethodGetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetReferences(Hashtable^, Boolean)

Gets the objects that the MajorObject references.(Inherited from MajorObject.)

System_CAPS_protmethodGetService(Type^)

(Inherited from Component.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGetUpdateOverwrites(Boolean)

Gets the Hashtable object that overwrites the updated MajorObject.(Inherited from MajorObject.)

System_CAPS_pubmethodInitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodReconnect()

Re-establishes the connection to the Analysis Services database.(Inherited from Server.)

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^)

Removes a ModelComponent object from the specified container.(Inherited from ModelComponent.)

System_CAPS_protmethodRenameScriptMeasure(String^, String^, String^, String^, FixUpExpressions)

Creates a new name for the script measure.(Inherited from Server.)

System_CAPS_protmethodRenameTable(String^, String^, String^, FixUpExpressions)

Gets or sets the name of table.(Inherited from Server.)

System_CAPS_protmethodRenameTableColumn(String^, String^, String^, String^, FixUpExpressions)

Gets or sets the name of column.(Inherited from Server.)

System_CAPS_protmethodReset()

Resets the component to its initial state.(Inherited from NamedComponent.)

System_CAPS_pubmethodRestore(RestoreInfo^)

Restores an Analysis Services database from a backup file, using the options set on a RestoreInfo object.(Inherited from Server.)

System_CAPS_pubmethodRestore(String^)

Restores an Analysis Services database from a backup file.(Inherited from Server.)

System_CAPS_pubmethodRestore(String^, String^)

Restores an Analysis Services database from a backup file to the specified database.(Inherited from Server.)

System_CAPS_pubmethodRestore(String^, String^, Boolean)

Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag.(Inherited from Server.)

System_CAPS_pubmethodRestore(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.(Inherited from Server.)

System_CAPS_pubmethodRestore(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.(Inherited from Server.)

System_CAPS_pubmethodRestore(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.(Inherited from Server.)

System_CAPS_pubmethodRestore(String^, String^, Boolean, array<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. (Inherited from Server.)

System_CAPS_pubmethodRestore(String^, String^, Boolean, array<RestoreLocation^>^, RestoreSecurity, String^, String^, ReadWriteMode)

Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag and multiple remote servers.(Inherited from Server.)

System_CAPS_pubmethodRollbackTransaction()

Rolls back the current transaction on the connection to the server.

System_CAPS_pubmethodSendXmlaRequest(XmlaRequestType, Stream^)

Sends an XML for Analysis (XMLA) request of the specified type using the given stream.(Inherited from Server.)

System_CAPS_pubmethodSendXmlaRequest(XmlaRequestType, TextReader^)

Sends an XML for Analysis (XMLA) request of the specified type using the given stream. (Inherited from Server.)

System_CAPS_pubmethodStartXmlaRequest(XmlaRequestType)

Starts an XML for Analysis (XMLA) request to the server.(Inherited from Server.)

System_CAPS_pubmethodSubmit()

Submits a ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubmethodSubmit(Boolean)

Submits a ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubmethodSynchronize(String^, String^)

Synchronizes the current object.(Inherited from Server.)

System_CAPS_pubmethodSynchronize(String^, String^, SynchronizeSecurity, Boolean)

Synchronizes the current object.(Inherited from Server.)

System_CAPS_pubmethodSynchronize(SynchronizeInfo^)

Synchronizes the specified object to the Server.(Inherited from Server.)

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_pubmethodUpdateObjects(array<IMajorObject^>^)

Infrastructure. Sends the updates made on the Server object to the Analysis Services server.

System_CAPS_pubmethodUpdateObjects(array<IMajorObject^>^, ImpactDetailCollection^)

Infrastructure. Sends the updates made on the Server object to the Analysis Services server.

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)

Indicates whether the Server object is valid. (Overrides Server::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()

Creates a new body for the server.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIMajorObject::DependsOn(IMajorObject^)

Determines whether the dimension permission depends on an object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIMajorObject::WriteRef(XmlWriter^)

Writes a reference for the server.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICloneable::Clone()

Creates a new copy of the current object.

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

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIHostableComponent::Host

(Inherited from ModelComponent.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIModelComponent::FriendlyPath

(Inherited from ModelComponent.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIModelComponent::OwningCollection

(Inherited from ModelComponent.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIMajorObject::BaseType

Gets the base type implementation of the Server.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIMajorObject::ObjectReference

Gets the object reference.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIMajorObject::ParentDatabase

Gets the parent database implementation of the server.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIMajorObject::ParentServer

Gets the parent server of this object.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIMajorObject::Path

Gets the path implementation for this object.

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
Show: