AdomdConnection クラス

多次元データ ソースへの接続を表します。

継承階層

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() AdomdConnection クラスの新しいインスタンスを既定値で初期化します。
パブリック メソッド AdomdConnection(String) 指定した接続文字列を使用して、AdomdConnection クラスの新しいインスタンスを初期化します。
パブリック メソッド AdomdConnection(AdomdConnection) 指定した AdomdConnection クラスの値を使用して、AdomdConnection クラスの新しいインスタンスを初期化します。セッション識別子とコマンドの状態は同じではありません。

先頭に戻る

プロパティ

  名前 説明
パブリック プロパティ ClientVersion AdomdConnection を実装する ADOMD.NET クライアントのバージョンを取得します。
パブリック プロパティ ConnectionString AdomdConnection が分析データ ソースを開くために使用する string を取得します。値の設定も可能です。
パブリック プロパティ ConnectionTimeout 接続の確立を待機する時間を取得します。この時間内に接続を確立できなかった場合、AdomdConnection は接続を中止してエラーを生成します。
パブリック プロパティ Container (Component から継承されています。)
パブリック プロパティ Cubes 分析データ ソースに含まれるキューブのコレクションを表す CubeCollection のインスタンスを取得します。
パブリック プロパティ Database AdomdConnection を開いた後に使用されるデータベースの名前を取得します。
パブリック プロパティ MiningModels 分析データ ソースに含まれるマイニング モデルのコレクションを表す MiningModelCollection のインスタンスを取得します。
パブリック プロパティ MiningServices 分析データ ソースに含まれるマイニング サービスのコレクションを表す MiningServiceCollection のインスタンスを取得します。
パブリック プロパティ MiningStructures 分析データ ソースに含まれるマイニング構造のコレクションを表す MiningStructureCollection のインスタンスを取得します。
パブリック プロパティ ProviderVersion AdomdConnection によって使用される XML for Analysis プロバイダーのバージョンを取得します。
パブリック プロパティ ServerVersion AdomdConnection によって使用されるサーバーのバージョンを取得します。
パブリック プロパティ SessionID AdomdConnection によって開かれたサーバーとのセッションの文字列識別子を取得します。値の設定も可能です。
パブリック プロパティ ShowHiddenObjects 非表示のオブジェクトが返されるかどうかを示す値を取得します。値の設定も可能です。
パブリック プロパティ Site (Component から継承されています。)
パブリック プロパティ State AdomdConnection の現在の状態を取得します。

先頭に戻る

メソッド

  名前 説明
パブリック メソッド BeginTransaction() 新しいトランザクションを開始します。
パブリック メソッド BeginTransaction(IsolationLevel) 指定した IsolationLevel 列挙値を使用して新しいトランザクションを開始します。
パブリック メソッド ChangeDatabase 開いている AdomdConnection の現在のデータベースを変更します。
パブリック メソッド Clone 現在の AdomdConnection に基づいて AdomdConnection のインスタンスを作成して返します。セッション ID と状態は複製されません。
パブリック メソッド Close() データベースへの接続を閉じて、セッションを終了します。
パブリック メソッド Close(Boolean) データベースへの接続を閉じて、セッションを終了するかどうかを指定します。
パブリック メソッド CreateCommand AdomdConnection に関連付けられた AdomdCommand を作成して返します。
パブリック メソッド CreateObjRef セキュリティ クリティカル。 (MarshalByRefObject から継承されています。)
パブリック メソッド Dispose (Component から継承されています。)
パブリック メソッド Equals (Object から継承されています。)
パブリック メソッド GetHashCode (Object から継承されています。)
パブリック メソッド GetLifetimeService セキュリティ クリティカル。 (MarshalByRefObject から継承されています。)
パブリック メソッド GetSchemaDataSet(Guid, array<Object[]) データ ソースからスキーマ情報を取得します。情報を識別するための Guid オブジェクトと、その情報に対して適用する制限を引数として指定します。
パブリック メソッド GetSchemaDataSet(String, AdomdRestrictionCollection) データ ソースからスキーマ情報を取得します。情報を識別するためのスキーマ名と、その情報に対して適用する制限を引数として指定します。
パブリック メソッド GetSchemaDataSet(Guid, array<Object[], Boolean) データ ソースからスキーマ情報を取得します。情報を識別するための Guid オブジェクト、および情報に対して適用する制限を引数として指定します。オプションで、インライン エラーの発生時に例外をスローさせることもできます。
パブリック メソッド GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean) データ ソースからスキーマ情報を取得します。情報を識別するためのスキーマ名、および情報に対して適用する制限を引数として指定します。オプションで、インライン エラーの発生時に例外をスローさせることもできます。
パブリック メソッド GetSchemaDataSet(String, String, AdomdRestrictionCollection) データ ソースからスキーマ情報を取得します。情報を識別するためのスキーマ名と名前空間、および情報に対して適用する制限を引数として指定します。
パブリック メソッド GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean) データ ソースからスキーマ情報を取得します。情報を識別するためのスキーマ名と名前空間、および情報に対して適用する制限を引数として指定します。オプションで、インライン エラーの発生時に例外をスローさせることもできます。
パブリック メソッド GetType (Object から継承されています。)
パブリック メソッド InitializeLifetimeService セキュリティ クリティカル。 (MarshalByRefObject から継承されています。)
パブリック メソッド Open() AdomdConnection の ConnectionString プロパティに指定されている設定を使用して、分析データ ソースとの接続を開きます。
パブリック メソッド Open(String) インフラストラクチャです。指定されたパスを使用して、分析データ ソースとの接続を開きます。
パブリック メソッド RefreshMetadata すべてのメタデータをサーバーから強制的に再読み込みします。
パブリック メソッド ToString (Component から継承されています。)

先頭に戻る

イベント

  名前 説明
パブリック イベント Disposed (Component から継承されています。)

先頭に戻る

明示的なインターフェイスの実装

  名前 説明
明示的なインターフェイスの実装プライベート メソッド IDbConnection.BeginTransaction() データベース トランザクションを開始します。
明示的なインターフェイスの実装プライベート メソッド IDbConnection.BeginTransaction(IsolationLevel) 指定した分離レベル値を使用してデータベース トランザクションを開始します。
明示的なインターフェイスの実装プライベート メソッド ICloneable.Clone 現在の AdomdConnection に基づいて AdomdConnection のインスタンスを作成して返します。セッション ID と状態は複製されません。
明示的なインターフェイスの実装プライベート メソッド IDbConnection.CreateCommand この接続に関連付けられた新しい AdomdCommand を作成し、その IDbCommand オブジェクトを返します。

先頭に戻る

説明

AdomdConnection は、分析データ ソースとの接続 (Microsoft SQL Server 2005 Analysis Services (SSAS) のインスタンスへの接続など) を表します。 各接続は、XML for Analysis セッションと関連付けられます。 AdomdConnection がスコープ外になっても、接続は閉じません。 接続を閉じるには、AdomdConnection の Close メソッドまたは Dispose メソッドを明示的に呼び出す必要があります。 Close メソッドも Dispose メソッドも呼び出されない場合は、AdomdConnection に関連付けられたセッションがアクティブなままとなり、別の AdomdConnection によるセッションの再利用が可能になります。 セッションの管理の詳細については、「ADOMD.NET での接続およびセッションの使用」および「SessionID」を参照してください。

使用例

次のサブルーチンでは、接続文字列の作成に使用する引数を受け取り、指定された Analysis Services インスタンスに接続して、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

スレッド セーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

関連項目

参照

Microsoft.AnalysisServices.AdomdClient 名前空間