SQL Server

SFTP Download Files Matching a Pattern

See more SFTP Examples

Demonstrates how to download files in a directory matching one or more patterns (such as "*.zip" or "abc*_*0719.csv". 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 requires 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

    -- The SyncTreeDownload method can be used non-recursively to download all files matching a set of patterns.

    -- This example will download all files, but only those files having filenames
    -- that match *.csv and *.eml
    EXEC sp_OASetProperty @sftp, 'SyncMustMatch', '*.eml; *.gif'

    DECLARE @remoteDir nvarchar(4000)
    SELECT @remoteDir = 'syncDownloadTest/someDir'
    DECLARE @localDir nvarchar(4000)
    SELECT @localDir = 'qa_output'

    -- mode=0: Download all matching files according to SyncMustMatch
    DECLARE @mode int
    SELECT @mode = 0

    -- do not recursively traverse the remote directory tree.
    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