AdomdConnection AdomdConnection AdomdConnection Class

Definition

Represents a connection to a multidimensional data source.

public ref class AdomdConnection sealed : System::ComponentModel::Component, ICloneable, IDisposable, System::Data::IDbConnection
public sealed class AdomdConnection : System.ComponentModel.Component, ICloneable, IDisposable, System.Data.IDbConnection
Public NotInheritable Class AdomdConnection
Inherits Component
Implements ICloneable, IDbConnection, IDisposable
Inheritance
AdomdConnectionAdomdConnectionAdomdConnection
Implements

Examples

The following subroutine uses the given arguments to build a connection string that the subroutine uses to try to connect to a specified instance of Analysis Services and return an AdomdConnection:

Public Function Connect(Optional ByVal ServerID As String = "localhost", _  
    Optional ByVal DatabaseID As String = "", _  
    Optional ByVal UserID As String = "", _  
    Optional ByVal Password As String = "") As AdomdConnection  

    Dim strConnectionString As String  
    Dim objConnection As AdomdConnection  

    Try  
        ' First, build the connection string.  
        '   
        ' The ConnectionString property consists of   

        ' key/value pairs seperated by semicolons.  
        ' - The format, as a regular expression, should be:  
        ' (<Key>=<Value>)*([[;]/*(<Key>=<Value>)])  

        ' The connection string can take "Datasource", "Data Source",   
        ' or "Location" for this parameter.  
        If ServerID <> "" Then  
            strConnectionString &= "Data Source=" & ServerID & ";"  
        End If  

        ' The connection string can take "Catalog" or "Initial Catalog"   
        ' for this parameter.  
        If DatabaseID <> "" Then  
            strConnectionString &= "Initial Catalog=" & DatabaseID & ";"  
        End If  

        ' The connection string can take "UID", "User ID",   
        ' "Authenticated User", or "UserName" for this parameter.  
        If UserID <> "" Then  
            strConnectionString &= "User ID=" & UserID & ";"  
        End If  

        ' The connection string can take "PWD" or "Password"   
        ' for this parameter.  
        If Password <> "" Then  
            strConnectionString &= "Password=" & Password & ";"  
        End If  

        ' Get a reference to an AdomdConnection object.  
        objConnection = New AdomdConnection()  

        ' Assign the connection string and try to   
        ' open a connection.  
        objConnection.ConnectionString = strConnectionString  
        objConnection.Open()  

        Catch ex As AdomdConnectionException  
            ' The connection could not be opened or was disconnected.  
            ' This error can occur at any time, if the provider is   
            ' disconnected from the server.  
            Debug.WriteLine(ex)  
        Catch ex As AdomdErrorResponseException  
            ' A response is received from a provider that indicates an error.  
            Debug.WriteLine(ex)  
        Catch ex As AdomdUnknownResponseException  
            ' A response has been returned from the provider that   
            ' was not understood.  
            Debug.WriteLine(ex)  
        Catch ex As AdomdCacheExpiredException  
            ' A cached version of an ADOMD.NET object is no longer valid.  
            ' This error is typically raised when reviewing metadata.  
            Debug.WriteLine(ex)  
        Catch ex As AdomdException  
            ' Any other error raised by ADOMD.NET.  
            Debug.WriteLine(ex)  
        Catch ex As Exception  
            ' Any other error that occurs.  
            Debug.WriteLine(ex)  
    Finally  
        Debug.Write("The connection ")  
        If objConnection.State = ConnectionState.Open Then  
            Debug.WriteLine("is connected!")  
        Else  
            Debug.WriteLine("failed to connect!")  
        End If  
    End Try  

    ' Return the AdomdConnection object.  
    Return objConnection  
End Function  

Remarks

The AdomdConnection represents a connection with an analytical data source (for example, a connection to an instance of Microsoft SQL Server 2005 Analysis Services (SSAS)). Each connection is associated with an XML for Analysis session. If an AdomdConnection goes out of scope, the connection is not closed. To close the connection, you must explicitly call the Close or Dispose method of the AdomdConnection. If the Close or Dispose method is not called, the session associated with the AdomdConnection remains active and can be reused by another AdomdConnection. For more information about managing sessions, see Working with Connections and Sessions in ADOMD.NET and SessionID.

Constructors

AdomdConnection() AdomdConnection() AdomdConnection()

Initializes a new instance of the AdomdConnection class with default values.

AdomdConnection(AdomdConnection) AdomdConnection(AdomdConnection) AdomdConnection(AdomdConnection)

Initializes a new instance of the AdomdConnection class by using values from a specified AdomdConnection class. The session identifier and command state are not the same.

AdomdConnection(String) AdomdConnection(String) AdomdConnection(String)

Initializes a new instance of the AdomdConnection class by using the specified connection string.

Properties

ClientVersion ClientVersion ClientVersion

Gets the version of the ADOMD.NET client that implements the AdomdConnection.

ConnectionString ConnectionString ConnectionString

Gets or sets the string that the AdomdConnection uses to open an analytical data source.

ConnectionTimeout ConnectionTimeout ConnectionTimeout

