Ajouter des connexions par programmation

  • Article

S’applique à :SQL Server SSIS Integration Runtime dans Azure Data Factory

La classe ConnectionManager représente des connexions physiques aux sources de données externes. La classe ConnectionManager isole du runtime les détails d'implémentation de la connexion. Elle permet au runtime d’interagir avec chaque gestionnaire de connexions de façon cohérente et prévisible. Les gestionnaires de connexions contiennent des propriétés stock que toutes les connexions ont en commun, telles que les propriétés Name, ID, Description et ConnectionString. Toutefois, les propriétés ConnectionString et Name sont habituellement les seules propriétés requises pour configurer un gestionnaire de connexions. Contrairement à d’autres paradigmes de programmation, où les classes de connexion exposent des méthodes telles que Open ou Connect pour établir physiquement une connexion à la source de données, le moteur d’exécution gère toutes les connexions du package pendant qu’il s’exécute.

La classe Connections est une collection des gestionnaires de connexions qui ont été ajoutés à ce package et qui sont disponibles au moment de l'exécution. Vous pouvez ajouter d’autres gestionnaires de connexions à la collection en utilisant la méthode Add de la collection, et en fournissant une chaîne qui indique le type de gestionnaire de connexions. La méthode Add renvoie l'instance ConnectionManager ajoutée au package.

Propriétés intrinsèques

La classe ConnectionManager expose un jeu de propriétés communes à toutes les connexions. Toutefois, vous avez parfois besoin d’accéder aux propriétés qui sont uniques au type de connexion spécifique. La collection Properties de la classe ConnectionManager fournit l'accès à ces propriétés. Les propriétés peuvent être extraites de la collection à l’aide de l’indexeur ou du nom de propriété et de la méthode GetValue, et les valeurs sont définies à l’aide de la méthode SetValue. Les propriétés des propriétés de l'objet de connexion sous-jacente peuvent également être définies via l'acquisition d'une instance réelle de l'objet et la définition directe de ses propriétés. Pour obtenir la connexion sous-jacente, utilisez la propriété InnerObject du gestionnaire de connexions. La ligne de code suivante présente une ligne C# qui crée un gestionnaire de connexions ADO.NET qui possède la classe sous-jacente ConnectionManagerAdoNetClass.

ConnectionManagerAdoNetClass cmado = cm.InnerObject as ConnectionManagerAdoNet;

Elle convertit l'objet du gestionnaire de connexions managées en son objet de connexion sous-jacente. Si vous utilisez C++, la méthode QueryInterface de l’objet ConnectionManager est appelée et l’interface de l’objet de connexion sous-jacent est demandée.

Le tableau suivant répertorie les gestionnaires de connexions inclus dans les services d’intégration et la chaîne utilisée dans l’instruction package.Connections.Add("xxx"). Pour obtenir la liste de tous les gestionnaires de connexions, consultez Connexions Integration Services (SSIS).

String Gestionnaire de connexions
"OLEDB" Gestionnaire de connexions pour les connexions OLE DB.
"ODBC" Gestionnaire de connexions pour les connexions ODBC.
"ADO" Gestionnaire de connexions pour les connexions ADO.
"ADO.NET:SQL" Gestionnaire de connexions pour les connexions ADO.NET (fournisseur de données SQL).
"ADO.NET:OLEDB" Gestionnaire de connexions pour les connexions ADO.NET (fournisseur de données OLE DB).
"FLATFILE" Gestionnaire de connexions pour les connexions de fichiers plats.
"FILE" Gestionnaire de connexions pour les connexions de fichiers.
"MULTIFLATFILE" Gestionnaire de connexions pour les connexions de fichiers plats multiples.
"MULTIFILE" Gestionnaire de connexions pour les connexions de fichiers multiples.
"SQLMOBILE" Gestionnaire de connexions pour les connexions SQL Server Compact.
"MSOLAP100" Gestionnaire de connexions pour les connexions Analysis Services.
"FTP" Gestionnaire de connexions pour les connexions FTP.
"HTTP" Gestionnaire de connexions pour les connexions HTTP.
"MSMQ" Gestionnaire de connexions pour les connexions Message Queuing (également appelées MSMQ).
"SMTP" Gestionnaire de connexions pour les connexions SMTP.
"WMI" Gestionnaire de connexions pour les connexions WMI (Microsoft Windows Management Instrumentation).

L'exemple de code suivant montre l'ajout d'une connexion OLE DB et FILE à la collection Connections d'un objet Package. L'exemple définit ensuite les propriétés ConnectionString, Name et Description.

