Server Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents an instance of Analysis Services and provides methods and members that enable you to control that instance. This class cannot be inherited.
[System.Runtime.InteropServices.Guid("554BBCA3-925F-4797-9460-2421A8CD7030")]
public sealed class Server : Microsoft.AnalysisServices.Core.Server, ICloneable, IDisposable, Microsoft.AnalysisServices.IMajorObject[<System.Runtime.InteropServices.Guid("554BBCA3-925F-4797-9460-2421A8CD7030")>]
type Server = class
inherit Server
interface IMajorObject
interface INamedComponent
interface IModelComponent
interface IComponent
interface IDisposable
interface ICloneablePublic NotInheritable Class Server
Inherits Server
Implements ICloneable, IDisposable, IMajorObject- Inheritance
- Attributes
- Implements
Examples
...
Remarks
his 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.
Constructors
| Server() |
Initializes a new instance of the Server using the default values. |
Fields
| MaxIDLength |
Specifies the maximum length of the identifier. (Inherited from NamedComponent) |
| MaxNameLength |
Specifies the maximum length of the name. (Inherited from NamedComponent) |
Properties
| AccessToken |
Access token (Inherited from Server) |
| Annotations |
Gets the collection of all annotations associated with the major object. (Inherited from MajorObject) |
| Assemblies |
Gets a collection of assemblies from the Server object. |
| CaptureLog |
Gets a collection containing XMLA commands that were generated while CaptureXml property was set to true. (Inherited from Server) |
| 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. (Inherited from Server) |
| CompatibilityMode |
Gets or sets the mode of the Analysis Services. This is read-only. (Inherited from Server) |
| Connected |
Gets an indication whether there is a connection to an instance of Analysis Services. (Inherited from Server) |
| ConnectionInfo |
Gets the information regarding the connection to the Server object. (Inherited from Server) |
| ConnectionString |
Gets the connection-string used to connect to an instance of Analysis Services. (Inherited from Server) |
| CreatedTimestamp |
Gets or sets the date and time of the creation of the object. (Inherited from MajorObject) |
| Databases |
Gets the collection of databases resident on a Server. |
| DefaultCompatibilityLevel |
Gets or sets a default compatiblity level to use whenever this value is unspecified. This is read-only. (Inherited from Server) |
| Description |
Gets or sets the description of major object. (Inherited from MajorObject) |
| Edition |
Gets or sets the currently installed edition of Analysis Services. This is read-only. (Inherited from Server) |
| EditionID |
Gets or sets the EditionID for the currently installed version of Analysis Services. This is read-only. (Inherited from Server) |
| FriendlyName |
Gets a user-friendly name for the component. (Inherited from NamedComponent) |
| ID |
Gets or sets the identifier of the component. (Inherited from NamedComponent) |
| IsInTransaction |
Gets the value indicating whether there is an active transaction started on Server. |
| IsLoaded |
Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject) |
| KeyForCollection |
Gets the key used in collections. (Inherited from NamedComponent) |
| LastSchemaUpdate |
Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject) |
| Name |
Gets or sets the name of the component. (Inherited from NamedComponent) |
| OnAccessTokenExpired |
Defines a callback method for notifying applications when the current access token is near expiration. (Inherited from Server) |
| OwningCollection |
Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent) |
| Parent |
Gets the IModelComponent object that is the parent of the ModelComponent object. (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. (Inherited from Server) |
| ProductName |
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) |
| Roles |
Gets the collection of Roles for a database, cube, or mining model. |
| ServerLocation |
Gets or sets 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). This is read-only. (Inherited from Server) |
| ServerMode |
Gets or sets the mode the server is operating in. This is read-only. (Inherited from Server) |
| ServerProperties |
Gets a collection of server properties associated with a specific Server object. (Inherited from Server) |
| SessionID |
Gets the session ID for the server. (Inherited from Server) |
| SessionTrace |
Gets the SessionTrace object that is used to start and stop traces on the server. |
| Site |
Gets or sets the site associated with the component. (Inherited from NamedComponent) |
| SiteID |
Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent) |
| SupportedCompatibilityLevels |
Get information regarding the set of compatibility levels, supported by the server. (Inherited from Server) |
| Traces |
Gets the traces available on the server. |
| Version |
Gets or sets the server version. This is read-only. (Inherited from Server) |
Methods
| AddToContainer(IContainer) |
Adds the ModelComponent object to the specified container. (Inherited from ModelComponent) |
| AfterInsert(Int32) |
Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent) |
| AfterMove(Int32, Int32) |
Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent) |
| AfterRemove(ModelComponentCollection) |
Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent) |
| Attach(String, ReadWriteMode, String) |
Attaches a folder to the server with specified mode and password. (Inherited from Server) |
| Attach(String, ReadWriteMode) |
Attaches a folder to the server with specified mode. (Inherited from Server) |
| Attach(String) |
Attaches a folder to the server. (Inherited from Server) |
| BeforeRemove(Boolean) |
Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent) |
| BeginTransaction() |
Starts a transaction on the server. |
| CancelCommand() |
Cancels the command executing on the current connection and session (a new temporary connection is used). (Inherited from Server) |
| CancelCommand(String) |
Cancels the command executing in the specified session (a new temporary connection is used). (Inherited from Server) |
| CancelConnection(Int32, Boolean) |
Cancels the specified connection (a new temporary connection is used). (Inherited from Server) |
| CancelConnection(Int32) |
Cancels the specified connection (a new temporary connection is used). (Inherited from Server) |
| CancelSession() |
Cancels the current session (a new temporary connection is used). (Inherited from Server) |
| CancelSession(Int32, Boolean) |
Cancels the specified session (a new temporary connection is used). (Inherited from Server) |
| CancelSession(Int32) |
Cancels the specified session (a new temporary connection is used). (Inherited from Server) |
| CancelSession(String, Boolean) |
Cancels the specified session (a new temporary connection is used). (Inherited from Server) |
| CancelSession(String) |
Cancels the specified session (a new temporary connection is used). (Inherited from Server) |
| Clone() |
Returns a clone of the object. |
| Clone(Boolean) |
Creates a new copy of the MajorObject object. (Inherited from MajorObject) |
| CommitTransaction() |
Commits the changes made in the current transaction. |
| CommitTransaction(ModelOperationResult) |
Commits the changes made in the current transaction and returns ModelOperationResult. |
| ConcatenateCaptureLog(Boolean, Boolean, Boolean) |
Gets the capture log in a concatenated XML format, wrapped in an XMLA Batch element, indicates whether to include the transaction attribute and XMLA Parallel element, and indicates whether affected objects will be processed. (Inherited from Server) |
| 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. (Inherited from Server) |
| Connect(String, Boolean) |
Connects the current instance of Server to the Analysis Services server using the specified connection string and properties-only indication. (Inherited from Server) |
| Connect(String, String) |
Connects the current instance of Server to the Analysis Services server, using the specified connection string and session identifier. (Inherited from Server) |
| Connect(String) |
Connects the current instance of Server to the Analysis Services server, using the specified connection string. (Inherited from Server) |
| CopyTo(MajorObject, Boolean) |
Copies a Server object to the specified destination. (Inherited from Server) |
| CopyTo(ModelComponent) |
Copies a ModelComponent object to the specified object. (Inherited from ModelComponent) |
| CopyTo(NamedComponent) |
Copies a NamedComponent object to the specified object. (Inherited from NamedComponent) |
| CopyTo(Server) |
Copies the content of this object to another object (the destination). |
| CopyTo(Server) |
Copies the content of this object to another object (the destination). (Inherited from Server) |
| Disconnect() |
Disconnects the Server object from the Analysis Services server. (Inherited from Server) |
| Disconnect(Boolean) |
Disconnects the Server object from the Analysis Services server. |
| Dispose(Boolean) |
Releases the unmanaged resources used by the Server and optionally releases the managed resources. (Inherited from Server) |
| Drop() |
Removes current object and updates server. (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) |
| 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) |
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) |
Removes current object and updates server using specified options. (Inherited from MajorObject) |
| EndXmlaRequest() |
Ends the last XML for Analysis (XMLA) request. (Inherited from Server) |
| EndXmlaRequestAndGetResults() |
Ends the Xmla request and get the results from the Server. (Inherited from Server) |
| EndXmlaRequestWithReader(XmlaResultCollection) |
Similar to EndXmlaRequest(), but returns an AmoDataReader instead of raw XmlReader. (Inherited from Server) |
| Execute(String, ImpactDetailCollection, Boolean) |
Executes the specified command on the Analysis Services server, and provides support for impact analysis. (Inherited from Server) |
| Execute(String) |
Executes the specified command on the Analysis Services server. (Inherited from Server) |
| ExecuteCaptureLog(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) |
| 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. (Inherited from Server) |
| 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. (Inherited from Server) |
| ExecuteReader(String, XmlaResultCollection, IDictionary, Boolean) |
Executes given XMLA command and returns AmoDataReader (Inherited from Server) |
| GetConnectionState(Boolean) |
Gets the current state of the connection to the Analysis Services server. (Inherited from Server) |
| GetCreateReferences(Hashtable, Boolean, Boolean) |
Gets a Hashtable to create references. (Inherited from MajorObject) |
| GetDependents(Hashtable) |
Gets the dependents to the specified Hashtable. (Inherited from MajorObject) |
| GetDropDependents(Hashtable, Hashtable) |
Gets the drop dependents. (Inherited from MajorObject) |
| GetLastSchemaUpdate(IMajorObject) |
Retrieves the date and time when the specified object schema was last updated. |
| GetReferences(Hashtable, Boolean) |
Gets the objects that the MajorObject references. (Inherited from MajorObject) |
| GetSupportedCompatibilityLevels() |
Obtain the set of compatibility levels supported by the server. (Inherited from Server) |
| GetUpdateOverwrites(Boolean) |
Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject) |
| ImageLoad(ImageLoadInfo) |
??? (Inherited from Server) |
| ImageLoad(String, String, Stream, ReadWriteMode) |
??? (Inherited from Server) |
| ImageLoad(String, String, Stream) |
??? (Inherited from Server) |
| ImageSave(ImageSaveInfo) |
??? (Inherited from Server) |
| ImageSave(String, Stream) |
??? (Inherited from Server) |
| NotifyTableChange(DataSource, TableNotificationCollection) |
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. (Inherited from Server) |
| Refresh() |
Updates the object from server definitions. (Inherited from MajorObject) |
| Refresh(Boolean, RefreshType) |
Updates the object from server definitions, as well as loaded dependent objects [if specified]. (Inherited from MajorObject) |
| Refresh(Boolean) |
Updates the object from server definitions, as well as loaded dependent objects [if specified]. (Inherited from MajorObject) |
| RemoveFromContainer(IContainer) |
Removes the ModelComponent object from the specified container. (Inherited from ModelComponent) |
| RenameScriptMeasure(String, String, String, String, FixUpExpressions) |
Execute a rename operation of a measure. (Inherited from Server) |
| RenameTable(String, String, String, FixUpExpressions) |
Execute a rename operation of a table. (Inherited from Server) |
| RenameTableColumn(String, String, String, String, FixUpExpressions) |
Execute a rename operation of a column. (Inherited from Server) |
| Reset() |
Resets the component to its initial state. (Inherited from NamedComponent) |
| Restore(RestoreInfo) |
Restores an Analysis Services database from a backup file, using the options set on the provided RestoreInfo object. (Inherited from Server) |
| Restore(String, String, Boolean, RestoreLocation[], RestoreSecurity, String, String, ReadWriteMode, Boolean) |
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, password, storage location, and read\write mode. (Inherited from Server) |
| Restore(String, String, Boolean, RestoreLocation[], RestoreSecurity, String, String, ReadWriteMode) |
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, password, storage location, and read\write mode. (Inherited from Server) |
| Restore(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, password, and storage location. (Inherited from Server) |
| Restore(String, String, Boolean, RestoreLocation[], RestoreSecurity, String) |
Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag, multiple remote servers, and specifying security settings and password. (Inherited from Server) |
| Restore(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. (Inherited from Server) |
| Restore(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. (Inherited from Server) |
| Restore(String, String, Boolean) |
Restores an Analysis Services database from a backup file to the specified database, given an overwrite flag. (Inherited from Server) |
| Restore(String, String) |
Restores an Analysis Services database from a backup file to the specified database. (Inherited from Server) |
| Restore(String) |
Restores an Analysis Services database from a backup file. (Inherited from Server) |
| 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 given stream. (Inherited from Server) |
| SendXmlaRequest(XmlaRequestType, TextReader) |
ends an XML for Analysis (XMLA) request of the specified type using the given request. (Inherited from Server) |
| StartXmlaRequest(XmlaRequestType) |
Starts an XML for Analysis (XMLA) request to the server. (Inherited from Server) |
| Submit() |
Submits a ModelComponent object. (Inherited from ModelComponent) |
| Submit(Boolean) |
Submits a ModelComponent object. (Inherited from ModelComponent) |
| Synchronize(String, String, SynchronizeSecurity, Boolean) |
Synchronizes the current object. (Inherited from Server) |
| Synchronize(String, String) |
Synchronizes the current object. (Inherited from Server) |
| Synchronize(SynchronizeInfo) |
Synchronizes the current object. (Inherited from Server) |
| ToString() |
Returns a string representing the named-component. (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, 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) |
| 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) |
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) |
Updates server definition of current object to actual values using the specified options 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) |
| UpdateObjects(IMajorObject[], ImpactDetailCollection) |
Infrastructure. Sends the updates made on the Server object to the Analysis Services server. |
| UpdateObjects(IMajorObject[]) |
Infrastructure. Sends the updates made on the Server object to the Analysis Services server. |
| Validate(ValidationErrorCollection, Boolean, ServerEdition) |
Indicates whether the Server object is valid. |
| 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(ValidationErrorCollection) |
Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent) |
| Validate(ValidationResultCollection, ValidationOptions, ServerEdition) |
Indicates whether the MajorObject is valid. (Inherited from MajorObject) |
| Validate(ValidationResultCollection, ValidationOptions) |
Indicates whether the MajorObject is valid. (Inherited from MajorObject) |
| Validate(ValidationResultCollection) |
Indicates whether the MajorObject is valid. (Inherited from MajorObject) |