Gets the time to wait for a connection to be established before the AdomdConnection stops trying to connect and generates an error.

Cubes Cubes Cubes

Gets an instance of a CubeCollection that represents the collection of cubes contained by an analytical data source.

Database Database Database

Gets the name of the database to be used after the AdomdConnection is open.

MiningModels MiningModels MiningModels

Gets an instance of a MiningModelCollection that represents the collection of mining models that an analytical data source contains.

MiningServices MiningServices MiningServices

Gets an instance of a MiningServiceCollection that represents the collection of mining services that an analytical data source contains.

MiningStructures MiningStructures MiningStructures

Gets an instance of a MiningStructureCollection that represents the collection of mining structures that an analytical data source contains.

ProviderVersion ProviderVersion ProviderVersion

Gets the version of the XML for Analysis provider that the AdomdConnection uses.

ServerVersion ServerVersion ServerVersion

Gets the version of the server used that the AdomdConnection uses.

SessionID SessionID SessionID

Gets or sets the string identifier of the session that the AdomdConnection opened with the server.

ShowHiddenObjects ShowHiddenObjects ShowHiddenObjects

Gets or sets a value that indicates whether hidden objects are returned.

State State State

Gets the current state of the AdomdConnection.

Methods

BeginTransaction() BeginTransaction() BeginTransaction()

Begins a new transaction.

BeginTransaction(IsolationLevel) BeginTransaction(IsolationLevel) BeginTransaction(IsolationLevel)

Begins a new transaction with the specified IsolationLevel enumeration value.

ChangeDatabase(String) ChangeDatabase(String) ChangeDatabase(String)

Changes the current database of the open AdomdConnection.

ChangeEffectiveUser(String) ChangeEffectiveUser(String) ChangeEffectiveUser(String)

Creates a new XML/A session with the specified user identity impersonated on the server. To use this method, the caller must have administrative permissions in Analysis Services.

Clone() Clone() Clone()

Creates and returns an instance of an AdomdConnection based on the current AdomdConnection. Session ID and state are not cloned.

Close(Boolean) Close(Boolean) Close(Boolean)

Closes the connection to the database, indicating whether to end the session.

Close() Close() Close()

Closes the connection to the database and ends the session.

CreateCommand() CreateCommand() CreateCommand()

Creates and returns an AdomdCommand that is associated with the AdomdConnection.

GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean, AdomdPropertyCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean, AdomdPropertyCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean, AdomdPropertyCollection)

Returns schema information from a data source by using a schema name and namespace to identify the information, applying any specified restrictions to the information, and, optionally, throwing an exception when inline errors occur as well as setting properties for the underlying XMLA Discover command.

GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean)

Returns schema information from a data source by using a schema name and namespace to identify the information, applying any specified restrictions to the information, and, optionally throwing an exception when inline errors occur.

GetSchemaDataSet(String, String, AdomdRestrictionCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection)

Returns schema information from a data source by using a schema name and namespace to identify the information, and by applying any specified restrictions to the information.

GetSchemaDataSet(Guid, Object[], Boolean) GetSchemaDataSet(Guid, Object[], Boolean) GetSchemaDataSet(Guid, Object[], Boolean)

Returns schema information from a data source by using a Guid object to identify the information, applying any specified restrictions on the information, and optionally throwing an exception when inline errors occur.

GetSchemaDataSet(String, AdomdRestrictionCollection) GetSchemaDataSet(String, AdomdRestrictionCollection) GetSchemaDataSet(String, AdomdRestrictionCollection)

Returns schema information from a data source by using a schema name to identify which schema to retrieve and by applying any specified restrictions to the information.

GetSchemaDataSet(Guid, Object[]) GetSchemaDataSet(Guid, Object[]) GetSchemaDataSet(Guid, Object[])

Returns schema information from a data source by using a Guid object to specify which schema information to return and by applying any specified restrictions to the information.

GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean)

Returns schema information from a data source by using a schema name to identify the information, applying any specified restrictions to the information, and optionally throwing an exception when inline errors occur.

Open() Open() Open()

Opens a connection with an analytical data source by using the settings specified in the ConnectionString property of the AdomdConnection.

Open(String) Open(String) Open(String)

Opens a connection with an analytical data source by using the specified path..

RefreshMetadata() RefreshMetadata() RefreshMetadata()

Forces the connection to repopulate all metadata from the server.

Explicit Interface Implementations

IDbConnection.BeginTransaction() IDbConnection.BeginTransaction() IDbConnection.BeginTransaction()

Begins a database transaction.

IDbConnection.BeginTransaction(IsolationLevel) IDbConnection.BeginTransaction(IsolationLevel) IDbConnection.BeginTransaction(IsolationLevel)

Begins a database transaction with the specified isolation level value.

IDbConnection.CreateCommand() IDbConnection.CreateCommand() IDbConnection.CreateCommand()

Creates a new AdomdCommand associated with this connection and returns its IDbCommand object.

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()

Creates and returns an instance of an AdomdConnection based on the current AdomdConnection. Session ID and state are not cloned.

Applies to