SQL Server

SFTP Sync Download Tree w/ Must-Match Filename Constraints

See more SFTP Examples

Demonstrates how synchronize a directory tree in the download direction, but only download files matching a set of wildcard filenames.

Note: This example requires Chilkat v9.5.0.76 or greater.

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

    -- Possible synchronization modes are:
    -- mode=0: Download all files
    -- mode=1: Download all files that do not exist on the local filesystem.
    -- mode=2: Download newer or non-existant files.
    -- mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
    -- mode=5: Download only missing files or files with size differences.
    -- mode=6: Same as mode 5, but also download newer files.

    -- This example will download all files, but only those files having filenames
    -- that match *.gif and *.eml

    -- Imagine our remote directory tree has these files and directories:

    -- 	accentedLatin1.txt
    -- 	accentedUtf8.txt
    -- 	alice.key
    -- 	anter_cert.pem
    -- 	chiliPepper.gif
    -- 	helloWorld.pdf
    -- 	abc/chiliPepper.gif
    -- 	abc/ghk/
    -- 	data/chiliPepper.gif
    -- 	data/xyz/dkimHtmlBody.txt
    -- 	data/xyz/dkimVerifyTest.eml
    -- 	data/xyz/emailForCreateDsn.eml
    -- 	text/frenchUtf8.txt
    -- 	text/helloWorld.txt
    -- 	text/PolishEmailBody.txt
    -- 	text/something/

    -- Indicate that we only want to create auto-create local directories (if needed)
    -- for the files that are actually downloaded.  If SyncCreateAllLocalDirs remains
    -- 1, then the corresponding local directory is created for each remote directory
    -- traversed regardless of whether files within are downloaded.
    EXEC sp_OASetProperty @sftp, 'SyncCreateAllLocalDirs', 0

    EXEC sp_OASetProperty @sftp, 'SyncMustMatch', '*.eml; *.gif'

    DECLARE @remoteDir nvarchar(4000)
    SELECT @remoteDir = 'syncDownloadTest/someDir'
    DECLARE @localDir nvarchar(4000)
    SELECT @localDir = 'qa_output'
    DECLARE @mode int
    SELECT @mode = 0
    DECLARE @recursive int
    SELECT @recursive = 1
    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

    -- The following files were downloaded:

    -- chiliPepper.gif
    -- abc/chiliPepper.gif
    -- data/chiliPepper.gif
    -- data/xyz/dkimVerifyTest.eml
    -- data/xyz/emailForCreateDsn.eml


    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @sftp


END
GO