using System;
using Microsoft.SqlServer.Dts.Runtime;
  
namespace Microsoft.SqlServer.Dts.Samples
{
  class Program
  {
    static void Main(string[] args)
    {
      // Create a package, and retrieve its connections.
      Package pkg = new Package();
      Connections pkgConns = pkg.Connections;
  
      // Add an OLE DB connection to the package, using the
      // method defined in the AddConnection class.
      CreateConnection myOLEDBConn = new CreateConnection();
      myOLEDBConn.CreateOLEDBConnection(pkg);
  
      // View the new connection in the package.
      Console.WriteLine("Connection description: {0}",
         pkg.Connections["SSIS Connection Manager for OLE DB"].Description);
  
      // Add a second connection to the package.
      CreateConnection myFileConn = new CreateConnection();
      myFileConn.CreateFileConnection(pkg);
  
      // View the second connection in the package.
      Console.WriteLine("Connection description: {0}",
        pkg.Connections["SSIS Connection Manager for Files"].Description);
  
      Console.WriteLine();
      Console.WriteLine("Number of connections in package: {0}", pkg.Connections.Count);
  
      Console.Read();
    }
  }
  // <summary>
  // This class contains the definitions for multiple
  // connection managers.
  // </summary>
  public class CreateConnection
  {
    // Private data.
    private ConnectionManager ConMgr;
  
    // Class definition for OLE DB Provider.
    public void CreateOLEDBConnection(Package p)
    {
      ConMgr = p.Connections.Add("OLEDB");
      ConMgr.ConnectionString = "Provider=SQLOLEDB.1;" +
        "Integrated Security=SSPI;Initial Catalog=AdventureWorks;" +
        "Data Source=(local);";
      ConMgr.Name = "SSIS Connection Manager for OLE DB";
      ConMgr.Description = "OLE DB connection to the AdventureWorks database.";
    }
    public void CreateFileConnection(Package p)
    {
      ConMgr = p.Connections.Add("File");
      ConMgr.ConnectionString = @"\\<yourserver>\<yourfolder>\books.xml";
      ConMgr.Name = "SSIS Connection Manager for Files";
      ConMgr.Description = "Flat File connection";
    }
  }
  
}

Imports Microsoft.SqlServer.Dts.Runtime
  
Module Module1
  
  Sub Main()
  
    ' Create a package, and retrieve its connections.
    Dim pkg As New Package()
    Dim pkgConns As Connections = pkg.Connections
  
    ' Add an OLE DB connection to the package, using the
    ' method defined in the AddConnection class.
    Dim myOLEDBConn As New CreateConnection()
    myOLEDBConn.CreateOLEDBConnection(pkg)
  
    ' View the new connection in the package.
    Console.WriteLine("Connection description: {0}", _
      pkg.Connections("SSIS Connection Manager for OLE DB").Description)
  
    ' Add a second connection to the package.
    Dim myFileConn As New CreateConnection()
    myFileConn.CreateFileConnection(pkg)
  
    ' View the second connection in the package.
    Console.WriteLine("Connection description: {0}", _
      pkg.Connections("SSIS Connection Manager for Files").Description)
  
    Console.WriteLine()
    Console.WriteLine("Number of connections in package: {0}", pkg.Connections.Count)
  
    Console.Read()
  
  End Sub
  
End Module
  
' This class contains the definitions for multiple
' connection managers.
  
Public Class CreateConnection
  ' Private data.
  Private ConMgr As ConnectionManager
  
  ' Class definition for OLE DB provider.
  Public Sub CreateOLEDBConnection(ByVal p As Package)
    ConMgr = p.Connections.Add("OLEDB")
    ConMgr.ConnectionString = "Provider=SQLOLEDB.1;" & _
      "Integrated Security=SSPI;Initial Catalog=AdventureWorks;" & _
      "Data Source=(local);"
    ConMgr.Name = "SSIS Connection Manager for OLE DB"
    ConMgr.Description = "OLE DB connection to the AdventureWorks database."
  End Sub
  
  Public Sub CreateFileConnection(ByVal p As Package)
    ConMgr = p.Connections.Add("File")
    ConMgr.ConnectionString = "\\<yourserver>\<yourfolder>\books.xml"
    ConMgr.Name = "SSIS Connection Manager for Files"
    ConMgr.Description = "Flat File connection"
  End Sub
  
End Class

Exemple de sortie :

Connection description: OLE DB connection to the AdventureWorks database.

Connection description: Flat File connection.

Number of connections in package: 2

Voir aussi