Share via

  • Article

Application.ExistsOnSqlServer Method

Returns a Boolean that indicates whether the specified package exists on the instance of SQL Server.

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public Function ExistsOnSqlServer ( _
    packagePath As String, _
    serverName As String, _
    serverUserName As String, _
    serverPassword As String _
) As Boolean
'Usage
Dim instance As Application
Dim packagePath As String
Dim serverName As String
Dim serverUserName As String
Dim serverPassword As String
Dim returnValue As Boolean

returnValue = instance.ExistsOnSqlServer(packagePath, _
    serverName, serverUserName, serverPassword)

public bool ExistsOnSqlServer(
    string packagePath,
    string serverName,
    string serverUserName,
    string serverPassword
)

public:
bool ExistsOnSqlServer(
    String^ packagePath, 
    String^ serverName, 
    String^ serverUserName, 
    String^ serverPassword
)

member ExistsOnSqlServer : 
        packagePath:string * 
        serverName:string * 
        serverUserName:string * 
        serverPassword:string -> bool 

public function ExistsOnSqlServer(
    packagePath : String, 
    serverName : String, 
    serverUserName : String, 
    serverPassword : String
) : boolean

Parameters

  • packagePath
    Type: System.String
    The package you are looking for.
  • serverName
    Type: System.String
    The name of the instance of SQL Server to search for the package.
  • serverUserName
    Type: System.String
    The SQL Server login name if you use SQL Server Authentication to log into the server; otherwise, nulla null reference (Nothing in Visual Basic) if you use Windows Authentication.
  • serverPassword
    Type: System.String
    The SQL Server login password if you use SQL Server Authentication to log into the server; otherwise, nulla null reference (Nothing in Visual Basic) if you use Windows Authentication.

Return Value

Type: System.Boolean
true if the package exists on the specified instance of SQL Server. false if the package does not exist.

Examples

The following code example creates a SQL Server folder, verifies that it exists, and then removes the folder and rechecks its existence. It also saves a package and verifies that the package was saved using the ExistsOnSqlServer method.

static void Main(string[] args)
        {
            // The variable pkg points to the location
            // of the ExecuteProcess package sample 
            // that is installed with the SSIS samples.
            string p = @"C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx";
            
            Application app = new Application();
            
            // Create a folder on SQL Server in the msdb database.
            app.CreateFolderOnSqlServer("\\", "myNewFolder", "yourserver", null, null);
            
            // Verify that the folder exists by using ExistsOnSqlServer method.
            Boolean folderExists = app.FolderExistsOnSqlServer("myNewFolder", "yourserver", null, null);
            Console.WriteLine("Folder exists? {0}", folderExists);

            // Load a package and save it.
            Package pkg = app.LoadPackage(p, null);
            app.SaveToSqlServerAs(pkg, null, "newPkg", "yourserver", null, null);

            // Verify that the package was saved.
            Boolean packageExists = app.ExistsOnSqlServer("newPkg", "yourserver", null, null);
            Console.WriteLine("Package exists? {0}", packageExists);

            //Remove the folder.
            app.RemoveFolderFromSqlServer("myNewFolder", "yourserver", null, null);

            // Verify that the folder was removed by using the ExistsOnSqlServer method.
            folderExists = app.FolderExistsOnSqlServer("myNewFolder", "yourserver", null, null);
            Console.WriteLine("Folder exists? {0}", folderExists);
        }

Sub Main(ByVal args() As String)
            ' The variable pkg points to the location
            ' of the ExecuteProcess package sample 
            ' that is installed with the SSIS samples.
            Dim p As String =  "C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx" 
 
            Dim app As Application =  New Application() 
 
            ' Create a folder on SQL Server in the msdb database.
            app.CreateFolderOnSqlServer("\\", "myNewFolder", "yourserver", Nothing, Nothing)
 
            ' Verify that the folder exists by using ExistsOnSqlServer method.
            Dim folderExists As Boolean =  app.FolderExistsOnSqlServer("myNewFolder","yourserver",Nothing,Nothing) 
            Console.WriteLine("Folder exists? {0}", folderExists)
 
            ' Load a package and save it.
            Dim pkg As Package =  app.LoadPackage(p,Nothing) 
            app.SaveToSqlServerAs(pkg, Nothing, "newPkg", "yourserver", Nothing, Nothing)
 
            ' Verify that the package was saved.
            Dim packageExists As Boolean =  app.ExistsOnSqlServer("newPkg","yourserver",Nothing,Nothing) 
            Console.WriteLine("Package exists? {0}", packageExists)
 
            'Remove the folder.
            app.RemoveFolderFromSqlServer("myNewFolder", "yourserver", Nothing, Nothing)
 
            ' Verify that the folder was removed by using the ExistsOnSqlServer method.
            folderExists = app.FolderExistsOnSqlServer("myNewFolder", "yourserver", Nothing, Nothing)
            Console.WriteLine("Folder exists? {0}", folderExists)
End Sub

Sample Output:

Folder exists? True

Package exists? True

Folder exists? False