SQL Server

SFTP Download all Files in a Directory

See more SFTP Examples

Demonstrates how to download all files in a remote directory. This example uses the SyncTreeDownload method in a non-recursive mode that forces the download of all files, regardless of date/time or size differences. SQL Server

-- 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)
    DECLARE @success int
    SELECT @success = 0

    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @sftp int
    EXEC @hr = sp_OACreate 'Chilkat.SFtp', @sftp OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, 'my-ssh-server.com', 22
    IF @success = 1
      BEGIN
        EXEC sp_OAMethod @sftp, 'AuthenticatePw', @success OUT, 'mySshLogin', 'mySshPassword'
      END
    IF @success = 1
      BEGIN
        EXEC sp_OAMethod @sftp, 'InitializeSftp', @success OUT
      END
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- Download all the files from the remote directory "syncDownloadTest/xml"
    -- into our local directory "qa_output"
    -- Both directories are relative paths.  The remote directory
    -- is relative to the HOME directory of the SSH user account.
    -- The local directory is relative to the current working directory of the process.
    -- It is also possible to use absolute paths.

    DECLARE @remoteDir nvarchar(4000)
    SELECT @remoteDir = 'syncDownloadTest/xml'
    DECLARE @localDir nvarchar(4000)
    SELECT @localDir = 'qa_output'
    -- Mode 0 causes SyncTreeDownload to download all files.
    DECLARE @mode int
    SELECT @mode = 0
    -- Do not recursively descend the remote directory tree.  Just download all the files in specified directory.
    DECLARE @recursive int
    SELECT @recursive = 0
    EXEC sp_OAMethod @sftp, 'SyncTreeDownload', @success OUT, @remoteDir, @localDir, @mode, @recursive
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END


    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @sftp


END
GO