AdomdConnection 类

Represents a connection to a multidimensional data source.

继承层次结构

System. . :: . .Object
  System. . :: . .MarshalByRefObject
    System.ComponentModel. . :: . .Component
      Microsoft.AnalysisServices.AdomdClient..::..AdomdConnection

命名空间:  Microsoft.AnalysisServices.AdomdClient
程序集:  Microsoft.AnalysisServices.AdomdClient(在 Microsoft.AnalysisServices.AdomdClient.dll 中)

语法

声明
Public NotInheritable Class AdomdConnection _
    Inherits Component _
    Implements IDbConnection, IDisposable, ICloneable
用法
Dim instance As AdomdConnection
public sealed class AdomdConnection : Component, 
    IDbConnection, IDisposable, ICloneable
public ref class AdomdConnection sealed : public Component, 
    IDbConnection, IDisposable, ICloneable
[<SealedAttribute>]
type AdomdConnection =  
    class
        inherit Component
        interface IDbConnection
        interface IDisposable
        interface ICloneable
    end
public final class AdomdConnection extends Component implements IDbConnection, IDisposable, ICloneable

AdomdConnection 类型公开以下成员。

构造函数

  名称 说明
公共方法 AdomdConnection() () () () Initializes a new instance of the AdomdConnection class with default values.
公共方法 AdomdConnection(String) Initializes a new instance of the AdomdConnection class by using the specified connection string.
公共方法 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.

页首

属性

  名称 说明
受保护属性 CanRaiseEvents (从 Component 继承。)
公共属性 ClientVersion Gets the version of the ADOMD.NET client that implements the AdomdConnection.
公共属性 ConnectionString Gets or sets the string that the AdomdConnection uses to open an analytical data source.
公共属性 ConnectionTimeout Gets the time to wait for a connection to be established before the AdomdConnection stops trying to connect and generates an error.
公共属性 Container (从 Component 继承。)
公共属性 Cubes Gets an instance of a CubeCollection that represents the collection of cubes contained by an analytical data source.
公共属性 Database Gets the name of the database to be used after the AdomdConnection is open.
受保护属性 DesignMode (从 Component 继承。)
受保护属性 Events (从 Component 继承。)
公共属性 MiningModels Gets an instance of a MiningModelCollection that represents the collection of mining models that an analytical data source contains.
公共属性 MiningServices Gets an instance of a MiningServiceCollection that represents the collection of mining services that an analytical data source contains.
公共属性 MiningStructures Gets an instance of a MiningStructureCollection that represents the collection of mining structures that an analytical data source contains.
公共属性 ProviderVersion Gets the version of the XML for Analysis provider that the AdomdConnection uses.
公共属性 ServerVersion Gets the version of the server used that the AdomdConnection uses.
公共属性 SessionID Gets or sets the string identifier of the session that the AdomdConnection opened with the server.
公共属性 ShowHiddenObjects Gets or sets a value that indicates whether hidden objects are returned.
公共属性 Site (从 Component 继承。)
公共属性 State Gets the current state of the AdomdConnection.

页首

方法

  名称 说明
公共方法 BeginTransaction() () () () Begins a new transaction.
公共方法 BeginTransaction(IsolationLevel) Begins a new transaction with the specified IsolationLevel enumeration value.
公共方法 ChangeDatabase Changes the current database of the open AdomdConnection.
公共方法 Clone Creates and returns an instance of an AdomdConnection based on the current AdomdConnection. Session ID and state are not cloned.
公共方法 Close() () () () Closes the connection to the database and ends the session.
公共方法 Close(Boolean) Closes the connection to the database, indicating whether to end the session.
公共方法 CreateCommand Creates and returns an AdomdCommand that is associated with the AdomdConnection.
公共方法 CreateObjRef (从 MarshalByRefObject 继承。)
公共方法 Dispose() () () () (从 Component 继承。)
受保护方法 Dispose(Boolean) (从 Component 继承。)
公共方法 Equals (从 Object 继承。)
受保护方法 Finalize (从 Component 继承。)
公共方法 GetHashCode (从 Object 继承。)
公共方法 GetLifetimeService (从 MarshalByRefObject 继承。)
公共方法 GetSchemaDataSet(Guid, array<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) 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, array<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, 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.
公共方法 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(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.
受保护方法 GetService (从 Component 继承。)
公共方法 GetType (从 Object 继承。)
公共方法 InitializeLifetimeService (从 MarshalByRefObject 继承。)
受保护方法 MemberwiseClone() () () () (从 Object 继承。)
受保护方法 MemberwiseClone(Boolean) (从 MarshalByRefObject 继承。)
公共方法 Open() () () () Opens a connection with an analytical data source by using the settings specified in the ConnectionString property of the AdomdConnection.
公共方法 Open(String)
公共方法 RefreshMetadata Forces the connection to repopulate all metadata from the server.
公共方法 ToString (从 Component 继承。)

页首

事件

  名称 说明
公共事件 Disposed (从 Component 继承。)

页首

注释

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 使用 ADOMD.NET 中的连接和会话 and SessionID.

示例

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

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。