Survey
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Table of Contents Alter Element (XMLA) Attach Element Backup Element (XMLA) Batch Element (XMLA) BeginTransaction Element (XMLA) Cancel Element (XMLA) ClearCache Element (XMLA) CommitTransaction Element (XMLA) Create Element (XMLA) Delete Element (XMLA) DesignAggregations Element (XMLA) Detach Element Drop Element (XMLA) Insert Element (XMLA) Lock Element (XMLA) MergePartitions Element (XMLA) NotifyTableChange Element (XMLA) Process Element (XMLA) Restore Element (XMLA) RollbackTransaction Element (XMLA) Statement Element (XMLA) Subscribe Element (XMLA) Synchronize Element (XMLA) Unlock Element (XMLA) Update Element (XMLA) UpdateCells Element (XMLA) XML Elements - Commands Alter Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Contains Analysis Services Scripting Language (ASSL) elements used by the Execute method to alter objects on an instance of Microsoft SQL Server Analysis Services. Syntax <Command> <Alter Scope="enum" AllowCreate="boolean" ObjectExpansion="enum"> <Object>...</Object> <ObjectDefinition>...</ObjectDefinition> </Alter> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Object, ObjectDefinition Attributes ATTRIBUTE DESCRIPTION ATTRIBUTE DESCRIPTION AllowCreate (Optional Boolean attribute) Indicates whether objects defined in the Alter command should be created if they do not already exist. If set to true, the objects defined in the ObjectDefinition element are created on the Analysis Services instance if they do not already exist. In other words, the Alter command is treated as a Create command if the objects do not already exist on the instance. If this attribute is omitted or set to false, an error occurs if the objects do not already exist. ObjectExpansion (Optional Enum attribute) Defines the extent of alteration to be performed by the Execute method. If set to ObjectProperties, the ObjectDefinition element should contain only the complete definition of the major object to be altered, including subordinate minor objects. Subordinate major objects of the object to be altered remain unchanged. Note: When using the ObjectProperties setting with the ClrAssembly data type, the Data element of the associated ClrAssemblyFile data types does not need to be specified. If not specified, the ClrAssembly uses existing files. If set to ExpandFull, the ObjectDefinition element should contain not just the definition of the object to be altered, but also the definitions of all major objects which are descendants of the object to be altered. Note: The ExpandFull setting cannot be used with the Server element. Scope (Optional Enum attribute) Defines the duration of objects defined in the ObjectDefinition element. If set to Session, the objects defined in the ObjectDefinition element exist only for the duration of the XMLA session. Note: When using the Session setting, the ObjectDefinition element can only contain Dimension, Cube, or MiningModel ASSL elements. If this attribute is omitted, the objects defined in the ObjectDefinition element are persisted on the Analysis Services instance. Remarks Each Alter command changes the definition of one major object under the parent object specified by the ParentObject element. See Also Commands (XMLA) Attach Element 3/24/2017 • 1 min to read • Edit Online Attaches a Microsoft SQL Server Analysis Services database that was previously detached from the current server instance or from another instance, to the current server instance. Syntax <Command> <Attach> <Folder>...</Folder> <ReadWriteMode>...</ReadWriteMode> <Password>...</Password> </Attach> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Folder ReadWriteMode Password See Also Detach Detach Element Attach and Detach Analysis Services Databases Move an Analysis Services Database Database ReadWriteModes Switch an Analysis Services database between ReadOnly and ReadWrite modes Backup Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Backs up a Microsoft SQL Server Analysis Services database to a backup file. Syntax <Command> <Backup> <Object>...</Object> <File>...</File> <Security>...</Security> <ApplyCompression>...</ApplyCompression> <AllowOverwrite>...</AllowOverwrite> <Password>...</Password> <BackupRemotePartitions>...</BackupRemotePartitions> <Locations>...</Locations> </Backup> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements AllowOverwrite, ApplyCompression, BackupRemotePartitions, File, Locations, Object, Password, Security Remarks The Backup command backs up the Analysis Services database specified in the Object element to a backup file, and optionally backs up remote partitions to remote backup files. If the Object element refers to an object other than an Analysis Services database, an error occurs. Which information the Backup command backs up depends on the storage mode used by objects in the database. The following table identifies the information that is backed up based upon the storage mode used. STORAGE MODE INFORMATION THAT IS BACKED UP Multidimensional OLAP (MOLAP) Source data, aggregations, and metadata Hybrid OLAP (HOLAP) Aggregations and metadata Relational OLAP (ROLAP) Metadata During a Backup command, a shared lock is placed on the Analysis Services database specified in the Object element. The shared lock releases after the Backup command has completed. Multiple Backup commands can be run in parallel, if the commands are included in the Parallel collection of a Batch command. The Parallel collection enables a database to be backed up into multiple backup files at the same time. For more information about backing up and restoring databases, see Backing Up, Restoring, and Synchronizing Databases (XMLA). IMPORTANT For each backup file, the user who runs the backup command must have permission to write to the backup location specified for each file. Also, the user must have one of the following roles: a member of a server role for the Analysis Services instance, or a member of a database role with Full Control (Administrator) permissions on the database to be backed up. See Also Restore Element (XMLA) Synchronize Element (XMLA) Commands (XMLA) Batch Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Performs one or more XML for Analysis (XMLA) commands as a batch operation, either sequentially or in parallel, on an instance of Microsoft SQL Server Analysis Services. Syntax <Command> <Batch Transaction="Boolean" ProcessAffectedObjects="Boolean"> <Bindings>...</Bindings> <DataSource>...</DataSource> <DataSourceView>...</DataSourceView> <ErrorConfiguration>...</ErrorConfiguration> <Parallel>...</Parallel> <!-- One or more XMLA commands --> </Batch> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Bindings, DataSource, DataSourceView, ErrorConfiguration, Parallel One or more of the following XMLA commands: Alter, Backup, BeginTransaction, ClearCache, CommitTransaction, Create, Delete, DesignAggregations, Drop, Insert, Lock, MergePartitions, NotifyTableChange, Process, Restore, RollbackTransaction, SetPasswordEncryptionKey, Statement, Subscribe, Synchronize, Unlock, Update, UpdateCells Attributes ATTRIBUTE DESCRIPTION ProcessAffectedObjects (Optional Boolean attribute) Indicates whether all objects that require reprocessing will be processed. If set to true, the Analysis Services instance processes any objects that require reprocessing as a result of processing an object included in the Batch command. If set to false, the Analysis Services instance processes only those objects included in the Batch command. Transaction (Optional Boolean attribute) Indicates whether the command included in the Batch command are treated as a single transaction or individual transactions. If set to true, all of the commands included in the Batch command are considered a single transaction. If any command fails, the commands executed prior to the failed command are rolled back, and the Batch command stops without executing subsequent commands. If set to false, the Batch command attempts to execute every command, and commits the results of each command that completes successfully. Remarks WARNING Command/Execute/Statement is currently not supported in a Batch operation. For more information about performing batch operations in XMLA, see Performing Batch Operations (XMLA). See Also Commands (XMLA) BeginTransaction Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Begins a transaction on the current session with an instance of Microsoft SQL Server Analysis Services. Syntax <Command> <BeginTransaction /> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements None Remarks The BeginTransaction command begins an active transaction on the current session. If an active transaction already exists, the Analysis Services instance increments the reference count of transactions for the current session. If not, the instance will begin a new transaction and set the reference count for the current session to 1. If an active transaction is explicitly specified using the BeginTransaction command, all subsequent commands are executed inside the explicitly specified transaction. When the current session is ended and the reference count for transactions is higher than zero, all active transactions are rolled back. If there are no explicitly specified active transactions on the current session, every command issued on the current session is executed inside an implicitly defined transaction. The implicit transaction is committed if the command succeeds, or rolled back if the command fails. See Also Cancel Element (XMLA) CommitTransaction Element (XMLA) RollbackTransaction Element (XMLA) Commands (XMLA) Cancel Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Cancels a currently running command an Microsoft SQL Server Analysis Services instance. Syntax <Command> <Cancel> <ConnectionID>...</ConnectionID> <SessionID>...</SessionID> <SPID>...</SPID> <CancelAssociated>...</CancelAssociated> </Cancel> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements CancelAssociated, ConnectionID, SessionID, SPID Remarks The Cancel command cancels currently executing commands within the context of a session. If the client application has not requested a session, a command cannot be canceled. If the Cancel command is executed during the execution of a Batch command, the entire Batch command is canceled. If the Batch command was transactional, all of the commands contained by the Batch command are rolled back. If the Batch command was not transactional, only those commands contained by the Batch command that were executing at the time the Cancel command was executed are rolled back. Commands in a nontransactional Batch command that had already executed would not be rolled back. Typically, the Cancel command is used to cancel executing commands on the currently active session. In that case, none of the child elements for the Cancel command must be specified. The Cancel command can also be used by administrators to cancel commands executing on connections or sessions other than the currently active session. Members of a role that has Administer permissions for a given database can cancel commands for connections and sessions applicable to that database, while server administrators can cancel commands for connections and sessions for a given Analysis Services instance. To retrieve information about current connections and sessions for an Analysis Services instance, the Discover method can be executed to request, respectively, the DISCOVER_CONNECTIONS and DISCOVER_SESSIONS schema rowsets. Members of a role that has Administer permissions for a given database can return sessions only for a given database by specifying that database in the SESSION_CURRENT_DATABASE restriction column for the DISCOVER_SESSIONS schema rowset. For more information about the Discover method, see Discover Method (XMLA). See Also Batch Element (XMLA) Commands (XMLA) ClearCache Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Clears the memory cache for the specified object on a Microsoft SQL Server Analysis Services instance. Syntax <Command> <ClearCache> <Object>...</Object> </ClearCache> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Object Remarks The ClearCache command flushes the cache for a specified database, dimension, cube, measure group, or partition on an Analysis Services instance. If an object other than a database, dimension, cube, measure group, or partition is specified in the Object element, an error occurs. See Also Commands (XMLA) CommitTransaction Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Commits a transaction on the current session with a Microsoft SQL Server Analysis Services instance. Syntax <Command> <CommitTransaction /> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements None Remarks The CommitTransaction command commits an active transaction, explicitly defined using the BeginTransaction element, on the current session. If an active transaction does not already exist, an error occurs. If an active transaction already exists, the Analysis Services instance decrements the reference count of transactions for the current session. If the reference count of explicitly defined active transactions reaches zero, the Analysis Services instance commits the transaction. See Also BeginTransaction Element (XMLA) Cancel Element (XMLA) RollbackTransaction Element (XMLA) Commands (XMLA) Create Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Contains Analysis Services Scripting Language (ASSL) elements used by the Execute method to create objects on a Microsoft SQL Server Analysis Services instance. Syntax <Command> <Create Scope="enum" AllowOverwrite="boolean"> <ParentObject>...</ParentObject> <ObjectDefinition>...</ObjectDefinition> </Create> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements ObjectDefinition, ParentObject Attributes ATTRIBUTE DESCRIPTION AllowOverwrite Optional Boolean attribute. If set to True, the objects defined in the ObjectDefinition element can overwrite existing objects on the Analysis Services instance. If this attribute is omitted or set to False, the presence of an existing object generates an error. ATTRIBUTE DESCRIPTION Scope Optional Enum attribute. Defines the duration of objects defined in the ObjectDefinition element. If this attribute is omitted, the objects defined in the ObjectDefinition element are persisted on the Analysis Services instance. The following value is available: Session: The objects defined in the ObjectDefinition element exist only for the duration of the XML for Analysis (XMLA) session. Note that when using the Session setting, the ObjectDefinition element can only contain Dimension, Cube, or MiningModel ASSL elements. Remarks Each Create operation creates one major object under a parent given by the ParentObject element. If the parent object is omitted, it is assumed to be the destination Analysis Services instance. This generates an error if the parent of a major object is not the destination instance. Example The following example creates an empty database named Test Database on an Analysis Services instance. <Create xmlns="http://schemas.microsoft.com/analysisservices/2003/engine"> <ObjectDefinition> <Database xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <Name>Test Database</Name> <Description>A test database.</Description> </Database> </ObjectDefinition> </Create> See Also Commands (XMLA) Delete Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Deletes an object on a Microsoft SQL Server Analysis Services instance. Syntax <Command> <Delete IgnoreFailures="boolean"> <Object>...</Object> </Delete> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Object Attributes ATTRIBUTE DESCRIPTION IgnoreFailures Optional Boolean attribute. If set to True, the Execute method ignores network failures or failures related to remote partitions. Remarks See Also Commands (XMLA) DesignAggregations Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Creates aggregations for an aggregation design on a Microsoft SQL Server Analysis Services instance. Syntax <Command> <DesignAggregations> <Object>...</Object> <Time>...</Time> <Steps>...</Steps> <Optimization>...</Optimization> <Storage>...</Storage> <Materialize>...</Materialize> <Queries>...</Queries> </DesignAggregations> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Materialize, Object, Optimization, Queries, Steps, Storage, Time Remarks The DesignAggregations command is used to generate aggregation definitions stored by an aggregation design. An aggregation design can then be used to materialize aggregations for a partition and can be reused between partitions. See Also Commands (XMLA) Detach Element 3/24/2017 • 1 min to read • Edit Online Detaches a Microsoft SQL Server Analysis Services database from the current server instance. Syntax <Command> <Detach> <Object>...</Object> <Password>...</Password> </Detach> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Object Password See Also Detach Attach Element Attach and Detach Analysis Services Databases Move an Analysis Services Database Database ReadWriteModes Switch an Analysis Services database between ReadOnly and ReadWrite modes Drop Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Deletes attribute members from a dimension. Syntax <Command> <Drop> <Object>...</Object> <DeleteWithDescendants>...</DeleteWithDescendants> <Where>...</Where> </Drop> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements DeleteWithDescendants, Object, Where Remarks The Drop command deletes attribute members from a write-enabled dimension. For more information about deleting members, see Inserting, Updating, and Dropping Members (XMLA). See Also Insert Element (XMLA) Update Element (XMLA) Commands (XMLA) Insert Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Inserts attribute members into a dimension. Syntax <Command> <Insert> <Object>...</Object> <Attributes>...</Attributes> </Insert> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Attributes, Object Remarks The Insert command inserts new attribute members into a write-enabled dimension. For more information about deleting members, see Inserting, Updating, and Dropping Members (XMLA). See Also Drop Element (XMLA) Update Element (XMLA) Commands (XMLA) Lock Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Locks a specified object on a Microsoft SQL Server Analysis Services instance. Syntax <Command> <Lock> <ID>...</ID> <Object>...</Object> <Mode>...</Mode> </Lock> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements ID, Mode, Object Remarks The Lock command locks an object, either for shared or exclusive use, within the context of the currently active transaction. Only database administrators or server administrators can explicitly issue a Lock command. A lock on an object prevents transactions from committing until the lock is removed. Analysis Services supports two types of locks, shared locks and exclusive locks. For more information about the lock types supported by Analysis Services, see Mode Element (XMLA). Analysis Services allows only databases to be locked. The Object element must contain an object reference to an Analysis Services database. If the Object element is not specified or if the Object element refers to an object other than a database, an error occurs. Other commands implicitly issue a Lock command on an Analysis Services database. Any operation that reads data or metadata from a database, such as any Discover method or an Execute method running a Statement command, implicitly issues a shared lock on the database. Any transaction that commits changes in data or metadata to an object on an Analysis Services database, such as an Execute method running an Alter command, implicitly issues an exclusive lock on the database. All locks are held in the context of the current transaction. When the current transaction is committed or rolled back, all locks defined within the transaction are automatically released. See Also Unlock Element (XMLA) Commands (XMLA) MergePartitions Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Merges the data of one or more source partitions into a target partition, and then deletes the source partitions. Syntax <Command> <MergePartitions> <Sources>...</Sources> <Target>...</Target> </MergePartitions> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Sources, Target Remarks All object references in the Sources and Target elements must point to distinct partitions in the same measure group. Otherwise, an error occurs. See Also Commands (XMLA) NotifyTableChange Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Notifies an instance of Microsoft SQL Server Analysis Services that a change has occurred to tables in a specified data source. Syntax <Command> <NotifyTableChange> <Object>...</Object> <TableNotifications>...</TableNotifications> </NotifyTableChange> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Object, TableNotifications Remarks The NotifyTableChange command allows a client application to explicitly notify an Analysis Services instance that one or more tables contained in a data source have been changed. For proactive caching, this notification indicates that relational OLAP (ROLAP) objects based on those tables should be reviewed and updated. This method of notification is best used for ROLAP objects based on views or named queries defined in a data source view for which changes can be hard to detect and track. The Object element must refer to a data source in the Analysis Services database. If the Object element refers to an object other than a data source, an error occurs. For more information about proactive caching, see Proactive Caching (Partitions). See Also Commands (XMLA) Process Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Processes objects on a Microsoft SQL Server Analysis Services instance. Syntax <Command> <Process> <Type>...</Type> <Object>...</Object> <Bindings>...</Bindings> <DataSource>...</DataSource> <DataSourceView>...</DataSourceView> <ErrorConfiguration>...</ErrorConfiguration> <WriteBackTableCreation>...</WriteBackTableCreation> </Process> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Bindings, DataSource, DataSourceView, ErrorConfiguration, Object, Type Element (XMLA), WriteBackTableCreation Remarks For more information about processing objects, see Processing Objects (XMLA). See Also Commands (XMLA) Restore Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Restores a Microsoft SQL Server Analysis Services database from a backup file. Syntax <Command> <Restore> <DatabaseName>...</DatabaseName> <DatabaseID>...</DatabaseID> <File>...</File> <Security>...</Security> <AllowOverwrite>...</AllowOverwrite> <Password>...</Password> <Locations>...</Locations> <DbStorageLocation>...</DbStorageLocation> </Restore> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements AllowOverwrite, DatabaseName, DatabaseID, File, Locations, Password, Security, DbStorageLocation Remarks The Restore command restores an Analysis Services database specified in the DatabaseName element from a backup file and optionally restores remote partitions from remote backup files. Depending on the storage mode used by objects stored in the backup file, the Restore command restores information as listed in the following table. STORAGE MODE INFORMATION Multidimensional OLAP (MOLAP) Source data, aggregations, and metadata Hybrid OLAP (HOLAP) Aggregations and metadata Relational OLAP (ROLAP) Metadata During a Restore command, an exclusive lock is placed on the Analysis Services database specified in the DatabaseName element. The lock is released after the Restore command has completed. For more information about backing up and restoring databases, see Backing Up, Restoring, and Synchronizing Databases (XMLA). IMPORTANT For each backup file, the user who runs the restore command must have permission to read from the backup location specified for each file. To restore an Analysis Services database that is not installed on the server, the user must also be a member of the server role for that Analysis Services instance. To overwrite an Analysis Services database, the user must have one of the following roles: a member of the server role for the Analysis Services instance, or a member of a database role with Full Control (Administrator) permissions on the database to be restored. NOTE After restoring an existing database, the user who restored the database might lose access to the restored database. This loss of access can occur if, at the time that the backup was performed, the user was not a member of the server role or was not a member of the database role with Full Control (Administrator) permissions. See Also Backup Element (XMLA) Batch Element (XMLA) Parallel Element (XMLA) Synchronize Element (XMLA) Commands (XMLA) RollbackTransaction Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Rolls back a transaction on the current session with an instance of Microsoft SQL Server Analysis Services. Syntax <Command> <RollbackTransaction /> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements None Remarks The RollbackTransaction command rolls back all active transactions, explicitly defined using the BeginTransaction element, on the current session. If an active transaction does not already exist, an error occurs. If an active transaction already exists, the Analysis Services instance decrements the reference count of transactions for the current session to zero, rolling back all active transactions. See Also BeginTransaction Element (XMLA) Cancel Element (XMLA) CommitTransaction Element (XMLA) Commands (XMLA) Statement Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Contains a query or statement to be sent using the Execute method to an instance of Microsoft SQL Server Analysis Services. Syntax <Command> <Statement>...</Statement> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length String Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements None Remarks The Statement command executes a query or statement on the Analysis Services instance. Analysis Services supports the following languages: Multidimensional Expressions (MDX) Data Mining Extensions (MDX) A subset of Structured Query Language (SQL) See Also Commands (XMLA) Subscribe Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Subscribes to a trace and returns a rowset that contains the trace events from a Microsoft SQL Server Analysis Services instance. Syntax <Command> <Subscribe> <Object>...</Object> </Subscribe> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Object Remarks The Subscribe command subscribes to and streams back a rowset from a specified trace on an Analysis Services instance. If an object other than a trace is specified in the Object element, an error occurs. If the Object element is not specified, a session trace is defined and subscribed to on the Analysis Services instance. The session trace returns a fixed set of trace events from the current session. The rowset stream returned by this command is terminated if the client application closes the connection to the Analysis Services instance, or if the session on which the Subscribe command is executed is terminated. See Also Commands (XMLA) Synchronize Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Synchronizes a Microsoft SQL Server Analysis Services database with another existing database. Syntax <Command> <Synchronize> <Source>...</Source> <SynchronizeSecurity>...</SynchronizeSecurity> <ApplyCompression>...</ApplyCompression> <Locations>...</Locations> </Synchronize> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements ApplyCompression, Locations, Source, SynchronizeSecurity Remarks The Synchronize command synchronizes the target database with a source instance and database specified in the Source element. Optionally, the Synchronize command synchronizes remote partitions defined on the source database. Depending on the storage mode used by objects stored in the backup file, the Synchronize command synchronizes information as listed in the following table. STORAGE MODE INFORMATION Multidimensional OLAP (MOLAP) Source data, aggregations, and metadata Hybrid OLAP (HOLAP) Aggregations and metadata STORAGE MODE INFORMATION Relational OLAP (ROLAP) Metadata During a Synchronize command, a read lock is placed on the source database and a write lock is placed on the target database. Both locks are released after the Synchronize command has completed. For more information about synchronizing databases, see Backing Up, Restoring, and Synchronizing Databases (XMLA). See Also Backup Element (XMLA) Batch Element (XMLA) Parallel Element (XMLA) Restore Element (XMLA) Commands (XMLA) Unlock Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Unlocks a specified lock on a Microsoft SQL Server Analysis Services instance. Syntax <Command> <Unlock> <ID>...</ID> </Unlock> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements ID Remarks The Unlock command removes a lock established within the context of the currently active transaction. Only database administrators or server administrators can explicitly issue an Unlock command. All locks are held in the context of the current transaction. When the current transaction is committed or rolled back, all locks defined within the transaction are automatically released. See Also Lock Element (XMLA) Commands (XMLA) Update Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Updates attribute members in a dimension. Syntax <Command> <Update> <Object>...</Object> <MoveWithDescendants>...</MoveWithDescendants> <Attributes>...</Attributes> <Where>...</Where> </Update> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Attributes, MoveWithDescendants, Object, Where Remarks The Update command moves attribute members within a write-enabled dimension. For more information about updating members, see Inserting, Updating, and Dropping Members (XMLA). See Also Drop Element (XMLA) Insert Element (XMLA) Commands (XMLA) UpdateCells Element (XMLA) 3/24/2017 • 1 min to read • Edit Online Updates cells in a write-enabled cube. Syntax <Command> <UpdateCells> <Cell>...</Cell> </UpdateCells> </Command> Element Characteristics CHARACTERISTIC DESCRIPTION Data type and length None Default value None Cardinality 0-n: Optional element that can occur more than once. Element Relationships RELATIONSHIP ELEMENT Parent elements Command Child elements Cell Remarks The UpdateCells command updates cells in a cube that supports cell writeback. For more information about updating cells, see Updating Cells (XMLA). See Also Drop Element (XMLA) Insert Element (XMLA) Update Element (XMLA) Commands (XMLA) XML Elements - Commands 3/24/2017 • 1 min to read • Edit Online This reference section contains XML for Analysis (XMLA) elements that can be used within the Command element during an Execute method call. ELEMENT DESCRIPTION Alter Element (XMLA) Contains Analysis Services Scripting Language (ASSL) elements used by the Execute method to alter objects on an instance of Microsoft SQL Server Analysis Services. Backup Element Backs up a Microsoft SQL Server Analysis Services database to a backup file. Batch Element Performs one or more XML for Analysis (XMLA) commands as a batch operation, either sequentially or in parallel, on an instance of Microsoft SQL Server Analysis Services. BeginTransaction Element Begins a transaction on the current session with an Analysis Services instance. Cancel Element Cancels a currently running command on an Analysis Services instance. ClearCache Element Clears the memory cache for the specified object on an Analysis Services instance. CommitTransaction Element Commits a transaction on the current session with an Analysis Services instance. Create Element Contains Analysis Services Scripting Language (ASSL) elements used by the Execute method to create objects on an Analysis Services instance. Delete Element Deletes an object on an Analysis Services instance. DesignAggregations Element Creates aggregations for an aggregation design on an Analysis Services instance. Drop Element Deletes attribute members from a dimension. Insert Element Inserts attribute members into a dimension. Lock Element Locks a specified object on an Analysis Services instance. MergePartitions Element Merges the data of one or more source partitions into a target partition, and then deletes the source partitions. NotifyTableChange Element Notifies an Analysis Services instance that a change has occurred to tables in a specified data source. ELEMENT DESCRIPTION Process Element Processes objects on an Analysis Services instance. Restore Element Restores an Analysis Services database from a backup file. RollbackTransaction Element Rolls back a transaction on the current session with an Analysis Services instance. Statement Element Ccontains a query or statement to be sent using the Execute method to an instance of Analysis Services. Subscribe Element Subscribes to a trace and returns a rowset containing the trace events from an Analysis Services instance. Synchronize Element Synchronizes an Analysis Services database with another existing database. Unlock Element Unlocks a specified lock on an Analysis Services instance. Update Element Updates attribute members in a dimension. UpdateCells Element Updates cells in a write-enabled cube.