Partager via


Classe AdomdConnection

Represents a connection to a multidimensional data source.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.AnalysisServices.AdomdClient
Assembly :  Microsoft.AnalysisServices.AdomdClient (en Microsoft.AnalysisServices.AdomdClient.dll)

Syntaxe

'Déclaration
Public NotInheritable Class AdomdConnection _
    Inherits Component _
    Implements IDbConnection, IDisposable, ICloneable
'Utilisation
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

Le type AdomdConnection expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique AdomdConnection() () () () Initializes a new instance of the AdomdConnection class with default values.
Méthode publique AdomdConnection(String) Initializes a new instance of the AdomdConnection class by using the specified connection string.
Méthode publique 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.

Haut de la page

Propriétés

  Nom Description
Propriété protégée CanRaiseEvents (hérité de Component.)
Propriété publique ClientVersion Gets the version of the ADOMD.NET client that implements the AdomdConnection.
Propriété publique ConnectionString Gets or sets the string that the AdomdConnection uses to open an analytical data source.
Propriété publique ConnectionTimeout Gets the time to wait for a connection to be established before the AdomdConnection stops trying to connect and generates an error.
Propriété publique Container (hérité de Component.)
Propriété publique Cubes Gets an instance of a CubeCollection that represents the collection of cubes contained by an analytical data source.
Propriété publique Database Gets the name of the database to be used after the AdomdConnection is open.
Propriété protégée DesignMode (hérité de Component.)
Propriété protégée Events (hérité de Component.)
Propriété publique MiningModels Gets an instance of a MiningModelCollection that represents the collection of mining models that an analytical data source contains.
Propriété publique MiningServices Gets an instance of a MiningServiceCollection that represents the collection of mining services that an analytical data source contains.
Propriété publique MiningStructures Gets an instance of a MiningStructureCollection that represents the collection of mining structures that an analytical data source contains.
Propriété publique ProviderVersion Gets the version of the XML for Analysis provider that the AdomdConnection uses.
Propriété publique ServerVersion Gets the version of the server used that the AdomdConnection uses.
Propriété publique SessionID Gets or sets the string identifier of the session that the AdomdConnection opened with the server.
Propriété publique ShowHiddenObjects Gets or sets a value that indicates whether hidden objects are returned.
Propriété publique Site (hérité de Component.)
Propriété publique State Gets the current state of the AdomdConnection.

Haut de la page

Méthodes

  Nom Description
Méthode publique BeginTransaction() () () () Begins a new transaction.
Méthode publique BeginTransaction(IsolationLevel) Begins a new transaction with the specified IsolationLevel enumeration value.
Méthode publique ChangeDatabase Changes the current database of the open AdomdConnection.
Méthode publique Clone Creates and returns an instance of an AdomdConnection based on the current AdomdConnection. Session ID and state are not cloned.
Méthode publique Close() () () () Closes the connection to the database and ends the session.
Méthode publique Close(Boolean) Closes the connection to the database, indicating whether to end the session.
Méthode publique CreateCommand Creates and returns an AdomdCommand that is associated with the AdomdConnection.
Méthode publique CreateObjRef (hérité de MarshalByRefObject.)
Méthode publique Dispose() () () () (hérité de Component.)
Méthode protégée Dispose(Boolean) (hérité de Component.)
Méthode publique Equals (hérité de Object.)
Méthode protégée Finalize (hérité de Component.)
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetLifetimeService (hérité de MarshalByRefObject.)
Méthode publique 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.
Méthode publique 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.
Méthode publique 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.
Méthode publique 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.
Méthode publique 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.
Méthode publique 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.
Méthode protégée GetService (hérité de Component.)
Méthode publique GetType (hérité de Object.)
Méthode publique InitializeLifetimeService (hérité de MarshalByRefObject.)
Méthode protégée MemberwiseClone() () () () (hérité de Object.)
Méthode protégée MemberwiseClone(Boolean) (hérité de MarshalByRefObject.)
Méthode publique Open() () () () Opens a connection with an analytical data source by using the settings specified in the ConnectionString property of the AdomdConnection.
Méthode publique Open(String)
Méthode publique RefreshMetadata Forces the connection to repopulate all metadata from the server.
Méthode publique ToString (hérité de Component.)

Haut de la page

Événements

  Nom Description
Événement public Disposed (hérité de Component.)

Haut de la page

Notes

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 Utilisation de connexions et de sessions dans ADOMD.NET and SessionID.

Exemples

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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.