(SQL Server) SCP Download from a Specific Directory

Demonstrates how to download a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server. The remote directory can be a path relative to the HOME directory of the SSH user account, or an absolute path on the remote filesystem. Obviously, in both cases the SSH user account must have permission to open and read the file in the specified directory.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @ssh int
    -- Use "Chilkat_9_5_0.Ssh" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Ssh', @ssh OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Hostname may be an IP address or hostname:
    DECLARE @hostname nvarchar(4000)
    SELECT @hostname = 'www.some-ssh-server.com'
    DECLARE @port int
    SELECT @port = 22

    -- Connect to an SSH server:
    DECLARE @success int
    EXEC sp_OAMethod @ssh, 'Connect', @success OUT, @hostname, @port
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- Wait a max of 5 seconds when reading responses..
    EXEC sp_OASetProperty @ssh, 'IdleTimeoutMs', 5000

    -- Authenticate using login/password:
    EXEC sp_OAMethod @ssh, 'AuthenticatePw', @success OUT, 'myLogin', 'myPassword'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- Once the SSH object is connected and authenticated, we use it
    -- in our SCP object.
    DECLARE @scp int
    -- Use "Chilkat_9_5_0.Scp" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Scp', @scp OUT

    EXEC sp_OAMethod @scp, 'UseSsh', @success OUT, @ssh
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @scp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        EXEC @hr = sp_OADestroy @scp
        RETURN
      END

    -- This downloads a file from the "testApp/logs/" subdirectory (relative to the SSH user account's HOME directory).  
    -- For example, if the HOME directory is /Users/chilkat, then the following downloads
    -- /Users/chilkat/testApp/logs/test1.log
    DECLARE @remotePath nvarchar(4000)
    SELECT @remotePath = 'testApp/logs/test1.log'
    DECLARE @localPath nvarchar(4000)
    SELECT @localPath = 'c:/testApp/logs/test1.log'
    EXEC sp_OAMethod @scp, 'DownloadFile', @success OUT, @remotePath, @localPath
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @scp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        EXEC @hr = sp_OADestroy @scp
        RETURN
      END

    -- The following call to DownloadFile specifies an absolute file path on the SSH server:
    SELECT @remotePath = '/Users/chilkat/Documents/gecko.jpg'
    SELECT @localPath = 'c:/temp/images/gecko.jpg'
    EXEC sp_OAMethod @scp, 'DownloadFile', @success OUT, @remotePath, @localPath
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @scp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        EXEC @hr = sp_OADestroy @scp
        RETURN
      END


    PRINT 'SCP download file success.'

    -- Disconnect
    EXEC sp_OAMethod @ssh, 'Disconnect', NULL

    EXEC @hr = sp_OADestroy @ssh
    EXEC @hr = sp_OADestroy @scp


END
GO